wogaa.js Update Guide¶
Overview¶
Why is there a need to upgrade to wogaa.js?
As our product increased in scope, we wanted to make sure that there will be minimal changes at the agency end for their underlying services which tend to be bundled with many overheads.
The update to the latest wogaa.js will be used to power tracking for Transactional Services and also WOGAA Sentiments.
This guide will take you through the steps to updateyour existing code to wogaa.js v2 code in your Tracking and Production environment.
- Update tracker to latest version
- Implement and Verify Code in Test Environment
- Implement and Verify Code in Production
wogaa.js Version History¶
Info
The latest version of WOGAA Web Analytics code is wogaa.js v2.
What are the different types of existing tracking script?
Position | Environment | DTM | wogaa.js V1 | wogaa.js V2 |
---|---|---|---|---|
<head> of every page | Staging | <script src="//assets.adobedtm.com/a63ef04a8a06d4763abe9b28a8d967e7e749d199/satelliteLib-db3891214175cc48594c242657d262be8297f3d8-staging.js"></script> | <script src="https://assets.dcube.cloud/scripts/wogaa.js" async</script> | <script src="https://assets.dcube.cloud/scripts/wogaa.js"></script> |
Production | <script src="//assets.adobedtm.com/a63ef04a8a06d4763abe9b28a8d967e7e749d199/satelliteLib-db3891214175cc48594c242657d262be8297f3d8.js"></script> | <script src="https://assets.wogaa.sg/scripts/wogaa.js" async</script> | <script src="https://assets.wogaa.sg/scripts/wogaa.js"></script> | |
<body> of every page, just before the closing </body> | Staging and Production | <script type="text/javascript">_satellite.pageBottom();</script> | empty | empty |
Update tracker to latest version¶
Update DTM to wogaa.js v2¶
Updating from DTM will require you to first remove the existing codes that were previously placed in the <head>
and <body>
section of your website.
-
Remove the following script in the
<head>
<script src="//assets.adobedtm.com/a63ef04a8a06d4763abe9b28a8d967e7e749d199/satelliteLib-db3891214175cc48594c242657d262be8297f3d8.js"></script>
-
Remove the following script in the
<body>
<script type="text/javascript">_satellite.pageBottom();</script>
-
Follow the steps under Implement and Verify Code in Test Environment to setup the tracker for your Testing Environment and Implement and Verify Code in Production to setup the tracker for your Production Environment.
Update wogaa.js v1 to v2¶
The update from wogaa.js v1 to v2 involves a change of loading wogaa.js asynchronously to it being loaded synchronously. This reduce possible errors resulting from an asynchronous load.
- To update, remove the
async
attribute in the following script in the<head>
<script src="https://assets.wogaa.sg/scripts/wogaa.js" async></script>
- Verify that your code is working in your Testing Envrionment
- Verify that your code is working in your Production Environment
Implement and Verify Code in Test Environment¶
1.Register your Test Environment¶
- To register your test environment you will need to login to wogaa.sg
- Navigate to the specific Information Service under the
Manage Services
tab - Select the
Test Environment
tab - Select
Register Test Environment
to register your respective test environment's domain/URL
- After registration, proceed to Step 2 to insert tracking code into your registered environment.
2. Insert Tracking Code¶
Insert the following code into the <head>
of every page of your website, before other scripts.
<script src="https://assets.dcube.cloud/scripts/wogaa.js"></script>
Example
<html>
<head>
...
<script src="https://assets.dcube.cloud/scripts/wogaa.js"></script>
</head>
...
</html>
Info
The base code does not support subresource integrity (SRI). Please do not enable SRI for base code.
3. Content Security Policies for Test Environment¶
Info
This step is optional if your website doesn't have Content Security Policy enabled.
If your website has Content Security Policy enabled, update your CSP with the following code.
Test Environment CSP
default-src 'self' https://*.dcube.cloud/ https://*.demdex.net/ https://cm.everesttech.net/ https://wogadobeanalytics.sc.omtrdc.net/;
frame-src 'self' https://wogaa.demdex.net;
script-src 'self' blob: https://*.dcube.cloud https://assets.adobedtm.com/;
img-src 'self' data: https://wogadobeanalytics.sc.omtrdc.net/ https://cm.everesttech.net/ https://dpm.demdex.net/;
connect-src 'self' https://*.dcube.cloud https://dpm.demdex.net/;
style-src 'self' 'unsafe-inline' https://assets.dcube.cloud/fonts/;
font-src 'self' data: https://assets.dcube.cloud/fonts/;
4. Verify Test Environment¶
We will need the Chrome extension Adobe Experience Cloud Debugger to verify if the base code and event trigger codes are working
- Install Adobe Experience Cloud Debugger
- Navigate to the website with the base code.
- Open the Adobe Experience Cloud Debugger extension.
- Navigate to the
Analytics
tab in theAdobe Experience Cloud Debugger
and clicks onClear All Requests
. - Refresh the website and check if there is any data in the
Hits
section. - If the implementation is correct, there should be a set of data.
- Expand the set of data and screen capture them.
Email Template for Verification in Test Environment
Please fill in the template below and email WOGAA NCS Support at wog.aa.support@ncs.com.sg
- Informational Service Name:
- Informational Service URL:
- Environment:
- Attachment: Screenshot taken in the previous step
Implement and Verify Code in Production¶
1. Insert tracking code¶
Insert the following code into the <head>
of every page of your website, before other scripts.
<script src="https://assets.wogaa.sg/scripts/wogaa.js"></script>
Example
<html>
<head>
...
<script src="https://assets.wogaa.sg/scripts/wogaa.js"></script>
</head>
...
</html>
Note The base code does not support subresource integrity (SRI). Please do not enable SRI for base code.
2. Content Security Policies for Production¶
Info
This step is optional if your website doesn't have Content Security Policy enabled.
If your website has Content Security Policy enabled, update your CSP with the following code.
Production CSP
default-src 'self' https://*.wogaa.sg https://*.demdex.net/ https://cm.everesttech.net/ https://wogadobeanalytics.sc.omtrdc.net/;
frame-src 'self' https://wogaa.demdex.net;
script-src 'self' blob: https://*.wogaa.sg https://assets.adobedtm.com/;
img-src 'self' data: https://wogadobeanalytics.sc.omtrdc.net/ https://cm.everesttech.net/ https://dpm.demdex.net/;
connect-src 'self' https://*.wogaa.sg https://dpm.demdex.net/;
style-src 'self' 'unsafe-inline' https://assets.wogaa.sg/fonts/;
font-src 'self' data: https://assets.wogaa.sg/fonts/;
3. Verify Production Environment¶
We will need the Chrome extension Adobe Experience Cloud Debugger to verify if the base code and event trigger codes are working
- Install Adobe Experience Cloud Debugger
- Navigate to the website with the base code.
- Open the Adobe Experience Cloud Debugger extension.
- Navigate to the
Analytics
tab in theAdobe Experience Cloud Debugger
and clicks onClear All Requests
. - Refresh the website and check if there is any data in the
Hits
section. - If the implementation is correct, there should be a set of data.
- Expand the set of data and screen capture them.
4. Send Image to WOGAA for Verification¶
Email Template for Verification in Production
Please fill in the template below and email WOGAA NCS Support at wog.aa.support@ncs.com.sg
- Informational Service Name:
- Informational Service URL:
- Environment: Production
- Attachment: Screenshot taken in previous step