Export Definition Details
Click here to see this page in full context

 Export Definition Details

Overview

The Export Definition Details screen provides all of the information about the selected Export Definition.

Access

To access the Export Definition Details screen, click on the desired Export Definition from the Exports screen.

Navigation links are provided near the top of the Export Definition Details screen:

Features

Manage the Export Definition

This section describes how to manage and edit the Export Definition. 

 Edit Export Definition Properties

Click hereClick here

To edit the Export Definition properties:

  1. Click the Edit icon next to the Export Definition name. The "Edit Export Definition Name" pop-up window is displayed.

  2. Optionally change the name of the Export Definition.

  3. If your account is configured to use Business Units, optionally enter one or more Business Units to which this Export Definition applies. A confirmation dialog box is displayed; click confirm.

Note: If you assign a Business Unit to an Export Definition, you can't later change or remove that assignment.

  1. From the "Integration Queue Name" field, select a priority ranking for this Export Definition: High, Normal (the default setting), or Low. The platform will automatically process files in the highest possible priority queue unless that queue is empty; then the platform will move to the next-highest possible priority queue, and so on.

  2. Click save.

 

 

 Delete an Export Definition

Click hereClick here

To delete an Export Definition:

  1. Click the Edit icon next to the Export Definition name. The "Edit Export Definition Name" pop-up window is displayed.

  2. Click delete. A confirmation dialog box is displayed.

  3. Click confirm.

 

 

 Execute an Export Definition

Click hereClick here

Export Definitions can be scheduled to run automatically on a one-time or recurring basis. You can also manually execute an Export Definition as follows:

  1. Click run. A confirmation dialog box is displayed.

  2. Click confirm.

Configure the Export Definition

This section describes how to configure the Export Definition. The Export Definition Details screen is split into multiple steps, identified by a series of numbered items across the top of the screen. You can complete these steps (described below) in any order you like.

Note: The sequence and content of these screens varies slightly depending on the Connector type. 

 Filter

Click hereClick here

The options available on the Filter screen vary based on the Connector type. Select one of the following for more details:

Secure FTP / Amazon S3 ConnectorsSecure FTP / Amazon S3 Connectors

HTTP API ConnectorsHTTP API Connectors

Google Ad / Facebook Ad ConnectorsGoogle Ad / Facebook Ad Connectors

 

 

 Map and Transform

Click hereClick here

The options available on the Map & Transform screen vary based on the Connector type.

Note: This screen is not used for HTTP API Connectors. 

Select one of the following for more details:

Secure FTP / Amazon S3 ConnectorsSecure FTP / Amazon S3 Connectors

Google Ad ConnectorsGoogle Ad Connectors

Facebook Ad ConnectorsFacebook Ad Connectors

 

 Destination

Click hereClick here

The Destination screen is used to define the destination of the export file. The options available on the Destination screen vary based on the Connector type. Select one of the following for more details:

