Engagement analytics

Overview

Workplace’s engagement analytics features utilise Google Analytics to provide:

  • In-page analytics for news items and other types of pages. This feature offers a snapshot of user engagement statistics, showing a summary of information about the page’s total number of views, comments, number of times the page was marked as a favourite (or "favourited"), the average time spent on the page, and when the page was last updated.

  • A reporting dashboard which allows Workplace system administrators to view content engagement metrics across their entire Workplace site and can be accessed from the in-page analytics feature. The reporting dashboard provides access to:

    • The Analytics Overview page, showing the total number of users, news items, pages, as well as social interactions which have occurred in your Workplace system.

    • The Users Analytics page, showing which users have recently published the most pages/news items, high-level insights into the total number of users who visited, and time spent on the Workplace site, as well as a link to more detailed information in Google Analytics.

    • The News Analytics page, showing which news items have received the most views, average time spent, number of comments, other data and news item summary information, as well as a link to more detailed information in Google Analytics.

Engagement analytics are not configured by default in Workplace.

Use the instructions provided on this page to implement the engagement analytics features within your Workplace instance.

Prerequisites

To set up engagement analytics for your Workplace instance, you require a Workplace user whose account type is system administrator in Workplace. These people are known as Workplace system administrators.

Read more about morphing an existing Workplace user into a Workplace system administrator in Changing Account Types of the Squiz Matrix documentation. An existing Workplace system administrator can morph an existing Workplace user to a Workplace system administrator account type.

As part of this process, you also require someone who can configure a Google API project and credentials, as well as a Google Analytics property to integrate with your Workplace instance. For the purpose of these procedures, these people are known as Google resource administrators.

Last, ensure the general prerequisites have been met before continuing.

Configure the Google API project and credentials, and Google Analytics property for Workplace

Configuring a Google API project and credentials, and a Google Analytics property for Workplace requires work conducted by Workplace system administrators and Google resource administrators. The Google API project and credentials are required to allow Workplace to interact with Google Analytics.

Create your Workplace instance’s Workplace Analytics API asset and obtain its authorised redirect URI

As a Workplace system administrator, create your Workplace instance’s Workplace Analytics API asset and obtain its authorised redirect URI. This URI is required to complete the Google API project and credentials configuration process.

  1. Ensure you are logged in to Workplace as a Workplace system administrator and have accessed admin mode.

  2. In the Asset Map section on the left, create a new Workplace Analytics API asset (within the Squiz Workplace Mk III > Squiz Workplace - Site > Services asset) and in the resulting Page Name, provide a descriptive name (e.g. "Workplace Analytics API", which is assumed throughout the remainder of this documentation).

  3. Right-click the Workplace Analytics API asset and choose Web Paths.

  4. Copy and paste/record the URL for your Services > Website Analytics API asset, which would typically have the format:
    https://<squiz-workplace-url>/services/<name-of-your-workplace-analytics-api-asset>
    (This is required in the next procedure for your Google resource administrator.)

Configure your Google API project and credentials

You are now ready to configure your Google API project and credentials, which is conducted by a Google resource administrator. This procedure is performed by the Workplace customer (for their own Google Analytics Service) and Squiz (for Squiz’s own Google Analytics Service).

  1. Visit the Google APIs page for creating a new project and credentials.

  2. Click CREATE (to the right) to begin creating a new Google API project and credentials.

  3. On the New Project page, complete the Project Name and the additional fields for your Organisation and Location (if these are provided/available).

  4. Click the CREATE button.

  5. On the Create OAuth Client ID page, click the Configure consent screen button (to the right).

  6. On the Credentials page > OAuth consent screen tab, specify at least the following values:

    • Under Application type, choose Internal.

    • The Application name for this Google API project (e.g. Squiz Workplace), which is the Workplace instance on which you are configuring engagement analytics.

    • ( Optional ) The Support email address, which may already be populated with your Google account’s email address. (You may wish to change this to suit your requirements.)

    • Your Workplace site’s domain in the Authorised domains field.

  7. Click the Save button towards the end of the page.

  8. Click the Credentials tab towards the top of the Credentials page.

  9. In the center of the page, click the Create credentials button > OAuth client ID menu option.

  10. On the Create OAuth client ID page, choose the Web application option under Application type and specify the following values:

    • The Name for your OAuth client ID (e.g. "Workplace Analytics API"). This is usually the same name as the Workplace Analytics API asset you configured in your Workplace instance above (e.g. Workplace Analytics API within Squiz Workplace Mk III > Squiz Workplace - Site > Services in admin mode).

    • In the Authorised redirect URIs field, specify the URL value obtained from Workplace Analytics API asset above.

  11. Click the Create button.

  12. On the OAuth client dialog box, copy and (discreetly) paste/record the client ID and client secret values (required in a subsequent procedure for your Workplace system administrator).

