Scheduling Reports from Omni Reporting Tool

Owned by Prakash Nagulapati
Last updated: Oct 29, 2024
6 min read

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 or to SFTP according to business or operational requirements.

Supported Destinations

  1. Email Addresses

  2. GCS Buckets

  3. AWS Buckets

  4. SFTP

 

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

User with app.admin privilege
User with app.admin privilege
image-20240227-061844.png
User with other standard/custom roles

 

Schedules Page

  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.

  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 or SFTP.

Setting up a Pipeline

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

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

 

 

 

  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

    9. Host - Host address of the SFTP server. (IP or DNS entry)

    10. Username - username to login to SFTP server

    11. Password - password to login to SFTP server

Depending on the Pipeline Type, only a few fields from the above needs to be configured

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

Pipeline Cannot be saved without test connection being successful

  1. [AWS or GCS] Testing connection will create a sample file in the location specified in the configuration. Successful creation of page implies successful test connection.

  2. [SFTP] Testing connection happens based on auth. Files/folders won’t be created/validated in the sftp location

  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

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

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

Schedule Time

 

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

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

Usage examples:

Case 1: Need the previous day’s data

  • From: Yesterday

  • To: Yesterday

Case 2: Need today’s data till now

  • From: Today

  • To: Now or Today (Today’s end is in future and it works same as Now technically)

Case 3: Need yesterday’s and today’s data

  • From: Yesterday

  • To: Now or Today

Case 4: Need Last month’s complete data

  • From: 1st of Last Month

  • To: 1st of Current Month (which takes 00:00:00 as the time field only in this particular case)

Case 5: Need data of 1st week of this month

  • From: 1st of Current Month

  • To: 1 Week

Email as Recipient’s destination

  1. Choose Email if the report needs to be scheduled to email. Provide e-mail addresses one after one. Click image-20240227-055819.png adjacent to the Input bar after every email address to add it as the recipient list.

  2. Custom Email Subject can be configured to uniquely identify the schedule. This comes more handy if the same report has multiple schedules with multiple different filters in it.

AWS or GCS or SFTP as the Recipient’s destination

 

  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.

    1. 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.

    2. [SFTP] If a folder name is configured, please make sure the folder exists in the SFTP server. Scheduler cannot create/write file to non-existing folder.

  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 Scheduler 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 [GCS or AWS] 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.

  4. In case of pipeline [SFTP] schedules, please make sure the folder name mentioned is existing. If not, the file cannot be written in the said location.