For the complete documentation index, see llms.txt. This page is also available as Markdown.

Managing Report Jobs

Report Jobs allow you to query large amounts of message data in the background.

Common use cases include:

  • Finding messages that are within a specific geofence

  • Filtering MO messages by specific message properties

  • Producing data suitable for visualisation using the GAP Reports app's "Visualise" functionality

user-lock

These activities require the View Reports Web App and Manage Report Jobs permissions.

Access to data included in reports will depend on other permissions assigned to your user role.

There are two steps to running a Report Job:

  • Preparing the dataset for querying

  • Running the Report Job

Preparing Datasets

  1. In the GAP Reports app, click the "Report Jobs" button on the left-hand side menu.

  2. Click "Explore Prepared Messages Data".

  3. If the time period you want to query is not available, click the "+" button.

  4. Enter a name for the dataset in the "Name" text box.

  5. Enter a description in the "Description" text box.

  6. Select a tenant from the "Tenant" drop-down list.

  7. Select a date period using the "From" and "To" pickers.

  8. Click the "Submit" button.

When the status of the job is shown as "Completed", you can set up your report job.

Running Report Jobs

  1. In the GAP Reports app, click the "Report Jobs" button on the left-hand side menu.

  2. Click the "Add Report Job" button.

  3. Click the type of report job you want to run.

  4. Enter a name for the dataset in the "Name" text box.

  5. Enter a description in the "Description" text box.

  6. Select a tenant from the "Tenant" drop-down list.

  7. Select a date period using the "From" and "To" pickers.

  8. Depending on the type of job you selected, other parameters may be available. For example, if you selected "MO Messages in Geofence", you will need to select a geofence from the "Geofence" drop-down list.

  9. Click the "Submit" button.

  10. When the status of the job is shown as "Completed", you can download the data using the (download) button.

Last updated