DashboardUpsert

Use this node to create or update a Tableau Next dashboard.

Asset Type Name for Rules 

dashboard

Example Definition in chain.json 

1{
2  "name": "dashboard_example",
3  "label": "Creates A Dashboard",
4  "dominoVariant": "sfdc_internal__UnifiedAnalyticsDominoVariant",
5  "parameters": {},
6  "definition": {
7    "nodes": {
8      "upsert_dashboard1": {
9        "graphNodeType": {
10          "name": "DashboardUpsert"
11        },
12        "parameters": {
13          "name": "dashboard_name",
14          "label": "dashboard label",
15          "file": "dashboards/dashboard.json"
16        },
17        "sources": [],
18        "runAs": "CurrentUser"
19      }
20    }
21  }
22}

Parameters 

ParameterDefinition
name(Required) The template specific asset name. NOTE: this value isn’t used as the name of the created dashboard. The dashboard name is generated from the label value in the dashboard input JSON. The name is considered the templateAssetSourceName that is used to define a specific dashboard in context.
label(Required) The template specific label. NOTE: this value isn’t used as the label of the created dashboard. This is the label that appears in app logs and app install history.
file(Required) The path to the JSON file that contains the dashboard representation.
condition(Optional) An EL expression, evaluated at runtime, that determines whether to create or upgrade this dashboard or not.

Set runAs to CurrentUser so that this node runs with the permissions of the user installing the app. If you omit runAs, the node runs as AutoProc, a system user.

Note

App Context Values 

Dashboards created from a template get an entry in the App Context if they are successful. These entries are keyed off of the template specific asset name and contain information about the instance that was created.

App Context ValueDefinition
App.Dashboards.<template specific asset name>.IdThe ID of the created dashboard.
App.Dashboards.<template specific asset name>.NameThe name of the created dashboard. This is generated from the label value in the dashboard input JSON.
App.Dashboards.<template specific asset name>.LabelThe label of the created dashboard. This is the label value in the dashboard input JSON.

On Failure 

If this task fails, it returns a FAIL_TERMINAL status. The chain stops and no downstream nodes run.

See Also