Track Data Extraction and Delta Calculation API Jobs in the Job Monitor

You can track API export jobs you run with the Data Export Service using the job monitor.

To access the job monitor, go to the side navigation menu and choose Start of the navigation pathSystem Next navigation step Job MonitorEnd of the navigation path. You can also access the job monitor directly from the modeler via the Actions menu in the shell bar.

Under the Data Export API tab, API jobs are filtered by categories: Data Extractions and Delta Calculations. Here, you can check on the status of the jobs and monitor consumption and usage.

Data Extraction Jobs

Data extraction jobs allows you to monitor the current status of your initial, full load and delta subscription jobs. The retention period of data extractions jobs is seven days.

Data extractions jobs represent export requests from the Data Export API that have already been completed. Once a request is sent to extract data, for example Transaction Data (/FactData), an entry is logged to the job monitor.

If the full dataset is not extracted in the first request, the job remains in Pending status until the export has been fully paginated. Each subsequent request is represented as a page in the Details side panel in the Steps section.

For more information about pagination in the Data Export API, see Pagination of Exported Data.

Delta Calculation Jobs

Delta calculation jobs are created when delta subscriptions are activated on a model, and generate model cube events to capture delta changes of fact data. These jobs can be long running and numerous depending the number of changes and size of the model. Viewing these jobs in the job monitor provides visibility over their status, how much data has been processed and when the export jobs are complete. The retention period of delta calculation jobs is 24 hours.

Permissions for the Job Monitor

If you have Read or Manage permission for Job Monitor Administration privilege, you can view all data extraction and delta calculation jobs, including the name, status, total duration and source object for all API jobs.

If you do not have Read or Manage permission for Job Monitor Administration but have Read permission on the individual objects such as model, public dimension, currency conversion table, you can view all the jobs that you have executed.

Understand the Job Monitor

Here are the different columns you can find in the job monitor.
  • Name: the name of the job.

  • Status: the status of the job (see below for the complete list of statuses).

  • Started On: the date and time when the job was created.

  • Total Duration: the overall duration of the job run.

  • Started From: the Data Export API.

  • Started By: this corresponds to the technical name for a 2-legged or user name for 3-legged user.

  • Source Object: for data extractions, the name of the object where the data is taken from.

  • Model: for delta calculations, the model where the data is taken from.

These are the possible statuses for a data extraction job:

Status

Description

Pending

The extraction has started and pagination is in progress.

Successful

The full dataset has been extracted.

Failed

The extraction has failed

These are the possible statuses for a delta calculations job:

Status

Description

Pending

A job has been created and is about to run.

Pending (Retry)

The job has failed and the application will retry to run the job.

Running

The job is running and in progress.

Successful

The job has run successfully.

Failed

The job has failed

View More Details

You can click the name of a specific job to view more details. These details vary depending on whether the job is a delta calculation or data extraction.

The panel that opens is divided in three tabs: Status, Steps and Base Details.

Data Extractions

Status

Under Status, for data extractions, you can find the overall status of the API running time and the export summary including the number of exported records.

Steps

Under Steps, you can find detailed information about the API job. Each step that counts towards the overall completion of a job is logged. For data extractions, each step refers to a page of data which has been exported via a request to the Data Export API.

Parameters

Under Base Details, you can find the Provider ID, Namespace, Data Storage Location, Entity Set Name and Data Source.

Under Delta Parameters, you can find a list of delta parameters if the data is extracted via a model subscription, such as SubscriptionID or ExternalID.

Under URL Parameters, you can find a list of OData or standard URL parameters used in the data extractions such as pagesize, $select, $top, $skip, package, $orderby, $filter, $count.

Delta Calculations

Status

In this section, you can find the job status and number of job attempts.

Steps

Under Steps, you can find detailed information about the API job. Each step that counts towards the overall completion of a job is logged.

The API Running Time column differs from the Total Duration column in the main view. The API Running Time corresponds to the time taken by the API to export data broken by pagesize, while the Total Duration corresponds to overall duration of the job, including connection times, wait times, etc…

Base Details

In this section, you can find a list of delta parameters including Model ID, Model Name and Entity Set Name information.

Search, Sort, or Filter Jobs

You can search for jobs in the list view, sort the columns, or filter the list view by Started On, Job Type, Name, Status, Total Duration, Started By, Started From, Source Object or Model. If you filter jobs using Stared From, make sure to select REST API to display both the data extractions and delta calculations jobs at the same time.

In the search field, you can search by job name, step name, parameter, or other information that can be viewed in the details panel.

To view updated information about the jobs, choose (Refresh).

To clear all filters except for Started On, choose (Reset Filter). When you reset the filters, Started On is set by default to show jobs from the last seven days and Job Type is reset to main jobs. You can change these manually in the Filter section.

Data extractions and delta calculation jobs cannot be cancelled or deleted. They are automatically cleaned up by the retention policy.