Superflow Documentation

It's always handy to have a good product documentation around. We certainly do allocate an updated documentation for Magento Superflow on this page explaining installation, integration, product implementation and configuration processes.

Superflow Installation

You will receive the Superflow extension compressed in a tar-File called superflow.tar. For installation process please follow these steps:

  1. Upload superflow.tar into the root
    directory of your Magento installation
  2. Run the command "tar -xvf superflow.tar"
  3. Login to the Admin Panel of your Magento Shop
  4. Navigate to System » Configuration » Advanced
    and make sure Velite_Superflow is enabled.


Notice that the template files get copied into the directory of the default design template (/magento/app/design/frontend/default/default).

 

Superflow Integration

Now it's time to integrate the Superflow into your design. You either have the possibility to integrate the extension into a CMS-Page or into an existing Template-File.

Option 1: CMS-Page integration

  1. Login to the Magento Admin Panel and navigate to CMS » Manage Pages
  2. Switch to the page on which you want to integrate the Superflow
    (e.g. "Home page" for displaying it on the store's home page)
  3. In the content-field add the following code at the line you want the Superflow to be displayed: {{block type="superflow/index" template="superflow/box.phtml"}}

Option 2: Template-File integration

  1. Figure out which XML-Configuration file in the layout directory is responsible for the template in which you want to integrate the Superflow and open it in your favourite text-editor
  2. Add this line <block type="superflow/index" name="superflow_box" template="superflow/box.phtml" />
  3. Switch to the template directory and open the desired Template-File
  4. Add this line <?php echo $this->getChildHtml('superflow_box') ?> right at the position you want the Superflow to get shown up
 

Superflow Content

Now we want to get some of your products displayed in the Superflow:

  1. Navigate to Catalog » Manage Products within the Magento Admin Panel
  2. Select a product you want to get displayed in the Superflow
  3. Switch to the tab Superflow and choose an image from the dropdown
  4. You now have the ability to set an order priority, that means the higher you set the number, the more left the product will be pushed within the Superflow - this field is optional; if you don't set a priority the product will be placed randomly - multiple products can have the same priority
  5. Put in an alternative product name, which will replace the standard description from your Magento database - this field is optional but recommended if your product description is pretty long
  6. After saving the product, it should be displayed in the Superflow
 

Superflow Scopes

Scoping is a way to display different products in multiple Superflow instances. Basically there are two possible ways of scoping: Target based and category based scoping. Both can also be combined.

Option 1: Target based scoping

Login to the admin-area and go to the edit-page of a product you want to get added to the Superflow. Go to the "Superflow" tab. Make sure you have selected an image in the "Show in Superflow" Dropdown. There is a field "Scope" as well. Fill in a name for this scope (e. g. "scope1"). You have now the ability to only show products in the Superflow which are in that specific scope. If you integrate the Superflow in a CMS block you do it like this:

{{block type="superflow/index" template="superflow/box.phtml" use_scope="scope1"}}

If you integrate it in your template files, this is how you do it:

<block type="superflow/index" name="superflow_box" as="superflow_box" template="superflow/box.phtml" >
<action method="setUseScope"><scope>scope1</scope></action>
</block>

Option 2: Category based scoping

The second possibilty is to show only products of the current category and its subcategories in the Superflow. Therefor the products must also be added to the Superflow in the Magento backend. Let's say, you have two categories Shoes and Socks - you add 3 pair of shoes and 2 pair of socks to the Superflow. Now you want to use the Superflow on the category page and you only want the products of the current category being displayed. In the shoes category the shoes and in the socks category the socks. You handle this in a CMS block by enabling category based scoping like this:

{{block type="superflow/index" template="superflow/box.phtml" use_category_scope="yes"}}

Or in the template:

<block type="superflow/index" name="superflow_box" template="superflow/box.phtml" >
<action method="setUseCategoryScope"><use>yes</use></action>
</block>

Notice that the category scope won't have any effect, if you are using it on a page without category context.

Combining both

As mentioned above, you can also combine both ways of scoping:

{{block type="superflow/index" template="superflow/box.phtml" use_scope="scope1" use_category_scope="yes"}}

This would only display products from the current category which has the target "scope1" in the Superflow. The following way shows how to implement it directly into the template:

<block type="superflow/index" name="superflow_box" template="superflow/box.phtml" >
<action method="setUseCategoryScope"><use>yes</use></action>
<action method="setUseScope"><scope>scope1</scope></action>
</block>

As you see, scoping provides a great new flexibility.

 

Superflow Advanced

To provide you a maximum of flexibility we have integrated some advanced features.

JavaScript Callbacks

You can setup Superflow to call a JavasScript function when someone clicks on the currently focused Image and/or when a image changes. JavaScript Callbacks can be setup in the Advanced-Section of the configuration-menu. The JavaScript functions get the ID of the product passed as an argument. Here is a sample callback function that alerts the product ID when someone clicks on a Cover:

function superflowClick(productId) {
    alert('The ID of the product you clicked on is: ' + productId);
}

 

Superflow Uninstallation

This is a short description on how you can uninstall the Superflow completely from your Magento installation. First delete these Files and Folders:

  • app/code/local/Velite/Superflow/
  • js/velite/superflow/
  • app/etc/modules/Velite_Superflow.xml
  • app/design/frontend/default/default/template/superflow/
  • app/design/frontend/default/default/template/layout/superflow.xml

If you don't use any other velite extensions, you can also delete the folders js/velite/ and app/code/local/Velite/

Clear the attributes that the Superflow writes into the database by executing these SQL delete statements:

DELETE FROM `eav_attribute` WHERE attribute_code = 'superflowadd';
DELETE FROM `eav_attribute` WHERE attribute_code = 'superflowprio';
DELETE FROM `eav_attribute` WHERE attribute_code = 'superflowalttext';
DELETE FROM `eav_attribute` WHERE attribute_code = 'superflowscope';
DELETE FROM `core_resource` WHERE code = 'superflow_setup';
DELETE FROM `core_config_data` WHERE path LIKE 'superflow/%';
DELETE FROM `eav_attribute_group` WHERE attribute_group_name = 'Superflow';

Rebuild Flat Catalog Product in System » Cache Management.

That's it. Please notice that running these SQL statements is required, otherwise you will get an error message on your product-edit page. This happens just because the Superflow installs some special system attributes that we need to get rid of.