Testing
- Federicco Grasso (Unlicensed)
- Sylvain Paillard
Tutorials
1. Why does this appear live?
2. How to test before publish?
3. Understand personalization
This is the testing view, it consists of two main parts: The Test Request (left) and the Test Results (right).
At the top of the view there is a tutorial, which consists out of three container each of them has an own topic. You can see a title and a short summary and if you click the blue ‘show’ button on the right top of the container, a sidepanel will slide in with a more detailed explanation.
If the tutorial disturbs you or you just don’t want to see it anymore and save some space, you can simply hide it by clicking on the switch button on top right of the view. It is labeled with the word ‘Tutorial’. Even if you refresh the page now it won’t show up, until you turn it on again.
1.1.1 Test Request
Input | Use |
Select a saved request | With this dropdown you can select previously saved requests and fill out the tabs with the data provided in the saved request. |
This button will save the request you have last run so that you can use it in the future. | |
This button will delete the request that is currently selected in the dropdown. | |
Get results | Sends the request and displays the results as a new column, by clicking a second time on it, the current column refreshes with the currently set parameters. |
| This button will activate the compare mode, now you’ll be able to add a new second column to the right side, with the values you want. |
Recover | Recovers the last parameters you’ve set. That’s very helpful, if you accidentally refresh a site oder switch to another. |
1.1.1.1 Widget
Dropdown | Use |
Widget | In this dropdown you can select one of the CPO Drivers that you have defined in the Strategies view. |
Language (by default: ‘de’) | This dropdown allows you to select a language to be used in the request. The languages will be listed as country codes such as “en” for English or “de” for German. |
Mode (by default: ‘test mode with live data’) | This dropdown lets you select between the following four test modes: · “Live mode with live data” · “Test mode with live data” · “Live mode with dev data” · “Test mode with dev data” |
Fields | Allows you to select one or more fields to be displayed in the results. |
Test Variant | Allows you to select between several test variants for the selected widget. |
1.1.1.2 Visitors / Customer ID
Input | Use |
Visitor ID | Allows you to specify a numeric id for a profile to be used in the request profile. |
Customer ID | Allows you to specify a numeric id for a customer to be used in the request profile. |
IP Address | Allows you to specify an IP address (format: 255.255.255.255) for the request profile. |
1.1.1.3 Parameters
This tab allows you to define the context used for the request.
Input | Use |
Search Query | This input allows you to enter your own search query which will be used in the request. |
Item ID | This input allows you to enter a numeric item id. |
Context Parameters | This input allows you to enter specific context parameters. It expects a format of “parameter=value” with no spacing around the “=”. To have multiple parameter value pairs you need to put an “&” between the “param=value” groups. |
Filter | This input allows you to enter one or more field value pairs which will be used to filter your request. It expects the same format as the context parameters input. |
This button will allow you to set your default request filter to whatever you currently have entered in the “Filter” input. | |
Facets | Similar to the filters, simply enter the facets in the same format as the filters. |
1.1.1.4 Advanced
Input | Use |
Connection type | Allows you to select a connection type for your request. The options are: · “Direct (no cache)” · “Public (5 mins. cache)” |
Page size | Allows you to enter a number which dictates up to how many results you will have on the page. |
Min. hit count | How many products should at least be returned. |
Offset | Where should the list of Products start? E.g. if you type 3, the first product, that will be shown in the list will be the 4th product, that is returned. |
Group by field | How should the products be grouped. |
Sort by field | Allows you to select a field with which the request results will be sorted. |
Order (Ascending / Descending) | Allows you to select the direction in which the results should be sorted in. |
Index | Define a different index apart from the main one. E.g. customers or property value |
Server | Choose a different server to test with. E.g. api.bx-cloud.com |
API key | Key value for the new setup. |
API Secret | Secret value for the new setup. |
Debug Level | Allows you to set the level on how much information you want to see about your result, when you click on the ‘Extra info’ button on the top right of your result. |
1.1.2 Test Results
Element | Use |
Title | By clicking on this, you will be able to give your result a name. |
Extra Info | This button opens a dialog which provides additional information about your request. |
Debug Info | Loads the data used to get the results in this column back into the request form. |
Upload | To save the changes you made, you have to press this button, which uploads all your changes, which is the same as doing save & test on a widget strategy. |
Delete | Removes the column from the view. |
Lists all parameters which have been set for this specific request. | |
Lists all the facets of this request. On the right side of each facet is a info button, where you get more information about it. | |
Allows you to select a field with which the request results will be sorted. | |
Allows you to select the direction in which the results should be sorted in. Arrow pointing upwards = Ascending Arrow pointing down = Descending
| |
| This is the pagination, you can move between all your hits/products. Arrow:
Number:
By clicking on the number, you can jump to this specific page. |
This indicates the number of products shown on a page. You can choose between these numbers: 10, 25, 50, 100 | |
The percent symbol represents the personal relevance score. | |
Displays the current position of each product. | |
The fields in the results can be clicked to open a dialog, which allows you to search for facets and hits using the field. | |
This arrow button will add the current field and value to the filters input in the ‘Parameters’ tab of the request. | |
Opens a dialog to create a new rule using this result. | |
Opens a dialog to edit the existing rule for this result. | |
Deletes the existing rule for this result. |
You will see your results in form of these containers. In the first tab you will see the picture of your product and the title under it. The blue line, percentage and number is explained in the table above.
The ‘Details’ tab will show you all the fields which are involved in the scoring and filtering of your products.
If you want to see other product attributes, you can add them on the left in the “Returned Fields” and refresh the view.
Then they will appear as well in the list of attributes of the Details tab of the products.
In the ‘Explain’ tab you will be able to see a pie-chart showing you, which one of your Use Cases contributes to which part of the total ranking score. Normally, your use-case should always be configured with easy to understand labels, so (as on the left) it should be easy to understand what are the constituents of the score.
The scoring is easy: it sums the value generated by each of the pie chart elements and the total is indicated above the pie-chart. The product with the highest score appears first.
A much more complex to understand tree (with all the technical details) appears below the pie-chart for the ones who want to understand the formula exactly.
Below the pie-chart is a green ‘Compare’ button, this will help you understand why a product doesn't appear in the top results. Click on the button of any of the products and indicate the product in the dialog box.
This will open a new column with only this product.
If this new column is empty, it means that the reason the product is not on the top of the list, is because it is not in the list at all. This means the scoring is not the reason why it doesn’t appear, but some other filters are causing it to be filtered out.
You can check the scoring factors of this product compared to the top appearing products (in the explain tabs) to understand what Use-Case causes the difference in scores.
1.1.3 Extra Info
If you want to know why you see the results you see, you can inspect the detailed information in the Extra Info dialog. Click the button with the letter ' i ' on it.
A dialog will appear which shows you the detailed information about your testing results, which will look like that:
In there you have three main tabs (Heuristics, General and Query). In the Heuristics tab you’ll find another three tabs. The first tab is called template.accessor.ContextJsonAccessor, if the tab is not there, something went wrong with your Json, you should make sure that everything is fine with it.
In there you have an overview of your json path and the values you’ve got through it out of your json.
At the left side you have your json path and on the right side your value.
In the HeuristicManager tab you see your active heuristic list, if your conditions were a success or a failure and you see your segment filter query.
The active list displays you, which heuristics are passed from the json.
Here you have an example how a successful condition looks like. We have the heuristic quiz-travel-food-heavy, which is in the active list, and the value passed from the json, matches the one from your condition, in this case deftig.
Here you see an example of a failure. Here we have the heuristic quiz-modern which should pass the value modern, but it passed klassisch instead, so the condition is false.
The last one is the HEURISTIC_SEGMENT_FILTER_QUERY, there are the heuristic effects displayed which are in the active list.
In the last tab DistributionHeuristic, you’ll see the filed values of the heuristic distributions.
The General tab displays the general information about the request.
In the Query tab you see two field, the first one is the QUERY_BOOST_FILTERS which displays the effects again, but on top of it, there is the formula, which boost the Top seller to the top.
And the other field QUERY_FILTERS shows the filters which you’ve set in the your widget.