Skip to main content

​
Requirements

To follow the steps in this guide, you’ll need:
  • The SFTP delivery destination enabled. An Organization Admin can do this in Settings > Deliveries.
  • An SFTP address that resolves to a public host. Omni rejects IP addresses in private, loopback, link-local, or reserved ranges, and .internal, .local, or .localhost hostnames.
1

Configure the delivery settings

  1. Navigate to a published dashboard or workbook.
  2. Click File > Deliveries & Alerts. The delivery options will display on the left side of the page.
  3. Fill in the following:
    • Delivery - Select Schedule or Alert.
    • Send - Select the content to be delivered.
    • Destination - Select SFTP.
    • Name - Enter a name for the delivery.
If creating an alert, use the Alert tab to define the conditions that must be met to trigger the delivery. For example, you have a chart that tracks the Total sales for your ecommerce company. Using an alert, you can trigger a delivery when the total of your sales has changed.Click Preview in the form footer to see a live preview of the delivery, matching the current format and print options, in the dashboard’s content area. Click Preview again to close it.
Preview is unavailable for single-chart (tile) deliveries and for spreadsheet formats (CSV, XLSX).
2

Configure the delivery schedule

In this step, you’ll define the cadence for the delivery:
  • For schedules, this determines when Omni will deliver the specified content to the destination
  • For alerts, this tells Omni when to check if the current query results meet the conditions required to send the delivery
Schedules can be defined using the visual options or with cron:
Use the UI options (Daily, Weekly, etc.) to select a time period.By default, schedules are set to send in the local timezone of the delivery creator’s computer. Use the Times are in drop down to change the timezone.
A cron expression is a string that describes the individual details of a schedule:Using cron, you can create schedules like the following:
At 9:00 AM every day
At 6:30AM on the last day of the month
At 8:45 AM every day, Monday through Friday
Omni uses Amazon Web Services’ (AWS) syntax for cron expressions. Refer to the AWS documentation for more information. By default, the most frequent you can configure a schedule is hourly.
If your organization has AI enabled, you can use the AI cron generator to create cron expressions from natural language. Click the sparkle icon next to the cron input field and describe your desired schedule, such as “every weekday at 9am” or “first Monday of each month at noon.”
Schedule send timezone may be different than query run timezone. For example, if your Database timezone is UTC with no other timezone conversion settings and you set your schedule to send at 12:00 PM PST, the query will execute at 8:00 PM UTC.Refer to your connection timezone settings for more information.
3

Select format and filter options

You can use filters to customize content for different recipients! For example, set a filter to A in a scheduled delivery to recipient A, and in another scheduled delivery to recipient B, set a filter to B.
In the Dashboard or Chart tab, you can:
  • Select the format of the content, such as PNG, PDF, XLSX, or CSV.
  • Lightly customize the contents and layout, such as expanding tables to include up to 1,000 rows, hiding filter values, or arranging tiles in a single column.
  • Select the page(s) to include in the dashboard delivery. This is applicable only to advanced layouts with multiple pages. Note: PNGs can only include one page. You’ll need to create multiple deliveries to output a PNG for each page.
  • Override the query timezone for the delivery using the timezone picker. The picker label changes based on whether Personalize delivery with recipient user attributes is enabled (Recipient’s timezone when enabled, Default timezone when disabled). This setting affects the content of queries included in the delivery, not the timing of the delivery itself. Use the Schedule tab to define when content should be delivered.
  • Set filter or control values for the delivery. Some formats will have additional customization options. PDF formats, for example, will allow you to specify the orientation and page size for the PDF. For dashboard deliveries, the default filters and controls will automatically be applied upon creation. Subsequent default filter value updates will not change the filter values set for existing deliveries.
4

Configure SFTP settings

To finish setting up the delivery, click the SFTP tab and enter the following:
  • Address - Enter the address of an SFTP server in the format sftp://hostname/optional/path. For example, sftp://ftp.example.com/incoming/. The address must start with sftp://. Do not include the port or username in the address; enter those in the Port and Username fields below. This address must resolve to a public host. Omni rejects IP addresses in private, loopback, link-local, or reserved ranges, and .internal, .local, or .localhost hostnames.
  • Port - Enter the port of your SFTP server
  • File name - Enter the file name you want the delivery to have, without an extension. Mustache references are supported.
  • Username - Enter the username of the SFTP user Omni will use to authenticate.
  • Authentication - Select one of the following:
    • Password - Enter the password for the SFTP user.
    • SSH key - Use an OpenSSH key or PEM RSA/EC key to authenticate. Add your Private key and, if the key is encrypted, the Private key passphrase.
    Omni encrypts the stored password or key after you save the delivery.
5

Test the delivery

If you want to test the delivery before saving, click the Test Now button in the bottom left corner of the page. This will send the dashboard/chart to the destination using the current settings. For example, using Test Now would send the delivery to all Recipients.
The Test Now button will be unavailable for alerts if the Condition type is Results have changed or Results have stayed the same. A workaround is to use the Send Now option to manually trigger the delivery, which is available once the delivery has been saved.Save the alert and then click the icon to display the Send Now option. This will initiate a check on the alert condition - if the condition isn’t met, the delivery will show as successful but not send anything.
6

Save the delivery

When finished, click Save to create the delivery.