Engagement Engine Editor is only usable by organizations that have tagged their pages with the ATGSvcs JavaScript tag (atgsvcs.js).
This tag should be on each page within the website as it is required in order to provide continuity and ensure a complete history when using conditions such as Page URL History or Search Engine.
Engagement Engine Page Tag
Engagement Engine Editor will only be usable by organizations that have tagged their pages with the ATGSvcs JavaScript tag (atgsvcs.js).
An example of such a tag is:
<script type='text/javascript'>window.ATGSvcs = {'uoid': account ID number};</script>
<script type='text/javascript' src='//static.atgsvcs.com/js/atgsvcs.js'></script>Note: If you are using this tag but do not require Engagement Engine to load any legacy eStara rules you should replace uoid with eeid in the page tag. This loads the rules without the legacy eStara rules.
This tag should be on each page within the website as it is required in order to provide continuity and ensure a complete history when using conditions such as Page URL History or Search Engine.
You can view the tag associated with your account by clicking on the Settings button in the navigation bar. The page tag is displayed in the General Settings screen.
Note: Organizations migrating from WebCare Rule Builder should replace their eStara legacy tag with this new page tag. Having both tags on a page may cause problems on that page.
RightNow Page Tag
For RightNow CX customers, a RightNow specific page tag is required on any page where you wish to deploy a syndicated widget. Detailed instructions on how to deploy a page tag on a RightNow page can be found at https://cx.rightnow.com/app/answers/detail/a_id/7153/kw/7153.
Page Tag Modifications
You can add parameters to your page tag to customize how your page runs. These parameters should be defined when you make your call to window.ATGSvcs in your page tag. The parameters that can be set are:
eeFlag: By default, the protocol used for requests to the Engagement Engine servers matches the protocol of the page from which the request is made. You can use the eeFlag parameter if you want to instruct Engagement Engine to use HTTPS protocol for these requests even though your page uses HTTP protocol. If this is the case you should set this parameter to ‘s’.
window.ATGSvcs = { "eeid": <account-id>, CFG: { '-eeFlag': 's'} };eeSPA: This parameter is used to indicate that the page is configured to run as a single page application. You should set this parameter to 1 if you are using Engagement Engine on a single page application.
window.ATGSvcs = { "eeid": <account-id>, CFG: { '-eeSPA': 1} };Note: When the eeSPA flag is set to 1, a new rules request is triggered when Engagement Engine detects changes to the hash fragment, or when you use the HTML5 pushState method.
eeTimeout: This parameter is used to indicate how long the page should wait for a response to the call to load rules for the page. You should set this parameter to the number of milliseconds you wish to wait before timing out.
window.ATGSvcs = { "eeid": <account-id>, CFG: { '-eeTimeout': 10000} };For example, to set the single page application parameter, your page tag should include the following code:
<script type='text/javascript'>window.ATGSvcs = {'eeid': <account-id>, CFG: { '-eeSPA': 1} };</script>
<script type='text/javascript' src='//static.atgsvcs.com/js/atgsvcs.js'></script>You may also use ATGSvcs.setCfg to change one of these Engagement Engine settings after the call to windows.ATGSvcs. For example, if you want to instruct Engagement Engine to use HTTPS protocol on one page on your site but, for the sake of consistency, do not wish to change the page tag, you could add the following code after the call to window.ATGSvcs:
<script type='text/javascript'> ATGSvcs.setEEID(account-ID); ATGSvcs.setCfg('-eeFlag', 's');</script>;Note: You must make the call to ATGSvcs.setCfg before the DOMContentLoaded event is fired.
The above examples are designed for use by RightNow CX customers. If you are not using RightNow CX, you should replace eeid with uoid.
Load the ATGSvcs Library Dynamically
It is recommended you load the ATGSvcs library by using a page tag included in either the head or the body of each page. This ensures that the library is loaded before the DOMContentLoaded event is fired by the browser, and so we can use the DOMContentLoaded event to trigger the rules request for the page.
If you do not load the ATGSvcs library by including a page tag you can load it dynamically by calling ATGSvcs.start() to trigger the rules request for the page.
Hosting of the Engagement Engine ATGSvcs Library
The ATGSvcs library is hosted on a content delivery network to ensure optimal performance. Engagement Engine requires the latest version of this ATGSvcs library, and for this reason the library should always be referenced via either the page tag method or dynamic loading method described in this section of this document. Any other hosting (for example within your web application) is not supported by Oracle.
