Splunk Cloud Platform

Splunk Dashboard Studio

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Download and schedule an email export of a dashboard

Download or schedule an email export of a dashboard to analyze, save, and share them with other people. In View mode, navigate to the Actions dropdown and select an operation.

The following is an example of the Actions dropdown used to choose various actions available for a dashboard, such as downloading, cloning, scheduling an export, or deleting.

A dropdown with various actions available for a dashboard, such as downloading, cloning, scheduling an export, or deleting.

Download a dashboard

You can download a dashboard as a PDF or PNG in View mode by clicking the Actions dropdown in the menu bar and selecting a format. A dashboard downloaded in either format displays the entire dashboard as one image.

Schedule an email export

Scheduled email export of dashboards is currently only available as a Limited Availability Release (LAR) for Splunk Cloud Platform customers with their Enterprise Cloud deployments in AWS US N. Virginia.

You must have the list_settings and list_tokens_scs capabilities to schedule an export with Dashboard Studio. By default, only admins and sc_admins have the list_settings and list_tokens_scs capabilities.

Schedule an email export of a dashboard PDF to deliver by the hour, day, week, month, or cron schedule. When scheduling an export, consider the following.

  • The Splunk mail server has a default attachment size limit of 7.5 MB. Images and icons in the dashboard count towards this limit.
  • Only one scheduled export per dashboard will be processed at a time. If the previously scheduled export of a given dashboard is still running when the export schedule is triggered again, the newly triggered export will be skipped.
  • A scheduled export will process a maximum of three concurrent searches per dashboard.
    • For example, if a dashboard has ten searches, only three will process at a time.
  • Inputs within a dashboard must have default values.
    • If no default value is defined, any dashboard panels depending on the input will not render. Currently, specific (non-default) inputs are not supported.

Use the preset options for your scheduled email export or configure it further using specific email domain lists, tokens, and cron scheduling.

The following image is an example of a popup modal used to specify the scheduling and details of a scheduled email export.

A modal for specifying the details of a scheduled email export of a dashboard. Details include the export schedule, email recipients, the subject, and email message.
  1. In View mode, navigate to Actions > Scheduled Export.
  2. Switch the Enable toggle to Active.
  3. Set the cadence of your export using the Schedule dropdown.
    1. If you select Run by Cron, see Specify a cron schedule.
  4. Specify the email details.
    1. Use a comma-separated list of email recipients in the Email To field. You can also use a defined list of allowed email recipients. See Create email domain lists.
    2. Set the Priority of the email to Critical, High, Normal, Low, or Very Low. Enforcement of priority depends on your email client.
    3. Write the contents for Subject and Message. You can also use tokens in the Subject and Message fields. See Use tokens.
  5. (Optional) Select Send Test Email to immediately send a preview of the email contents to all recipients in the Email To field.
  6. Click Save & Enable to save the scheduled delivery settings.

Create email domain lists

Admins can specify a comma-separated list of allowed Email Domains for a defined list of email recipients. Do not enter a return (newline) between items in this list because it restricts the number of email domains available for scheduled email exports. Leave the field blank for no domain restriction.

To learn more about 'Email Domains, see Configure email notifications for your Splunk Instance in the Alerting Manual.

Use tokens

Tokens represent data generated by a search. Use tokens as placeholders or variables for data values that populate when the search completes.

Access the value of a token with the following syntax.

$<token-name>$


For example, place the following token in the subject field of a scheduled PDF delivery to reference the app containing the dashboard.

Search results from $app$

Specify a cron schedule

You can use cron notation to define a custom delivery schedule. Select the Cron option to input a schedule. When specifying a cron expression, only five cron parameters are available, not six. The sixth parameter for year, common in other forms of cron notation, is not available.

Here are some example cron expressions.

*/5 * * * *       Every 5 minutes.
*/30 * * * *      Every 30 minutes.
0 */12 * * *      Every 12 hours, on the hour.
*/20  * * * 1-5   Every 20 minutes, Monday through Friday.
0 9 1-7 * 1       First Monday of each month, at 9am.

View scheduled exports

You can view the list of scheduled email exports by navigating to Settings > User Interface > View PDF Scheduling.

Discontinue a scheduled email export of a dashboard

  1. In View mode, navigate to Actions > Scheduled Export.
  2. Switch the Enable toggle to Inactive.
  3. Click Save & Disable to save the scheduled delivery settings.

Troubleshooting

  • Your download does not render or only partially renders.
    • Make sure your searches have finished. If you try to download a dashboard while searches are still running, you'll see a confirmation message. If you continue to download the dashboard, it might not render completely.
    • Visualizations that depend on real-time searches will result in the same confirmation message as those searches that are still running. These visualizations will render depending on the search results at the time the dashboard is downloaded.
  • Visualization panels are empty.
    • Any visualizations that depend on data sources that return no data will appear empty.
    • Images that come from an external URL will not render. To ensure these images render, save them to a local directory and upload them to your dashboard.
Last modified on 11 March, 2022
PREVIOUS
View options for dashboards and visualizations
  NEXT
Add a visualization to your dashboard

This documentation applies to the following versions of Splunk Cloud Platform: 8.2.2109, 8.2.2111, 8.2.2112, 8.2.2201 (latest FedRAMP release), 8.2.2202, 8.2.2203


Was this documentation topic helpful?


You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters