Skip to main content

Overview

Omni allows users to schedule a delivery or set an alert on dashboards or tiles (charts) to multiple destinations, specific timeframes, and various recipients. This functionality can be managed at an instance or document level Read more about document abilities here.

To enable this functionality for embedded instances follow these instructions.

Deliveries & Alerts for Dashboards​

  1. Navigate to the File menu on the left-hand side and select Deliveries & Alerts.
  1. The dashboard's delivery settings will populate and a user can choose to build a new delivery (option 1) or edit existing deliveries (option 2). Note, users will be able to see other schedules in the system for the dashboard.
  1. There are two delivery options: schedule or alert (beta). A scheduled delivery will run at a given date/time regardless of results; whereas an alert is set up only to deliver results based on the conditions a user sets.

For each you will set:

  • What to Send : the entire dashboard or just the tile?
  • What Destination : Email, Slack, or Webhook?
  • What to Name the delivery?
  1. After making those selections a user can further customize the (1) cadence of delivery (2) formatting and filtering of the content, and the (3) recipients. More information about each of those options is below.
  1. If setting an alert, establish the conditions that will trigger a delivery: (1) choose the result set from one of the charts on the dashboard (2) choose the condition.

Destinations​

Note about multiple destinations

While users can schedule deliveries to different destinations, Omni does not allow schedules or alerts to deliver to multiple destinations with one delivery, e.g. one delivery cannot deliver to both email and slack. A user would need to create two deliveries to each destination.

Cadence​

Configuration is available to schedule daily, weekly, monthly, or on a custom timeframe using cron (see Custom Cron Scheduling below to learn more)

Test Now​

In addition to recurring deliveries, reports can be sent immediately using the timeframe Now or by selecting Test Now at the bottom of the page. Test now will send the report to all recipients.

Custom Cron Scheduling​

Content can be delivered using the UI options for selecting time periods. In specific cases, you may want finer grain control over timing content delivery, using custom cron strings. Omni uses an AWS flavor of cron. Schedules are set in the local timezone of the creator's computer by default, but that can be adjusted via the dropdown in the bottom right-hand corner.

Custom cron strings can be applied by selecting the custom schedule timing:

Below are several examples of custom schedules, more notes and examples here:

                                  Allowed Values    Allowed Special Characters

┌───────────── minute                  0-59              * , - /
│ ┌───────────── hour                  0-23              * , - /
│ │ ┌───────────── day of month        1-31              * , - / L W ?
│ │ │ ┌───────────── month             1-12 or JAN-DEC   * , - /
│ │ │ │ ┌───────────── day of week     1-7  or SUN-SAT   * , - / # L ?
│ │ │ │ │ ┌───────────── year          any               * , - /
│ │ │ │ │ │
* * * * * *
  • 9AM each morning: 0 9 ? * * *
  • 6:30AM on the last day of the month: 30 6 L * ? *
  • 8:45 AM every weekday: 45 8 ? * MON-FRI *

Formatting Options​

Users can schedule the delivery of dashboards or charts to the listed destinations in the following formatting options:

DestinationsFormat Options
EmailCSV, Link-only, PNG, PDF, XLSX (Excel), JSON
SlackCSV, Link-only, PNG, PDF, XLSX (Excel), JSON
WebhooksCSV, Link-only, PDF, PNG, JSON
SFTPCSV (in Zip File), PNG, PDF, XLSX (Excel), JSON

Link back to dashboards

By selecting this format, Omni will send the following message: "Check Omni for the latest updates to hyperlinked content title."

Recipients​

Schedule recipient options are dictated by the schedule's destination.

Selecting Email as a schedule's destination, allows users to email to both Omni and non-Omni users.

Non-users can be added as recipients to email schedules. Note, that a shell user account will be created for any non-Omni user email receiving a schedule, allowing for dynamic permissioning, and clearer curation of who receives what. Learn more about email-only users below

For any content leveraging user attributes, there is also an option to personalize the content that is being delivered to reflect that attribute.

For example, if there was a general dashboard that shows the quarterly sales information for an entire company, a user could have that information delivered to each area sales manager so that it only shows the data for their region by checking the box to personalize delivery.

The user attribute will be applied anywhere that it is leveraged -- be it a dashboard filter, access filter, or otherwise.

Selecting Slack as the schedule's destination allows users to share the dashboard to individual Slack users, public channels and private channels - learn more about scheduling to Slack.

Selecting Webhook recipients are determined by the specific webhook's configuration - learn more about using Webhooks in Omni.

Filters on deliveries​

When scheduling a dashboard delivery the Default filters will automatically be applied to any newly created schedule. If a user wants to modify the filters that apply to a dashboard, 1. select the Dashboard tab 2. update the filter section and save. It is important to note that updating the dashboard filter itself (3.) will not adjust the scheduled filters or the default filters.

Users can utilize schedule filters to send customized dashboard content to different recipients (individuals or groups). e.g. a user can set a filter on one schedule that is set to Value A and set the same filter on another schedule that's set to Value B so each schedule is customized to each recipient.

Users can also decide to hide titles or filters on dashboards and tiles when creating a delivery:

Editing Dashboards with Deliveries​

For any dashboard with a delivery scheduled, users who try to edit the dashboard will see this warning in the top right-hand corner of the dashboard.

Deliveries & Alerts for Tiles​

The same functionality for deliveries is available on the tile/chart level. The options are available from the three dot menu:

Deliveries Admin Settings​

Here you will find all current scheduled deliveries in the app. A user can see or do the following actions in the deliveries settings:

  • Deliveries be explored by destination type (email, slack, webhook)
  • Deliveries can be adjusted or deleted from the dashboard scheduling interface by any user in the system

Additionally, deliveries can be monitored and controlled centrally from the Admin > Deliveries. Here you will find all current scheduled programs in the app, including paused schedules. Schedules can be explored by owner or status, including search:

In addition, each individual run is available in the recent activity tab, where each job shows runtime, success/fail, and some metadata on recipients:

Admin can also control whether or not users have the ability to schedule content through document abilities.

Email-Only Users​

Any email address that is receiving scheduled Omni content will be available to view from Admin > Users > Email-only. Note the email-only user section will only show once there are scheduled recipients not associated with Omni accounts.

These Email-only users accounts are built to easily collect scheduler usage and metadata. These user types can also be assigned user attributes for dynamic content.

  1. Navigate to the Admin menu
  2. Select Attributes in the left-hand menu
  3. Select the attribute that you want to add to the email-only users: