Salesforce Orchestrator Template Commands
A comprehensive list of all Orchestrator template commands available in the Salesforce CLI.
Global Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--flags-dir=<value> | option | No | Import flag values from a directory. |
--json | boolean | No | Format output as json. |
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>]
| Flag | Type | Required | Description |
|---|---|---|---|
--target-org, -o | option | Yes | The target org to connect to for creating the template. This org must have Data 360 and Tableau Next enabled, and you must have the AppFrameworkManageApp user permission to create templates. |
--name, -n | option | Yes | A unique identifier for the template. Must be unique within your org. Use descriptive names that help identify the template's purpose. Template names should follow your org's naming conventions |
--type, -t | option | No | Specifies the type of template to create. Valid values are app, component, dashboard, lens. Defaults to app if not specified. Choose the type that matches your intended use case for the template. |
--subtype, -s | option | No | An optional subtype categorization for the template (e.g., tableau for app templates). Subtypes help organize templates and provide additional context about their intended use or underlying technology.. |
--label, -l | option | No | A human-readable label for the template. This is displayed in Tableau Next and helps users identify the template's purpose. Use clear, descriptive labels that explain what the template does. |
--description, -d | option | No | A description of what the template does and its intended use case. This is displayed in Tableau Next and helps users understand when to use this template. Include information about the template's purpose, features, and any prerequisites. |
--api-version | option | No | Override the API version used for orchestrator API requests. Use this flag to specify a particular API version when the default version doesn't work with your org's configuration. |
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]
| Flag | Type | Required | Description |
|---|---|---|---|
--target-org, -o | option | Yes | The target org to connect to for deleting the template. This org must have Data 360 and Tableau Next enabled and you must have the AppFrameworkManageApp user permission to delete templates. The template must exist in this org. |
--template-id, -i | option | * | The unique identifier of the template to delete. Template IDs are guaranteed to be unique within an org. Use this flag when you know the template's ID, which you can get from "sf orchestrator template list" command. Either --template-id or --template-name is required. |
--template-name, -n | option | * | The name of the template to delete. Template names should be unique within an org. Use this flag when you know the template's name but not its ID. If the name contains spaces, enclose it in quotes. Either --template-id or --template-name is required. |
--no-prompt, -p | boolean | No | Skip the confirmation prompt before deleting the template. Use this flag carefully, especially in scripts or automation, as template deletion can't be undone. |
--api-version | option | No | Override the API version used for orchestrator API requests. Use this flag to specify a particular API version when the default version doesn't work with your org's configuration. |
*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>]
| Flag | Type | Required | Description |
|---|---|---|---|
--target-org, -o | option | Yes | The target org to connect to for displaying the template. This org must have Data 360 and Tableau Next enabled, and you must have the AppFrameworkViewApp user permission to view templates. The template must exist in this org. |
--template-id, -i | option | * | Specify the unique identifier of the template you want to display. Template IDs are guaranteed to be unique within an org. Use this flag when you know the template's ID, which you can get from sf orchestrator template list command. Either --template-id or --template-name is required. |
--template-name, -n | option | * | Specify the name of the template you want to display. Template names should be unique within an org. Use this flag when you know the template's name but not its ID. If the name contains spaces, enclose it in quotes. Either --template-id or --template-name is required. |
--api-version | option | No | Override the API version used for orchestrator API requests. Use this flag to specify a particular API version when the default version doesn't work with your org's configuration. |
*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>]
| Flag | Type | Required | Description |
|---|---|---|---|
--target-org, -o | option | Yes | The target org to connect to for listing templates. This org must have Data 360 and Tableau Next enabled, and you must have the AppFrameworkViewApp user permission to view templates. |
--api-version | option | No | Override the API version used for orchestrator API requests. Use this flag to specify a particular API version when the default version doesn't work with your org's configuration. |
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>]
| Flag | Type | Required | Description |
|---|---|---|---|
--target-org, -o | option | Yes | The target org to connect to for updating the template. This org must have Data Cloud and Tableau Next enabled, and you must have the AppFrameworkManageApp user permission to modify templates. The template must exist in this org. |
--template-id, -i | option | * | The unique identifier of the template to update. Template IDs are guaranteed to be unique within an org. Use this flag when you know the template's ID, which you can get from sf orchestrator template list command. Either --template-id or --template-name is required. |
--template-name, -n | option | * | The name of the template to update. Template names should be unique within an org. Use this flag when you know the template's name but not its ID. If the name contains spaces, enclose it in quotes. Either --template-id or --template-name is required. |
--label, -l | option | No | This is the human-readable name shown to users in Tableau Next. The label helps users identify and select the appropriate template when creating apps. |
--description, -d | option | No | The description appears in Tableau Next and helps users understand when and how to use the template effectively. |
--api-version | option | No | Override the API version used for orchestrator API requests. Use this flag to specify a particular API version when the default version doesn't work with your org's configuration. |
*Either --template-id or --template-name is required.