Skip to main content

Domo - Refresh Dataset

Overview​

First time using this Blueprint? Make sure you follow our Domo authorization guide.​

Manually trigger a refresh of a dataset in Domo.

Authentication can be provided with either an access token or a combination of username and password. If both are provided, access token will be preferred.

This Blueprint will only kick off the refresh and will almost always return a status of success. It will not wait around to verify if the created refresh job was successfully completed, but it will create and store the generated job ID to shipyard-artifacts/domo-blueprints/variables/job_id.pickle

Recommended Setup:

  1. A Vessel built with the Domo - Check Refresh Status Blueprint should be run immediately after this Vessel. This will ensure that you build your Fleet to act on the final status of your refresh.

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
Access TokenDOMO_ACCESS_TOKENPasswordβž–--Access token to authenticate with Domo. Used in place of username/password.
EmailDOMO_EMAILAlphanumericβž–--Email that you use to log into Domo. Used with the password for authentication as an alternative method to providing an access token.
PasswordDOMO_PASSWORDPasswordβž–--Password associated to the email used to sign into Domo. Used with the email for authentication as an alternative method to providing an access token.
Client IDDOMO_CLIENT_IDAlphanumericβœ…--Client ID of your organization's Domo App.
SecretDOMO_SECRET_KEYPasswordβœ…--Secret associated with the provided Client ID.
Domo InstanceDOMO_INSTANCEAlphanumericβœ…--Typically found in the URL structure as https://DOMOINSTANCE.domo.com
Dataset IDDOMO_DATASET_IDAlphanumericβœ…--UUID of the dataset you want to download, typically found at the end of the URL.

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
blueprint: Domo - Refresh Dataset
inputs:
DOMO_ACCESS_TOKEN: null
DOMO_EMAIL: null
DOMO_PASSWORD: null
DOMO_CLIENT_ID: null ## REQUIRED
DOMO_SECRET_KEY: null ## REQUIRED
DOMO_INSTANCE: null ## REQUIRED
DOMO_DATASET_ID: null ## REQUIRED
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0s
runtime_cutoff: 4h0m0s
exclude_exit_code_ranges:
- "200"
- "201"
- "203"
- "204"
- "205"
- "210"
- "211"
- "207"