Setting Up Customer Journey Analytics Connection in AEP

My'Asja Wilson
My'Asja Wilson
  • Updated

Overview

Claravine integrates with Adobe Customer Journey Analytics (CJA) through Adobe Experience Platform (AEP) to solve the problem of sprawling marketing data complicated by siloed teams and tools, enabling you to govern and measure your campaigns. Our platform, The Data Standards Cloud, pushes governed campaign metadata outbound to an AEP dataset, making it easy to:

  • Automate the delivery of governed metadata to AEP
  • Import XDM schema fields directly from AEP and auto-map them
  • Audit and validate data against marketing data standards before it reaches CJA
  • Apply Data Standards to naming conventions before delivery
  • Pass data downstream for more readable classifications
  • Enrich data for improved dimensionality and segmentation in analysis

Once the connector is set up, The Data Standards Cloud automatically pushes the specified metadata from your submitted Dataset into the AEP dataset you select, where it becomes available in CJA as dimensions and metrics. From there, you can take a few approaches depending on what your team is looking to accomplish.

You can govern naming conventions and campaign metadata in our platform and deliver that data directly into CJA so you can more immediately understand performance in your Analysis Workspace reports. And, you can enrich this data with additional business-specific metadata before sending it downstream.

You can also create and validate data across various team workflows. For example, generate naming conventions in our platform, validate compliance and add business-specific metadata through the naming convention workflow, then push that governed data to AEP for cross-channel journey analysis in CJA. This type of approach helps you improve naming compliance while simultaneously putting more accurate, detailed data in the hands of your analytics teams, and adding important dimensionality to your final analysis in CJA.

Connect Claravine and Adobe Customer Journey Analytics

Before configuring the CJA integration in TDSC, you'll need to complete a one-time setup in Adobe Experience Platform. Claravine delivers metadata into an existing AEP dataset using that dataset's XDM schema. Claravine reads your schema and dataset, but does not create them. You will need to create an XDM schema, create a dataset, add that dataset to a CJA Connection, and generate API credentials with the correct permissions in Adobe before connecting.

Note: You must have the appropriate Adobe roles to complete this setup. The credential is added in the Adobe Admin Console, but the granular permissions Claravine requires are managed separately in the Permissions screen of Adobe Experience Platform; you will need to complete both.

 
Prerequisites
  • Access to Adobe Experience Platform (AEP) with Data Engineer or Administrator permissions
  • Access to the Adobe Developer Console (developer.adobe.com/console) with the ability to create projects
  • A System Administrator or Product Admin available to assign permissions and attach the API credential
  • A CJA Connection and Data View already configured in Adobe Customer Journey Analytics

Step 1: Create an XDM Schema in AEP

Claravine sends metadata to AEP using the XDM schema defined on an AEP dataset. You need a schema that includes the fields you want Claravine to populate.
  1. In AEP, navigate to Data Management → Schemas
  2. Click Create Schema and select the XDM ExperienceEvent class
  3. Add standard field groups relevant to your use case (e.g., Adobe Analytics ExperienceEvent Template, Campaign Details, Web Details)
  4. To add custom fields, click Add Field Group → Create New Field Group
    • Name the group (e.g., "Claravine Campaign Metadata")
    • Add the custom fields you want Claravine to populate, using dot-path naming (e.g., _claravine.campaign.trackingCode)
  5. If identity stitching is needed in CJA, enable the schema for Real-Time Customer Profile
  6. Save the schema and note its name
See supporting Adobe Article here.
image.png

Step 2: Create a Dataset in AEP

  1. In AEP, navigate to Data Management → Datasets
  2. Click Create Dataset → Create Dataset from Schema
  3. Select the schema you created in Step 1
  4. Give the dataset a name that identifies it as the Claravine integration target (e.g., "Claravine CJA Outbound — [Your Sandbox]")
  5. Click Finish and note the Dataset ID
See supporting Adobe Article here.
image.png

Step 3: Add the Dataset to a CJA Connection

  1. In CJA, navigate to Connections
  2. Open an existing Connection or create a new one
  3. Click Add Dataset and select the dataset created in Step 2
  4. Configure the Timestamp Field and Person ID field for the dataset
  5. Save the Connection
  6. In your CJA Data View, add the metadata fields you want to expose as dimensions or metrics for reporting
See supporting Adobe Article here.
image.png

Step 4: Generate AEP API Credentials in Adobe Developer Console

