Add Data Extract

Click Add Data Extract to add.

Select Campaign

On the Select Campaign tab, perform the following:

1. Click Add Data Extract.

2. Add a Name and a Description of the Data Extract.

3. Select the file to extract the data from Master or Transactional.

4. Select the Data Source from the dropdown list. This is active only for Transactional data extraction.

5. Select the Campaign Group. The available campaign groups are listed based on the selected Data Source.

6. Select the Campaigns. The Available Campaign are listed based on the selected Data Source.

7. Click Next.

Data Source

On the Data Source tab, perform the following:

1. Select a Data Source from the list. Data Source is the list of fields available for selection. There are standard data sources listed based on the selected Data type.

2. Move the Available Fields to the Selected Fields. Example: Call Activity is one data source. The data source provides details about call attempts made and the results of these attempts.

3. Click Next.

Edit Schedule Configuration

On the Edit Schedule Configuration, perform the following:

1. Select the required Run Type from Regular Intervals, Scheduled Time, and On Demand to define how and when the report will run based on your scheduling needs.

2. If the selected run type is On Demand, enter the Start Date and End Date to specify the exact time range the report must cover.

3. Select the TimeZone  from the dropdown list so that the report runs according to the selected TimeZone.

4. Select the Run Days to determine which days of the week the report must execute. You can select multiple days.

5. If the selected Run Type is Regular Intervals, enter the First Job Start Time to define the initial time at which the recurring report starts running. Make sure the First Job Start Time is greater than the current system time.

6. Enter the Interval in Minutes to specify how frequently the report must run after the first job start time.

   Example:

   If the First Job Start Time is configured as 8:00 PM and the Interval is set to 60 minutes, then:

   • The first report is generated at 9:00 PM and covers the time range from 8:00 PM (report start time) to 9:00 PM (report end time).

   • Subsequent reports generate every 60 minutes, each covering the corresponding one-hour interval.

   Note:

   The First Job Start Time and Interval in Minutes fields are disabled while the report is active.

7. Enter the File Name.

8. Select the File Extension from csv and txt. If the selected file extension is txt, select the Column Separator from the dropdown.

   Note:

   If data extracted from any table has JSON string, use the txt format to save the file. For example, the Audit Log table contains data in a JSON string.

9. Activate Table Specific File Creation. This appends the table name to the data extract file. You cannot disable this switch. Enable the other option if needed. Other options are visible based on the selected Data source.

10. Activate File Header Required if you need file header.

11. The Empty File Required option is enabled automatically when Campaign Specific File Creation toggle is ON. This writes a file with no records. If you do not require an empty file, turn this OFF. This is visible only if the selected data type is Master.

12. Activate Add Double Quote to include double quotes. Data for each field is embedded with double quotes.

13. Activate Append Date Time to append the server time. The file is saved with the server time appended with the file name.

    Note:

    This is mandatory if you select the Run Type as On Demand. Even for other Run Types, we recommend using the Append Date Time option. This avoids accidental overwriting of extracted files.

14. Activate Alert on No Records to alert when the data extract returns no records. When an alert is triggered, an email is sent to the recipient group configured in the Alerts section. The email includes:

    • Data Extract Name

    • Schedule Date and Time

    • Type of error: No Records

15. Activate Alert on Failure to alert when the data extract fails due to an error. When an alert is triggered, an email is sent to the recipient group configured in the Alerts section. The email includes:

    • Data Extract Name

    • Schedule Date and Time

    • Type of error - Failure

16. Click Save.