Claravine + Adobe Experience Manager (AEM) Integration

Adobe Experience Manager (AEM) integration enables data standardization across a variety of object types in AEM. Metadata from sites, assets, products, and tags can be configured to be imported into a Claravine template as well as enabled to update the corresponding fields which were imported.

Overview

Sprawling content and marketing data, complicated by siloed teams and tools, means you're likely struggling to properly automate digital customer experiences. That's why Claravine partners with Adobe Experience Manager. Our platform, The Data Standards Cloud, connects with this powerful content and digital asset management system, making it easy to:
- Quickly locate, identify, and address asset and webpage data quality issues
- Arm operations and measurement with the content and creative data they need
- Speak the same data language across all your tech
Once the connector is set up, The Data Standards Cloud imports metadata from Experience Manager using custom settings by type of data (asset or webpage), file format filters, and field mappings. Then, platform users can quickly identify data quality issues, plus update and enrich data based on the use case.

This improved and standardized data can be sent back into Adobe Experience Manager. It can also be used in The Data Standards Cloud to enable campaign deployment, or sent to downstream analytics and cloud storage for additional dimensions for creative measurement.

Learn more:
- Claravine blog: Experience Manager Users Make Asset & Webpage Data Work Harder with Claravine’s Enhanced Connector
- Short Claravine video: Optimizing Adobe Experience Manager Metadata
- Thought Leadership reading: Examining the Importance of Metadata in Content Creation Workflows and Accelerating Time to Value with Adobe Experience Manager
- Watch the webinar on Adobe Experience Manager here.
What's next:

Follow the instructions to create a Template with Inbound Pages AEM data or Inbound Assets AEM data.
Add a Connected Account

Our AEM integration provides Claravine access to an AEM instance based on a set of user credentials and the permissions of the user will need to be configured in AEM to enable the right scope of data access required for Claravine.
1. Navigate to Settings → Accounts → Integrations.
2. Click on the plus sign (+) in the upper right and select Adobe Experience Manager. If you don't have access to the AEM integration please reach out to your Customer Success Manager.
3. Enter the Account Name as a reference in Claravine to your AEM instance.
4. Enter the Username and password which was generated by your AEM Administrator.
5. Enter the Hosted URL which we will use to connect to your AEM instance. For authentication, we provide an optional proxy URL if you company AEM instance is hosted behind a firewall.
6. Click Save.
7. The connected account will now be available to be added to a template.
Security Considerations

Claravine connects to AEM through the AEM API and uses the username and password provided to access the fields on a specific object. The permission granted to this user will determine what data we can import and update. If you only plan on importing objects into Claravine read-only access is all that would be required of the user credentials.

For external access to systems Claravine uses a set of static IP address which can be whitelisted as another solution for controlling access. You will need to check with your network administrator to see if this is required or an option for the integration. Contact your CSM for the set of IP addresses to be whitelisted.

Inbound Integration

System requirements

Adobe supports multiple versions of AEM: cloud and on-premise. Below are the versions of Experience Manager Claravine’s integration is compatible with. If you’re unsure what version of AEM you are using, please contact your system administrator.

Deployment	Version	Product Name	Adobe Support	Claravine Support
Cloud	N/A	Experience Manager as a Cloud Service	Yes	Yes
On Premise / Hosted	6.5	Experience Manager	Yes	Yes
	6.4	Experience Manager	Yes	No
	6.0 to 6.3	Experience Manager	No	No
	5.6 to 5.6.1	Experience Manager	No	No
	5.3 to 5.5	CQ	No	No

To learn more about Adobe support for Experience Manager products, refer to their release documentation.

All connections between Claravine and Experience Manager are encrypted through HTTPS to ensure data is transferred securely.

Set Up a Connector

Connectors allow you to securely save connection and authentication details used in Claravine integrations once, avoiding the need to re-enter them for each integration you set up.

To set up an Experience Manager connector, you will need to:

Provide a name and description
Select Adobe Experience Manager as the type of connector you’d like to setup
Provide a username and password
Provide the location of the server where your Experience Manager instance is hosted
Optional: Add Custom Field Mappings

Helpful tips:

You may consider creating multiple connectors if you have multiple instances of Experience Manager. For example, you may have a staging and a production environment. In that case, you can set up one connector for each environment to set up and test changes before making those changes to a template containing production data.
We recommend using a service account for your integration. A service account is a user account set up specifically to orchestrate the integration between Experience Manager and Claravine, and is not tied to any one employee or user. This protects you against loss of functionality in the integration if the status or permissions to an employee’s individual user account changes for any reason.
All integrations to Experience Manager require encrypted connections. When you add your host URL, you must provide a URL beginning in https:// to ensure an encrypted connection. System requirements are discussed above.
In order for Claravine’s integration to Experience Manager to work, we require that the user account used in the connector have read permissions to the objects you wish to sync. For example, if you want to sync asset metadata, you should configure the account used in the integration to have read permissions to the asset object in AEM. Additionally, we recommend setting the user account up with access to just the directories in AEM that contain data to sync. To learn more about setting up user policies in AEM, refer to their documentation.
You may need to whitelist Claravine’s IP addresses in order to establish a connection. Some instances of Experience Manager are protected to allow only certain traffic through a firewall. If this is the case, you can get Claravine's IP addresses to whitelist in this article. If you’re unsure if this is needed, please contact the system administrator for your AEM environment.

Add an Integration to a Template

Templates connected to Experience Manager can contain a single inbound integration. If you add multiple inbound integrations, a template validation error notification will appear in the warning icon in the top right corner of the page.

What's Next:

Follow the instructions to set up an integration template for AEM Assets.
Follow the instructions to set up an integration template for AEM Pages.

View the Status of an Integration

To view the status of your sync, go the Pending menu and open the pending submission generated by the integration. Above the table you will see the AEM logo, the time the last sync ran, as well as the status of the last sync.

The following are statuses you may see for the last sync:

Success (green checkmark icon)
Failed (red ‘x’ icon)
Syncing (blue spinning icon)

To view when the next sync runs, hover over the last sync time and a tooltip will appear.

Add an AEM Integration to a Template for Asset Data

In order to sync asset metadata from AEM Assets, you will select 'Assets' as the data type when setting up an inbound Experience Manager integration. To learn more about AEM Assets, refer to their documentation.

Create a Template

Open an existing template or follow the steps to create a new template, creating the necessary Patterns, Pick Lists, and Field Sets (including any custom field mappings) to match your AEM fields.
Click Step 3 - Connect.
Click the plus sign (+) to add a new Inbound integration.
Click Adobe Experience Manager Inbound Integration.

The AEM Inbound configuration section displays.
Input the Integration Name.
Select the connected Adobe Experience Manager Account.
Click the modal for the Assets Data Selection type.
Select the frequency sync period in the Schedule Sync. All Experience Manager inbound integrations sync data every 8 hours, beginning from the time the template is initially saved. This is not currently configurable, but may be in the future.

ℹ️ Experience Manager syncs are incremental after the initial sync of data, meaning each subsequent sync will only pull in changes made in AEM since the last sync. The integration uses the jcr:lastModified property to detect recent changes.

Apply Integration Filters

In the Integration Filter section, apply the appropriate File Format, Folder, and Tag filters:

Name	Description	Notes
Folder	Searchable list of all folders to limit data. Using this filter will sync all contents of this folder and the contents of its sub-folders. Claravine support syncing of image, document, video, and audio files. Specifically, you can limit the data synced to specific file formats.
Tag	Searchable list of all tags ID to limit data.	Filter applied to `cq:tags`

File FormatSearchable list of file types to limit synced data on.Filter applied to dc:format The following file formats are available to filter on:

Image	Document	Video	Audio
GIF	PDF	MP4	MP3
JPEG	DOC	MPEG	WAV
BMP	DOCX
PNG	PPT
SVG	PPTX
TIFF	XLS
	XLSX
	HTML

Learn more about supported file types in Experience Manager, by visiting Adobe’s documentation.

💡 Helpful tips:

Sync content fragments by filtering to assets in HTML file formats.
Multiple filters applied will behave as an ‘AND’ filter. For example, if you apply a filter on file format and folder, metadata synced from AEM will be limited to data that of the specified file format AND located in the specified folder.

Field Mapping

In Experience Manager, an object is uniquely identified using its path which Claravine relies upon in its integration as its key to detect changes. As such, path is a required field mapping when adding an AEM integration to a template.

In the Field Mapping section, use the Map from AEM drop-down list to select the standard and custom inbound AEM field, and select the corresponding Map to Claravine drop-down list of fields in the template.
Claravine’s Experience Manager integration allows mapping to many of its standard properties. Depending upon what type of data you choose to sync to a template, the list of properties will change to be relevant to the data you select to sync (e.g. Assets vs. Page).

**Mappable Properties**
Property	Display Name
path	path
dc:date	dc:date
dc:description	dc:description
dc:format	dc:format
dc:identifier	dc:identifier
dc:language	dc:language
dc:publisher	dc:publisher
dc:relation	dc:relation
dc:rights	dc:rights
dc:source	dc:source
dc:subject	dc:subject
dc:title	dc:title
dc:type	dc:type
cq:tags	cq:tags
jcr:uuid	jcr:uuid
jcr:created	jcr:created
jcr:createdBy	jcr:createdBy
jcr:lastModifiedBy	jcr:lastModifiedBy
jcr:lastModified	jcr:lastModified
jcr:createdBy	jcr:createdBy
jcr:created	jcr:created
cq:parentPath	cq:parentPath
jcr:primaryType	jcr:primaryType
cq:name	cq:name
dam:assetID	dam:assetID
dam:assetState	dam:assetState
dam:fileFormat	dam:fileFormat
dam:relativePath	dam:relativePath

To learn more about properties in Experience Manager, refer to their documentation.

Click + Add New Mapping to add additional AEM to Claravine mapping.
Click Save to save the template.

💡 Helpful tip: You can use custom field mappings to sync data in custom properties in Experience Manager. It’s common for companies to customize their AEM environment through custom properties. In order to map data from custom properties, you simply add a custom field mapping to the AEM connect account.

Watch a video showing you how to add an AEM Inbound Integration to an AEM Assets template.

Learn more: Download the Claravine Practitioner's Guide To Using DAM Metadata.

What's next: Follow the instructions to set up an integration template for AEM Pages.

Add an AEM Integration to a Template for Pages Data