Domo Data

Requirements

For all Domo clients:

• Domo admin credentials

• Domo Developer Token

• Communication around the use of Domo as a warehouse

If needed, whitelist CastorDoc IP

Here is our fixed IP: 35.246.176.138

CastorDoc Managed

To get things started with Domo in CastorDoc, you will need to be a Domo admin and provide us with:

• A Client ID - Domo documentation

• A Domo API token (Client Secret) - Domo documentation

Minimum scopes required for the API Client: data, dashboard, audit, user, workflow

• The Base URL of your Domo instance (https://www.XXXX.domo.com/)

• A Developer Token - Domo documentation

• The Cloud Id of your external Warehouse (if applicable remove otherwise)

For more information on how to retrieve those information, see their documentation here or reach out 🙂

{
    "apiToken": "*****",
    "clientId": "*****",
    "baseUrl": "https://www.XXXX.domo.com/",
    "developerToken": "*****",

    "cloudId": "my-external-warehouse-cloud-id"
}

The CastorDoc account needs to have direct sign on enabled, if SSO is activated on your Domo instance.

• clientId: id of the CastorDoc account

• baseUrl: Domo base url, your api endpoint, usually your Domo URL homepage

• developerToken: Token to access the Domo private API

• cloudId: Id of the external warehouse used within Domo (if applicable remove otherwise)

The account used to log into the developer portal to generate the client id and secret needs to have access to all the dashboards you would like to have in CastorDoc. You can go in the Admin > Dashboards section in Domo and share the needed dashboards with that user.

For your first sync, it will take up to 48h and we will let you know when it is complete ✅

If you are not comfortable giving us access to your credentials, please continue to Client Managed 👇

Client Managed

Doing a one shot extract

For your trial, you can simply give us a one shot view of your BI tools.

Running the CastorDoc package

Install the PyPi package

pip install castor-extractor

For further details: link

Running the PyPi package

Once the package has been installed, you should be able to run the following command in your terminal:

castor-extract-domo [arguments]

Arguments

• -c, --client-id: Domo client id

• -a, --api-token: Domo access token

• -d, --developer-token: Domo developer token

• -b, --base-url: Domo base url

• -o, --output: target folder to store the extracted files

Optional arguments

• -C, --cloud-id: Mandatory if you use an external warehouse (and not Domo as a warehouse)

Scheduling and Push to Catalog

When moving out of trial, you'll want to refresh your Domo content in Catalog. Here is how to do it:

The Catalog team will provide you with

1. Catalog Identifier (an id for us to match your looker files with your Catalog instance)

2. Catalog Token An API Token

You can then use the castor-upload command:

castor-upload [arguments]

Arguments

• -k, --token: Token provided by Catalog

• -s, --source_id: account id provided by Catalog

• -t, --file_type: source type to upload. Currently supported are { DBT | VIZ | WAREHOUSE }

Target files

To specify the target files, provide one of the following:

• -f, --file_path: to push a single file

or

• -d, --directory_path: to push several files at once (*)

(*) The tool will upload all files included in the given directory.

Make sure it contains only the extracted files before pushing.

Then you'll have to schedule the script run and the push to Catalog, use your preferred scheduler to create this job

You're done!