A/B-Testing

Release Notes for the version 1.6.0

e-Spirit AG

2020-10-09
Table of Contents

Version 1.6.0

Update Notice

With this version the support of the FS_LIST input component is dropped. It is replaced by the FS_CATALOG input component.

For new installations all necessary project adjustments are included in the templates, which can be imported via the module configuration.

For existing projects, the following adaptations must be made manually in the project. It is not necessary to close existing experiments for this purpose.

Page template Dispatcher

The FS_LIST input component pt_variants must be replaced by an FS_CATALOG input component:

Input component pt_variants. 

<FS_CATALOG name="pt_variants">
    <LANGINFOS>
        <LANGINFO lang="*" label="Variants"/>
        <LANGINFO lang="DE" label="Varianten"/>
    </LANGINFOS>
    <TEMPLATES type="link">
        <TEMPLATE uid="variant"/>
    </TEMPLATES>
</FS_CATALOG>

Within the HTML output channel of the page template, a getItem() call must be added four times:

HTML output channel. 

<c:set target="${variant}" property="hash" value="$CMS_VALUE(variant.getItem().get(#global.language, "lt_referenceUid").get().hashCode)$"/>
<c:set target="${variant}" property="url" value="$CMS_REF(pageref:variant.getItem().get(#global.language, "lt_referenceUid").get(), abs:1)$"/>
<c:set target="${variant}" property="name" value="$CMS_VALUE(variant.getItem().get(#global.language, "lt_text").get())$"/>
<c:set target="${variant}" property="id" value="$CMS_VALUE(variant.getItem().get(#global.language, "lt_referenceUid").get())$"/>

Link template Variant

For the correct representation of the individual elements within the FS_CATALOG input component, the link template used for the elements must contain a snippet definition.

Label of the snippet definition. 

lt_text + " (" + lt_referenceUid + ")"

Extract of the snippet definition. 

"Original: " + (lt_original.size() > 0) + " / Comment: " + if(lt_comment.empty, "-", lt_comment)

CSS file A/B-Testing Configuration

In line 31 of the CSS file A/B-Testing Configuration the width must be increased from 90px to 120px:

A/B-Testing Configuration. 

input[type="text"].fs-abtest-experimentParticipationRateOutput, input[type="text"].fs-abtest-experimentParticipationRateOutput.hideBorder:focus {
    height: 30pt;
    width: 120px;
    text-align: left;
    background: transparent;
    border: 1px solid #cccccc;
    border-radius: 3px;
}

Format template Traffic Allocation Plugin

In line 106 of the Traffic Allocation Plugin the function appendGuiComponentsTo must be extended by the creation of a link to the CSS file:

Traffic Allocation Plugin. 

