"Motivation block" documentation

The addon is designed to increase the product detail page conversion indicators due to the placement of the special block with content which will create motives to the user to make a purchase (checked for more than 1000 shops, the conversion increase effect is guaranteed).

Example of work

Content of this block open by clicking on heading of each motivational message which consists of such elements:

title — captures the essence of the motivational message (for example, Free shipping, Only original products, Worldwide delivery);
icon — visualizes and divides among themselves motivational messages in the block;
block content (with Smarty support) — expands with the information motivational message essence (displayed by clicking on message title).

Store administrator can flexibly manage each block content (create new, change a demonstration order in the list).

Each block element can be dependent on the main product category and user location (when changing the user’s location, the contents of the block will be overloaded using Ajax). In this way:

For products from different categories, you can show different motivational messages;
For users from different rate areas (delivery zones in CS-Cart), different contents of block elements can be shown.

The correct use of motivational messages in the store will significantly increase the conversion rates of the product card (the percentage of users who make a purchase will increase).

For CS-Cart Multi-Vendor redactions administrator can create preparation (blocks plan) with default filling and allow vendors to manage the specific blocks' content (for which the option allowing editing is set).

Compatibility

Available add-on version	CS-Cart/Multi-Vendor compatible versions
`v2.13.0`	4.15.1 – 4.18.1
`v2.12.0`	4.14.3
`v2.11.1`	4.12.2 – 4.14.2
`v2.7.1`	4.12.1 – 4.15.2
`v2.7.0`	4.11.1 – 4.11.5
`v1.3.0`	4.10.1 – 4.10.4

Add-on is compatible with the following Themes:

YoupiTheme (compatible with correspond CS-Cart version);
UniTheme2 (compatible with correspond CS-Cart version);
Responsive.

Support

General technical support conditions are available at this link (be sure to review these conditions, all solutions from the AlexBranding development team come with limited technical support).

In order to use our technical support, you need to:

Log in with your order owner account on https://cs-cart.alexbranding.com;
Go to the page My Account → Orders;
Find the corresponding order with the problem add-on in the orders list and pass to its details;
Find the “Support” link next to the corresponding add-on name (near you can find Documentation link also) and click on it;
Fill in the data with the problem, provide access to your CS-Cart installation (path to the administration panel, admin mail, admin password + FTP access) and create a ticket (after you will create the ticket, you will receive an e-mail and a special code to track the ticket in the future);
Wait for the specialist answer in accordance with the regulations of the technical support service and the priority of your ticket.

If you didn't receive an answer within the deadlines, according to the chosen ticket priority, send e-mail info@alexbranding.com with the ticket number, for which you did not receive an answer in time, and the team manager will solve the problem in compliance with regulations.

Technical support by telephone calls and direct e-mails is not provided. Any help comes through tickets and helpdesk. Carefully learn documentation and technical support conditions before creating a request.

Demo

You can test the addon work with admin access using our demo server Demos for CS-Cart solutions from Alexbranding by choosing it in Addons list or just follow the link.

Restrictions and warnings

We recommend to note general restrictions:

All solutions from AlexBranding developers team require pre-installation of the AB: Addons Manager service addon. It is delivered free of charge and is responsible for such services: installation, upgrades, license verifications. Excluding this service addon usage is not possible;
Addon files may have a closed (encoded) part, in which only a license check is located;
The addon will work only on those domains, that are specified in the user's license. If you try to use the solution on CS-Cart installations, whose domains are not included in the license, the addon will be automatically turned off;
Local installation is not possible, so that the addon works on the additional domain (subdomain), enter this domain (subdomain) in the Domain field, when ordering (or write to info@alexbranding.com) - adding technical domains for the developing or for testing is always free.

Usage

Installation

After your order has been processed by our manager, it will be transferred to Completed state, you will receive an email to your mailbox with ordered add-ons license numbers (usually it takes from 15 minutes to 8 hours depending on the day time and week day).

Then follow the steps below, which differs depending on your version of the CS-Cart platform:

If you have CS-Cart 4.16.1 and newer version

If you have CS-Cart 4.13.1 and newer version

If you have CS-Cart 4.12. *

If you have CS-Cart 4.11.5 and an earlier version

You can also install the add-on with a standard installation for CS-Cart. To do this, download the appropriate archive with an add-on version compatible with your version of the CS-Cart platform.
Go to the website cs-cart.alexbranding.com, log in under the account of the order holder and go to the page My Profile → Orders → Relevant Order, go to details and you will see a list of available archives for the ordered add-on. Download the version (archive) you need and make the installation (standard for CS-Cart installation: Add-ons → Downloaded add-ons and in the gearwheel menu select Manual installation).

Service add-on AB: Add-ons Manager must be installed and have Active status.

Demo data (quick start)

The addon allows creating in the automatic mode AB: Motivation block, already filled with a data structure.

For demo data adding, go to the page Administration panel → Add-ons → Manage add-ons and at the add-on name AB: Motivation block in the gearwheel menu select Demo data. On the opened page click button Add.

The sequence of adding demo data

Selection of storefronts is provided in multi-storefront that allows to add demo data for every storefront.

Result of adding demo data in Responsive

Result of adding demo data in UniTheme2

Settings

For access to the add-on settings you should go to the page Administration panel → Add-ons → Manage add-ons and at the add-on name in the gearwheel menu select appropriate menu item.

"General" settings tab

'General' settings tab

1. Elements description type

2. Use additional product categories

3. Save blocks state for elements in block

"Appearance" settings tab

"Appearence" tab settings

1. Template variant

2. Block Style

3. Background color of the block

4. Use style presets

"Admin panel settings" tab

"Admin panel settings" tab settings

This setting is available in mode "All storefronts" only!

1. Display a list of motivational elements attached for this category

Work with functionality

New element

Adding the element

To add a new element Motivation block, go to the page Administration panel → Add-ons → Manage add-ons and at the add-on name AB: Motivation block in the gearwheel menu select Data management. On the opened page click button Add.

A window of the element adding

Filling the element

To create a new motivational element fill in mandatory fields in the tab General and, if needed, fill in data in other tabs and fields.

Window of the element filling

1. Name

2. Position

3. Icon type

4. Template

5. Custom content

6. Set the disclosure element by default

7. User groups

8. Allow vendor editing (Multi-Vendor only)

9. Status

Result of new element adding for Responsive

Result of new element adding for UniTheme2

Displaying the motivation block

a) Standart (as the block in the layout)

b) With hook helping in the tpl file

For UniTheme2 this hook is already added to the most optimum place!

For Responsive addition the hook in two variants is available:

A). In template Standard template — for this open file (by FTP or go to Design → Templates) responsive/templates/blocks/product_templates/default_template.tpl for editing and replace string 46 code:

{hook name="products:promo_text"}
                {if $product.promo_text}
                <div class="ty-product-block__note-wrapper">
                    <div class="ty-product-block__note ty-product-block__note-inner">
                        {$product.promo_text nofilter}
                    </div>
                </div>
                {/if}
                {/hook}

by code:

{hook name="products:promo_text"}
                    <div class="ty-product-block__note-wrapper">
                            <div class="ty-product-block__note ty-product-block__note-inner">
                                {if $product.promo_text}
                                    {$product.promo_text nofilter}
                                {/if}

                                {hook name="products:ab__motivation_block"}{/hook}
                            </div>
                    </div>
                {/hook}

Modified file example

B). In template Big picture — for this open file (by FTP or go to Design → Templates) responsive/templates/blocks/product_templates/bigpicture_template.tpl for editing and replace code:

{hook name="products:promo_text"}
                    {if $product.promo_text}
                    <div class="ty-product-block__note">
                        {$product.promo_text nofilter}
                    </div>
                    {/if}
                    {/hook}

with code:

