Data Landing Zone destination

Last update: 2024-01-08
  • Created for:
  • Admin
    User
IMPORTANT

This documentation page refers to the Data Landing Zone destination. There is also a Data Landing Zone source in the sources catalog. For more information, read the Data Landing Zone source documentation.

Overview

Data Landing Zone is an Azure Blob storage interface provisioned by Adobe 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 application services 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-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

Supported audiences

This section describes which types of audiences you can export to this destination.

Audience origin Supported Description
Segmentation Service Audiences generated through the Experience Platform Segmentation Service.
Custom uploads Audiences imported into Experience Platform from CSV files.

Export type and frequency

Refer to the table below for information about the destination export type and frequency.

Item Type Notes
Export type Profile-based You are exporting all members of a segment, together with the applicable schema fields (for example your PPID), as chosen in the select profile attributes screen of the destination activation workflow.
Export frequency Batch Batch destinations export files to downstream platforms in increments of three, six, eight, twelve, or twenty-four hours. Read more about batch file-based destinations.

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 Azure Storage Explorer 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.

Select resource highlighted in the Azure UI.

Next, select Shared access signature URL (SAS) as your connection method, and then select Next.

Select connection method highlighted in the Azure UI.

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

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 Adobe Experience Platform APIs guide.

API format

GET /data/foundation/connectors/landingzone/credentials?type=dlz_destination
Query parameters Description
dlz_destination The dlz_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-user-container",
    "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-user-container?sv=2022-09-11&si=dlz-ed86a61d-201f-4b50-b10f-a1bf173066fd&sr=c&sp=racwdlm&sig=4yTba8voU3L0wlcLAv9mZLdZ7NlMahbfYYPTMkQ6ZGU%3D"
}
Property Description
containerName The name of your landing zone.
SASToken The shared access signature token for your landing zone. This string contains all the information necessary to authorize a request.
SASUri The shared access signature URI for your landing zone. This string is a combination of the URI to the landing zone for which you are being authenticated to and its corresponding SAS token,

Update Data Landing Zone 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
Query parameters Description
dlz_destination The dlz_destination type allows the API to distinguish a landing zone destination container from the other types of containers that are available to you.
refresh The refresh 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-user-container",
    "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-user-container?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.

Enter connection info highlighted in the Azure UI.

The Summary window appears, providing you with an overview of your settings, including information on your Blob endpoint and permissions. When ready, select Connect.

Summary of settings shown in the Azure UI.

A successful connection updates your Azure Storage Explorer UI with your Data Landing Zone container.

Summary of the DLZ user container highlighted in the Azure UI.

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

IMPORTANT

To connect to the destination, you need the View Destinations and Manage Destinations access control permissions. Read the access control overview or contact your product administrator to obtain the required permissions.

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

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 Adobe-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

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

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

IMPORTANT

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

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.

Export datasets

This destination supports dataset exports. For complete information on how to set up dataset exports, read the tutorials:

Validate successful data export

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.

On this page