Claravine authenticates with AEP using OAuth 2.0 client credentials. You need to create a project in the Adobe Developer Console and generate the credentials TDSC requires.
  1. Go to developer.adobe.com/console and sign in
  2. Click Create New Project
  3. Click Add API and select Experience Platform API
  4. Select the OAuth Server-to-Server credential type
  5. Assign the following product profiles to the credential:
    • AEP — Default Data Access
    • AEP — Data Ingestion Service (or the equivalent for your org)
  6. Complete the credential creation and note the following — you'll need all five when creating the connector in TDSC:
    • Client ID
    • Client Secret (copy immediately — it is only shown once)
    • Organization ID (IMS Org ID) — found in AEP Settings
    • Scopes — listed on the credential page
    • Sandbox Name — found in AEP Settings

Note: The Client Secret is stored encrypted in Claravine and is never exposed in the UI after initial entry. If you lose it, generate a new one in Adobe Developer Console and update the connector in TDSC.

Once you have these values, you're ready to create the AEP Connector in TDSC.
See supporting Adobe Article here.
 
image.png

Step 5: Grant the Required Permissions and Attach the Credential

This step requires a System Administrator or Product Admin, and is the most common source of connection and delivery errors. Granular permissions are managed in the Permissions screen of Adobe Experience Platform, not in the Admin Console.

  1. In AEP, go to the Permissions screen and find or create a role scoped to your production sandbox. Follow the principle of least privilege — grant only the permissions Claravine needs, not full admin.
  2. Under the Data Management category, grant the following permissions to that role: view-datasets (read), view-schemas (read), and manage-datasets (write).
  3. Open the role's API credentials tab — not the Users tab or the Developers tab — click Add API credential, and paste the Technical Account Email from Step 4.
  4. Save. Permission changes can take a few minutes to propagate.

Why all three permissions are required: Saving the connector and using the dataset and field pickers are read-only operations that work with view-datasets and view-schemas alone. Row delivery, however, writes data into the dataset and requires manage-datasets (write). There is no ingest-only permission. This is why a connector can save successfully yet fail to deliver rows later — the save-time check never exercises the write path. Granting all three up front avoids a silent delivery failure.

Step 6: Confirm the Sandbox API Name

The sandbox API name must exactly match what Claravine is configured to send. In AEP, go to Sandboxes and find your production sandbox, then check the API name — not the display name.

  • The API name is case-sensitive: prod is not the same as Prod.
  • The display name may read "Production," but the API name is what Claravine uses.
  • It should not be production or any custom slug.

If the API name does not match what you entered, update the Sandbox Name in your Claravine connector settings so it matches exactly

Step 7: Add the Connector in Claravine

Once the Adobe setup is complete, add the AEP connector in Claravine:

  1. In Claravine, navigate to Integrations → Connectors.
  2. Click the plus sign (+) to add a new connector and select the Adobe Experience Platform tile.
  3. Enter the five values from Step 4: Client ID, Client Secret, Organization ID (IMS Org ID), Scopes, and Sandbox Name.
  4. Click Save to validate and save the connector.

Note: The Client Secret is stored encrypted in Claravine and is never exposed in the UI after initial entry. If you lose it, generate a new one in the Adobe Developer Console and update the connector in Claravine.

If the save fails, double-check the following: the API credential (not just the project) is attached to the product profile; the technical account was added under the API credentials tab rather than the Users or Developers tab; the sandbox API name matches exactly (prod, not Prod); and that enough time has passed for permission changes to propagate.

Known Limitations

  • Delivery is outbound only. Claravine pushes metadata to AEP; it does not read event data back from CJA.
  • The integration is configured at the Field Set level, not the Template level.
  • The fields available for delivery are determined by the XDM schema on your AEP dataset. Claravine reads your schema and does not create or modify it.
  • Delivery runs automatically when a Dataset is submitted. There is no manual "Run Now" trigger.

Adobe Customer Journey Analytics Fields Available for Integration

The integration delivers governed metadata from Claravine into the XDM schema on your AEP dataset. Because the available fields are defined by the schema you build in AEP, the tables below are representative of the standard XDM field groups customers commonly use. Your own field set will reflect whatever standard and custom field groups exist on your schema. All fields are delivered outbound (Claravine → AEP).

Identity & Event

XDM Field Path Field Label Description Req'd Inbound Outbound
_id Event ID Unique identifier for the ExperienceEvent record. Y  
timestamp Timestamp The time the event occurred. Used as the dataset's Timestamp Field in the CJA Connection. Y  
eventType Event Type The type of ExperienceEvent being recorded.    
identityMap Identity Map Map of identities used for stitching in CJA when the schema is enabled for Real-Time Customer Profile.    

Campaign Details