Secure FTP / Amazon S3 ConnectorsSecure FTP / Amazon S3 Connectors

  1. Click 3: destination.

  2. From the "Connection Profile" drop-down menu, select a Connection Profile (see Connectors for more details).

  3. In the "File Path" field, enter the path to the folder where you want to save the export file.

  4. In the "Filename" field, enter the name of the export file.

  5. From the "Delimiter" drop-down menu, select a delimiter character, or select Custom Delimiter and enter the custom character.

  6. To use a text qualifier in the export file, select the appropriate character from the "Text Qualifier" drop-down menu. The platform supports the following standard qualifiers: single quote ('), double quote ("), and pipe (|). Or, select None if you don't want to use text qualifiers. To use a custom qualifier, select Custom Qualifier and enter the custom character.

  7. If you want the export file to include a column header row, select Yes from the "Include Headers" drop-down menu.

  8. From the File Encoding drop-down menu, select an encoding method (the default method is UTF-8).

  9. To export a Control File along with the export file, enter the desired Control File name in the "Control File Name" field. The Control File contains the expected record count of the export file. 

  10. To PGP-encrypt the export file, select the desired Encryption Key from the "Encrypt with" drop-down menu. 

  11. Click save. Or click next to move to 4: Schedule.

HTTP API ConnectorsHTTP API Connectors

  1. Click 2: destination.

  2. From the "HTTP Operation" drop-down menu, select an HTTP method. 

  3. Click save. Or click next to move to 3: Schedule.

Google Ad ConnectorsGoogle Ad Connectors

  1. Click 2: destination.

  2. From the "Connection Profile" drop-down menu, select a Connection Profile (see Connectors for more details).

  3. From the "Account Name" drop-down menu, select the desired Google Ad account.  

  4. The "Audience Name" drop-down menu is populated with the existing Audiences, for the selected ad account. This drop-down menu is populated in real-time, so if you create Audiences in the ad platform, they will appear in this menu. Select the Audience that you want to populate with the records selected by your Segment.

  5. Select a match option: Email, Phone, or Mailing Address. This option defines how Google will attempt to match the records in the Segment to existing Google accounts. 

Note: You must provide the appropriate fields on the Map & Transform screen that correspond to the match option you select here. 

  1. Click save. Or click next to move to 3: Map & Tansform.

 

Facebook Ad ConnectorsFacebook Ad Connectors

  1. Click 2: destination.

  2. From the "Connection Profile" drop-down menu, select a Connection Profile (see Connectors for more details).

  3. From the "Account Name" drop-down menu, select the desired Facebook account.  

  4. From "Audience ID" drop-down menu, select the desired Facebook Audience that you want to populate.

  5. Click save. Or click next to move to 3: Map & Tansform.

 

 

 Schedule

Click hereClick here

In addition to running an import on demand, EDP supports the following automated execution options -- run once at a specified date / time, or run repeatedly at a specified frequency.

  1. Click 4: schedule.

  2. In addition to running an import on demand, EDP supports the following automated execution options -- run once at a specified date / time, or run repeatedly at a specified frequency. Configure the desired option as described below. 

  3. Optionally, if you want to send error notifications, toggle "Error" to Yes, then enter the email addresses for the notification recipients.

  4. Optionally, if you want to send success notifications, toggle "Success" to Yes, then enter the email addresses for the notification recipients.

  5. Click save.

Execute Once

You can schedule an export to process once at a specified date / time.

  1. Toggle Enabled to Yes.

  2. From the Recurrence drop-down menu, select Once.

  3. Click into the "Execute Once On field." A calendar pop-up window is displayed.

  4. Select the desired date when you want the export to execute.

  5. Within the calendar pop-up window, click the clock icon.

  6. Define the time when you want the export to execute.

  7. From the "Time Zone" menu, select the time zone to use when determining the time to execute.

Execute on a Recurring Frequency

You can schedule an export to run on a recurring frequency:

  1. Toggle Enabled to Yes.

  2. From the Recurrence drop-down menu, select Repeat.

  3. Next to Schedule Composer, select an interval:

  • Hour: Select the minute past the hour.

  • Day: Select the time of day.

  • Week: Select the day of the week, and the time of day.

  • Month: Select the day of the month, and the time of day.

  • Year: Select the day, the month, and the time of day.

  1. Optionally, to manually enter a CRON expression, check "Advanced Mode," then enter the expression.

  2. Define the export schedule begin and end date. If you leave these date ranges blank, the schedule will run indefinitely.

  3. From the Time Zone menu, select the time zone to use when determining the time to execute.

 

 Job History

Click hereClick here

To view the execution history of an Export Definition:

  1. Click 5: job history. Each execution of an export is displayed as a row on the Job History screen. Each row indicates the start and end date / time, the current status, and the number of records exported.

  2. Optionally, to filter the Job History log by processing status, select a status value from the drop-down menu, then click the Search button

  3. Optionally, to download a log file associate with an execution, click the Download icon within the Action column:

  4. Optionally, to delete a job, click the Delete icon within the Action column.

 

Back to Exports

 

 

© Cheetah Digital    Engagement Data Platform Online Help 22.0  April 2022