Protected: Freemium package
3
min
quiz
This content is password protected. To view it please enter your password below: Password:
Protected: A/B testing package
3
min
quiz
This content is password protected. To view it please enter your password below: Password:
Protected: Predictive package
3
min
quiz
This content is password protected. To view it please enter your password below: Password:
Installation guide
Be careful! All our scripts have recently changed in order to adapt to the implementation of Intelligent Tracking Prevention (ITP) by some browsers Old tags are still supported for now. However, once you changed the script in the back-office, you won't be able to recover it.
What is ITP?
Apple’s ITP aims to increase user privacy by preventing unwanted tracking of users by websites and the various scripts installed on them. It is present on all Safari browsers. The latest version (2.1) introduces major restrictions on the functioning of browsers and applications using JavaScript, especially regarding cookies. It strongly affects web analytics software (such as Google Analytics) and A/B testing tools.
Before launching tests on your website, you must install the Kameleoon script. This script has to be added at the <head> tag of the source code of your website. It contains your unique website code. Don’t worry: we can guide you step by step; and our adaptable solution will take all the distinctive features of your website into account.
If your package allows you to do so, you can set up multiple websites with your Kameleoon account. This can be particularly useful for testing your website and mobile version or if you want to test Kameleoon on your pre-production website first.
Several setup options are available. Their sequence follows this pattern:
At any time, if you have any doubts or difficulties, don’t hesitate to contact your developer by clicking on the corresponding button at the bottom of the setup page. The necessary information will then be sent to them so that they can help you.
Where to configure the setup of your website?
In your Kameleoon back-office, go to the “My websites” page on the “Configuration” tab in the left-hand side menu.
On this page, you will find a list of the websites added to your Kameleoon account.
The card of a website will already be there by default: this is the website you entered when you registered.
Setup via your website card
On the card assigned to the website, click on “Setup”. A page will open, allowing you to configure your installation.
Setup when adding a new website
To add a new one, click on “New site” (if your package allows it).
In the pop-in that opens, enter the URL of the site you want to add and, if you wish, a description. Then click on “Add”.
A new page will open and guide you through the installation of the Kameleoon’s script.
Modification of the setup
To modify the installation of an already added and installed website, click on “Setup” on the the website card.
At the bottom of the page that opens, click on “Modify setup”.
A pop-in alert will then open.
Confirm your choice to access the setup interface of the Kameleoon script.
Step 1: Choosing your setup options
In the successive drop-down menus, choose your setup options.
Setting up Kameleoon with/without a tag manager
Adding the script directly to the html code of your pages
We recommend this installation method at Kameleoon. It avoids any performance issues related to the use of a tag manager. With this method, you put the Kameleoon script in the right place yourself, within the pages of your website.
Using a tag manager
Kameleoon is compatible with all the major Tag Management Systems (Google Tag Manager, Tag Commander, Eulerian Tag Master). However, if possible, we recommend that you install Kameleoon directly in the source code of your website and not via a TMS. The reason for this is the : using a TMS delays loading for Kameleoon and increases flickering. This is especially problematic if your TMS is loaded at the bottom of your HTML page. Moreover, the tag manager needs to be loaded first in order to load Kameleoon, which can add a latency period.
If you use a Tag Management System, you should not use the asynchronous script with anti-flicker as it is not designed to work within a TMS.
Selecting an installation tag
This option is only available if you do not use a tag manager (recommended method).
If you have chosen to add the script directly to the html code of your pages, this installation option gives you the choice between three types of loading.
Synchronous loading
The scripts of the page are loaded one after the other following their order in the code. The page only appears once each script is loaded. So, if one of the scripts blocks, the page remains blank.
Asynchronous loading
For modern websites loading an important number of JavaScript files, best practice suggests that every script should be loaded asynchronously.
This ensures that page loading is not blocked while scripts are being downloaded by the browser. In addition, ideally, scripts that are important should be loaded at the top of the page, whereas scripts that are less important or that can wait should be loaded at the bottom of the page.
A script is loaded asynchronously when the browser doesn’t wait for the script to load to display the requested page to the user. Consequently, an asynchronous script loads in parallel with the loading of the page, and doesn’t prevent it from being displayed.
This can cause a flicker effect: for a few seconds, the user can see the original page before it is replaced by the variation (in the case of an A / B test) or the custom page (in the case a personalization) when the Kameleoon script has fully loaded.
Asynchronous loading with anti-flicker
This integration simulates a blocking effect, preventing the loading of the page until the Kameleoon JavaScript is received by the browser. This is done in order to mitigate the flickering effect, while ensuring that if the script takes a long time to download, the page will be displayed.
Enabling or disabling cross domain tracking
If your package includes it, you can enable cross domain tracking by selecting “Yes” in the “Activate cross domain tracking” drop-down menu. This option makes it possible to track visitors on different domains (example.fr and example.org), subdomains (example.fr and payment.example.org), or on different protocols http and https.
If you do not activate it, we will not be able to track visitors from one domain to another: they will be considered as new visitors when they arrive on another domain and will be exposed again to personalization or to another variation of an A/B test.
If you enable cross domain tracking when you install your website, you will find an option in the general configuration of your site allowing you to specify the domains authorized in cross-domain tracking.
By default, all domains can load your Kameleoon script and access the data associated with your users (such as custom data), which can create a risk. If you want to allow access to Kameleoon only on a specific list of domains, enter them here. For each added domain, all subdomains will be included automatically.
Selecting a hosting for the Kameleoon application file
You can choose to host the application file yourself or let Kameleoon host it. Select the option that best suits you from the drop-down menu.
If you select “Yes”, you will be asked to enter the URL of your CDN.
Once these steps have been completed, click on “Continue” to access the second phase of the setup.
Step 2: Copying the code
The Kameleoon script specific to your website will appear.
The detailed instructions on the page depend on the options you selected in Step 1.
It is very important that this script is copied before any other tag, to load your variation as soon as possible and thus avoid the flicker effect.
Once the Kameleoon script is copied to your web pages, save them and transfer them to your server. You can then click on “Validate”.
Note : If you don’t know how to integrate this script, let your developer do it by clicking on “Forward to your developer”.
Kameleoon then makes sure that the script is present and that everything is in order. The verification process takes a few seconds.
If Kameleoon warns you that it could not detect the script, make sure that it is present on your website, otherwise the experiments created on Kameleoon will not be launched on your website. If the script is present and correctly integrated, then you can skip the verification step to validate the installation.
For more information on installation tags, do not hesitate to consult the developer documentation section.
3
min
quiz
Be careful! All our scripts have recently changed in order to adapt to the implementation of Intelligent Tracking Prevention (ITP)…
Setting up a new website
You can set up several websites with your account. It can be very useful if you want to test both your website and its mobile version or if you want to test Kameleoon on your website in pre-production first.
Adding a new website
To add a new website, you must be logged in to your personal space.
Use the left menu to go to “Configuration”, then click on “My websites”.
On this page, you will find the list of the websites you have configured with your account. To add a new one, click on “New site”.
A pop-in displays. Fill in the informations needed: the site URL and a description (optional). Then click on the “Add” button.
Once you have registered your URL, Kameleoon will create a script to install on your website. You can now install Kameleoon on your website with the same method used for your previous websites. For further information about the installation of Kameleoon, please read our installation guide.
Setting up the website
When you have installed the script on your pages, you can set up your new website. Reporting tools and goals are specifics to a single website, so you will have to set them up for each of your sites.
For further information about reporting tools and goals, please read our article Reporting tools and goals.
3
min
quiz
You can set up several websites with your account. It can be very useful if you want to test both…
User and rights
Access to the “Users & Rights” page
To access the “Users & Rights” page, you must be connected to your personal space. Once connected, you will find the page in the “Configuration” section of the left side menu.
Presentation of user profiles
There are five types of user profiles. Some can act on the “Users & Rights” page. They have different rights and means of action.
Each of the functions related to these five profiles is detailed below.
Super Admin
The Super Admin can add, deactivate/reactivate or delete users, and configure their rights on websites and on the account.
Admin
The Admin can add new users to the websites he administers, and manage tools and resources related to those sites.
Technical
The Technical role gives access to the options for managing your sites, advanced configuration and configuration of your analytics tool with Kameleoon.
Marketing
The Marketing role allows you to consult the details of the experiences launched with Kameleoon.
Production
The Production role activates or not the button to launch experiments in the Kameleoon editor.
Adding a user
Only Admin and Super Admin can add new user accounts and configure their rights.
Click on the “Add” button at the top right of the User management page.
In the pop-in that opens, fill in the email address of the user you want to add and click on “Next”.
Depending on your profile (Super Admin or Admin), the following steps, which involve assigning rights to the user, differ.
Defining website authorizations
For each website, you can assign to the user one or several role(s):
-
Super Admin
-
Admin
-
Production
-
Technical
-
Marketing
Check the role(s) you want to give to the user on each of the websites installed on the account.
Check the boxes next to each website to allow access to the user, then click “Next”.
Are you an Admin?
You can only configure user permissions for websites that you administer. In the list which is proposed to you only appear these websites: you can’t make a mistake!
Defining account authorizations
Unlike the “Website authorizations” tab, which details the rights for each website registered on the account, this tab concerns the overall management of the account and associated users.
As a Super Admin, when you add or edit a user, you have access to the “Account authorizations” tab.
In this tab you can choose:
-
to set the user as Super Admin; he will then have the same rights as you on the account;
-
and/or to activate an API key, which is an authentication system with external tools.
Switch the toggle from “OFF” to “ON” and confirm. A pop-in confirms the creation of his account and a welcome email is sent to the user. This email contains an activation link allowing him to complete his profile and access the platform.
Are you an Admin?
This option is only available for Super Admins users.
Creating and activating the user profile
Regardless of your role in the Kameleoon account, when a Super Admin or Admin adds you as a new user, you will receive an email that will allow you to log in and enter your profile information. Your profile page will then include both this information and the authorizations granted to you by the Super Admin or the Admin.
Note: If they want to speed up the process and/or gain control over creating your profile, a Super Admin has the power to force the initialization of your account. Even simpler for you!
Information of your profile
Click on the activation link received by email and fill in the information to complete your profile.
Your password must contain at least 8 characters, including one lowercase, one uppercase, and one number. It can not contain your name, first name or company name.
To load a profile picture, simply hover the location of the photo and select the file you want to add.
Then click on “Save”. Congratulations, you can now connect to Kameleoon!
Access to your profile
At the top right of the back office, a click on your name enables you to scroll down a menu. Then click on “My Account”.
Contents of the profile page
Your profile page includes the main information related to your account, especially the permissions associated with it.
-
In the upper part, you will find general information: your photo, your name and surname, and the email address with which you created your account.
-
In the center of the page you will see your rights for each of the websites registered on the account
-
At the bottom of the page there are the account authorizations: if you are Super Admin and/or if an API key is associated with your user account, you will find this information here.
Are you an Admin?
At the bottom of the page, in the “Account Authorizations” section, this message may appear. This means that you are not Super Admin and no API key has been associated with your user account.
Editing your profile
On the profile page, click on “Edit”.
In the pop-in that opens, you can edit your name, first name or email address.
To edit or delete the profile photo, hover the photo icon.
Forced activation of a user account
A Super Admin has the option to force the initialization of an account by completing the user’s profile. They thus save time and can control account creation and validation more easily. The account then has the status “activated” and can be used immediately.
To do so, simply go to the User management page and click on the menu dedicated to the user on the right-hand side of the line (the status of the account is currently “not activated”). The “Force account validation” command avoids waiting for the user to complete their profile.
Are you an Admin?
Only Super Admins can force the validation of a user account.
Editing a user account
You are Super Admin or Admin and want to make changes to a user account? Depending on your role and the status of the user account, you have access to certain actions.
Accounts not enabled
As long as the user has not confirmed his account by clicking on the activation link received by email, then filled in the information of his profile, the status of his account is “not activated”.
To edit a user account, hover the end of the line and click on “Edit”.
An editing pop-in will appear.
You can edit the user’s email address, website authorizations, and account-related authorizations.
- In the “Website authorizations” tab, check and uncheck the roles associated with each website for the user you are editing.
- In the “Account authorizations” tab, switch the position of the toggle buttons according to the changes you want to apply.
Are you an Admin?
-
You can only edit non-activated user accounts you created yourself.
-
You can configure rights only for websites that you are an admin for.
Activated accounts
Once the user confirmed the creation of their account and filled in the profile information, the account status is “activated”.
To edit a user account, hover the end of the line and click on “Edit”. A change pop-in will appear.
You can change the user information (first name, last name, email address), the authorizations linked to the websites as well as account permissions.
Are you an Admin?
-
If the user’s account is already activated, you can only change their authorizations for websites you administer.
-
You can not deactivate or delete the account.
Password regeneration
This option enables you to improve an account’s security level. By activating it, you will be asked to regenerate your password. This regeneration applies to all users associated with the account: they will receive a message asking them to change their password. You can schedule this change periodically or punctually.
To access the option, pull down the menu at the top right of the back-office which mentions your name and click on “Parameters”.
Then click on “Password regeneration”.
A pop-in opens.
Switch the button on “YES” to activate the automatic regeneration, and choose its frequency.
Do not forget to save your choice!
Are you an Admin?
Only Super Admin profiles can enable password regeneration.
Deactivating/reactivating a user account
As a Super Admin, you can temporarily deactivate a user account and then reactivate it when necessary. With this feature you can suspend a user’s rights: he will no longer be able to access Kameleoon for the duration of the deactivation.
To deactivate an account, go to the User management page and click at the end of the user’s line. In the menu that opens, click on “Deactivate account”.
A pop-in asks you to confirm this choice.
If you click on “Continue”, the deactivation will be effective immediately and the user notified by email.
Deactivated accounts are symbolized by a padlock in front of the user name. The reactivation command is available with a single click on the menu at the end of the line.
Are you a Super Admin?
As a Super Admin, if you are the only one for the account, you can not deactivate your own account. On a boat, you always need someone to steer!
Are you an Admin?
Only Super Admin profiles can deactivate or reactivate a user account.
Deleting a user account
Unlike the deactivation of an account, which can only be temporary, the deletion is definitive. They will no longer be part of the account and their profile will have to be recreated in case you want to grant access to Kameleoon again.
To delete a user account, hover the end of the line with your mouse and click on “Delete”.
A pop-in asks you to confirm this choice.
Are you a Super Admin and do you want to delete your account?
As a Super Admin, you can not delete your own account. On a boat, you always need someone to steer!
Are you an Admin?
Only Super Admin profiles can delete a user account.
Overview of user rights
Now that you know everything about all user profiles, here is a global table of the different rights associated with them, which have been discussed in detail in this article.
3
min
quiz
Access to the "Users & Rights" page To access the "Users & Rights" page, you must be connected to your…
Password and personal information
You can update your password and personal information at any moment.
My account page
First, you need to be logged in to your personal space.
Once you are logged in, click on your name on the top of your screen. A drop-down menu appears, allowing you to click on “My account”.
This page allows you to update your name, first name, e-mail address and password.
Updating your information
To change your name, first name or e-mail address, simply type in directly in the fields you want to change.
Then, click on the “Validate” button to save your changes.
Changing your password
To change your password, click on the “Edit” icon on the right of your current password.
Type in your current password, then choose your new password.
Click on the “Validate” button to save your changes.
3
min
quiz
You can update your password and personal information at any moment. My account page First, you need to be logged in…
Advanced configuration options
Several advanced options are available for your website, such as cookies management or behavior in case of timeout. If you want to change the default settings, this article will allow you to manage the different options.
My websites
Access options
To access it, log in to your personal back-office .
Then use the menu on the left to access the “My websites” page of the “Configuration” menu, which groups together all your websites configured with your Kameleoon account.
Add a new site
You can add a new site.
A simple click on this button will open the pop-in.
Search, filter, sort
A search bar, as well as filtering and sorting tools, are also available.
Filter websites by status (Kameleoon enabled/disabled) or by script (script installed/not detected/not installed) and quickly find the one whose configuration you want to view.
You can also sort sites by name (alphabetical order), date added, status (Kameleoon enabled/disabled) or amount of associated experiences. By default, they are sorted in ascending order. To sort them in descending order, click on the green triangle that appears on the right when hovering.
Information and actions on the site
Information
Three sections are accessible from the identification card of your site.
Setup
This page allows you to install the Kameleoon script on your site.
Configuration
This page gives access to advanced configuration options: this is the one that interests us here.
Indicators
This page displays the indicators measured on your site.
When you move the mouse over the card, an information and action bar appears at the bottom:
On the left you will find the number of A/B tests and personalizations created on the site.
On the right, three icons gives you access to three different actions.
Disable/Enable
OR
If Kameleoon is enabled on your website, the displayed button is the “Disable” one. If Kameleoon is disabled then the button is the “Enable” button.
If you choose to disable Kameleoon, a confirmation pop-in will open and ask you to confirm your decision. If you disable Kameleoon, a confirmation message will appear at the bottom of the page and your A/B tests and personalizations will no longer be active on your site; however, your experiments will resume if you reactivate Kameleoon.
Remove
At the click of this button, a pop-in confirmation will appear to ask you to validate your decision or not.
Edit
Once you have identified the website that interests you, click on “Edit” or “Configuration”.
Configuration
The following page is displayed:
It consists of a header, a menu bar and three scrollable sections, accessible in one click:
- General;
- A/B test;
- Personalization.
Header
The header indicates the name of the website.
The “Actions” menu at the top right gives you access to two distinct actions. Click to scroll down.
Enable / Disable Kameleoon
If Kameleoon is enabled on your site, the option is “Disable Kameleoon”. If it’s off, then you can click on “Enable Kameleoon”.
OR
If you choose to disable Kameleoon, a confirmation pop-in will open and ask you to confirm your decision. If you disable Kameleoon, a confirmation message will appear at the bottom of the page and your A/B tests and personalizations will no longer be visible on your site. Your experiments will resume if you reactivate Kameleoon.
Remove site
Click on this option: a confirmation pop-in appears. You will have to re-install entirely the website if you change your mind.
Menu bar
You will find here the three menus “Installation”, “Configuration” and “Indicators”, as well as the possibility of displaying again the page with all your configured websites: “View all sites”.
Website description
You can add a description of your site here.
Behavior if timeout occurs
You can redefine Kameleoon’s behavior when the script exceeds its usual loading time. By default, Kameleoon will eventually launch with a flicker effect.
The available options are:
- Start Kameleoon (with flicker effect);
- Disable Kameleoon for this page;
- Disable Kameleoon for the whole visit.
Data storage
This option allows you to choose where to store data about your A/B tests on the visitor’s computer:
- Standard Cookie: Stores the data in the user’s cookies.
- Custom Cookie: Allows you to customize the user’s cookie. When you click this option, two fields appear. You must then fill in the domain name and the duration. By default, the cookie is positioned on your domain name and its validity is 30 days. You can specify a custom domain name. Do not hesitate to consult our article on this subject.
- Local storage: Stores the data in the local storage of the browser (to know more, consult our article on this subject).
Global custom script
Any JavaScript code you add in this insert will be executed each time the page is loaded, just after loading Kameleoon. This is the solution to add complex tracking code or integration to other solutions.
A/B Test
Editor launching
This option allows you to manage the access to the Kameleoon editor by using the keyboard shortcut Shift + F2. By default, the button is set to “ON”: the option is activated. To disable it, click on the button to switch it to “OFF”.
Result reporting
Enable (“ON”) or disable (“OFF”) the results reporting with this option.
Variation selection script
A variation selection script is a script to force the display of a variation based on specific rules. Enter here the complete the script code to use with Kameleoon.
Necessary reliability for the determination of a winning variation
By changing this percentage, you can set the threshold above which a variation is winning.
Variations that have a lower reliability than the set rate can not be presented as winning ones in your results, regardless of their number of conversions. This has an impact on the results presented by Kameleoon; we therefore recommend that you change this setting sparingly.
To find out more about the reliability rate, visit our lexicon page.
Personalization
Exclude visitors
You can set a percentage of your visitors who will never be exposed to your personalizations.
We recommend keeping a population unexposed, to measure the impact of your personalizations.
Advanced options
By default, Kameleoon allows the display of more than one similar personalization on a page (for example, 2 pop-ins or 2 images inserted in the same place). You can, however, forbid this simultaneous display by switching the “OFF” button to “ON”.
To add animation effects to your personalizations, Kameleoon embeds the jQuery library in the source code of your pages. If you already inject jQuery into your source code, you must disable this option by switching from “OFF” to “ON”.
Once your changes are complete, click the “Validate” button at the bottom of the page to save your settings.
If you want to reset all the default options defined on this site, click on the “Reset” button.
3
min
quiz
Several advanced options are available for your website, such as cookies management or behavior in case of timeout. If you want…
