Data Landing Zone destination
Overview overview
Data Landing Zone is an Azure Blob storage interface provisioned by ÃÛ¶¹ÊÓƵ Experience Platform, granting you access to a secure, cloud-based file storage facility to export files out of Platform. You have access to one Data Landing Zone container per sandbox, and the total data volume across all containers is limited to the total data provided with your Platform Products and Services license. All customers of Platform and its applications such as Customer Journey Analytics, Journey Orchestration, Intelligent Services, and Real-Time Customer Data Platform are provisioned with one Data Landing Zone container per sandbox. You can read and write files to your container through Azure Storage Explorer or your command-line interface.
Data Landing Zone supports SAS-based authentication and its data is protected with standard Azure Blob storage security mechanisms at rest and in transit. SAS stands for .
SAS-based authentication allows you to securely access your Data Landing Zone container through a public internet connection. There are no network changes required for you to access your Data Landing Zone container, which means you do not need to configure any allow lists or cross-region setups for your network.
Platform enforces a strict seven-day time-to-live (TTL) on all files uploaded to a Data Landing Zone container. All files are deleted after seven days.
Connect to your Data Landing Zone storage through API or UI connect-api-or-ui
- To connect to your Data Landing Zone storage location using the Platform user interface, read the sections Connect to the destination and Activate audiences to this destination below.
- To connect to your Data Landing Zone storage location programmatically, read the Activate audiences to file-based destinations by using the Flow Service API tutorial.
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.
Export datasets export-datasets
This destination supports dataset exports. For complete information on how to set up dataset exports, read the tutorials:
File format of the exported data file-format
When exporting audience data, Platform creates a .csv, parquet, or .json file in the storage location that you provided. For more information about the files, see the supported file formats for export section in the audience activation tutorial.
When exporting datasets, Platform creates a .parquet or .json file in the storage location that you provided. For more information about the files, see the verify successful dataset export section in the export datasets tutorial.
Prerequisites prerequisites
Note the following prerequisites that must be met before you can use the Data Landing Zone destination.
Connect your Data Landing Zone container to Azure Storage Explorer
You can use to manage the contents of your Data Landing Zone container. To start using Data Landing Zone, you must first retrieve your credentials, input them in Azure Storage Explorer, and connect your Data Landing Zone container to Azure Storage Explorer.
In the Azure Storage Explorer UI, select the connection icon in the left navigation bar. The Select Resource window appears, providing you with options to connect to. Select Blob container to connect to your Data Landing Zone storage.
Next, select Shared access signature URL (SAS) as your connection method, and then select Next.
After selecting your connection method, you must provide a display name and the Blob container SAS URL that corresponds with your Data Landing Zone container.
Retrieve the credentials for your Data Landing Zone retrieve-dlz-credentials
You must use the Platform APIs to retrieve your Data Landing Zone credentials. The API call to retrieve your credentials is described below. For information about getting the required values for your headers, refer the Getting started with ÃÛ¶¹ÊÓƵ Experience Platform APIs guide.
API format
GET /data/foundation/connectors/landingzone/credentials?type=dlz_destination
dlz_destinationdlz_destination type allows the API to distinguish a landing zone destination container from the other types of containers that are available to you.Request
The following request example retrieves credentials for an existing landing zone.
curl -X GET \
'https://platform.adobe.io/data/foundation/connectors/landingzone/credentials?type=dlz_destination' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
Response
The following response returns the credential information for your landing zone, including your current SASToken and SASUri, and the storageAccountName that corresponds to your landing zone container.
{
"containerName": "dlz-destination",
"SASToken": "sv=2022-09-11&si=dlz-ed86a61d-201f-4b50-b10f-a1bf173066fd&sr=c&sp=racwdlm&sig=4yTba8voU3L0wlcLAv9mZLdZ7NlMahbfYYPTMkQ6ZGU%3D",
"storageAccountName": "dlblobstore99hh25i3df123",
"SASUri": "https://dlblobstore99hh25i3dflek.blob.core.windows.net/dlz-destination?sv=2022-09-11&si=dlz-ed86a61d-201f-4b50-b10f-a1bf173066fd&sr=c&sp=racwdlm&sig=4yTba8voU3L0wlcLAv9mZLdZ7NlMahbfYYPTMkQ6ZGU%3D"
}
containerNameSASTokenSASUriUpdate Data Landing Zone credentials update-dlz-credentials
You can also refresh your credentials when desired. You can update your SASToken by making a POST request to the /credentials endpoint of the Connectors API.
API format
POST /data/foundation/connectors/landingzone/credentials?type=dlz_destination&action=refresh
dlz_destinationdlz_destination type allows the API to distinguish a landing zone destination container from the other types of containers that are available to you.refreshrefresh action allows you to reset your landing zone credentials and automatically generate a new SASToken.Request
The following request updates your landing zone credentials.
curl -X POST \
'https://platform.adobe.io/data/foundation/connectors/landingzone/credentials?type=dlz_destination&action=refresh' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
Response
The following response returns updated values for your SASToken and SASUri.
{
"containerName": "dlz-destination",
"SASToken": "sv=2020-04-08&si=dlz-9c4d03b8-a6ff-41be-9dcf-20123e717e99&sr=c&sp=racwdlm&sig=JbRMoDmFHQU4OWOpgrKdbZ1d%2BkvslO35%2FXTqBO%2FgbRA%3D",
"storageAccountName": "dlblobstore99hh25i3dflek",
"SASUri": "https://dlblobstore99hh25i3dflek.blob.core.windows.net/dlz-destination?sv=2020-04-08&si=dlz-9c4d03b8-a6ff-41be-9dcf-20123e717e99&sr=c&sp=racwdlm&sig=JbRMoDmFHQU4OWOpgrKdbZ1d%2BkvslO35%2FXTqBO%2FgbRA%3D"
}
Provide your display name (containerName) and Data Landing Zone SAS URL, as returned in the API call described above, and then select Next.
The Summary window appears, providing you with an overview of your settings, including information on your Blob endpoint and permissions. When ready, select Connect.
A successful connection updates your Azure Storage Explorer UI with your Data Landing Zone container.
With your Data Landing Zone container connected to Azure Storage Explorer, you can now start exporting files from Experience Platform to your Data Landing Zone container. To export files, you must establish a connection to the Data Landing Zone destination in the Experience Platform UI, as described in the section below.
Connect to the destination connect
To connect to this destination, follow the steps described in the destination configuration tutorial. In the destination configuration workflow, fill in the fields listed in the two sections below.
Authenticate to destination authenticate
Make sure that you have connected your Data Landing Zone container to Azure Storage Explorer as described in the prerequisites section. Because Data Landing Zone is an ÃÛ¶¹ÊÓƵ-provisioned storage, you do not need to perform any further steps in the Experience Platform UI to authenticate to the destination.
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: Fill in the preferred name for this destination.
-
Description: Optional. For example, you can mention which campaign you are using this destination for.
-
Folder path: Enter the path to the destination folder that will host the exported files.
-
File type: Select the format Experience Platform should use for the exported files. When selecting the CSV option, you can also configure the file formatting options.
-
Compression format: Select the compression type that Experience Platform should use for the exported files.
-
Include manifest file: Toggle this option on if you’d like the exports to include a manifest JSON file that contains information about the export location, export size, and more. The manifest is named using the format
manifest-<<destinationId>>-<<dataflowRunId>>.json. View a sample manifest file. The manifest file includes the following fields:flowRunId: The dataflow run which generated the exported file.scheduledTime: The time in UTC when the file was exported.exportResults.sinkPath: The path in your storage location where the exported file is deposited.exportResults.name: The name of the exported file.size: The size of the exported file, in bytes.
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, see 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
-
To activate data, you need the View Destinations, Activate Destinations, View Profiles, and View Segments access control permissions. Read the access control overview or contact your product administrator to obtain the required permissions.
-
To export identities, you need the View Identity Graph access control permission.
See Activate audience data to batch profile export destinations for instructions on activating audiences to this destination.
Scheduling
In the Scheduling step, you can set up the export schedule for your Data Landing Zone destination and you can also configure the name of your exported files.
Map attributes and identities map
In the Mapping step, you can select which attribute and identity fields to export for your profiles. You can also select to change the headers in the exported file to any friendly name that you wish. For more information, view the mapping step in the activate batch destinations UI tutorial.
Validate successful data export exported-data
To verify if data has been exported successfully, check your Data Landing Zone storage and make sure that the exported files contain the expected profile populations.