Dashboard task for jobs

Use a dashboard task to refresh results on a published Azure Databricks dashboard as part of a job.

Configure a dashboard task

Before you begin, check that the dashboard is published and accessible to the user configuring the job. You must have at least CAN VIEW access to the dashboard you want to deploy.

Note

The jobs UI displays options dynamically based on other configured settings.

To begin the flow to configure a Dashboard task:

  1. Go to the Tasks tab in the Jobs UI. For general instructions, see Create or configure a task.

  2. Enter a Task name.

  3. In the Type drop-down menu, select Dashboard.

  4. In the Dashboard drop-down menu, select the dashboard that you want to update.

  5. (Optional) Select the SQL warehouse used to refresh the dashboard. If not specified, the task uses the dashboard's default warehouse.

    Note

    You must use a serverless or pro SQL warehouse for dashboard tasks.

  6. In the Subscribers drop-down, select the users and notification destinations to receive email updates when the dashboard is refreshed. This list is separate from any subscribers configured through the Dashboards UI or API.

  7. (Optional) To pre-apply filter values when the dashboard refreshes, configure Dashboard filters:

    1. Click Add filter.
    2. In the Filter drop-down, select a global or page-level filter widget from the dashboard.
    3. Enter a value for the filter.
    4. Repeat for each additional filter you want to set.

    Note

    Dataset parameters can't be set directly in the task. To use a dataset parameter, first attach it to a dashboard filter widget on the dashboard canvas, then set that filter's value here.

    If a dashboard filter's URL Identifier matches a job-level parameter key, the task automatically applies that parameter's value to the filter. See Parameterize jobs.

  8. (Optional) To configure Duration threshold, Notifications, or Retries, see Advanced task settings.

  9. Click Save task.

Dashboard execution and access

Dashboard permissions and caching behavior depend on how the dashboard is published:

  • For dashboards published with shared data permissions, viewers access data and compute according to the dashboard publisher's credentials.
  • For dashboards published without shared data permissions, the identity defined in the job's Run as setting is used to refresh the dashboard. The Run as setting defaults to the job owner. To change the Run as identity, see Configure the Run as user for job runs. Viewers use their own data and compute permissions to view the dashboard output and can't view refreshed results generated by the Run as identity.

Note

Dashboards with shared data permissions are always updated using the publisher's credentials. You can't use the Run as setting in the Jobs UI to change the Run as identity.

To learn more about publish settings for dashboards, see Publish a dashboard. To learn more about caching behavior for each access type, see Dataset optimization and caching.

  • Last updated on