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.

orchestrator app create

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.

Usage

Examples

1# Create an app from a template by ID:
2$ sf orchestrator app create --target-org myOrg --name "my_app" --template-id 01t000000000123
3
4# Create an app from a template by name:
5$ sf orchestrator app create --target-org myOrg --name "sales_app" --template-name "Sales_Template"
6
7# Create an app with a custom label and description:
8$ sf orchestrator app create --target-org myOrg --name "analytics_app" --template-name "Analytics_Template" --label "My Analytics App" --description "Custom analytics app"
9
10# Create an app with specific runtime configuration:
11$ sf orchestrator app create --target-org myOrg --name "dashboard_app" --template-id 01t000000000456 --runtime-method async --log-level debug
12
13# Create an app using a specific API version:
14$ sf orchestrator app create --target-org mySandbox --name "test_app" --template-name "Test Template" --api-version 60.0

Flags

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.

orchestrator app delete

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.

Usage

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

Examples

1# Delete an app by ID with confirmation prompt:
2$ sf orchestrator app delete --target-org myOrg --app-id 01t000000000123
3
4# Delete an app by name with confirmation prompt:
5$ sf orchestrator app delete --target-org myOrg --app-name "My App"
6
7# Delete an app without confirmation prompt:
8$ sf orchestrator app delete --target-org myOrg --app-id 01t000000000123 --no-prompt
9
10# Delete an app with a name containing spaces:
11$ sf orchestrator app delete --target-org myOrg --app-name "Sales Analytics App"
12
13# Delete an app in a specific org with API version:
14$ sf orchestrator app delete --target-org mySandbox --app-id 01t000000000123 --api-version 60.0

Flags

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.

orchestrator:app:display

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.

Usage

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

Examples

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

Flags

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.

orchestrator app list

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.

Usage

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

Examples

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

Flags

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.

orchestrator app update

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.

Usage

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

Examples

1# Update an app's label:
2$ sf orchestrator app update --target-org myOrg --app-id 1zAxx000000000123 --label "Updated App Label"
3
4# Update an app's description:
5$ sf orchestrator app update --target-org myOrg --app-name "My App" --description "Updated description for the app"
6
7# Update both label and description:
8$ sf orchestrator app update --target-org myOrg --app-id 1zAxx000000000123 --label "Updated App" --description "Updated description for the app"
9
10# Update an app using a specific API version:
11$ sf orchestrator app update --target-org mySandbox --app-id 1zAxx000000000123 --label "New Label" --api-version 65.0

Flags

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.