Set up the module

Installing with Maven

Maven is the easiest way to install the module. Add the following to your bundle:

<dependency>
  <groupId>info.magnolia.abtesting.external</groupId>
  <artifactId>magnolia-abtesting-external-vwo</artifactId>
  <version>1.0.1</version>
</dependency>

Configure the module

To link the VWO account with Magnolia, you must have a relevant configuration file.

Create config.yaml at {$magnolia.resources.dir}/abtesting-external-vwo/config.yaml.

Add the following to config.yaml.

.config.yaml

# ID of VWO account
accountId: 47115813 (1)
# Token from VWO
token: ff8dc6af94...ecce77ca518a6edacf6e46cfb (1)

types: ["ab", "split", "multivariate", "heatmap", "conversion"]

mappings:
  - publicInstanceAddress: https://your-public-instance.com
    # optional, but only if / (root) is used like in the example below
    publicInstanceContext: /
    magnoliaWebsitePath: /my-website
    # optional: if not specified, .html is added
    pageSuffix: .html
  # optional: more mappings
  - publicInstanceAddress: https://your-public-instance.com
    publicInstanceContext: /your-context
    magnoliaWebsitePath: /my-other-path
    pageSuffix: .html

1	Retrieve your VWO `accountId` and `token` from your VWO account.

Configure Test Types

You can restrict or extend the types of tests the module queries from the VWO API by using the types array. If the types option is not specified, "ab" will be used as the default. Please refer to the official VWO documentation for a list of valid values.

Add the SmartCode

VWO generated a SmartCode when it verified your domain.

If you’re on a DX Core license, use the Marketing Tags module and create a tag.

If you do not have the Marketing Tags module, you must manually insert the SmartCode into your site’s header.

<head>
    <!-- VWO Smartcode -->
</head>

Instructions

Go to your Marketing Tags app in Admincentral.
Click Add item in the Action bar.
In the Properties tab:
1. Give the tag a name.
2. Choose header for the Tag location.
In the Content tab, paste the SmartCode.
In the Pages tab, choose the pages you want the tag in such as /travel for example.

Be sure to include Insert in subpages if desired.
Don’t forget to save your changes.