experiment.appendGuiComponentsTo = function(container) {
    var link = window.parent.document.createElement("link");
    link.rel = "stylesheet";
    link.type = "text/css";
    link.href = "$CMS_REF(media:"abtesting_configuration")$";
    link.media = "all";
    container.appendChild(link);
    container.appendChild(createDomElement("h1", { "className": "pluginHeading", "innerHTML": AbTesting.Labels.get(AbTesting.Labels.keys.PARTICIPATION_RATES) }));
    container.appendChild(createDomElement("h2", { "className": "pluginHeading", "innerHTML": AbTesting.Labels.get(AbTesting.Labels.keys.EXPERIMENT) }));
    container.appendChild(controls);
    ...

Fixed issues

IDDescription

ABTEST-219

Switched from FS_LIST to FS_CATALOG.

Version 1.5.2

Fixed issues

IDDescription

CORE-11889

The module cannot be installed on the server.

Version 1.5.1

Update notice

If you wish to run FirstSpirit in Isolated mode, the module must be completely reinstalled and configured in accordance with the documentation. The minimum required FirstSpirit version is then 5.2.181106.

New features

IDDescription

ABTEST-214

The module now supports FirstSpirit Servers running in isolated mode and Java 11

Version 1.5.0

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.2

-

Fixed issues

IDCategoryDescription

ABTEST-210

Module

Adaptation for the FirstSpirit R17 Rebrush

Version 1.4.0

Update Notice
In ABTEST-209 changes in templates were made. Thus, the update of the FirstSpirit module is not sufficient. The format-templates must be updated manually. These are located in the export-abtesting_formattemplates.zip and can be imported into any FirstSpirit project to be edited further.

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.2

-

Fixed issues

IDCategoryDescription

ABTEST-209

Module

Enhanced multi-user behaviour

Version 1.3.35

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.2

-

Fixed issues

IDCategoryDescription

ABTEST-200

Module

Exception handling for arithmetic operations added

Version 1.3.34

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.2

-

Fixed issues

IDCategoryDescription

ABTEST-202

Documentation

Changed several images and little modifications

ABTEST-203

Documentation

Modified chapter 4.2

Version 1.3.33

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.2

-

Fixed issues

IDCategoryDescription

ABTEST-204

Module

Error creating experiment in store root

Version 1.3.32

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.1 - 5.2

-

Fixed issues

IDCategoryDescription

ABTEST-155

Documentation

Added a note regarding the manual execution of the release workflow

Version 1.3.28

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.1 - 5.2

-

Fixed issues

IDCategoryDescription

ABTEST-190

Module

Experiment breaks when exiting under certain circumstances.

New features

IDCategoryDescription

ABTEST-127

Code/Template

Changed naming of importfiles.

Version 1.3.27

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.1 - 5.2

-

Fixed issues

IDCategoryDescription

ABTEST-185

Module

Reports don’t show experiments in the SiteArchitect client since FS 5.2 R3

ABTEST-186

Module

Variants are not visible separately in the sitemap anymore

ABTEST-188

Module

It’s not possible to choose a workflow in the project component.

Version 1.3.26

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.1 - 5.2

-

New features

IDCategoryDescription

ABTEST-170

Code/Template

Parallel finshing experiments

Version 1.3.24

Update Notice
In ABTEST-181 changes in templates and media were made. Thus, the update of the FirstSpirit module is not sufficient. The format-templates and CSS/JS media files must be updated manually. These are located in the export-abtesting_formattemplates.zip and export-abtesting_media.zip and can be imported into any FirstSpirit project to be edited further.

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.1 - 5.2

-

New features

IDCategoryDescription

ABTEST-166

Documentation

Updated english documentation

ABTEST-181

Templates

Added namespace for CSS classes

Version 1.3.23

Update Notice
In ABTEST-101 errors in the templates have been fixed. Thus, the update of the FirstSpirit module is not sufficient.

The following templates (the UID in parentheses) must be updated manually:

  • A/B Testing Configuration (abtesting_configuration)
  • Release (release)

These are located in the export-abtesting_formattemplates.zip and export-abtesting_workflow.zip and can be imported into any FirstSpirit project to be edited further.

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.1 - 5.2

-

Fixed issues

IDCategoryDescription

ABTEST-101

Code/Template

Improve error message if PageRef is locked

Version 1.3.22

Update Notice
In ABTEST-135 an error in the templates has been fixed. Thus, the update of the FirstSpirit module is not sufficient.

It must have the following templates (the UID in parentheses) to be manually updated:

  • A/B Testing Configuration (abtesting_configuration)
  • A/B Testing Bar (abtesting_bar)

These are located in the export-abtesting_formattemplates.zip and can be imported into any FirstSpirit project to be further edited.

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.1 - 5.2

-

Fixed issues

IDCategoryDescription

ABTEST-135

Template

Error in external preview of SiteArchitect

ABTEST-171

Code

Parallel creation of a new experiment on the same store item in the SiteArchitect by other session

ABTEST-172

Code

Updating an experiment in the SiteArchitect does not unlock all new variants every time

ABTEST-175

Code

Creating a new experiment takes too long in SiteArchitect

Version 1.3.21

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.1 - 5.2

-

Fixed issues

IDCategoryDescription

ABTEST-119

Code

Improved continuing an experiment

ABTEST-124

Dokumentation

Fixed errors within links

ABTEST-165

Code

Improved prevention to delete variants

New features

IDCategoryDescription

ABTEST-75

Project-Component

Refactoring the configuration dialog

ABTEST-169

Documentation

Refactoring the chapter API

Version 1.3.1

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.1 - 5.2

-

Fixed issues

IDCategoryDescription

ABTEST-151

Documentation

Include JavaDoc documentation for the API

ABTEST-161

Workflow

Only one workflow may be started for an experiment

New features

IDCategoryDescription

ABTEST-157

Documentation

Note about the usage of cookies

ABTEST-164

Workflow

Releasing a experiment page releases the complete experiment

Version 1.3.0

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.1 - 5.2

-

Fixed issues

IDCategoryDescription

ABTEST-144

Code

Added functionality for multi-experiments

ABTEST-147

Code

Improved error message in the SiteStore for missing configuration

ABTEST-148

Code

Fixed exception when requesting a release

ABTEST-149

Code

Reviewed changes made by code formatting

ABTEST-150

Code

Adjusted the deletion of variants

ABTEST-160

Code

Fixed exception when finishing an experiment

ABTEST-162

Code

Fixed exception when adding a variant in the SiteArchitect

ABTEST-163

Code

Fixed exception when deleting a variant in the SiteArchitect

New features

IDCategoryDescription

ABTEST-140

Functionality

Provided an easy integration into existing workflows

ABTEST-154

SiteArchitect

Added a prefix to the displaynames

Version 1.2.13

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.1 - 5.2

-

Fixed issues

IDCategoryDescription

ABTEST-141

Code

Fixed StringIndexOutOfBoundsException in JSP

Version 1.2.1

Compatibility

ProductVersion(s)Notice

FirstSpirit

5.1 - 5.2

-

Fixed issues

IDCategoryDescription

ABTEST-138

Release

Release order causes problem.

Help

The Technical Support of the e-Spirit AG provides expert technical support to customers and partners covering any topic related to the FirstSpirit™ product. You can get and find more help concerning relevant topics in our community.