An export job can be either:

• Recurring: This job runs on a regular schedule (e.g., daily). It only exports new or updated data since the last export. For example, if the job is set to run daily for a month, each day it exports only the data from the previous day.
• One-Time: This job runs only once and exports the data available at that specific time.

Prerequisites

• Insights access
• FTP server configuration
• Make sure the FTP server is correctly set up to handle data exports. This setup is crucial for the successful transfer of data.

📘

Note

• The system does not assure a fixed finish time for the jobs. The export framework picks up a job according to the order of scheduled time.
• Please note that you cannot:
  • Edit the template after creation.
  • Modify KPIs, dimensions, filters, and customer list once scheduled.
  • Export measures (such as bill id, bill number, bill amount, auto update time) and custom fields in custom templates. You can export only KPIs and its dimensions.
• Current day's data will not be included in the exported data as the data will be synced to the capillary server only during non-business hours.

Configuring an export schedule

Perform the following steps to configure an export schedule:

1. Create an Export Job (Step 1 of 3) .
2. Select Data Templates (Step 2 of 3) templates that you want to export.
3. Modifying Template & Creating Schedule (Step 3 of 3) templates to add or remove fields, apply filters and dimensions to export a specific data that you need
4. Click Create to schedule

📘

Important

• When you use a Dimension template, the entire data will be exported irrespective of the duration filter applied. Hence, it is recommended not to use templates of Dimensions, Users for example, for recurring schedules unless you wanted to apply the Audience Group filter on it
• You cannot apply standard filters such as outlier status, fraud status, merge status, and admin TILL

Once scheduled, the recipients will receive emails as per the scheduled frequency with the job details including the destination link of the exported data.

📘

Note

As the export job writes the files in the specified FTP location, It is recommended to periodically check whether the username/password of the FTP location is configured correctly.
To access files from the FTP location, user should have read access to the FTP location

Viewing Export Jobs

After creating an export job, you can view its status on the Export Schedules page. Additional search options are available to refine your search.

• Name search: Use the search box to find a specific export job, by its name.
• Filter list by frequency: Filter jobs by frequency: Once, Daily, Weekly, or Monthly. By default, all frequencies are displayed.
• Filter list by status: Filter jobs by status: All, Active, or Completed. By default, all jobs are displayed.

The More options icon is used to either Duplicate a job, Delete a job, or View the execution log of a job..

A job has one of the following statuses: Yet to Execute, Success, or In Progress.

📘

Note

• A recurring schedule job can have more than 1 executions where as a one-time schedule will have only one execution
• When the job is in progress, you cannot kill or rerun the job
• For each successful export job, an email will be sent to all the chosen recipients with the destination links of the exported files (either FTP or S3). To download files from FTP server, click the respective link received on the email, login and download the zip file

To view details of a specific job:

1. Click on the schedule that you want to see

2. On the Overview tab, you can see the details of the schedule such as schedule name, description, schedule type, FTP tag, frequency, execution date, export data fields, notify recipients, and templates.

3. To see the execution log, click the Execution Log tab.

4. If an export job fails in the middle for some reason, you can run the job manually by clicking the Rerun button. The job will run from the previous successful schedule.