DashboardDelete

Use this node to delete dashboards from an app. You can delete all dashboards or selectively delete specific dashboards by specifying their template asset names.

Asset Type Name for Rules

dashboard

Example Definition in chain.json

Delete all the dashboards for an app or only delete specific dashboards by name with templateAssetNames.

Delete All Dashboards

1{
2  "name": "delete_all_dashboards",
3  "label": "Deletes All Dashboards",
4  "dominoVariant": "sfdc_internal__UnifiedAnalyticsDominoVariant",
5  "parameters": {},
6  "definition": {
7    "nodes": {
8      "delete_dashboard": {
9        "graphNodeType": {
10          "name": "DashboardDelete"
11        },
12        "parameters": {
13          "condition": "${Variables.shouldDeleteDashboards}"
14        },
15        "sources": [],
16        "runAs": "CurrentUser"
17      }
18    }
19  }
20}

Delete Specific Dashboards

1{
2  "name": "selective_delete_dashboard",
3  "label": "Selectively Deletes Specific Dashboards",
4  "dominoVariant": "sfdc_internal__UnifiedAnalyticsDominoVariant",
5  "parameters": {},
6  "definition": {
7    "nodes": {
8      "delete_dashboard": {
9        "graphNodeType": {
10          "name": "DashboardDelete"
11        },
12        "parameters": {
13          "templateAssetNames": ["my_dashboard"]
14        },
15        "sources": [],
16        "runAs": "CurrentUser"
17      }
18    }
19  }
20}

Parameters

Parameter	Definition
`condition`	(Optional) An EL expression, evaluated at runtime, that determines whether to execute the delete operation or not. If the condition evaluates to `false`, the node is skipped.
`templateAssetNames`	(Optional) A list of template asset names to selectively delete. When specified, only the dashboards matching these template asset names are deleted. When omitted or empty, all dashboards in the app are deleted.

Set runAs to CurrentUser so that deletion is limited to the permissions of the user installing the app. If you omit runAs, the node runs as AutoProc, a system user, which fails security review in delete chains.

Note

App Context Values

Nothing added to App Context.

On Failure

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

See Also

Orchestrate Templated App Assets with Chains