LivePerson v1.1

This package provides capabilities that extend the Avoka Transact platform for users wishing to include LivePerson chat services in their forms using the LiveEngage platform.

To support chatting capability this package provides the following components:

  1. LiveEngage Tag

    This component provides integration with the LiveEngage chat service version 1.7.


Clients must ensure they are appropriately licenses in order to use this package. Organisations who wish to use this package are required to establish a commercial relationship with LivePerson directly.


This package has the following compatibility requirements:

Transact Manager5.0.0 or above
Transact Maestro5.1.1 or above

Installation Instructions

To install this package please walk through the following proceedure:

  1. Unzip the package to a directory on your computer
  2. Import each archive found in the libraries folder to Maestro. Importing these into the Organisation level libraries folder is recommended as this will make the components available to all projects, however they can be imported at the Project level if required.

CSP Configuration

The Content Security Policy (CSP) response header helps you reduce XSS risks on modern browsers by declaring what dynamic resources are allowed to load via a HTTP Header, thereby protecting your solution from a range of vulnerability attacks.

The Liveperson integration loads a remote JavaScript library which is injected to the form, and this will get blocked if the form header includes strict Content Security Policy (CSP) settings. By default, Avoka Transact has strict CSP settings configured so these will likely need to be modified in order to enable the Liveperson integration.

You can configure CSP settings in Transact Manager at a system wide level via the 'Form Submission Access Controller' service, or at an Organization level in the Security tab. The following Sample CSP demonstrates how to enable the Liveperson JavaScript integration:

script-src 'self'; object-src 'none';

For more information see CSP on The Avoka Community

Usage Instructions

To configure this component please walk through the following procedure:

  1. Login to LivePerson portal. And Copy your LiveEngage Tag. The tag is a small piece of Javascript code to be embedded in the form header.
  2. Login to Transact Manager and open your form.
  3. Navigate to page called Page Tracking and tick the box Use Form Page Tracking.
  4. Select the value 'Inside <HEAD>' in the field called 'Page Script Include Position'.
  5. Paste the LiveEngage Tag into the field called 'Form Page Tracking Script'. And save your changes.
  6. Open your form in Maestro and drag and drop the LiveEngage Tag component from Liveperson category in the Palette. This widget is invisible, so it can be placed at the top or bottom of the form.

  7. Open the Engagement Attributes section from the properties of the LiveEngage Tag component
  8. Set your constant attribute section. This attribute takes an array string. Don't use comments in the string. For example ["acs", "credit-card"].
    The section attribute can be dynamically set by calling the component method$setSection.
  9. Optionally you can set the attribute Taglet Section. If not set, the system will use the values within the section attribute to produce a Taglet string in the format acs-credit-card
    The Taglet Section attribute can be dynamically set by calling the component method $setTagletSection.
  10. Create new rule called On Request Chat and set the dynamic Engagement Attributes, by calling the method $uploadJsonData. This method takes data JSON object and a flag. When the flag is set, the data is sent immediately, otherwise the data is pushed into a queue to be sent when possible, which should be used in most cases.
    The JSON object can be one of the following: Customer Info, Marketing source, Personal Info, Cart Update, Transaction, Viewed product, Lead, Service Activity, Visitor Error, or Searched Content
    The JSON structures can be found in LivePerson portal, under Campaigns tab, Data sources For example:
    var jsonData = { "type": "purchase", "orderId": "DRV1534XC", "total": 1, "cart":{ "products": [{ "product": { "name": "Fixed Rate Home Loans" } }] } }; Form.items.liveengageTag.$uploadJsonData(jsonData,false);

Release Notes

Version 1.1 Jun 14, 2017

  • Upgraded to LiveEngage version 1.7.

Version 1.0 Feb 25, 2017

  • Baseline release.

Maestro Assets

LiveEngage Tag Library: exchange.liveperson Category: Liveperson

LiveEngage Tag widget

Rule Templates

You may add your own logic to handle the following rule types triggered by this component:

  • On Request Chat : a script to run on request a chat


Property Category Description Type Default
Section Engagement Attributes

Section attribute allows to describe specific webpages. Use section to determine the appropriate location for engaging with visitors, or to display where those visitors are browsing. The expected value is array string

Taglet Section Engagement Attributes

Set the taglet section, or by default the section attribute will be used to produce a taglet string in the format item1-item2-item3..

Record Insights Milestones Insights

If selected, a milestone event will be sent to Transact Insights when LivePerson chat is initiated

boolean true