{hook name="products:promo_text"}
                        <div class="ty-product-block__note">
                            {if $product.promo_text}
                                {$product.promo_text nofilter}
                            {/if}

                            {hook name="products:ab__motivation_block"}{/hook}
                        </div>
                    {/hook}

Modified file example

Recommended using the hook addition standard place specified in this document. It guarantees the styles correct display and is the most optimum from the addon developers viewpoint.

Element binding to the subcategory

If a product has more than the main category — then it's possible to display motivational elements for the product if only an additional category is specified.

For motivation block elements (items) placing to concrete category, it is necessary go to the page Administration panel → Add-ons → Manage add-ons and at the add-on name AB: Motivation block in the gearwheel menu select Data management. On the opened page press needed element name, go to the tab Categories and press button + Add categories and with picker help choose that additional categories (which you specified on the page Administration panel → Products → Products → [product name]), and press button Add categories, then press Save button.

Example of binding new element to the category

Element binding to rate area

The addon allows displaying the motivation block concrete necessary element for each concrete area.

Example of binding new element to rate area

For motivation block elements (items) placing to concrete tariff zone, it is necessary go to the page Administrative panel → AB: Addons → AB: Motivation block → Data management press needed element name, go to the tab Rate areas and press button + Add rate areas and with picker help choose that areas, for which it is necessary to display this motivation block element, press button Add rate areas, then press Save button.
There is a possibility to include and exclude motivational elements for the chosen rate areas by applying the field "Active for". If you need to include motivational elements for the rate areas that are chosen in the list, you should select "Active for all in the list". And if you need to exclude ‒ select "Active for all not in the list".

Element binding to the product

The add-on allows displaying the motivation block concrete necessary element for each concrete product.

Example of binding new element to products

For motivation block elements (items) placing to concrete product, it is necessary go to the page Administration panel → Add-ons → Manage add-ons and at the add-on name AB: Motivation block in the gearwheel menu select Data management. On the opened page press needed element name, go to the tab Products and choose products with picker, then click Save button.

There is a possibility to include and exclude motivational elements for chosen products by applying the field "Active for". If you need to include motivational elements for products that are chosen in the list, you should select "Active for all in the list". And if you need to exclude ‒ select "Active for all not in the list".

Editing item content for Vendors in the Multi-Vendor edition

For each vendor in the Multi-Vendor edition accessible editing motivational element content by the Allow vendor editing option.

Editing content window for MV

To go to the editing it is necessary by access permissions as a vendor go to the page Administration panel → Vendors → Vendors → [vendor name] → AB: Motivation block. You will see page with the available motivation block element editing.

Editing content window

Also if desired, each vendor can turn off the motivational element on its own.

Edit motivational elements separately for each storefront

In Multi-Vendor edition vendor can edit each motivational element separately for each storefront. Thus, you can write a flexible content for element specifying the most precision information for each storefront. This functionality is located on the page Administration panel → Vendors → [vendor’s name] → “AB: Motivation block” tab.

Split elements for each storefront

Templates for motivation block content

Templates for motivation block content
Besides the use of the custom content in the content of motivational element you may use pre-installed templates. Template displays dynamic content in the element of motivation block for the appropriate product. To use the templates go to the page Administration panel → Add-ons → Manage add-ons and at the add-on name AB: Motivation block in the gearwheel menu select Data management. On the opened page press needed element name and select one of four templates in the Template field.

Add-on contains of the following templates:

Shipping information ‒ the template displays information about the cost of delivery of products. Available when the Maps and Geolocation add-on is active. Information will be shown only with active setting Show shipping cost and time on product pages for Maps and Geolocation add-on.
Payment methods information ‒ the template displays information about the available payment methods.
Product categories list ‒ the template displays a list of all categories in which the product is involved. It is available if there is at least 1 category in the store (except for the "Cart category");
Product tags list ‒ the template displays a list of all tags assigned to the product.

Icons table for theme

The all available icons list is on the page Administration panel → Add-ons → Manage add-ons and at the add-on name AB: Motivation block in the gearwheel menu select Available icons. On the opened page click the Copy button — in the clipboard, the icon class that looks like ty-icon-up-dir will be copied.

Themes UniTheme2 and YoupiTheme add its own icons to standard one.

Path to icon list page

Permissions

Add-on adds following access rights:

Full access ‒ allows to edit add-on data;
Can view only ‒ allows to view motivation elements;
No access ‒ forbids access to add-on data.

Integrations

PHP-hooks in add-on

There are list of php-hooks in order to make it more convenient for you to integrate your solutions with the add-on AB: Motivation block

Hook in the icon fetch function

Hook in the selection of information on the motivational element (one)

Hook in the selection of information on motivational elements (several)

Hook in the function of saving information of a motivating element

Smarty-hooks

There are list of smarty-hooks in order to make it more convenient for you to integrate your solutions with the add-on AB: Motivation block.

Hook in the template list of the "Template" field of the motivational element

Hook in a file listing available icons

Hook in the file of motivational elements output for the vendor

Hooks in the file responsible for displaying vertical tabs

Hooks in the file responsible for displaying horizontal tabs

Hooks in the form of searching motivational elements

Javascipt-hooks

There are a number of javascript hooks in the module in order to make it more convenient for you to integrate your solutions with the add-on AB: Motivation block

Hook after restoring content of a motivational element by a vendor

Hook after ajax loading of motivational elements

PHP-schemes

Scheme ab__mb/item_templates.php

How to update

To have possibility to update an add-on, you must have an active subscription period for add-on license.

AB: Add-ons Manager will notify you about available updates (you will see an indicator of new alerts). The recommended way is to update via the CS-Cart Upgrade center (a regular procedure of the platform). This method will allow lossless configuration of the transition to the new add-on version, that is guaranteed to be compatible with your CS-Cart platform version.

Before updating, always make a full database and your store files backup (we recommend backing up using server or hosting tools).

To make updates procedure:

Go to the Administration panel → Administration → Upgrade center;
Find the appropriate update among the available updates and click the Update button;
Follow all the instructions, that will be shown during the upgrade procedure;
Clear CS-Cart cache and start using new add-on version.

If you have an earlier version of the add-on (without the Upgrade center support)

AB cookies

Add-on adds its cookies as follows:

Cookie name	Description	Expiry
`ab__mb_id__`	Stores motivation tabs element state.	1000 days

List of releases

Subscribe to our Telegram-channel to get info about new releases.

v2.13.0 from 14 September 2023

Functionality changes:
[*] UniTheme2. Adapted rounding for elements of motivation block according to the theme setting.
[*] UniTheme2. Changed style of block elements.
[*] The setting “Data management → Set the disclosure element by default” has been changed. Added ability to manage the setting individually for different devices.

Bug fixes:
[!] UniTheme2. On the product page tabs of the block collapsed when expand and close pop-up window of the block “Share”.

v2.12.2 from 22 September 2022

Functionality changes:
[*] For Multi-Vendor edition added prohibition for vendor to use Smarty construction at the panel of vendor management on the editing company page.

v2.12.1 from 06 Jule 2022

Bug fixes:
[!] Added compatibility with CS-Cart 4.15.1.

v2.12.0 from 13 June 2022

New features and improvements:
[+] UniTheme2. Improved adaptivity, compatibility with the theme version 4.14.3.c.

v2.11.1 from 01 December 2021

Bug fixes:
[!] Fixed security issue.

v2.11.0 from 21 October 2021

