Integrating HCL Digital Analytics and Campaign

Online segments that are defined in Digital Analytics can be used in HCL® Campaign to target customers based on their web activity and behavior. Important! This topic pertains to IBM Digital Analytics, not HCL Digital Analytics for On Premises.

Before you begin

  • Regardless of the HCL Campaign environment that you are integrating (Development, Test, Stage, Production), you must point the Campaign installation to a production version (not a test version) of the IBM Digital Analytics environment, because that is the only environment that has the required “export" capability.
  • The server machine where the HCL Campaign listener is running must be able to reach the IBM Digital Analytics data center in order to communicate with the hosted Coremetrics URL (https://export.coremetrics.com/eb/segmentapi/1.0/api.do). Use port 443, which is the default port for https. Without direct access between the listener machine (which may sit behind a secure firewall) and the data center, the integration will not work.

About this task

The integration relies on several components:

  • An integration service that acts as the integration point between the two products.
  • A translation table that maps Digital Analytics keys to HCL Campaign audience IDS.
  • Configuration settings in HCL Campaign that enable the integration on a per-partition basis.
  • Permissions and accounts set in Digital Analytics, Marketing Platform, and HCL Campaign.

Procedure

  1. Make the following adjustments in IBM Digital Analytics and HCL Campaign.
    Task Performed by Details For documentation
    A. Configure a Digital Analytics client ID to support the integration. HCL Provisioning Global User Authentication must be enabled and an ExportBuilderSegmentAPI role must be added to your Digital Analytics client ID. This step is performed by HCL.
    B. Configure Digital Analytics for integration with Campaign. Digital Analytics user with admin rights Create a user group and a user account in the Digital Analytics production environment for all of the client IDs that you want to access in Campaign. Assign the user to the group, then set Global User Authentication.Export
    Important: After you perform this task, HCL Provisioning must enable the ExportBuilderSegmentAPI role for the new user group.
    		 See Configuring Digital Analytics to enable Campaign integration.
    C. Broadcast Digital Analytics segments for use in Campaign. Digital Analytics user with admin rights In Digital Analytics, select Manage > Report options > Report segments. In the Actions menu, click the Broadcast icon next to the segment that you want to share with Campaign. When opens, complete the segment form. See the Digital Analytics and Export product documentation.
    D. Create and populate a translation table. HCL Consulting, HCL Business Partner, or customer IT team A translation table maps the Digital Analytics registrationid (online key) to the Campaign audience ID (offline key). See Creating and populating the translation table.
    E. Optional: Configure SSO. Campaign user with admin rights Single sign-on (SSO) lets Campaign users access Digital Analytics without being prompted to log in, for easier navigatation between products. See the HCL Marketing Platform Administrator's Guide.
    F. Configure a Marketing Platform account and data source to access the integration service. Campaign user with admin rights This step may be done before or after step G.

    Choose Settings > Users, select the same user that is defined for ASMUserForCredentials (see step G), click Edit data sources, and add a new data source:

    • The Data Source name must exactly match the value that is defined in Campaign for ASMDatasourceForCredentials.
    • The Data source login and Password are the Digital Analytics user account credentials that were defined in step B, Configure Digital Analytics for integration with Campaign..
    		 See the HCL Marketing Platform Administrator's Guide.
    G. Set Campaign configuration properties for each partition where you will enable integration. Campaign user with admin rights Choose Settings > Configuration.

    Go to Campaign

    | partitions | partition[n] | Coremetrics and set the following properties:
    • ServiceURL: https://export.coremetrics.com/eb/segmentapi/1.0/api.do
    • CoremetricsKey: registrationid
    • ClientID: The Digital Analytics ID that is assigned to your company. If you have multiple IDs, use any client ID that was selected for the user account in step B. Configure Digital Analytics for integration with Campaign..
    • TranslationTableName: The name of the translation table.
    • ASMUserForCredentials: The Marketing Platform account that is allowed to access the integration service. The default is asm_admin.
    • ASMDatasourceForCredentials: The data source assigned to the Marketing Platform account. The default is UC_CM_ACCESS.
    		 See Campaign | partitions | partition[n] | Coremetrics
    H. Map the translation table. Campaign user with admin rights Choose Settings > Campaign Settings > Manage table mappings. When prompted, specify the data source that corresponds to the user database where the user tables reside (not the data source that you defined for ASMDatasourceForCredentials).

    Select the translation table, the table fields, and audience levels.

    Store the table mapping in the default catalog (default.cat) so it is available to all flowcharts.

    		 See Mapping the translation table.
    I. Give Campaign users permission to use Digital Analytics segments in flowcharts. Campaign user with admin rights Choose Settings > User roles and permissions.

    Go to Campaign | Partition[n] | Global Policy.

    Click Add roles and assign permissions, then Save and edit permissions.

    Under Campaigns, grant permission to Access digital analytics segments.

    Note: Even if you are using single sign-on (SSO), you still have to set Global Policy to provide access to segments.
    		 See Implementing security policies
    J. Enable the integration for each Campaign partition. Campaign user with admin rights Choose Settings > Configuration. Go to Campaign | partitions | partition[n] | server | internal and set UC_CM_integration to Yes. See Campaign | partitions | partition[n] | server | internal.
  2. Campaign users can now select Digital Analytics segments in flowcharts:
    1. Add a Select process to a flowchart.
    2. Choose Digital Analytics segments as the Input.
    3. Select a Client ID to see the segments that were broadcast for that ID.
    4. Select a segment. The Select segment list shows only the segments that were created for the client ID that is selected. To see other segments, select a different client ID (assuming you have permission to see that client ID).
    5. Use the Segment range date and calendar controls at the bottom of the dialog to specify the date range from which you want to obtain data for the selected segment.

    When the Select process runs:

    • It pulls data from Digital Analytics via the integration service. The segment data is simply a list of registration IDs.
    • Using the mapped translation table, registration IDs are converted to Campaign audience IDs.
    • The audience IDs are then available for use in downstream processes in the flowchart.

    For more information about flowcharts, see the HCL Campaign User's Guide.