Salesforce Orchestrator App Commands
A comprehensive list of all Orchestrator app 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 orchestrated app using an existing template as the foundation. The app is initialized with the configuration, structure, and settings defined in the template, providing a quick start for app development.
You can identify the template to use 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 new app inherits the template's configuration, but can be customized independently after creation.
Use this command to quickly create apps with consistent configurations and accelerate your development workflow. The created app assets appear in Data 360 and Tableau Next where you can customize as needed. You can manage the app from the App Install History page in Setup.
You must have Data 360 and Tableau Next enabled in your org and the AppFrameworkManageApp user permission to create apps. Both the template and the new app must be in the same org.
$ sf orchestrator app create -o <value> -n <value> [--json] [--flags-dir <value>] [--api-version <value>] [-l <value>] [-d <value>] [-i <value> | -t <value>] [-r sync|async] [-g debug|info|warn|error]
| Flag | Type | Required | Description |
|---|---|---|---|
--target-org, -o | option | Yes | The target org to connect to for creating the app. This org must have Data 360 and Tableau Next enabled, and you must have the AppFrameworkManageApp user permission to create apps. The template must also exist in this org. |
--name, -n | option | Yes | A unique identifier for the app. Must be unique within your org. Use descriptive names that help identify the app's purpose. App names should follow your org's naming conventions. |
--template-id, -i | option | * | The unique identifier of the template to use for generating the new app. |
--label, -l | option | No | A human-readable label for the app. This is displayed on the App Install History setup page and helps users identify the app's purpose. If not provided, the name is used as the label. |
--description, -d | option | No | A description of what the app does and its intended use case. This helps users understand the app's purpose and functionality. The description appears on the App Install History page. |
--runtime-method, -r | option | No | Specifies the runtime method for the app execution. This affects how the app processes data and handles user interactions. Valid values are sync and async. |
--log-level, -g | option | No | Sets the logging level for the app. This controls how much diagnostic information is captured during app execution. Valid values are debug, info, warn, and error. |
--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.
Delete an orchestrated app from your org.
You can identify the app to delete by either its unique ID or its name. App IDs are guaranteed to be unique, while app names should be unique within an org. The command prompts for confirmation before deletion unless you use the --no-prompt flag.
Deleting an app removes it Tableau Next and makes it unavailable to users. Any dashboards, visualizations, data assets, or other components that depend on this app may be affected. Consider the impact on your users and any dependent systems before proceeding.
You must have Data 360 and Tableau Next enabled in your org and the AppFrameworkManageApp user permission to delete apps. You can only delete apps that exist in the target org.
$ sf orchestrator app 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 app. This org must have Data 360 and Tableau Next enabled, and you must have the AppFrameworkManageApp user permission to delete apps. The app must exist in this org. |
--app-id, -i | option | * | The unique identifier of the app to delete. |
--app-name, -n | option | * | The name of the app to delete. |
--no-prompt, -p | boolean | No | Skip the confirmation prompt before deleting the app. Use this flag carefully, especially in scripts or automation, as app deletion can't be undone. This flag is useful for CI/CD pipelines and automated processes. |
--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 --app-id or --app-name is required.
Display comprehensive information about a specific orchestrated app including its name, label, ID, type, template association, creation details, and configuration properties. Use this command to inspect apps to understand their current state, template relationships, and configuration settings.
You can identify the app by either its unique ID or its name. App IDs are guaranteed to be unique, while app names should be unique within an org. The command displays all available app properties in a formatted, easy-to-read layout.
App information helps you understand the app's current configuration, its template relationship, and any runtime settings that may be applied. This is particularly useful before making updates, troubleshooting issues, or understanding app dependencies.
You must have Data 360 and Tableau Next enabled in your org and the AppFrameworkViewApp user permission to view apps.
$ sf orchestrator app 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 app. This org must have Data 360 and Tableau Next enabled, and you must have the AppFrameworkViewApp user permission to view apps. The app must also exist in this org |
--app-id, -i | option | * | The unique identifier of the app to display. |
--app-name, -n | option | * | The name of the app to display. |
--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 --app-id or --app-name is required.
List all orchestrated apps in your org with their key information including name, label, ID, type, and associated template details. This command helps you discover and manage existing apps in your organization.
Apps are displayed in a table format showing their current status, creation details, and template associations. Use this information to understand your app inventory and make informed decisions about app management.
You must have Data 360 and Tableau Next enabled in your org and the AppFrameworkViewApp user permission to view apps. This command works with production orgs, sandboxes, and scratch orgs.
$ sf orchestrator app 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 apps. This org must have Data 360 and Tableau Next enabled, and you must have the AppFrameworkViewApp user permission to view apps. |
--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 an existing orchestrated app's label and description. This command allows you to modify the display properties of an app without changing its underlying template or functionality.
You can identify the app by either its unique ID or its name. App IDs are guaranteed to be unique, while names should be unique within an org.
Use this command to update the human-readable display name (label) and description that users see when viewing the app. This is useful for improving app discoverability and providing clearer information about the app's purpose.
You must have the AppFrameworkManageApp user permission to modify apps.
$ sf orchestrator app 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 listing apps. This org must have Data 360 and Tableau Next enabled, and you must have the AppFrameworkManageApp user permission to view apps. |
--app-id, -i | option | * | The unique identifier of the app to update. |
--app-name, -n | option | * | The name of the app to update. |
--label, -l | option | No | A new display label for the app. This is the human-readable name shown to users on the App Install History page. The label helps users identify and select the appropriate app. Use clear, descriptive labels that explain the app's purpose. |
--description, -d | option | No | A new description for the app. This provides detailed information about the app's purpose, features, and intended use cases. The description appears on the App Install History page and helps users understand when and how to use the app 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 --app-id or --app-name is required.