Salesforce Orchestrator Template Commands

A comprehensive list of all Orchestrator template commands available in the Salesforce CLI.

Global Flags

Create a new template that can be used as a blueprint for building orchestrated apps. Templates allow you to define reusable configurations, layouts, and settings that can be shared across multiple apps.

Once created, templates appear in Tableau Next where users can use them to create new apps. Templates help standardize app development and ensure consistency across your org.

You must have Data 360 and Tableau Next enabled in your org and the AppFrameworkManageApp user permission to create templates. The template name must be unique within your org. This command works with production orgs, sandboxes, and scratch orgs that have orchestrated apps configured.

$ sf orchestrator template create -o <value> -n <value> [--json] [--flags-dir <value>] [--api-version <value>] [-t app|component|dashboard|lens] [-s <value>] [-l <value>] [-d <value>]

1# Create a basic app template:
2sf orchestrator template create --target-org myOrg --name "my_template"
3
4# Create a template with a label for better identification:
5sf orchestrator template create --target-org myOrg --name "sales_template" --type app --label "Sales Analytics Template"
6
7# Create a dashboard template with a specific subtype:
8sf orchestrator template create --target-org myOrg --name "dashboard_template" --type dashboard --subtype "analytics"
9
10# Create a comprehensive template with all metadata:
11sf orchestrator template create --target-org myOrg --name "analytics_template" --type app --subtype "tableau" --label "Sales Template" --description "Template for sales analytics apps"
12
13# create a template using a specific API version:
14sf orchestrator template create --target-org myOrg --name "legacy_template" --api-version 65.0

Delete a template from your org. This command provides several options for handling apps that were created from the template.

By default, when you delete a template, any apps created from it remain in your org but lose their association with the template. You can also choose to force delete both the template and all associated apps, or decouple apps before deletion to ensure they continue functioning independently.

This is a destructive operation that can’t be undone. The command prompts for confirmation unless you use the --no-prompt flag. Consider carefully which deletion strategy best fits your needs before proceeding.

You must have Data 360 and Tableau Next enabled in your org and the AppFrameworkManageApp user permission to delete templates. You can only delete templates that exist in the target org.

$ sf orchestrator template delete -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value> | -n <value>] [-p]

1# Delete a template by ID (keeps associated apps):
2$ sf orchestrator template delete --target-org myOrg --template-id 0XtB000000001aXYAQ
3
4# Delete a template by name with confirmation prompt:
5$ sf orchestrator template delete --target-org myOrg --template-name "My Template"
6
7# Force delete template and all apps created from it:
8$ sf orchestrator template delete --target-org myOrg --template-id 0XtB000000001aXYAQ --force-delete
9
10# Delete template without confirmation prompt:
11$ sf orchestrator template delete --target-org myOrg --template-id 0XtB000000001aXYAQ --no-prompt
12
13# Decouple apps before deleting template:
14$ sf orchestrator template delete --target-org myOrg --template-name "Sales Template" --decouple
15
16#Delete template in specific org with API version:
17$ sf orchestrator template delete --target-org mySandbox --template-id 0XtB000000001aXYAQ --api-version 65.0

*Either --template-id or --template-name is required.

Display comprehensive information about a specific template including its name, label, ID, type, subtype, description, and other metadata properties. Use this command to inspect templates before using them to create apps or for understanding template configurations.

You can identify a template by either its unique ID or its name. Template IDs are guaranteed to be unique, while template names should be unique within an org. The command displays all available template properties in a formatted, easy-to-read layout.

Template information helps you understand what the template provides, its intended use case, and how to use it effectively when creating orchestrated apps. You must have Data 360 and Tableau Next enabled in your org and the AppFrameworkViewApp user permission to view templates.

$ sf orchestrator template display -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value> | -n <value>]

1# Display a template using its ID:
2$ sf orchestrator template display --target-org myOrg --template-id 01RM0000000HwBGMA0
3
4# Display a template using its name:
5$ sf orchestrator template display --target-org myOrg --template-name "MyTemplate"
6
7# Display a template with a name that contains spaces:
8$ sf orchestrator template display --target-org myOrg --template-name "Sales Analytics Template"
9
10# Display a template in a specific org using a particular API version:
11$ sf orchestrator template display --target-org mySandbox --template-id 01RM0000000HwBGMA0 --api-version 60.0
12
13# Display a template by name in your default org:
14$ sf orchestrator template display --template-name "dashboard_template"

*Either --template-id or --template-name is required.

Templates are reusable configurations that define the structure and settings for creating orchestrated apps. Use this command to discover available templates in your org before creating new apps.

Templates are displayed in a table format showing their name, label, ID, type, and other metadata. This information helps you choose the right template for your orchestrated app development.

You must have Data 360 and Tableau Next enabled in your org and the AppFrameworkViewApp user permission to view templates. This command works with production orgs, sandboxes, and scratch orgs.

$ sf orchestrator template list -o <value> [--json] [--flags-dir <value>] [--api-version <value>]

1# List all templates in your default org:
2$ sf orchestrator template list
3
4# List templates in a specific org:
5$ sf orchestrator template list --target-org myOrg
6
7# List templates using a specific API version:
8$ sf orchestrator template list --api-version 64.0
9
10# List templates in a sandbox org with a specific API version:
11$ sf orchestrator template list --target-org mySandbox --api-version 60.0

Update the metadata and properties of an existing template. Use this command to modify the template’s label, description, and other properties to keep your templates current and well-documented.

You can identify the template to update by either its unique ID or its name. Template IDs are guaranteed to be unique, while template names should be unique within an org. You can update one or more properties in a single command.

Template updates are useful for maintaining accurate documentation, improving template discoverability, and ensuring templates remain relevant as your org’s needs evolve. Updated templates immediately reflect changes in Tableau Next.

You must have Data 360 and Tableau Next enabled in your org and the AppFrameworkModifyApp user permission to modify templates. You can only update templates that exist in the target org.

$ sf orchestrator template update -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [-i <value> | -n <value>] [-l <value>] [-d <value>]

1# Update a template's label by ID:
2$ sf orchestrator template update --target-org myOrg --template-id 0XtB000000001aXYAQ --label "New Display Label"
3
4# Update a template's description by name:
5$ sf orchestrator template update --target-org myOrg --template-name "MyTemplate" --description "Updated template description"
6
7# Update both label and description:
8$ sf orchestrator template update --target-org myOrg --template-id 0XtB000000001aXYAQ --label "Sales Analytics Template" --description "Template for comprehensive sales reporting and analytics"
9
10# Update a template in a specific org with API version:
11$ sf orchestrator template update --target-org mySandbox --template-name "Dashboard Template" --label "Executive Dashboard" --api-version 60.0
12
13#Update a template with a name containing spaces:
14$ sf orchestrator template update --target-org myOrg --template-name "Sales Analytics Template" --description "Enhanced template for sales team analytics"

*Either --template-id or --template-name is required.

j

App Template Framework Overview

Get Started with the App Template Framework

Salesforce Orchestrator CLI Commands

Salesforce Orchestrator App CLI Commands

Salesforce Orchestrator Template CLI Commands