New features and improvements:
[+] Added setting “User groups” on the page “AB: Motivation block → Data management → [motivation element name] → “General” tab.
[+] Multi-Vendor edition. On the page “Vendors→ [vendor's name] → Motivation block” added view of information for which motivation element belongs to.

v2.10.1 from 01 September 2021

Bug fixes:
[!] CS-Cart Ultimate. An error occurred while editing the storefront. Fixed.

v2.10.0 from 01 September 2021

New features and improvements:
[+] Added compatibility with Multi-Vendor Ultimate.

Bug fixes:
[!] "Product reviews" add-on. On the product page sorting of products didn't work. Fixed.

v2.9.0 from 08 June 2021

New features and improvements:
[+] Added compatibility with CS-Cart 4.13.1.
[+] Multi-Vendor. Added compatibility with the add-on "Vendor's privilages".

v2.8.0 from 23 March 2021

New features and improvements:
[+] On the editing page of motivational element added tab "Products" that allows to add or exclude product list for displaying motivational element.

Bug fixes:
[!] CS-Cart Multi-Vendor. "Vendor-to-admin payments" add-on. On the product page "Debts payment" elements of the add-on "AB: Motivation block" were displayed. Fixed.

v2.7.1 from 18 December 2020

New features and improvements:
[+] Added compatibility with CS-Cart 4.12.1.

v2.7.0 from 11 September 2020

Bug fixes:
[!] Template of the motivational element “Payment methods information” was not styled according to the rest motivational elements. Fixed.
[!] On the page of motivational elements management PHP Notice occurred when any category or rate area was not selected for motivational element. Fixed.
[!] On the storefront PHP Notice occurred for elements with no template selected. Fixed.
[!] On the page of motivational elements management the template “Custom content (HTML/Smarty)” was duplicated in the search block. Fixed.

v2.6.0 from 23 June 2020

Functionality changes:
[*] Improved add-on performance.

Bug fixes:
[!] Add-on "Maps and geolocation". On the storefront when displaying a motivational element with the "Shipping information" template, the delivery information of the "Maps and Geolocation" add-on was not blocked.
[!] It was impossible to create a new motivational element with the template "Shipping information". Fixed.

v2.5.0 from 29 May 2020

New features and improvements:
[+] Added Ukrainian language support.

Bug fixes:
[!] On the storefront in the template of the motivational element "Payment methods information" all payment methods were displayed regardless of the setting "User groups". Fixed.
[!] On the storefront motivational element was not displayed if tag img was used only in the content. Fixed.

v2.4.0 from 18 March 2020

New features and improvements:
[+] Added a new template "Product tags list" that display the list of product tags. The template is available for any motivational element when using the "Tags" add-on on the page AB: Add-ons → AB: Motivation block → Data management → [motivational element] → "Template" field → "List of product tags" option;
[+] Responsive and YoupiTheme: Added icons for demo data of motivational elements;
[+] Added output of icons on the page "AB: Addons → AB: Motivation block → Available icons" YoupiTheme. (available from version YoupiTheme 4.11.3.e);
[+] Added the ability to edit not only the name of the motivational element but its content as well on the storefront when the mode "Edit texts" is chosen and set the template "Custom content".

Functionality changes:
[*] Field ""Brand" feature id" is a mandatory one when the template "Product categories list" is chosen;
[*] Demo data element "Find similar items here" was renamed on "Find similar" and its status by default was changed on "Disabled".

Bug fixes:
[!] For servers of version PHP to 7.0.0 was displayed the PHP Notice that scalar and null values are available only for constants. Fixed;
[!] Motivational elements with no content were displayed on the storefront. Fixed.

v2.3.0 from 10 February 2020

New features and improvements:
[+] Added sidebar for manage page with hints of motivation element (could be seen when the setting "Type of elements description: HTML-content with Smarty support" is switched on);
[+] Added the ability to switch on/off motivation elements for categories or rate areas;
[+] Added template to output categories where the product participates;
[+] Added setting "Display a list of motivational elements attached for this category" (it works for the categories in administrative panel).

Functionality changes:
[*] Add-ons color picker changed to the standard CS-Cart picker;
[*] Updated demo data of the add-on (new element "Find similar items here" is added).

Bug fixes:
[!] Rate areas picker did not work at Ultimate CS-Cart versions on the page "Administration panel → AB: Addons → AB: Motivational block → Manage data". Fixed.

v2.2.0 from 27 December 2019

New features and improvements:
[+] Added setting "Use style presets", which controls whether predefined styles for motivational elements will be used;
[+] Sorting by name and status has been added to the page for managing motivational elements;

Bug fixes:
[!] Themes Responsive and Youpitheme. Popups displayed by the "Delivery Information" template were cut off according to the framework of the motivation block. Fixed;

v2.1.0 from 25 December 2019

New features and improvements:
[+] On the page for managing motivational elements, a search was added for the "Template" field;
[+] Added Smarty hooks for the possibility of expanding the search form;
[+] Added a template "Information about payment methods" as an option for the "Template" field of a motivation element;

Functionality changes:
[*] Removed the option "Use AJAX for the block loading"

Bug fixes:
[!] Motivation elements created on the basis of demo data from the previous version of the module were not displayed for mobile devices. Fixed

v2.0.0 from 10 December 2019

New features and improvements:
[+] Added several design styles for the motivation block, optionally "With background color" and "With frame";
[+] Added setting "Template option" optionally defining a template for displaying the motivation block "Horizontal tabs" and "Vertical tabs";
[+] Added setting "Save state of disclosure of elements";
[+] Added the ability to output a motivational element of a template to the content. Added version of the template "Information about the cost of delivery";

Functionality changes:
[*] Changed the color picker (from the standard Cs-Cart picker to jquery.minicolors) in the settings of the motivational element;

Bug fixes:
[!] When the "Warehouses" module was active, the picker for destinations did not work. Fixed;
[!] When the "Edit Texts" mode was turned on, the showcases of the tooltips displayed in the motivation block caused an error. Fixed

v1.3.0 from 25 September 2019

New features and improvements:
[+] Added the possibility to select motivational elements not only by the product main category but also for additional;
[+] Added ability for the vendor to set item display on its product page.

Bug fixes:
[!] On the product card page PHP-notice occurred when error mapping was active. Fixed;
[!] The allowed input value in the "Icon class" field has increased. Fixed;
[!] The added icons had no padding, the icon stuck to the name. Fixed;
[!] On the product card page at displaying by the "Big picture" template, in the Unitheme2 template there were too large paddings inside the block. Fixed;
[!] In the YoupiTheme, if you set an icon to a motivational element, its had no paddings. Fixed;
[!] In motivational elements names, on the storefront long spans were not cut. Fixed.

v1.2.0 from 15 August 2019

Feature additions:
[+] Addon option "Use AJAX for the block loading" is added.

Functionality changes:
[*] Styles for YoupiTheme are renewed.

Bug fixes:
[!] Motivational block displaying on the product card page depended from AlexBranding server status. Fixed;
[!] At addon settings saving from the administrator on the multistore site PHP-warning is appeared. Fixed.

v1.1.1 from 08 August 2019

Feature additions:
[+] Added compatibility with YoupiTheme template.

Bug fixes:
[!] At the motivational element editing on the multistore website — rate areas picker button was not displayed. Fixed;
[!] At the motivational block output — sellers changes were not considered. Fixed;
[!] In the administration panel at the motivational element creation tabs don't displayed. Fixed.

v1.1.0 from 02 August 2019

Feature additions:
[+] On the storefront, block loading is taken out in AJAX. Now the block is not indexed by search engines;
[+] During the motivational element creation, the ability to set category and rate area for which this element will be displayed is added;
[+] On the motivational elements list page, the elements mass switching on/off ability is added;
[+] On the motivational block data management page, the search panel is added.

Bug fixes:
[!] In the product card template "Big picture", when using the motivation block background color, the external space was incorrectly displayed. Fixed.

v1.0.3 from 03 Jule 2019

Bug fixes:
[!] On the addon "Data management" page, the 403rd mistake on the multistore website was appearing;
[!] In Unitheme2 it was impossible to set the colors of the motivational unit. Fixed.

v1.0.2 from 25 June 2019

Bug fixes:
[!] Fixed bug when displaying the block with a hook on multivendor;

v1.0.1 from 19 June 2019

Feature additions:
[+] Added support for multiple "Motivational Blocks" on the page;
[+] Added mass cloning of elements;