You are here:
Flow Orchestration Version Properties
An orchestration version’s properties consist of its label and description. These values drive the field values that appear on the orchestration’s detail page.
Required Editions
| View supported editions for Flow Orchestration. |
| Property | Description |
|---|---|
| Orchestration Label | The label for the orchestration version. The label appears in the orchestration detail page and list views. You can edit the label for inactive orchestrations and orchestration versions. |
| Orchestration API Name | The API name for the orchestration. The API name differentiates this orchestration from other parts of Salesforce, such as in a URL or Lightning web component. An API name can include underscores and alphanumeric characters without spaces. It must begin with a letter and can’t end with an underscore. It also can’t have two consecutive underscores. The API name appears on the orchestration detail page. You can’t edit the API name after saving the orchestration. |
| Description | Differentiates the orchestration version from other versions. The description appears in the orchestration detail page and list views. You can edit the description for inactive orchestrations and orchestration versions. |
| How to Run the Orchestration | Determines the context that the orchestration runs in. For orchestrations running in API version 60 and later, all orchestrations run in system context without sharing. For orchestrations running in API version 59 and earlier, you can run the orchestration in system context with sharing or system context without sharing. By default, the context that the orchestration runs in depends on how it’s launched.
|
| Source Template | The orchestration template that the current orchestration is based on. |
| Template | Specifies whether the orchestration is a template. When a template is installed from a managed package, the subscriber can view the orchestration and save it as a new, editable orchestration. However, when a subscriber installs a non-template orchestration from a managed package, they can only activate and deactivate it. Suppose that your company needs an orchestration that differs slightly for each country where you do business. You can create or install a template for the base orchestration and then clone it to create each country-specific orchestration. Even if you don’t use managed packages, you can use this field to identify the base orchestration. |
| Original Orchestration | The label of the original, packaged orchestration that the current orchestration overrides. When active, this orchestration runs instead of the packaged orchestration. |
| Overridable | Indicates whether users can create a linked, customizable version of this orchestration. The customized version inherits changes from the original orchestration while maintaining customizations. Only one active customized version can exist per original orchestration. |
| API Version for Running the Orchestration | Specifies which versioned run-time behavior improvements the orchestration adopts. Changing this field requires the Manage Flow permission. Before you select a new API version, review all run-time improvements delivered between the currently selected API version and the new API version. You can find all orchestration run-time improvements for an API version in the Salesforce Release Notes. By default, when you create an orchestration, it runs in the latest API version. New orchestrations and orchestration versions inherit the run-time API version from the original orchestration. The run-time API version doesn’t change as future Salesforce releases roll out. You decide when, if ever, to change the API version for running each orchestration version. By using this field, you can test and upgrade your orchestrations individually and at your own pace. |
| Interview Label | The label for the orchestration’s runs. This label appears in several areas.
You can edit the label for inactive orchestrations and orchestration
versions. by default, the label contains the orchestration name and the
Use a text
template defined in the orchestration to reference other resources in the label.
For example, |