Configure your Google Analytics website property

Now, configure your Google Analytics website property, which is conducted by a Google resource administrator. Again, this procedure is performed by the Workplace customer (for their own Google Analytics Service) and Squiz (for Squiz’s Google Analytics Service).

  1. Visit the Google Analytics site and sign in with the appropriate Google account credentials.

  2. If the New Account page does not appear, click Create Account at the top-left.

  3. On the New Account page, ensure Website is set to be tracked.

  4. In the Account Name field, specify the name of your Google Analytics account. Typically, this might relate to the Google account with which you used to sign in to Google Analytics, or your organisation’s name (e.g. "Example Organisation").

  5. In the Setting up your account section, specify at least the following values:

    • Website Name - the name of your Workplace site (e.g. "Squiz Workplace").

    • Website URL - your Workplace site’s domain without the protocol (e.g. <squiz-workplace-url>) and select https:// from the adjacent drop-down.

    • Reporting Time Zone - specify your country and the relevant time zone within your country using the drop-down menus.

  6. Scroll down to the end of the page and click the Get Tracking ID button.

  7. Agree to the Google Analytics Terms of Service Agreement and on the subsequent Tracking Code page, copy the Tracking ID value (typically beginning with "UA-" and required in a subsequent procedure) for your Workplace system administrator.

    You can always retrieve this Tracking ID value at a later point in time by signing in to Google Analytics again (with the same Google account), accessing the full Admin page and clicking Tracking Info > Tracking Code (in the central column).
  8. Click the back arrow icon on the left to access the full Admin page and then click View Settings to obtain the View ID value.

  9. Copy and paste/record the View ID value (required in a subsequent procedure for your Workplace system administrator).

In Google Analytics, obtain the URLs for the Google Analytics dashboard pages that the See Google Analytics Dashboard links will lead to (on the Users and News tabs of the Workplace reporting dashboard). These are configured in Workplace in a later procedure.

This procedure must be conducted by a Google resource administrator.

  1. Visit the Google Analytics site and sign in with the appropriate Google account credentials.

  2. From the Google Analytics home page, click Behaviour > Site Content > All Pages.

  3. Copy and paste/record the URL of this Google Analytics dashboard page, which is required by your Workplace system administrator in a subsequent procedure to configure the Google Analytics Dashboard - News Section URL property in Workplace.

  4. Again from the Google Analytics home page, click Audience > Overview.

  5. Copy and paste/record the URL of this Google Analytics dashboard page, which again is required by your Workplace system administrator in a subsequent procedure to configure the Google Analytics Dashboard - Users Section URL property in Workplace.

Configure Workplace for engagement analytics

Now, as a Workplace system administrator, configure Google Analytics and various metadata fields in Workplace to set up engagement analytics.

Configure Google Analytics Tracking IDs

  1. Ensure you are logged in to Workplace as a Workplace system administrator and have accessed admin mode.

  2. In the Asset Map section on the left, locate the Squiz Workplace Mk III > Squiz Workplace - Site asset and expand its tree.

  3. Right-click the Squiz Workplace asset and choose Metadata.

  4. On the right, click the Acquire Locks button.

  5. Scroll down the page and under the third-party-ids section (about 2/3 of the way down the page), modify the following property values (ensuring that you clear the Use default checkbox to set a property’s value/s):

    • Google Analytics ID - the Tracking ID (typically beginning with the characters "UA-") of the customer’s own Google Analytics service above.

    • Product Google Analytics ID - the Tracking ID of Squiz’s Google Analytics service.

      ( For customers ) Squiz continually improves their products and services by configuring a Squiz-controlled Google Analytics service Tracking ID in your Workplace instance. Squiz only uses the data it collects (i.e. button clicks and not personally identifiable data) through this service to improve the functionality of its products and none of this data will be shared with any third parties. Please also check the privacy policy that accompanied your Squiz Workplace contract.
    • Leave the current Google Analytics view and Typekit ID property values unchanged.

  6. Click the Commit button to save your changes.

