Skip to content

Implementation Guide

Abstract

This document will guide you through how you can onboard and verify Sentiments on your site

Warning

Do not reshare this document with anyone unless they need to implement WOGAA tracking on their websites

Prerequisite

In order to start using Sentiments on your services (e.g. IS and/or TS), you should ensure that you have fulfilled the following prerequisites:

  • Informational Service/Transactional Service should be registered on WOGAA
  • Informational Service should have implemented or updated with the latest wogaa.js code
  • Transactional Service should have completed implementation for the Start and End Trigger Codes of your service(s)

Onboard Sentiments

As of 30 Sep 2019, agencies are able to activate WOGAA Sentiments for their respective services. This can be activated by following the guided steps on wogaa.sg under Manage Sentiments.


Enabling Sentiments on your Informational Service (IS)

To begin with, Step 1 - Click on Sentiments, then Manage Sentiments

OB_1


Step 2 - Enter the Service Name on the search bar or navigate through the list to select the service you want to enable Sentiments for by clicking the eye icon - MANAGE SENTIMENTS

OB_2


Step 3 - Choose on the services (IS or TS) that you want to enable Sentiments for. Click on the Sentiments Status toggle, it allows you to toggle the Sentiments widget appearing on your site/service on or off. This will immediately halt all data collection from Sentiments the moment you turn it off.

OB_3

Here you will see a modal dialog pops-up where you can confirm the activation of Sentiments on your Live Site.

OB_7

Step 4 - Click YES. You should see a success message similar to the one below:

OB_6

And that’s it! You have successfully activated Sentiments on your Production/Live Service.


Enabling Sentiments on your Transactional Service (TS)

Since Transactional Service(s) are grouped according to their respective IS (es) under Digital Service Register (DSR), it is required for the IS to be verified first before you can start enabling Sentiments on your individual TS(es).

To enable Sentiments on a TS, you first need to select the IS that your TS resides in, under Manage Sentiments, then follow through similar steps as described above for enabling Sentiments on an IS.

Enable Sentiments for Multiple Transactional Services

If you need to enable Sentiments for multiples TS(es) at one go, click on the Select All (1) checkbox and then click on ACTIVATE (2). Sentiments will then be successfully enabled for all the selected TS(es).

OB_4


Testing Sentiments on Non-Prod Environments

To test out the behaviour and interaction of Sentiments on your Non-Production (e.g. Development, QA, Staging) Environments, you can simply select on the Test Environment Tab and by clicking on the REGISTER TEST ENVIRONMENT and enter your Non-Prod domain name (without the path) into the text field.

For e.g. "http://[dev,stg,qa].example.com"

Note: Make sure your Non-Prod Environment(s) is using the right testing script tag.

OB_5


Looking at customising your Sentiments Widget? [NEW]

You can start customising Sentiments to match the theme that best suits your site/service(s) which includes the design, positioning, questions, and many more.


If you have any questions, please don’t hesitate to reach out to our customer success team at wogaa@tech.gov.sg. We will response to you as soon as possible.


Optional: How to Correlate Sentiments Data to Your Agency's Data

Info

If you’re looking at WOGAA Sentiments data you need to understand one thing: we do not collect any personally identifiable information other than the e-mail input field; except that it’s an optional field for the user to fill it in.

There are many times when an agency wants to get more information of their visitors to provide better services or support cases and in some cases both.

So what can you do? Sentiments now offers the ability to correlate your agency's data with Sentiments data through tagging of agency's own unique identifier (for e.g. Transaction ID, Session ID, or others) that is stored in your own database/server that can uniquely identify the visitor(s) or the transaction(s) performed on your website(s). To illustrate:

  • Transaction ID - for e.g. after a successful submission by a user, usually there will be a transaction ID that can be used to verify the ownership of the submitted transaction.
  • Session ID - for e.g. a unique identifier that your website assigns to a specific user for some predetermined duration of time or session, to keep track of visitor activity such as the last state before the user drop off from your site.

After you've defined and done the setup on your end, you will be able to associate it with the Sentiments data collected once a user submits his/her sentiments through your website(s). And in the following, we'll show you how to implement the unique identifier for each digital service(s) or in your page(s).

For Informational Services

For pages that you would like to tag sentiments, just call the method addMeta() with the object {"agencyTxnId": "<your_own_unique_identifier>"}.

<html>
<head>
<!-- WOGAA.js code -->
</head>
<body>
...
...
<script>
    /*
     * Once the Transaction ID has been retrieved e.g. from an API call,
     * pass the Transaction ID to the method below.
     *
    */

    window.wogaaCustom.addMeta({"agencyTxnId": "<your_own_unique_identifier>" });
</script>
</html>

For Transactional Services

For Transactional Services, Sentiments will be triggered on the completeTransactionalService() call. As such, the addMeta() with the object {"agencyTxnId": "<your_own_unique_identifier>"} should be called before that.

<html>
<head>
<!-- WOGAA.js code -->
</head>
<body>
...
...
<script>
    window.wogaaCustom.addMeta({"agencyTxnId": "<your_own_unique_identifier>" });
    // addMeta() must be called before completeTransactionalService()

    window.wogaaCustom.completeTransactionalService("<tracking_ID>");
    /*
    tracking_ID is given to you when you registered your Transaction Service(s)
    onto wogaa. For e.g tracking-123
    */
</script>
</html>