Skip to end of banner
Go to start of banner

Scheduling Reports from Omni Reporting Tool

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview

The Scheduler feature is now available in the Omni Reporting Tool. Essential reports can be scheduled at specified time intervals and sent to email addresses or GCS/AWS buckets according to business or operational requirements.

Supported Destinations

  1. Email Addresses

  2. GCS Buckets

  3. AWS Buckets

Schedulers can only be configured by the users with app.admin privilege

image-20240227-061808.png
image-20240227-061844.png

Schedules Page

image-20240227-120821.png

  1. All the schedules of the org and it’s success/failure runs can be viewed here.

  2. At what time the next schedule will run is also shown under Next Schedule

  3. Status of the schedule whether enabled or disabled can be toggled here (and inside the schedule edit panel as well).

  4. Once a schedule is deleted, it will no longer visible in UI.

  5. Disabled schedules (by toggling off) will still be part of the screen. Can be re-enabled anytime just by toggling it on.

image-20240227-141627.png

  1. Similar to the reporting Request Status, schedules' status can also be viewed. Click on image-20240227-141425.png button on the top left of the schedules page to view the status of the schedule runs.

What is a Pipeline?

Pipeline is a configuration framework in Omni Reporting Tool that holds the credentials and necessary details to connect with the GCS or AWS buckets.

Setting up a Pipeline

  1. Navigate to image-20240227-060837.png Pipelines panel and click on image-20240227-060855.png Add Pipeline Button

image-20240227-060745.png

  1. Provide the necessary details to setup GCS or AWS connections

image-20240227-061105.png
image-20240227-061503.png

  1. Field Details:

    1. Pipeline Name - a name given to the connection to identify this uniquely

    2. Pipeline Type - Allowed types are GCS and AWS as of now

    3. Bucket Name - the bucket name to which the pipeline needs to be connected with

    4. Bucket URL - URL of the bucket

    5. Credentials - GCS credentials as a JSON file to connect to GCS

    6. Region - Region of the AWS Bucket

    7. Access Key - Access Key of Amazon AWS S3 Bucket

    8. Secret Key - Secret Key of the Amazon AWS S3 Bucket

image-20240227-071752.png

  1. Client image-20240227-071844.png Test Connection button to test the connection.

Pipeline Cannot be saved without test connection being successful

Testing connection will create a sample file in the location specified in the configuration. Successful creation of page implies successful test connection.

  1. Click on image-20240227-072202.png Save Changes to save the configured pipeline.

How to Schedule?

  1. Navigate to image-20240227-053707.png Schedules panel and click on image-20240227-053633.png Add Schedule Button

image-20240227-053538.png

  1. Choose the report to be scheduled from the Select Report dropdown

image-20240227-054036.png

  1. Provide necessary details of the the filters and schedule time

Schedule Time

image-20240227-082755.png

Choosing Weekly will allow to select any particular week or Every-Day as the options from the drop-down.

image-20240227-082525.png

Choosing Monthly will allow to select any particular day of a month or Every-Day or Last-Day as the options in drop-down.

Relative DateTime Filters

Unlike in the usual report explorer, the scheduler panel will have relative date-time filters.

Available Options:

  • Now

  • Today

  • Yesterday

  • 1 Week

  • 15 Days

  • 1st of Current Month

  • 1st of Last Month

“From” datetime type filter will consider from 00 minutes 00 seconds

“To” datetime type filter will consider till 59 minutes 59 seconds

Usage examples:

Case 1: Need the previous day’s data (Considering schedule is at 00:00:00 everyday)

  • From: Yesterday

  • To: Yesterday

Case 2: Need today’s data (Considering schedule is every 6 hours every day)

  • From: Today

  • To: Now

Case 3: Need the previous day’s data (Considering schedule is at 06:00:00 everyday)

  • From: Yesterday

  • To: Yesterday

Email as Recipient’s destination

  1. Choose Email if the report needs to be scheduled to email. Provide e-mail addresses one after one.

  2. Click image-20240227-055819.png adjacent to the Input bar after every email address to add it as the recipient list.

image-20240227-122851.png

AWS or GCS as the Recipient’s destination

image-20240227-081611.png

  1. Choose the pipeline to which the report needs to be sent. Refer the above section on how to set up a pipeline.

  2. Provide a Folder Name to which the files need to send. Failing to provide the folder name will result in writing all the files in the root folder of the bucket that is configured in the pipeline.

  3. Same as multiple mail addresses, multiple pipelines can be attached to a single schedule. Click on image-20240227-140949.png button to add.

  4. The file generated as a part of schedule will be posted in all the mapped pipelines in the respective mentioned folders.

Handling Schedule Failures

  1. In case of email schedules, all the reports generated should be less than or equal to 50 MB in size. The file sizes are handled as below:

    1. For reports with less than equal to 15 MB in size, the report is attached directly as an attachment.

    2. For reports with file size greater than 15 MB and less than equal to 50 MB, file will be compressed and attached as a .zip in the attachment.

    3. For reports with file size exceeding 50 MB, the report will not be sent as an email. Schedule will fail.

  2. To handle this in email type schedules, please go back to the schedule panel and choose the filters in more granular level.

  3. In case of pipeline schedules, the connection might not be successful to the configured bucket. Please check if the bucket configured in the pipeline is no longer accessible or deleted.

  • No labels