XDM Field Path Field Label Description Req'd Inbound Outbound
marketing.trackingCode Tracking Code The governed tracking code Claravine delivers for downstream classification.    
marketing.campaignName Campaign Name The campaign name as governed in Claravine.    
marketing.campaignGroup Campaign Group The campaign group or program the campaign belongs to.    
marketing.trackingCodeAlias Tracking Code Alias An optional alias for the tracking code, used for downstream classification.    

Web Details

XDM Field Path Field Label Description Req'd Inbound Outbound
web.webPageDetails.name Page Name The name of the page associated with the event.    
web.webPageDetails.URL Page URL The URL associated with the event, including governed tracking parameters.    
web.webReferrer.URL Referrer URL The referring URL associated with the event.    

Custom Field Groups

You can also create a custom field group in your XDM schema (for example, "Claravine Campaign Metadata") containing any additional business-specific fields you want to push from Claravine. Use dot-path naming when defining custom fields in AEP (for example, _claravine.campaign.trackingCode). When you import field groups during the Claravine integration setup, your custom field group appears alongside the standard Adobe field groups and can be selected and auto-mapped the same way.

Configuration options you can apply to the integration are:

  • AEP Connector (selects which AEP tenant and credentials to use)
  • Target AEP Dataset
  • XDM Field Groups (one or more selected at import time)
  • Required field groups (pre-checked and locked by Claravine based on schema requirements)
  • Field-level mappings (auto-created on import, editable before save)

Field Set: Outbound Integration Configuration

Claravine can push governed campaign metadata directly into an AEP dataset, avoiding manual exports and hand-built AEP Source Connectors, then make this data available downstream in CJA as dimensions and metrics for cross-channel journey analysis.

Note: The CJA integration must be enabled for your organization by a Claravine representative before it appears in your Field Set. Contact your Claravine account team if you do not see the CJA integration option. Once enabled, the integration is configured at the Field Set level, not at the Template level. A single Field Set can have multiple independent CJA integrations, each pointing to a different AEP dataset.

Integration

To add a CJA outbound integration to a Field Set:

  1. An Administrator must first add an Adobe Experience Platform connector in Integrations → Connectors. See the Connect Claravine and Adobe Customer Journey Analytics section above.
  2. Open or create the Field Set in the Elements → Field Sets menu.
  3. Open the Integrations tab and, under Configure new integration, click the CJA Powered through AEP card.
  4. Select the connected AEP Connector from the drop-down list.
  5. Select the target AEP Dataset the metadata should be delivered to.
  6. Click Import fields to read the available XDM field groups from the dataset's schema.
  7. Select the XDM Field Groups you want to deliver. Required field groups are pre-checked and locked by Claravine based on the schema's requirements.
  8. Click Add fields to field set to add the imported fields to the Field Set.

Field Mapping

1. When fields are imported, Claravine auto-creates field mappings between each XDM schema field and a Claravine field in the Field Set. Review the auto-mapped fields on the Integrations tab.

2. To adjust a mapping, select the Claravine field that should populate a given XDM field path. Required schema fields must be mapped before the integration can be saved.

3. Click Save to save the integration.

Fields Tab

Imported fields appear on the Field Set's Fields tab, where you can govern them like any other field before they are delivered to AEP:

  • Assign to a list: Assign a field to a list to control the allowed values delivered to AEP.
  • Define text governance: Apply text governance rules (such as case, length, or format) so values are standardized before delivery.
  • Removing an integration: Fields imported via Import fields are not deleted when an integration is removed — they remain in the Field Set on the Fields tab, just without a schema path value.
  • Deleting a field with an active CJA mapping: Blocked. Remove the mapping on the Integrations tab first, then delete the field from the Fields tab.

Verifying the Integration

On the Template: Once a Field Set with an active CJA integration is used in a Template, a read-only Field Set Integrations card appears on the Template page showing which AEP datasets are connected via which Field Sets. Click the link to navigate to the Field Set to update mappings.

On the Dataset: When a Dataset has been submitted and the CJA outbound sync has run, a CJA integration card appears on the Dataset's Integrations tab. The card shows Active or Inactive sync status and which AEP dataset received the data. The integration runs automatically on submission — there is no manual "Run Now" trigger.

What's Next:

  • Confirm the Claravine fields you pushed to AEP appear in your CJA Data View as dimensions or metrics. Your CJA Admin configures the Data View — Claravine does not manage Data Views or Connections directly.
  • Review the AEP dataset activity log to confirm rows arrived and to inspect record counts and timestamps.
  • Build your reports in CJA Analysis Workspace using the Claravine-governed dimensions you just exposed.
 
 
 

Comments

0 comments

Please sign in to leave a comment.