You are here:
Variable Flow Orchestration Resource
Store a value that can be changed throughout the orchestration.
Required Editions
| View supported editions for Flow Orchestration. |
| Field | Description |
|---|---|
| Apex Class | Defines fields for the Apex-defined data type. Only fields with the @AuraEnabled annotation are available in an orchestration. |
| API Name | The requirement for uniqueness applies only to elements within the current orchestration. Two elements can have the same API name, provided they’re used in different orchestrations. 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. |
| Description | Helps you differentiate this variable from other resources. |
| Data Type | Determines the types of values that the variable can store. You can’t change the data type of a previously saved variable. The Record data type can store multiple field values for one record. The Apex-defined data type can store multiple field values for one Apex class. Looking for sObject? In Flow Builder, that data type changed to Record. |
| Allow multiple values (collection) | When selected, the resource is a collection variable. You can store a list of values in collection variables. Collection variables can store only values that are compatible with their data type. When the data type is Record, the collection variable can only store values for the associated object’s records. For example, store multiple email addresses in a collection variable, and reference the collection variable to send an email. |
| Object | The object whose field values you can store in the variable. You can’t change the object of a previously saved variable. Available only when the data type is Record. |
| Decimal Places | Controls the number of digits to the right of the decimal point up to 17 places. If you leave this field blank or set it to zero, only whole numbers appear when your orchestration runs. Available only when the data type is Number or Currency. |
| Availability Outside the Flow | When a variable is available for input, it can be set at the start of the orchestration, such as when an orchestration is started from a Lightning page. Disabling input or output access for an existing variable can break the functionality of applications and pages that call the orchestration and access the variable. For example, you can access variables from URL parameters, processes, and other flows. This field doesn’t affect how variables are assigned or used within the same orchestration. |
| Default Value | Determines the variable value when the orchestration starts. If you leave this field
blank, the value is Not available for Picklist and Multi-Select Picklist variables. |
