Claravine + Adobe Analytics Integration

Rebekah Garner
Rebekah Garner
  • Updated

Claravine's platform, The Data Standards Cloud (TDSC), connects with Adobe’s powerful analytics and attribution tool, making it easy to:

  • Generate and define key values for more accurate, granular tracking
  • Audit and validate data, including tag placement and configuration, to ensure it is consistently capture
  • Enrich data for improved dimensionality and segmentation

mceclip0.png

Using the classifications API, you can apply standards to any object with an associated set of classifications, from eVars and tracking codes to page attributes and product eVars.

This data is pushed to the appropriate Adobe Analytics report suite and classification setup to further enrich measurement and activation. You can also simultaneously push data to parallel analytics instances or cloud storage solutions to further enable insights.

  • Integrate Claravine With Adobe Analytics

    Step 1. In Your Adobe Analytics Console: Grant Permissions to a Claravine User

    Claravine needs an API connection into any Adobe account you want to connect with. Create a Claravine user in Adobe using the email address team@claravine.com,

    Permissions suggested within the Enterprise User Management Product Profile include:

    • Report Suites: Access to all report suites for which Claravine will be used
    • Metrics: We don't necessarily need access to the metrics; we will not be using them
    • Dimensions: We need access to any variables that Claravine will be used to push data to classifications for, as well as any variables that we need to include in the validation check when we ensure the page is ready. We're not able to access any real data without metric or UI access (which we don't require), so this is not granting us access to data directly.
    • Report Suite Tools: Report Suites (Read), Report Suites (Write) [we will not be creating any report suites, just accessing the list of report suites and writing data to classifications], Conversion Variables (if working with classifications for eVars or validating their presence on a page), Traffic Variables (if working with classifications for props or validating their presence on a page).
    • Analytics Tools: Permissions (Read) - Web Services, Permissions (Write) - Web Services, Web Service Access, Logs - Web Services, Code Manager - Web Services.

    Provisioning Web Services Access allows report suites, reports, and classification information to be shared between Adobe and Claravine. We do not need the password; we will never log in to Adobe.

    Step 2. In Your Adobe Analytics Console: Configure OAuth Authentication

    IMPORTANT: Adobe Analytics is sunsetting JWT authentication on January 27, 2025. Before that date, you must migrate all Claravine integrations to OAuth to continue delivering data to Adobe Targets. Refer to this Adobe article for full details about migrating from JWT auth to OAuth in your Adobe Developer Project.

    To migrate to OAuth, you can either update existing Adobe Analytics Accounts in Claravine or create net new accounts:

    • If you update an existing account to use OAuth, no updates are required for your Adobe Targets.
    • If you configure a new Adobe Analytics account in Claravine, then you must update each relevant Adobe Target to use the new account.

    This article provides configuration instructions for OAuth and Adobe Targets. Adobe Analytics OAuth authentication is controlled through a project in the Adobe Developer Console. 

    To configure OAuth authentication:

    1. In the Adobe Developer console, navigate to your project.

      Adobe15.png

    2. Under Credentials, click OAuth Server to Server and scroll down.



      Copy the following:

      • Organization ID
      • Client ID
      • Client Secret
      • Scopes

      You will need this information to complete the instructions in Step 3.

    Step 3. In Your TDSC Account: Create a New Authentication Method

    1. Navigate to SettingsIntegrationsAccounts and select Adobe Analytics.

      Adobe17.png

    2. Add a Name and Description.

    3. Above the integration configuration fields, select the OAuth option, enter the relevant information (you collected this in Step 2), and click Save Account.

      Adobe18.png

    Step 4. Hold Internal Discussions

    To ensure a timely launch, hold internal discussions with all stakeholders and channel directors to confirm all teams are on the same page with the transition to Claravine and all information and changes have been determined. Please confirm all report suites, reports, classifications, taxonomies, pick lists, and campaign building requirements are in place.

    Consider viewing the DAA Webinar created by Anne Saylor which shows attendees how leading companies create structure and process to support clean and complete Adobe Analytics classification data. More than just a technical effort, this involves a great communication strategy among teams, a structured rollout, and a long-term view of maintenance efforts. Come away with actions you can take at your own company to improve the accuracy and timeliness of your classification data.

  • Templates, Patterns, and Field Sets

    Create inbound and outbound templates following the instructions in Templates Overview. Refer also to Patterns Overview and Field Sets Overview.

    Designate the Pattern is the Key to send to Adobe/Google Analytics. Open the Edit menu on the Parent Pattern field and Associate Field Sets. This step indicates to Claravine that the output of the Pattern is the Key and the values entered in the fields of the Associated Field Set will be sent to Adobe/Google Analytics as metadata classifications. Learn in detail about patterns and field sets.

  • Targets

    Targets specify where data from a Connected Account and Claravine flow. Administrators and Managers with target-management permissions have the permissions to view and manage Targets. You have the permissions to add multiple targeted locations in a single Target, which is beneficial to send data to multiple locations with a single submission.

    You must have a Connector set up to use a Target. For administrators additional information about creating a Connected Account, refer the Connected Accounts Overview article. For instructions to view, create, edit, and delete targets, refer to the Targets Overview article.

    View a Target

    To view Targets:

    1. Click Settings in the Navigation menu.

    2. Click Targets in the Sub-Navigation menu.
      The Targets page displays.

      mceclip0.png

    You can view the following information about Targets:

    • Name
    • Type
    • Multi Targets
    • Description

    The sort feature is available for all columns. You can sort all columns in ascending or descending order.

    Create a Target

    To create a Target:

    1. In the Targets page, click the plus sign (+) to create a new Target.
      The Edit Target menu displays.

      mceclip1.png
    2. Enter the Target Name and Description in the designated fields.
      We recommend to enter a description to make it easier to determine the use of the target for future use.

    3. Select the Integration Type from the drop-down menu (Adobe Analytics).

    4. Select the Connected Account from the drop-down menu. This list of Connected Account are populated from the Connected Account menu.

    5. Claravine will use the API connection to determine the available report suites that are available. Select the Report Suite from the drop-down list or begin typing the name to narrow the list.

    6. Claravine will use the API connection to determine the available reports that are available. Select the Report from the drop-down list or begin typing the name to narrow the list.

    7. An Administrator has the option to receive the Adobe "SAINT Export Successful" emails received for each submission sent to this Target. Check the box Send Adobe Analytics import confirmation emails when data is submitted to Target then enter the email address* the Adobe confirmation email should be sent to.
      *NOTE: This field only accepts one email address.  Entering more than one email address will cause submissions to fail.

      targetform.png

    8. Click Save.
      The target is now available for use and displays in the Targets list.

    Edit a Target

    To edit a Target to change the Target:

    1. On the Target page, click the name of the Target you want to modify.
      The Edit Target menu displays.

    2. Edit the Name, Description, Integration Type, Connected Account, Report Suite, or Report as needed.

    3. Click Save.

    Delete a Target

    To delete a Target:

    1. On the Target page, click the name of the Target you want to remove.

    2. Click Delete .
      A confirmation message displays.
    3. Click Confirm.

    Upload to Multiple Targets

    You can add multiple destination locations in a single Target, which is beneficial to send data to multiple Adobe reports and eVars with a single submission. The most common implementation practice that inspired this feature is called Multi-Suite Tagging, or Multi-Target Uploads (MTU) which is sending all of your Key (aka tracking code, campaign ID) and all associated metadata to multiple data repositories inside Adobe Analytics’ vaults.

    How It Works

    The classifications in the destination targets must be exactly replicated across all the report suites and eVars that will receive your codes and metadata. The individual classifications must be named the exact same and the amount of classification must match exactly (one eVar cannot have 10 classification while the additional target eVar has 12).

    The most valuable feature of the Multi-Target Upload is the ability to manage a global pattern that will apply to multiple report suites.

    Multi-Target Upload is only available for Adobe Analytics accounts.

    Example

    A marketing firm, ROI Branding, manages the marketing campaigns of 20 customers through Claravine. ROI Branding created a Global Report Suite and Campaign Report in Claravine from which they will manage one set of campaign reports for each channel (email, social, display) instead of managing a channel for each of their 20 customers. When a marketing representative creates a tracking code for one of its customers, Central Park Clothing, the pattern is set up to include a classification to identify the Central Park Clothing brand. When the tracking code is submitted through Claravine, the code is pushed to all 20 of the Report Suites included in the Multi-Target Upload box, but only the customer Central Park Clothing will receive the metadata being tracked. The other 19 customers will show this tracking code in their report but it will not track data because they are not Central Park Clothing.

    Add a Multi-Target Upload

    1. Click Settings in the Navigation menu.

    2. Click Targets in the Integrations Sub-Navigation menu.



    3. Click to create a new Target or click the name of the Target you want to modify.
      The Edit Target menu displays.

      mceclip1.png

    4. Multi Targets that have been previously set will show in the Multi Targets area at the bottom of the page.

      mceclip2.png

    5. Click to Add a Multi Target to this parent Target.

    6. Find the Report Suite and click the arrow to expand the list of available Reports.

    7. If the classifications in the Report match exactly to the parent Target, the Report is available to select.

      mceclip0.png

    8. If there is a discrepancy between the parent and added Multi Target classifications, you will see an error "This Report Suite has no compatible reports available to add". This indicates there is a discrepancy in the classifications in Adobe. Please navigate to Adobe to correct the issue and make all classifications match exactly.

    9. Claravine can add many multi targets, continue to add as many as are necessary. Check the Report name box for each multi target.

    10. Click Add Multi-Target.

    11. Click Save to save the Target.

    All submissions from this point forward that use this Target in the field set will send the Key and metadata to all Adobe Report Suite and Report targets in this Multi Target.

    If you need to send existing data from Claravine submissions to this additional Adobe Report Suite and Report, it is recommended to Edit and Resubmit each submission.

  • Update API Shared Secret

    Generate a New Shared Secret Key in Adobe Analytics

    1. Log in to Adobe Analytics, not the Admin Console.

    2. In the top menu click Admin.

    3. Under User Management, click Analytics Users & Assets.
      mceclip2.png

    4. Search for the user profile you want to connect with Claravine. Click the User ID.

    5. In the AccessWeb Services Credentials section, make sure Regenerate shared secret on save is selected. mceclip0.png

    6. Click Save Changes.
      The browser page refreshes with the new Shared Secret.

    7. Copy the new Shared Secret and share with your Claravine CSM or follow the steps below to update the Shared Secret in Claravine.

    Apply the New Shared Secret in Claravine

    1. Navigate to SettingsAccounts.
      The Accounts page displays.



    2. Click the name of the Adobe Analytics Account you want to modify.
      The Edit Account menu displays.

      mceclip2.png

    3. Confirm that the User Name is in this format:User Name:Company Name(e.g., rgarner:Claravine).

    4. Paste the new API Shared Secret.

    5. Click Save.
  • Sync New Adobe Classifications to Claravine

    Claravine uses an API connection to share data between Adobe Analytics and Claravine. If an Administrator makes changes in Adobe, the Claravine Target and Field Set mapping must be updated as well.

    In Adobe Analytics:

    For assistance adding a classification in Adobe, contact your Adobe Care representative or review the Adding Conversion Classifications information from the Analytics Components Guide.

    In Claravine:

    1. Navigate to SettingsTargets.

    2. Click the name of the Target you want to modify or check the box to the left of the Target name and click Edit (pencil icon) to open the Edit Target menu.

      mceclip0.png

    3. Claravine will use the API to search the report suite and report for updates to the classification fields and display the information under the Target Fields for Report section.
      • Check Mark (✓) indicates the classifications that existed the last time the Target was refreshed.
      • Plus Sign (+) indicates new classifications in Adobe to be added.
      • Minus Sign (-) indicates classifications that have been deleted from Adobe since the last time the Target was saved and will no longer send data to that classification.

    4. Click Save to save the Target changes.

      Important: Now that we have synced the new classification to the Target in Claravine, we need to map any fields to the new classification. Without this step, metadata from the users' submissions will not be sent to Adobe Analytics.

    5. Navigate to SettingsElements → Field Sets.
    6. Click the name of the Field Set you want to modify or check the box to the left of the Field Set name and click Edit (pencil icon) to open the Edit Field Set menu.

    7. If the field does not exist in the Field Set, click Add Field (+), define the field type and add governance as desired.

      Follow this link for more information on how to Add a Field or define governance.

    8. Click Target Mapping to associate a classification in the appropriate Target.

      mceclip3.png
      Without this field to Target classification association, no metadata will be sent to Adobe Analytics and the classifications will be unspecified. Not mapping this field will act as a Claravine-local field.

    9. Find the Target Name, use the arrow to expand the view of classification options for this Target.


    10. Check the box to the left of the classification(s) name to map the field.
      mceclip3.png
      You can map a single field to many classifications in any Target.

    11. Click Done.

    12. Click Save to save the Field Set.

      Important: If you added and mapped the new classification field in the Field Set, we need to add the classification field to the Template. If you mapped the Target to an existing field, the following steps are not necessary.

    13. Navigate to SettingsTemplatesTemplates.

    14. Check the box to the left of the name of the Template you want to edit., click Edit (pencil icon) to edit the Template.

    15. In Step 2 - Define and Govern, click + Select Fields to add the new field from the Field Set.

    16. Check the box to select all the fields in the Field Set or click the drop down menu to select individual fields.
      Use the Search field to find a specific field name across all Field Sets.



    17. Click Select Fields.

    18. The classification field selected will populate at the bottom of the schema.

    19. Move the field into the order as it should appear to the user in the submission table:
      • Manual: Drag the field into the ordering you desire.
      • Custom: Reorder Mode (mceclip5.png) allows the administrator to easily order the fields by assigning a line number.

    20. Click Save to save the Template changes.
  • Learn More

Comments

0 comments

Article is closed for comments.