Connecting Liferay DXP to Analytics Cloud

Documentation Menu
Go Back

Connecting Liferay DXP to Analytics Cloud

Available Liferay DXP 7.4 U67+

Liferay DXP and Analytics Cloud connect via a secure, encrypted token. This token is generated by Analytics Cloud and must be added to your Liferay DXP configuration. Once connected, you can determine which data to sync.

note

This process varies for different Liferay DXP versions, though prerequisites are the same. See Liferay DXP 7.4 U66 and Earlier Versions for alternative instructions.

Prerequisites

Connecting Liferay DXP to Analytics Cloud has these prerequisites:

  1. You need a liferay.com account. If you don’t have one, you can create an account.

  2. When you visit analytics.liferay.com for the first time, you must set up multi-factor authentication for the account. See Multi-Factor Authentication for details.

  3. Your Liferay DXP installation must meet one of the following minimum versions:

    • 7.4 (Any version)
    • 7.3 Fix Pack 1
    • 7.2 Fix Pack 11
    • 7.1 Fix Pack 22
    • 7.0 Fix Pack 98

  4. You must have access to at least one Analytics Cloud workspace. As a paid Analytics Cloud user, you should see your workspace upon login. If you don’t, contact support through help.liferay.com.

Using the Onboarding Guide

  1. Log into Analytics Cloud and select your workspace.

    If this is your first time logging in, the onboarding guide appears. Click Next and copy the Analytics Cloud token.

    You see an onboarding guide when you login first.

    Alternatively, you can find the token under Settings → Data Sources. Click Add Data Source, select Liferay DXP, and copy the Analytics Cloud token.

  2. Log into your Liferay DXP instance.

  3. Open the Global Menu (Global Menu), go to the Control Panel tab, and click Instance Settings.

  4. Under Platform, click Analytics Cloud.

    You see a four-step onboarding guide the first time you do this.

  5. Enter the Analytics Cloud token and click Connect.

    Enter the token and click Connect.

  6. Select an existing Analytics Cloud property or click Add (Add Button) to create one. Once selected, click Assign.

    note

    Properties are labels associated with one or more Liferay sites and determine how Analytics Cloud aggregates your data.

    Select an existing property or create a new one.

  7. Select the sites you want to assign to the property. Enable the Commerce toggle to assign Commerce channels as well.

    You can assign the same site or channel to only one property at a time. See Scoping Sites and Individuals Using Properties for more information.

    Select sites and channels to sync with Analytics Cloud.

  8. Click Next.

  9. Select the individual and account profiles you want to sync.

    Use the toggle to sync all contact and account data or select subsets based on user group, organization, and account group.

    Select the contact data you want to sync with Analytics Cloud.

    important

    Analytics Cloud provides tools to sync and manage individual contact data. However, these tools do not guarantee compliance with privacy regulations (e.g. GDPR). You must carefully determine the practices and configurations necessary for complying with the privacy laws where your sites store and process personal data.

  10. Click Next.

  11. Select the desired attributes for each entity. If you’re syncing Commerce channels, you can select attributes for Commerce entities.

    Analytics Cloud requires some fields to be synced; these fields are grayed out.

    Select the attributes to sync for each of the entities.

  12. Click Finish.

    Verify this message appears:

    Success: DXP has successfully connected to Analytics Cloud. You will begin to see data as activities occur on your sites.

Congratulations, your Liferay instance is now connected to Analytics Cloud!

Liferay DXP 7.4 U66 and Earlier Versions

Connection Token

Liferay DXP and Analytics Cloud connect via a secure, encrypted token. This token is generated by Analytics Cloud and must be added to your Liferay DXP configuration. Once connected, you can determine which data to sync. The process is different depending on the version of Liferay DXP you have.

  1. Log into Analytics Cloud and select your workspace.

    If this is your first time logging in, the onboarding guide appears. Click Next and copy the Analytics Cloud token.

    You see an onboarding guide when you log in first.

    Alternatively, you can find the token under Settings → Data Sources. Click Add Data Source, select Liferay DXP, and copy the Analytics Cloud token.

  2. Log into your Liferay DXP instance.

  3. Open the Global Menu (Global Menu), go to the Control Panel tab, and click Instance Settings.

  4. Under Platform, click Analytics Cloud.

  5. Paste the Analytics Cloud token and click Connect.

    Paste the token and click Connect.

    note

    On Liferay DXP 7.0, Analytics Cloud Admin is under Configuration → Analytics Cloud.

  6. Verify this message appears:

    Success: Your request completed successfully

Congratulations, your Liferay instance is now connected to Analytics Cloud! The next step is syncing your Liferay site and your contacts.

Syncing Sites

To sync sites, you must create properties and associate them with one or more sites. Analytics Cloud aggregates your data according to how you define your properties. This example shows a simple setup where a single site is associated with a property. To learn more about defining a property with multiple sites see Scoping Sites and Individuals Using Properties.

  1. In Analytics Cloud, navigate to Settings → Properties.

  2. Click New Property and enter a label (e.g. Minium Site).

  3. In your DXP instance, open the Global Menu (Global Menu), go to the Control Panel tab, and click Instance Settings.

  4. Under Platform, click Analytics Cloud.

  5. Click Select Sites.

  6. Select the new property under Available Properties.

  7. Select the site you want to sync and click Done.

    Select the site you want to sync.

    Verify this message appears:

    Success: Your request completed successfully

Syncing Contacts

  1. In your DXP instance, open the Global Menu (Global Menu), go to the Control Panel tab, and click Instance Settings.

  2. Under Platform, click Analytics Cloud.

  3. Click Select Contacts.

  4. Under Contact Sync Options, click Sync Contacts. Toggle Sync All to sync all contacts. Alternatively, click Sync by User Groups or Sync by Organizations if you want to sync a subset of your contacts.

    important

    Analytics Cloud provides tools to sync and manage individual contact data. However, these tools do not guarantee compliance with privacy regulations (e.g. GDPR). You must carefully determine the practices and configurations necessary for complying with the privacy laws where your sites store and process personal data.

  5. Click Save and Next.

  6. Switch between the Contact tab and User tab to select which fields to sync. Liferay DXP stores contact data in two separate tables (Contact and User). Analytics Cloud requires some fields to be synced; these fields are grayed out.

    Select the fields you want to sync from the list.

  7. Click Save.

    Verify this message appears:

    Success: Your request completed successfully

Great, now you’re all set up! As users visit and interact with your site, Analytics Cloud begins tracking what’s happening. Once that happens, you can take a dive into Viewing the Analytics Dashboard to see the different interactions that get tracked.

Not finding what you're looking for?

Pardon our dust as we revamp and transition our product documentation to this site. If something seems missing, please check Liferay Help Center documentation for Liferay DXP 7.2 and previous versions.

Try Liferay's Help Center