Resource Identifiers

Resource identifiers

Global Resource Names (GRNs)

A Global Resource Name or GRN is a way to reference Hashboard resources in a stable way. As a resource is changed, renamed, moved between collections, etc. its GRN will always remain the same.

Anatomy of a GRN

A GRN is comprised of three components: type, id, and alias, separated by :

  • type identifies the resource type

    • dsb: dashboard
    • m: model
    • palette: color palette
    • sv: saved exploration
  • id is an globally unique identifier first assigned when the resource is created. The ID appears in the URL bar when viewing a resource.

  • alias is an optional unique identifier set by the user in the resource's config.

Not all 3 components are necessary to specify a GRN. The alias can be omitted as long as an id is present:


and, likewise, the id can be omitted as long as an alias is specified (note the double ::):


The following are all valid GRNs:

# some GRNs have longer IDs:

GRNs are case sensitive.

Using GRNs

Linking configs to existing resources

All resources can be specified with the special grn property to link a Hashboard config to an existing resource. This allows you to move a resource created in the Hashboard web app to be code-controlled, without recreating it.

Referencing other resources

Anywhere you specify a filepath in a Hashboard config, you may instead specify a GRN. This allows you to reference resources independently of how you structure your files.

Referencing dbt models

When referencing models imported by the dbt integration, the standard GRN format is valid. It is also possible to reference dbt models using the unique identifier of the dbt node representing the model:


For example: