LiveRamp - Onboarding connection liveramp-onboarding
Use the LiveRamp - Onboarding connection to onboard audiences from Adobe Real-Time Customer Data Platform to LiveRamp Connect.
Use cases use-cases
To help you better understand how and when you should use the LiveRamp - Onboarding destination, here is a sample use case that Adobe Experience Platform customers can solve by using this destination.
As a marketer, I want to send audiences from Adobe Experience Platform to onboard identities into LiveRamp Connect so that I can target users on mobile, open web, social, and CTV platforms, using the Ramp ID identifier.
Prerequisites prerequisites
The LiveRamp - Onboarding connection exports files using LiveRamp’s SFTP storage.
Before you can send data from Experience Platform to LiveRamp - Onboarding, you need your LiveRamp credentials. Please reach out to your LiveRamp representative to obtain your credentials, if you don’t already have them.
Supported identities supported-identities
LiveRamp - Onboarding supports the activation of identities such as PII-based identifiers, known identifiers, and custom IDs, described in the official LiveRamp documentation.
In the mapping step of the activation workflow, you must define the target mappings as custom attributes.
Supported audiences supported-audiences
This section describes which types of audiences you can export to this destination.
Export type and frequency export-type-frequency
Refer to the table below for information about the destination export type and frequency.
Connect to the destination connect
To connect to this destination, follow the steps described in the destination configuration tutorial. In the configure destination workflow, fill in the fields listed in the two sections below.
Authenticate to destination authenticate
To authenticate to the destination, fill in the required fields and select Connect to destination.
SFTP authentication with password
-
Port: The port used for your LiveRamp - Onboarding storage location. Use the port that corresponds to your geographical location, as described below:
- NA: Use port
22 - AU: Use port
2222
- NA: Use port
-
Username: The username for your LiveRamp - Onboarding storage location.
-
Password: The password for your LiveRamp - Onboarding storage location.
-
PGP/GPG encryption key: Optionally, you can attach your RSA-formatted public key to add encryption to your exported files. View an example of a correctly formatted encryption key in the image below.
-
Subkey ID:If you provide an encryption key, you must also provide an encryption Subkey ID. See the LiveRamp encryption documentation to learn how to obtain the subkey ID.
SFTP with SSH key authentication
-
Port: The port used for your LiveRamp - Onboarding storage location. Use the port that corresponds to your geographical location, as described below:
- EU: Use port
4222
- EU: Use port
-
Username: The username for your LiveRamp - Onboarding storage location.
-
SSH Key: The private SSH key used to log in to your LiveRamp - Onboarding storage location. The private key must be formatted as a Base64-encoded string and must not be password protected.
- To connect your SSH key to the LiveRamp - Onboarding server, you must submit a ticket through LiveRamp’s technical support portal, and provide your public key. See more information in the LiveRamp documentation.
-
PGP/GPG encryption key: Optionally, you can attach your RSA-formatted public key to add encryption to your exported files. View an example of a correctly formatted encryption key in the image below.
-
Subkey ID:If you provide an encryption key, you must also provide an encryption Subkey ID. See the LiveRamp encryption documentation to learn how to obtain the subkey ID.
Fill in destination details destination-details
To configure details for the destination, fill in the required and optional fields below. An asterisk next to a field in the UI indicates that the field is required.
- Name: A name by which you will recognize this destination in the future.
- Description: A description that will help you identify this destination in the future.
- Region: Geographic region for your instance of the LiveRamp SFTP storage.
- Folder path: The path to the LiveRamp
uploadssubfolder that will host the exported files. Theuploadsprefix is automatically added to the folder path. LiveRamp recommends creating a dedicated subfolder for deliveries from Adobe Real-Time CDP to keep the files separate from any other existing feeds and to ensure all automation runs smoothly.- For example, if you want to export your files to
uploads/my_export_folder, type inmy_export_folderin the Folder path field.
- For example, if you want to export your files to
- Compression format: Select the compression type that Experience Platform should use for the exported files. Available options are GZIP or None.
Enable alerts enable-alerts
You can enable alerts to receive notifications on the status of the dataflow to your destination. Select an alert from the list to subscribe to receive notifications on the status of your dataflow. For more information on alerts, read the guide on subscribing to destinations alerts using the UI.
When you are finished providing details for your destination connection, select Next.
Activate audiences to this destination activate
Read Activate audience data to batch profile export destinations for instructions on activating audiences to this destination.
Scheduling scheduling
In the Scheduling step, create an export schedule for each audience, with the settings shown below.
- File export options: Export full files. Incremental file exports are currently not supported for the LiveRamp destination.
- Frequency: Daily
- Date: Select the export start and end times as you wish.
The exported file name is currently not user-configurable. All files exported to the LiveRamp - Onboarding destination are automatically named based on the following template:
%ORGANIZATION_NAME%_%DESTINATION%_%DESTINATION_INSTANCE_ID%_%DATETIME%
For example, the name of an exported file for an organization named Luma could look similar to this:
Luma_LiveRamp_52137231-4a99-442d-804c-39a09ddd005d_20230330_153857.csv
Map attributes and identities map
In the Mapping step, you can select which attributes and identities you want to export for your profiles.
Email and Phone, you must create a separate activation flow for each identity.In the Mapping step, the Target field mapping defines the name of the column header in the exported CSV file. You can change the CSV column headers in the exported file to any friendly name that you want, by providing a custom name for the Target field.
-
In the Mapping step, select Add new mapping. You will see a new mapping row on the screen.
-
In the Select source field window, choose the Select attributes category and select the XDM attribute that you want to map, or choose the Select identity namespace category and select an identity to map to your destination.
-
In the Select target field window, enter the attribute name that you want to map the selected source field to. The attribute name defined here will reflect in the exported CSV file as a column header.
You can also input the attribute name by typing it directly into the Target field.
Once you’ve added all your desired mappings, select Next and finish the activation workflow.
Exported data / Validate data export exported-data
Your data is exported to the LiveRamp - Onboarding storage location that you configured, as CSV files.
Exported files have a maximum size of 10 million rows. Experience Platform generates multiple files per delivery if the selected audiences exceed 10 million rows. If you expect to exceed the single file limit, contact your LiveRamp representative and ask them to configure batch ingestion for you.
When exporting files to the LiveRamp - Onboarding destination, Platform generates one CSV file for each merge policy ID.
For example, let’s consider the following audiences:
- Audience A (Merge policy 1)
- Audience B (Merge policy 2)
- Audience C (Merge policy 1)
- Audience D (Merge policy 1)
Platform will export two CSV files to LiveRamp - Onboarding:
- One CSV file containing audiences A, C, and D;
- One CSV file containing audience B.
Exported CSV files contain profiles with the selected attributes and the corresponding audience status, on separate columns, with the attribute name, and audience_namespace:audience_ID pairs as column headers, as shown in the example below:
ATTRIBUTE_NAME, AUDIENCE_NAMESPACE_1_AUDIENCE_ID_1, AUDIENCE_NAMESPACE_2_AUDIENCE_ID_2,..., AUDIENCE_NAMESPACE_X_AUDIENCE_ID_X
The profiles included in the exported files can match one the following audience qualification statuses:
Active: The profile is currently qualified for the audience.Expired: The profile is no longer qualified for the audience, but has qualified in the past.""(empty string): The profile never qualfied for the audience.
For instance, an exported CSV file with one email attribute, two audiences originating from the Experience Platform Segmentation Service, and one imported external audience, could look like this:
email,ups_aa2e3d98-974b-4f8b-9507-59f65b6442df,ups_45d4e762-6e57-4f2f-a3e0-2d1893bcdd7f,CustomerAudienceUpload_7729e537-4e42-418e-be3b-dce5e47aaa1e
abc117@testemailabc.com,active,,
abc111@testemailabc.com,,,active
abc102@testemailabc.com,,,active
abc116@testemailabc.com,active,,
abc107@testemailabc.com,active,expired,active
abc101@testemailabc.com,active,active,
In the example above, the ups_aa2e3d98-974b-4f8b-9507-59f65b6442df and ups_45d4e762-6e57-4f2f-a3e0-2d1893bcdd7f sections describe audiences originating from the Segmentation Service, while CustomerAudienceUpload_7729e537-4e42-418e-be3b-dce5e47aaa1e describes an audience imported into Platform as a custom upload.
Since Platform generates one CSV file for each merge policy ID, it also generates a separate dataflow run for each merge policy ID.
This means that the Identities activated and Profiles received metrics in the dataflow runs page are aggregated for each group of audiences that use the same merge policy, instead of being displayed for each audience.
As a consequence of dataflow runs being generated for a group of audiences that use the same merge policy, the audience names are not displayed in the monitoring dashboard.
Upload exported data to LiveRamp upload-to-liveramp
After your data was successfully exported to the LiveRamp - Onboarding storage, you must upload the data to the LiveRamp platform.
For more information on how to upload your files from the LiveRamp - Onboarding storage to a LiveRamp audience, see the following documentation: Considerations When Uploading the First File to an Audience.
Data usage and governance data-usage-governance
All Adobe Experience Platform destinations are compliant with data usage policies when handling your data. For detailed information on how Adobe Experience Platform enforces data governance, read the Data Governance overview.
Additional resources additional-resources
For more details on how to configure your LiveRamp - Onboarding storage, see the official documentation.
Changelog changelog
This section captures the functionality and significant documentation updates made to this destination connector.
| table 0-row-3 1-row-3 2-row-3 layout-auto | ||
|---|---|---|
| Release month | Update type | Description |
| March 2024 | Functionality and documentation update |
|
| July 2023 | Initial release | Initial destination release and documentation published. |