Response

In the response-menu you can define various extra-info, that is added to the response. Some cases, that use extra-info are: The banner (CSS and JavaScript), portfolio, voucher, search message, overlay, ...

Open

To add a response, click the Add-button and edit it by clicking on the pen-icon. This will open the response config dialogue.

The first step is to define when the data is added to the response in the Context-tab. To do this, choose one of the options in the Context-area and click add.

When this is configured, you can add the widgets you want the data to be added to. If this field is left empty, the data will be applied to any widget.

With the first example, the data will only be added if the context parameter urlParamKey=test1 is present and the widget search is used and in the case of the second example, the data will be added if the filter category_id=20 is active and the widget navigation is called.

Open

In the next tab values you can define the base-values for the searchmessage.

The following three tabs are custom and can be configured individually.

To do this open the response-menu and click on the button “Edit schema”. Here you can define a custom dialogue based on the jdorn-editor. The Format is expected to be as follows:

[{“name”:”tabName”, “schema”:”escapedSchemaObject”}]

Also, the json of the schema has to be escaped.

In the Advanced-tab you can add single parameters, that don't require a json schema to be created.

When you are finished with the configuration, you can click on save and then on Test. Now you can navigate to the test-menu to see if it works.

To begin testing add the followng parameters in the request:

When this is done, click on the Get Results button then click on the extra info button.

A pop-up will appear and display all the information that is added to the extra-info. You will find the key you defined in the Advanced-tab previously.

And also all the data you added for the search message in the Values-tab.

When you're satisfied, you can go to the publishing menu and click publish all.

1.2.1 Overlay Configuration

The configuration of the overlay is done as follows:

First create a new response by clicking the “+ Add” button and edit it by clicking the “pencil” button.

Next you have to configure when to add the values to the response. So, add the choiceID you want to use for the overlay to the widgets. I used a new widget extend for this.

In this case I have also added the fact that it only appears if the context parameter bxOverlay=54 is

set. This is completely optional.

The values you can change are located in the Extend-tab.

The template¹ and the corresponding block² that you want to use for the overlay.

The three covered cases are the following:

Simple Overlay:

T: Boxalino_Intelligence::journey/overlay/simple.phtml

B: Boxalino\Intelligence\Block\Journey\General

Products Overlay:

T: Boxalino_Intelligence::journey/overlay/products.phtml

B: Boxalino\Intelligence\Block\Journey\Product\ProductList

Banner Overlay:

T: Boxalino_Intelligence::journey/overlay/jssor.phtml

B: Boxalino\Intelligence\Block\Journey\Banner\JssorBanner

Choose if the lightbox effect³ (slightly darker background, similar to here) should be used.

Behavioural Parameters

Triggers⁴ (wait, exit, idle): what should be the triggering of the overlay if there are multiple, separate them with a hyphen (-).

Minimum amount of the basket value⁵ before the overlay will be displayed.

Maximum amount of the basket value⁶ before the overlay shouldn't be displayed anymore.

If you want to switch from one text to another, at a specific basket value, this will be the threshold⁷.

How often⁸ the overlay should appear on the page. (Normally once is enough)

How long the user should wait⁹ before the overlay appears in milliseconds. 1000ms = 1s. (only relevant if the trigger wait is selected).

How long should the user leave the window¹⁰ before the overlay appears in seconds. (only relevant if the trigger exit is selected)

How long the use should remain idle¹¹ on the page before the overlay appears in seconds. (only relevant if the trigger idle is selected)

The parameters, that should be added to the ajax callback¹² when the overlay is shown (separated by comma). (e.g.: test1=1,test2=2,test3=3)

Visual Parameters

Background image¹³ of the simple overlay

Localized URL of the title image¹⁴ of the simple URL

Localized default text¹⁵ that the overlay should display.

If you want the text to switch¹⁶ after a given point (e.g. a specific basket value), enter it here.

Localized link of the button image¹⁷ of the URL.

The redirect link¹⁸ where the user should be navigated to if he clicks on the overlay.

The behaviour is configured in the Advanced-tab. And is simply some JavaScript. This should normally not need to be edited.

When all is configured, you can save, test and publish your configuration.