Configure Google Analytics and Funnelback connector credentials

  1. Ensure you are logged in to Workplace as a Workplace system administrator and have accessed admin mode.

  2. In the Asset Map section on the left, locate the Squiz Workplace Mk III > Squiz Workplace - Site > Services asset and expand its tree.

  3. Right-click the Workplace Analytics API asset and choose Details.

  4. On the right, click the Acquire Locks button.

  5. Scroll down the page and under the Connection Settings (Google Analytics) section and specify the values for the following properties from your Google resources configurations:

    • Client ID - the client ID value obtained after configuring your Google API project and credentials above.

    • Client Secret - the client secret value also obtained after configuring your Google API project and credentials.

    • View ID - the View ID of the customer’s own Google Analytics service above.

  6. For the Access Token property, click the Get Access Token button and follow the instructions (i.e. sign in to Google Analytics with the Google account’s credentials used to create your Google Analytics account) for Workplace to obtain your Google Analytics account’s access token. You will be told if the process was successful and if so, the Get Access Token button changes to Revoke Access Token.

  7. Under the Connection Settings (Funnelback) section a little further down, specify the Username and Password of the Funnelback admin account credentials (noting that the password will not be displayed).

  8. Click the Commit button to save your changes.

Configure in-page analytics for all signed-in users

  1. Ensure you are logged in to Workplace as a Workplace system administrator and have accessed admin mode.

  2. In the Asset Map section on the left, locate the Squiz Workplace Mk III > Squiz Workplace - Site asset and expand its tree.

  3. Right-click the Squiz Workplace asset and choose Metadata.

  4. On the right, click the Acquire Locks button.

  5. Scroll down the page and under the Page Layout section (near the top), modify the Show in-page analytics property, ensuring that its value is set to Use default, which is yes.

  6. Click the Commit button to save your changes.

This process adds the See Reporting Dashboard link at the end of an In-Page Analytics section, when viewed by a user who is a Workplace system administrator.

  1. Ensure you are logged in to Workplace as a Workplace system administrator and have accessed admin mode.

  2. In the Asset Map section on the left, locate the Squiz Workplace Mk III > Squiz Workplace - Site asset and expand its tree.

  3. Right-click the Squiz Workplace asset and choose Metadata.

  4. On the right, click the Acquire Locks button.

  5. Scroll down the page and under the components section (about 60% of the way down the page), set the Analytics Dashboard Asset value to the Reporting Dashboard asset, which is an immediate child of the Squiz Workplace asset. To do this:

    • Click the Analytics Dashboard Asset's Change button.

    • In the Asset Map on the left, locate the Squiz Workplace Mk III > Squiz Workplace - Site > Squiz Workplace > Reporting Dashboard asset.

    • Right-click the Reporting Dashboard asset and choose Use Me from the pop-up menu.

  6. Click the Commit button to save your changes.

This process adds the See Google Analytics Dashboard links at the end of the Users and News tabs of the reporting dashboard (obtained above).

  1. Ensure you are logged in to Workplace as a user with the system administrator permission and have accessed admin mode.

  2. In the Asset Map section on the left, locate the Squiz Workplace Mk III > Squiz Workplace - Site > Squiz Workplace.

  3. Right-click the Squiz Workplace asset and choose Metadata.

  4. On the right, click the Acquire Locks button.

  5. Scroll down the page and under the analytics-configuration section (about 3/4 of the way down the page), set the following properties:

    • Google Analytics Dashboard - News Section URL - paste the Google Analytics Behaviour > Site Content > All Pages URL obtained above.

    • Google Analytics Dashboard - Users Section URL - paste the Google Analytics Audience > Overview URL obtained during the same procedure above.

  6. Click the Commit button to save your changes.

Configure permissions to access the reporting dashboard tabs

This process configures permissions to access the Overview, Users and News tabs on the reporting dashboard.

  1. Ensure you are logged in to Workplace as a Workplace system administrator and have accessed admin mode.

  2. In the Asset Map section on the left, locate the Squiz Workplace Mk III > Squiz Workplace - Site > Squiz Workplace > Reporting Dashboard and expand its tree.

  3. Note the following pages:

    • Reporting Dashboard - Overview

    • Reporting Dashboard - Users

    • Reporting Dashboard - News

  4. For each of these page assets, grant the Read permission to the System Administrators group (which can be accessed through System Management). To do this:

    1. Right-click the page and choose Permissions.

    2. On the right, click the Acquire Locks button.

    3. In the Add New Read Permission section, select Grant from the drop-down adjacent to Specific Reader Permission To.

    4. Click the Change button.

    5. In the Asset Map on the left, locate the System Management > System Administrators group asset.

    6. Right-click the System Administrators group asset and choose Use Me from the pop-up menu.

  5. Click the Commit button at the lower-right of the screen.

That’s it! Engagement analytics should now be functional in Workplace.

© 2015- Squiz Pty Ltd