Overview
Claravine connects to Adobe Customer Journey Analytics (CJA) through Adobe Experience Platform (AEP), so the campaign metadata you govern in The Data Standards Cloud flows directly into CJA as dimensions and metrics - no file exports, SFTP pipelines, or hand-built source connectors required.
With this integration, you can:
- Push governed campaign metadata to AEP automatically when a Dataset is submitted
- Import XDM schema fields from AEP with one click
- Auto-create and auto-map fields against your XDM schema
- Apply Data Standards before data reaches CJA
- Add richer dimensions and segmentation to your Analysis Workspace reports
How it works
Once your AEP connector is set up, the platform pushes campaign metadata from your Claravine dataset into the AEP dataset you select. The AEP dataset uses a record lookup schema, where each record is keyed on your tracking code and carries the metadata for that code. The data becomes available in your CJA Connection as a lookup dataset.
In CJA, your team joins this lookup dataset to event data (such as clicks and traffic) on the tracking code. Every event that carries a tracking code picks up the governed metadata Claravine sent for that code.
From there, your team has a few options:
- Govern and analyze. Standardize campaign metadata in Claravine, push it to AEP, and report on it in CJA - without manual cleanup in between.
- Enrich before activation. Add business-specific metadata in Claravine templates to deepen what's available in CJA and other downstream systems.
- Connect the workflow end-to-end. Generate naming conventions in Claravine, submit campaigns through your Template, and push that data to AEP. Naming compliance improves, analytics teams get more accurate dimensions, and your CJA reports gain the context they need.
Adobe Analytics and CJA: You can run the CJA integration on its own or alongside an existing Adobe Analytics integration. If a Field Set is already mapped to Adobe Analytics, that mapping stays in place and Claravine sends data to both destinations. Whether you use one or both depends on your organization's analytics strategy, including any phased migration from Adobe Analytics to CJA.
Connect Claravine to Adobe Customer Journey Analytics
Complete these steps in order. Steps 1 through 3 happen in your Adobe environment and are typically completed by your AEP team. Your Claravine team can advise.
Step 1: Create the Record Schema in AEP
Adobe recommends a custom Record class for CJA lookup datasets. Do not use an XDM ExperienceEvent schema, which is designed for time-based events. To create the schema:
- In Adobe Experience Platform, go to Data Management → Schemas.
- Click Create schema.
- Choose Manual.
- On the schema and class selection screen, choose Other → Custom.
- Click Create class.
- Enter a class name, such as
Campaign MetadataorClaravine Campaign Lookup. - For Schema Behavior, select Record. Do not select Time Series.
- Create the class and finish creating the schema.
Step 2: Create a Dataset in AEP
- In AEP, go to Data Management → Datasets.
- Click Create Dataset → Create Dataset from Schema.
- Select the schema you created in Step 1.
- Name the dataset so it is easy to identify as the Claravine integration target (for example, "Claravine CJA Outbound").
- Click Finish.
Step 3: Generate API Credentials
Claravine authenticates with AEP using OAuth Server-to-Server credentials from the Adobe Developer Console.
- In the Adobe Developer Console, click Create New Project.
- Click Add API, select Experience Platform API, and choose the OAuth Server-to-Server credential type.
- Complete the credential and copy the Client Secret right away. It is only shown once.
- In AEP, go to Permissions and open or create a role scoped to your sandbox. Grant
view-datasets,view-schemas, andmanage-datasets. On the role's API credentials tab, add the credential from this step. Withoutmanage-datasets, the connector saves but cannot deliver data. - In AEP, go to Sandboxes and note the sandbox API name, not the display name. The API name is case-sensitive.
Before moving on, confirm you have these five values: Client ID, Client Secret, Organization ID, Scopes, and Sandbox Name (the sandbox API name).
Step 4: Add the AEP Connector in Claravine
With your credentials ready, follow these steps in Claravine:
- Navigate to Integrations → Connectors. The Connectors page displays.
- Click Add Connector in the top left to create a new connector. The Add Connector menu displays.
- Enter the following information for the connector:
- Connector Name
- Description (optional). We recommend entering a description to make it easier to determine the use of the Connector when configuring integrations.
- Select the Adobe Experience Platform tile as the connector type. The AEP credential entry form displays.
- Enter the Client ID, Client Secret, Organization ID, Scopes, and Sandbox Name from Step 3. For Sandbox Name, enter the sandbox API name exactly as it appears in AEP.
- Click Save Connector. The Client Secret is stored encrypted 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.
Adobe Customer Journey Analytics Fields Available for Integration
The integration allows specific fields in Claravine to automatically push data into a connected AEP dataset, where they become available in your CJA Connection and Data View. Unlike fixed-schema integrations, the available fields are defined by the record lookup schema you have built in AEP - Claravine imports the schema fields you select and auto-maps them to their schema paths. Below is a list of common fields and identity attributes used with the integration.
Identity Fields
| API Field Name | Field Label | Description | Req'd | Inbound | Outbound |
|---|---|---|---|---|---|
_id |
Record ID | Unique identifier for each record sent to AEP. | ✔ | ||
identityMap |
Identity Map | Map of identifiers used for cross-channel stitching in CJA. View Identity Service documentation. | ✔ |
Campaign Details Fields
| API Field Name | Field Label | Description | Req'd | Inbound | Outbound |
|---|---|---|---|---|---|
campaign.id |
Campaign ID | The unique identifier of the campaign as governed in Claravine. | ✔ | ||
campaign.name |
Campaign Name | Name of the campaign as governed in Claravine. | ✔ | ||
campaign.channel |
Campaign Channel | The marketing channel the campaign runs on (e.g., paid social, display, email). | ✔ | ||
campaign.objective |
Campaign Objective | The objective of the campaign (e.g., awareness, consideration, conversion). | ✔ | ||
campaign.publisher |
Campaign Publisher | The publisher or platform where the campaign is running. | ✔ | ||
campaign.startDate |
Campaign Start Date | The date the campaign starts. | ✔ | ||
campaign.endDate |
Campaign End Date | The date the campaign ends. | ✔ | ||
campaign.budget |
Campaign Budget | The budget allocated to the campaign. | ✔ |
Web Details Fields
| API Field Name | Field Label | Description | Req'd | Inbound | Outbound |
|---|---|---|---|---|---|
web.webPageDetails.URL |
Page URL | The full destination URL associated with the campaign. | ✔ | ||
web.webReferrer.URL |
Referrer URL | The referrer URL associated with the campaign. | ✔ | ||
marketing.trackingCode |
Tracking Code | The tracking code governed in Claravine. If your Template's key is a Claravine Pattern, map this field to the Pattern under External fields. See Field Mapping. | ✔ | ||
marketing. trackingCodeAlias |
Tracking Code Alias | An optional alias for the tracking code, used for downstream classification. | ✔ |
Custom Fields
You can also add custom fields to your record lookup schema in AEP for any additional business-specific metadata you want to push from Claravine. Use dot-path naming when defining custom fields in AEP (e.g., _claravine.campaign.trackingCode). When you import fields in the Claravine integration setup, your custom fields appear alongside standard Adobe fields 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 schema fields (one or more selected at import time)
- Required fields (pre-checked and locked by Claravine based on schema requirements)
- Field-level mappings (auto-created on import, editable before save), including mapping your key field to a Claravine Pattern
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 CJA 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:
- An Administrator must first add an Adobe Experience Platform connector in Integrations → Connectors. See the Connect Claravine to Adobe Customer Journey Analytics section above.
- Open or create the Field Set in the Elements → Field Sets menu. The Field Set must contain (or be ready to receive) all fields you want to map to your XDM schema.
- Click the Integrations tab on the Field Set.
-
Under Configure new integration, click the CJA Powered through AEP card. The CJA integration configuration section displays.
- Optionally enter an Integration name. If left blank, the integration name defaults to the dataset name.
- Select the connected AEP Connector from the dropdown list.
- Select the target AEP Dataset. Claravine fetches the XDM schema automatically.
- Click Import fields. A panel opens showing the available fields from the schema.
- Select the fields you need. Required fields are pre-checked and locked - hover to see why. Use Select all only if you want every schema field in this Field Set.
- Click Add fields to field set. Claravine matches each selected schema field to an existing Field Set field by name and creates a new field for any that do not match. Each field is auto-mapped to its AEP schema path. All imported fields must be mapped before saving.
Important: Import only the fields you need. Any selected field that does not match an existing Field Set field by name becomes a new field when you save, and saving updates the saved date on every field, so newly created fields are hard to identify afterward. Before importing, review which fields already exist in the Field Set. Do not save your key field as a new field if your Template uses a Pattern as its key; map it to the Pattern instead (see Field Mapping).
Field Mapping
- Imported fields are auto-mapped to their AEP schema paths during the Import fields step. You do not need to map fields manually unless you want to override an auto-mapping or add a new mapping.
-
To modify the selected fields, click Edit in the Field mapping section. This reopens the field selection panel so you can add or remove fields.
-
Map your key field. If your Template's key (tracking code) is a Claravine Pattern, map the imported key field to that Pattern before saving:
- In the mapping dropdown for the key field, scroll to the External fields section at the bottom. This section lists every Pattern on the account.
- Select the Pattern your Template uses. The key field name in AEP varies by organization, so confirm which Pattern belongs to your Template before selecting it.
- If your key is a concatenated field that already exists in the Field Set, map it to that field instead. No External fields mapping is needed.
- Click Save integration to save the configuration.
Repeat these steps for any additional AEP datasets you want to push to. A single Field Set can have multiple CJA integrations active at the same time, each pointing to a different dataset.
Fields Tab
Once fields have been imported via the Integrations tab, they appear on the Fields tab of the Field Set. From the Fields tab you can:
- Assign to a list. For fields that should be governed by a controlled vocabulary, assign the field to an existing list so that values are validated against allowed options when a Dataset is submitted.
-
Define text governance. For free-text fields, configure character limits, allowed characters, regex patterns, or case rules to enforce naming convention standards before data is pushed to AEP.
Note: You cannot delete a field from the Fields tab if it has an active CJA mapping on the Integrations tab. Remove the mapping on the Integrations tab first, then delete the field.
Deletion Behavior
-
Deleting an integration: Removes the AEP connection and all XDM schema path mappings. Fields imported via Import fields are not deleted - they remain in the Field Set on the Fields tab, just without a schema path value.
-
Clearing all mappings at once: Done by deleting the integration, which clears the mappings for every imported field. Individual fields can be deleted from the Fields tab only after their mappings are removed.
-
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 CJA 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 adds the record lookup dataset to the CJA Connection and 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.
Updated
Comments
0 comments
Article is closed for comments.