Create and use the custom data

Custom data allows you to transfer certain information relating to your visitors to iAdvize.
They allow the capacities of behavioural targeting to be extended and offer better understanding of the visitor context to your agents.


1. How is custom data used

Once configured, custom data can then:

custom-data-EN01.png

  • be shown on the conversation panel, allowing agents to know certain visitor-related information during the conversation. These data are then shown in the navigation panel:

custom-data-EN03.png

  • but you won't be able to personalize the content of your messages with them.

Note: Custom data are retained and attached to the conversation. The retention period is the same as for conversations. By default, this period is 3 years, but can be customized on request to the support team.


A targeting strategy using custom data offers various possibilities, but is complex to put into place.

iAdvize offers to support you throughout the defining and designing process for your targeting strategy in order to maximise your return on investment. Please contact your Customer Success Manager for more information.


Accessing the custom data management page

To access the custom data management page, go to "Engagement" > "Settings" then select "Custom data".

custom-data-EN02.png
 
On this page, you can edit and delete existing data.

Two types of custom data exist: "on the page" and "Javascript setting".


2. Creating "Javascript setting" custom data

With this type of custom data, you can transfer a value to us using a Javascript setting. This setting therefore requires an additional Javascript code to be added to your site.

custom-data-EN05.png

Here are the different options available:

  • Data description: Indicate the description of the data here (e.g. device). You will find this description in the list of criteria when creating targeting rules, as well as in the information panel if the option "Display the custom data on the chat panel" is selected.
  • Source of the data: For this case, select "Javascript setting".
  • Type of data: Please indicate the type of data. You need to choose between an integer number (e.g. 12 with a maximum value of 2147483647), a decimal number (e.g. 12.1), a text value (e.g. error message), a Boolean value (e.g. true or false).
  • Variable description: Give the description of the Javascript variable here (e.g. device). This field is completed automatically from the data description given. For the data description "device", the variable "device" is therefore generated.
  • Display the custom data on the chat panel: This option allows the data to be shown on the discussion panel. Within the information panel, in the "Profile" section.

Integration of Javascript code

Once these new Javascript data have been saved, you can add them into your site through this javascript code (this code is an example):

<script type="text/javascript">
window.idzCustomData = {
"device":"Mac OS",
"website":,
"page_name":"value",
"test":,
"test2":,
"horairefermeture":
};
</script>

This code has to be inserted before the main iAdvize code.

Note: You can obtain this code be going to the "Projects" page. You can access it by clicking your avatar, displayed on the top right corner of the page:

On the next page, select "integration", in section 3 you will find the javascript custom data code to be inserted:

custom-data-EN04.png
 

: Do not copy / paste this code as it is on your site. The default values ("value", 0) have to be replaced dynamically on your pages by the expected values (using PHP / ASP / Javascript).

 

: When entering values in the parameters and integrating the javascript code, please make sure:
- To use the proper naming, because the values are case sensitive
- "Nested" objects are not supported in the custom data. For example you cannot do this:
window.idzCustomData = { "my_obj" : { "field1": "toto" }}

 

 


3. Creating "on the page" custom data

With this type of custom data, you can define data and we will collect its value directly and automatically from the page on your site.

custom-data-EN06.png

Here are the different options available:

  • Data description: Indicate the description of the data here (e.g. device). You will find this description in the list of criteria when creating targeting rules, as well as in the information panel if the option "Display the custom data on the chat panel" is selected.
  • Source of the data source: Select "on the page"
  • Type of data: Please indicate the type of data. You need to choose between an integer number (e.g. 12), a decimal number (e.g. 12.1), a text value (e.g. error message), a Boolean value (e.g. true or false).
  • Path to the HTML container: Here you have to indicate the html path to the container where the targeted data is located. E.g. #device > span
  • Data value: You can indicate the type of value you wish to store.
  • Display the custom data on the chat panel: This option allows the data to be shown on the discussion panel. Within the information panel, in the "Profile" section.
Warning : Contrary to the "Javascript" custom data, the routing engine is able to detect a change of value on a custom data of type "in the page" even after the complete loading of the page. However, it is necessary that the HTML container is already defined when loading the DOM for this to work. An HTML container added via a javascript code afterward will not be interpreted by our routine engine.

 
For further information go to