Metadata API Developer Guide
jNewer Version Available
Flow
For information about the corresponding UI-based flow building tool, see Flow Builder in Salesforce Help.
When using Metadata API to work with flows, consider that:
- You can’t use Metadata API to access a flow installed from a managed package, unless the flow is a template.
- Spaces in flow file names can cause errors at deployment. Heading and trailing spaces are allowed, but they’re trimmed during deployment.
- When using Metadata API, you can deploy changes to active flows in specific situations.
- The org isn’t a production org, such as a scratch org or sandbox. The active flow is the latest version.
- The org is a production org that enabled the Deploy processes and flows as active preference. The active flow is the latest version.
- You can delete a flow version as long as it isn’t active and has no paused interviews. If the flow version has paused interviews, wait for those interviews to resume and finish, or delete them.
Declarative Metadata File Suffix and Directory Location
Flows are stored in the Flow directory of the corresponding package directory. The file name matches the flow’s unique full name, and the extension is .flow.
Version
The flow Metadata API is available in API version 24.0 and later.
Flow
This metadata type represents a valid definition of a flow. This type extends the Metadata metadata type and inherits its fullName field.
| Field Name | Field Type | Description |
|---|---|---|
| actionCalls | FlowActionCall[] | An array of nodes that defines calls to actions. This field is available in API version 31.0 and later. |
| apexPluginCalls | FlowApexPluginCall[] | An array of nodes that defines calls to Apex plug-ins. |
| apiVersion | number | The API version that defines the execution behavior of the flow. This field is available in API version 50.0 and later. Flows created before API version 50.0 display an API version of 0 on the Flows list view in Setup. To display the correct API version number, create another version of the flow, and set the API version for running the flow to 49.0 or later. |
| assignments | FlowAssignment[] | An array of assignment nodes. |
| choices | FlowChoice[] | An array of static choice options. |
| collectionProcessors | FlowCollectionProcessor[] | An array of nodes that process collections. This field is available in API version 50.0 and later. |
| constants | FlowConstant[] | An array of constants. |
| decisions | FlowDecision[] | An array of decision nodes. |
| description | string | Description of the flow. |
| dynamicChoiceSets | FlowDynamicChoiceSet[] | An array that constructs a set of choice options based on a database lookup. |
| environments | FlowEnvironment (enumeration of type string) | The environment in which the flow can run. Valid values are:
This field is available in API version 55.0 and later. |
| formulas | FlowFormula[] | An array of formulas. |
| fullName | string | Required. Inherited from the Metadata component. Name of the file
in Metadata API. A unique name for the flow that contains only underscores and alphanumeric characters. The name must be unique across the org, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. To deploy or retrieve a version, you can specify the version number. For example, sampleFlow-3 specifies version 3 of the flow whose unique name is sampleFlow. If you don’t specify a version number, the flow is the latest version. In API version 43.0 and earlier, this field included the version number. In API version 44 and later, this field no longer includes the version number. |
| interviewLabel | string |
Label for the interview. This label
helps users and administrators differentiate interviews from the
same flow. In the user interface, this label appears in the Paused Flow Interviews component on the user’s Home tab and in the list of paused flow interviews in Setup. |
| isAdditionalPermissionRequiredToRun | boolean | Indicates whether to override the default behavior and restrict access to enabled profiles or permission sets (true) or not (false). The default value is (false). This field is available in API version 47.0 and later. |
| isTemplate | boolean |
Indicates whether the process or flow is
a template. When installed from managed packages, processes and
flows can’t be viewed or cloned by subscribers because of
intellectual property (IP) protection. But when those processes
and flows are templates, subscribers can open them in a builder,
clone them, and customize the clones. This field is
available in API version 45.0 and later. Default: false |
| label | string | Required. Label for the flow. |
| loops | FlowLoop[] | An array of nodes for iterating through collections. This field is available in API version 30.0 and later. |
| migratedFromWorkflowRuleName | string | The name of the workflow rule that the flow was migrated from. This field is available in API version 54.0 and later. |
| orchestratedStages | FlowOrchestratedStage[] | An array of stage nodes in an orchestration. This field is available in API version 53.0 and later. |
| processMetadataValues | FlowMetadataValue[] | Metadata values for the flow. This field is available in API version 31.0 and later. |
| processType | FlowProcessType (enumeration of type string) |
The type of the flow, as determined by the
active version, or the latest version, if there’s no active
version.
Valid values are:
Across flow versions, you can change the type only from Flow to AutoLaunchedFlow or vice versa. Before you change the flow type, make sure that the flow contains only elements, resources, and functionality that the new flow type supports. These values are reserved for future or Salesforce internal use.
This field is available in API version 31.0 and later. |
| recordCreates | FlowRecordCreate[] | An array of nodes for creating records in the database. |
| recordDeletes | FlowRecordDelete[] | An array of nodes for deleting records in the database. |
| recordLookups | FlowRecordLookup[] | An array of nodes for looking up records in the database. |
| recordRollbacks | FlowRecordRollback[] | An array of nodes for rolling back transactions in the screen flow. This field is available in API version 52.0 and later. |
| recordUpdates | FlowRecordUpdate[] | An array of nodes for updating records in the database. |
| runInMode | FlowRunInMode (enumeration of type string) | The context that the flow runs in. Valid values are:
This field is available in API version 48.0 and later. |
| screens | FlowScreen[] | An array of screen nodes. |
| segment | string | Reserved for future use. |
| stages | FlowStage[] | An array of stage resources that you can use throughout the flow. This field is available in API version 42.0 and later. |
| start | FlowStart | Represents the flow’s Start element, which specifies how and when the flow starts. This field is available in API version 47.0 and later. |
| startElementReference | string | Specifies which node or element is the starting point in the
flow. This field isn’t used in flows created or saved in Flow Builder in Winter ’20 and later. Those flows use the start field instead to specify how the flow starts. |
| status | FlowVersionStatus (enumeration of type string) | The activation status of the flow. Valid values are:
|
| steps | FlowStep[] | An array of step nodes. |
| subflows | FlowSubflow[] | An array of subflows. This field is available in API version 25.0 and later. |
| textTemplates | FlowTextTemplate[] | An array of text templates. |
| timeZoneSidKey | string | The ID that defines the time zone in which the flow runs. This field is available in API version 56.0 and later. |
| transforms (beta) | FlowTransform[] | An array of data transformations. This field is available in API version 59.0 and later. |
| triggerOrder | int | The run order of a record-triggered flow, from 1 to 2,000. See Guidelines for Defining the Run Order of Record-Triggered Flows for an Object in Salesforce Help. This field is available in API version 54.0 and later. |
| variables | FlowVariable[] | An array of variable definitions. |
| waits | FlowWait[] | An array of wait nodes. This field is available in API version 32.0 and later. |
FlowActionCall
Defines a call to an action from the flow. It extends FlowNode.
This metadata type is available in API version 31.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| actionName | string | Required. Name for the action. Must be unique across actions with the same actionType. |
| actionType | InvocableActionType (enumeration of type string) | Required. The
action type. Valid values are:
These values are used in the B2B Commerce Checkout Flow. If no version is specified, the value is available in API version 47.0 and later.
For values used in Business Rules Engine, see Flow for Business Rules Engine. These values are used in the Commerce Checkout Flow. If no version is specified, the value is available in API version 55.0 and later.
These values are used in Financial Services Cloud.
For values used in Fundraising for Nonprofit Cloud, see Flow for Fundraising. For values used in Health Cloud, see Flow for Health Cloud. For values used in Manufacturing Cloud, see Flow for Manufacturing Cloud. These values are used in Rebate Management.
These values are used in Loyalty Management.
These values are for Decision Table.
These values are for the Batch Management jobs.
This value is for Data Processing Engine.
This value is used for Einstein Visit Recommendation.
For values used in Intelligent Form Reader, see Flow for Intelligent Form Reader. For values used in Intelligent Document Reader, see Flow for Intelligent Document Reader. This value is used in Public Sector Solutions.
|
| connector | FlowConnector | Specifies which node to execute after this action call. |
| dataTypeMappings | FlowDataTypeMapping[] | An array of data type mappings for input and output values that have the generic sObject data type. This field is available in API version 48.0 and later. |
| faultConnector | FlowConnector | Specifies which node to execute if the action call results in an error. |
| flowTransactionModel | FlowTransactionModel (enumeration of type string) | Required. Specifies the transactional model for flows that
execute invocable actions. Valid values are:
|
| inputParameters | FlowActionCallInputParameter[] | An array of input parameters from the flow to the action. |
| nameSegment | string | Specifies the name of the versioned action. Supported only when nameSegment is specified. This field is available in API version 58.0 and later. |
| outputParameters | FlowActionCallOutputParameter[] | An array of output parameters from the action to the flow. |
| storeOutputAutomatically | boolean | Indicates whether the action’s output parameters are
automatically available in the flow without creating any variables.
When the value is true, you can
reference an output parameter by specifying the API name of the
Action element in the flow. The default value is false. When the value is false, create variables manually to
store output values from the action. This field is available in API version 48.0 and later. |
| versionSegment | int | Specifies the version of the versioned action. By default, the value is 1. Supported only when versionSegment is specified. This field is available in API version 58.0 and later. |
FlowActionCallInputParameter
Defines an input parameter from the flow to the action. It extends FlowBaseElement and inherits all its fields. This metadata type is available in API version 31.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| name | string | Required. Unique name for the input parameter. |
| value | FlowElementReferenceOrValue | Defines the value of the input parameter. |
FlowActionCallOutputParameter
Defines an output parameter from the action to the flow. It extends FlowBaseElement and inherits all its fields. This metadata type is available in API version 31.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| assignToReference | string | Required. Specifies the variable to which you want to assign the output parameter value. |
| name | string | Required. Unique name for the output parameter. |
FlowApexPluginCall
Defines a call to an Apex plug-in from the flow. It extends FlowNode and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| apexClass | string | Required. The name of the Apex class. |
| connector | FlowConnector | Specifies which node to execute after this Apex plug-in call. |
| faultConnector | FlowConnector | Specifies which node to execute if the Apex plug-in call results in an error. |
| inputParameters | FlowApexPluginCallInputParameter[] | An array of input parameters from the flow to the Apex plug-in. |
| outputParameters | FlowApexPluginCallOutputParameter[] | An array of output parameters from the Apex plug-in to the flow. |
FlowApexPluginCallInputParameter
Defines an input parameter from the flow to the Apex plug-in. It extends FlowBaseElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| name | string | Required. Unique name for the input parameter. |
| value | FlowElementReferenceOrValue | Defines the value of the input parameter. |
FlowApexPluginCallOutputParameter
Defines an output parameter from the Apex plug-in to the flow. It extends FlowBaseElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| assignToReference | string | Required. Specifies the variable to which you want to assign the output parameter value. |
| name | string | Required. Unique name for the output parameter. |
FlowAssignment
Defines an assignment node that can dynamically change the value of a variable in the flow. It extends FlowNode and inherits all of its fields.
| Field Name | Field Type | Description |
|---|---|---|
| assignmentItems | FlowAssignmentItem[] | An array of assignment operations that is executed in the given order, starting from the index 0. |
| connector | FlowConnector | Specifies which node to execute after this assignment node. |
FlowAssignmentItem
Defines an operation to apply to a variable. It extends FlowBaseElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| assignToReference | string | Required. Reference to the variable to which you want to apply the specified operator. |
| operator | FlowAssignmentOperator (enumeration of type string) | Required. Operation to apply to the variable reference in the assignToReference field. For valid values, see FlowAssignmentOperator. |
| value | FlowElementReferenceOrValue | Defines the value that you want the operator to apply to the variable reference in the assignToReference field. |
FlowAssignmentOperator
An enumeration of type string that specifies the operation to apply to the variable in the assignToReference field. See “Flow Operators in Assignment Elements” in Salesforce Help.
These values are valid.
| Enumeration Value | Description |
|---|---|
| Add | When the assignToReference field is a
variable of type number or currency, this operator adds the
value to the variable. When the assignToReference field is a variable of type date, this operator adds the value in days to the variable. When the assignToReference field is a variable of type string, this operator appends the value to the end of the string. When the assignToReference field is a variable of type picklist, this operator appends the value to the end of the last item in the picklist. When the assignToReference field is a variable of type multipicklist, this operator appends the value to the end of the last item in the multi-select picklist. To instead add an item to the end of the multi-select picklist, use the AddItem operator. When the assignToReference field is the $Flow.ActiveStages global variable, this operator appends the value as a new item at the end of $Flow.ActiveStages. When the assignToReference field is a collection variable, this operator appends the value to the end of the collection. Support for a collection variable as the value is available in API version 43.0 and later, but only via Metadata API. From Flow Builder, you can’t save an Assignment element that contains a collection variable in the Value column for the Add operator. The Add operator isn’t supported when the assignToReference field is a variable of type boolean, dateTime, or sObject. |
| AddAtStart | Supported only when the assignToReference field is a collection variable or the $Flow.ActiveStages global variable. Adds the value as a new item at the beginning of the collection. When the value is a collection variable, the operator adds all items at the beginning of the collection. This operator is available in API version 43.0 and later. |
| AddItem | Supported only when the assignToReference field is a variable of type multipicklist. Adds the value to the picklist, including the semicolon that’s required to mark a value as a separate item. This operator is available in API version 34.0 and later. |
| Assign | Assigns the value to the variable in the assignToReference field. |
| AssignCount | Supported only when the value is a collection variable or the $Flow.ActiveStages global variable. Counts the number of stages or items in the collection, and assigns that number to the variable in the assignToReference field. Corresponds to equals count in the user interface. This operator is available in API version 43.0 and later. |
| RemoveAfterFirst | Supported only when the assignToReference field is a collection variable or the $Flow.ActiveStages global variable. Finds the first instance of the value within the variable in the assignToReference field. Removes everything after that first instance from the variable. This operator is available in API version 43.0 and later. |
| RemoveAll | Supported only when the assignToReference field is a collection variable or the $Flow.ActiveStages global variable. Removes all instances of the value from the variable in the assignToReference field. When the value is a collection variable, the operator removes all instances of each item from the variable in the assignToReference field. This operator is available in API version 43.0 and later. |
| RemoveBeforeFirst | Supported only when the assignToReference field is a collection variable or the $Flow.ActiveStages global variable. Finds the first instance of the value within the variable in the assignToReference field. Removes everything before that first instance from the variable. This operator is available in API version 43.0 and later. |
| RemoveFirst | Supported only when the assignToReference field is a collection variable or the $Flow.ActiveStages global variable. Removes the first instance of the value from the variable in the assignToReference field. This operator is available in API version 43.0 and later. |
| RemovePosition | Supported only when the assignToReference
field is a collection variable or the
$Flow.ActiveStages global variable. Removes
the item at the specified position. For example, if the collection
contains three items, such as Red, Green, and Blue, and the
value is 2, the second item, Green, is
removed from the collection variable. This operator is available in
API version 43.0 and later. Make sure that the value at run time is a positive integer within the range of the number of items in the collection variable. |
| RemoveUncommon | Supported only when assignToReference and value are both collection variables. Keeps items that are in both collections and removes the rest from the collection variable in the assignToReference field. This operator is available in API version 43.0 and later. |
| Subtract | Supported only when the assignToReference
field is a variable of type currency, date, or number. When the assignToReference field is a variable of type number or currency, this operator subtracts the value from the variable. When the assignToReference field is a variable of type date, this operator subtracts the value in days from the variable. |
FlowChoice
A choice resource is a standalone choice option that you can reference or reuse throughout the flow. It extends FlowElement and inherits all of its fields.
| Field Name | Field Type | Description |
|---|---|---|
| choiceText | string | Required. Choice label to display in the screen. |
| dataType | FlowDataType (enumeration of type string) | Required. Valid types are:
|
| userInput | FlowChoiceUserInput | Enables the choice to allow user input when the choice is selected. Not supported for choices in multi-select fields. |
| value | FlowElementReferenceOrValue | Actual value that’s used during flow execution, for example, in assignments, calls to Apex plug-ins, and record elements. If null, this choice always has the value of null. |
FlowChoiceUserInput
Allows the choice to include a user input field that appears when the choice is selected by the user. User input isn’t supported for choices in multi-select fields. It extends FlowBaseElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| isRequired | boolean | Indicates whether users are required to enter something into the field when they select the choice. |
| promptText | string | Text that is displayed to prompt the user for input at runtime. Supports merge fields. |
| validationRule | FlowInputValidationRule | A rule used at runtime to validate the user input. |
FlowCollectionProcessor
Defines a node that processes the contents of a collection, depending on the collectionProcessorType. FlowCollectionProcessor is available in API version 50.0 and later. FlowCollectionProcessor extends FlowNode and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| assignNextValueToReference | string | The name of the variable assigned to the next value of the collection. |
| collectionProcessorType | FlowCollectionProcessorType | The type of the collection processor. Valid values are:
|
| collectionReference | string | The collection being sorted, filtered, or assigned to recommendations. |
| conditionLogic | string | Defines how the filtering conditions are evaluated. Valid values are:
|
| conditions | FlowCondition[] | An array of conditions for the input collection. |
| connector | FlowConnector | Specifies which node to execute after processing the collection. |
| formula | string | The formula expression that filters the input collection. If the formula evaluates to true, the record is added to the output collection. |
| limit | int | The maximum number of records to include in the generated
collection. There’s no default value. All items of the collection
are kept if it’s greater than the size of the collection. If sortField and sortOrder are also specified, the records are sorted before the limit takes effect. This field is available in API version 51.0 and later. This field is nillable in API version 51.0 and later. |
| mapItems | FlowCollectionMapItem[] | The rules to map each field of the collection variable. |
| outputSObjectType | string | The sObject type of the output collection. |
| sortOptions | FlowCollectionSortOption[] | An array of options to sort the items in the collection. This field is available in API version 51.0 and later. |
FlowCollectionSortOption
Sets the sorting field, sort order, and placement of empty or null values in the sorted collection. This metadata type is available in API version 51.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| doesPutEmptyStringAndNullFirst | boolean | Indicates whether to put empty or null values first in the sorted list (true) or not (false). The default value is false. |
| sortField | string | Determines the sorting of records that meet the filter criteria.
Required for record collections and collections of Apex-defined
variables. If the collection is a primitive data type, such as a list of string or integer values, sortField isn’t supported. |
| sortOrder | SortOrder (enumeration of type string) | The order in which the collection is sorted. Valid values are:
|
FlowCondition
Defines a condition for a rule. It extends FlowBaseElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| conditionType | FlowWaitConditionType (enumeration of type string) | The type of condition that a requirement in an orchestration is
used for. Valid values are:
|
| leftValueReference | string | Required. Unique name of the element that serves as the left side of the condition expression. |
| operator | FlowComparisonOperator (enumeration of type string) | Required. Comparison operators in conditions for flow elements
and resources. Valid values are:
|
| rightValue | FlowElementReferenceOrValue | Unique name of an element or the actual value, such as text or a number, for the right side of the condition expression. |
FlowConnector
Connectors determine the order in which the nodes of the flow are executed. A connector defines and links to the subsequent node. It extends FlowBaseElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| targetReference | string | Required. Which node to execute after completing the current node. |
FlowCollectionMapItem
Defines the rule to assign a value to the field reference. This metadata type is available in API version 51.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| assignToFieldReference | string | Required. Specifies the reference to the field to which the specified operator is applied. |
| operator | FlowAssignmentOperator (enumeration of type string) | Required. Applies to the variable reference in the assignToFieldReference field. |
| value | FlowElementReferenceOrValue | Required. Defines the value that the operator applies to the variable reference in the assignToFieldReference field. |
FlowDataTypeMapping
This data type mapping defines the specific sObject data type for input and out values that have the generic sObject data type. It extends FlowBaseElement and inherits all its fields. This metadata type is available in API version 48.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| typeName | string | Required. API name of the input or output variable. The T__ prefix is required for input variables. The U__ prefix is required for output variables. For example, T__inputCollection represents the API name of the input variable inputCollection. |
| typeValue | string | Required. API name of the specific sObject data type that this value maps to. For example, Account. |
FlowConstant
A constant resource defines a fixed value that can be used throughout your flow. It extends FlowElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| dataType | FlowDataType (enumeration of type string) | Required. Valid types are:
|
| value | FlowElementReferenceOrValue | Default value of the constant. This field can’t have merge fields, nor can it reference another resource besides $GlobalConstant.EmptyString. |
FlowDecision
Decision node that evaluates a set of rules and routes the flow execution based on the first rule that evaluates to true. It extends FlowNode and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| defaultConnector | FlowConnector | Specifies which node to execute if none of the rules evaluate to true. |
| defaultConnectorLabel | string | Label for the default connector. |
| rules | FlowRule[] | An array of rules for the decision. The rules are evaluated in the order that they’re listed, and the connector of the first true rule is used. If no rules are true, then the default connector is used. In Flow Builder, rules are referred to as decision outcomes. |
FlowDynamicChoiceSet
Looks up data or metadata from an object and dynamically generates a set of choices at run time. It extends FlowElement and inherits all its fields. Depending on the fields that are set, this element represents a record choice or a picklist choice.
- A record choice dynamically generates choices based on records that meet specified filter criteria. If a dynamic choice doesn’t have the picklistField and picklistObject parameters set, it’s a record choice and it can’t have a data type of Picklist or Multipicklist.
- A picklist choice dynamically generates choices based on the available values for a picklist or multi-select picklist field. If a dynamic choice has the picklistField and picklistObject parameters set, it’s a picklist choice and it must have a data type of Picklist or Multipicklist.
| Field Name | Field Type | Description |
|---|---|---|
| collectionReference | string | The collection used to generate choices. This field is available in API version 54.0 and later. |
| dataType | FlowDataType (enumeration of type string) | Required. Valid types are:
Picklist and Multipicklist are available in API version 35.0 and later. Record is available in API version 54.0 and later. |
| displayField | string | Required for record choices. Specifies the object field. The
values of the object field are displayed to the user as choice
labels for selecting a record. For example, for an account, if you want the dynamically generated choices to be displayed as the account names from the records that are retrieved from the database, specify Name in displayField. Not supported for picklist choices. Picklist choices always display the labels for the retrieved picklist values. |
| filters | FlowRecordFilter[] | An array of filters to apply to the records retrieved from the
database. For example, filter accounts to include only the accounts
that were created in the past three months. Not supported for picklist choices. |
| limit | int |
Maximum number of choices to include in
the generated set of choices. Maximum and default:
200. If sortField and sortOrder are also specified, the records are sorted before the limit takes effect. This field is available in API version 25.0 and later. This field is nillable in API version 45.0 and later. |
| object | string | Required for record choices. The object whose fields you want to
retrieve from the database and use to generate the set of choices.
For example, use “Account” to dynamically generate
choices from the information in account records in the
database. Not supported for picklist choices. |
| outputAssignments | FlowOutputFieldAssignment[] | An array that assigns fields from the user-selected record to
variables that can be used elsewhere in the flow. For example, when
the user selects an account name from the dynamically generated list
of choice options, outputAssignments can assign the ID and
AnnualRevenue from the user-selected account to variables that you
specify. Not supported for picklist choices. |
| picklistField | string |
Required for picklist choices. The
field whose available values you want to retrieve from the
database and use to generate the picklist choice. For example,
use “Industry” to dynamically generate one choice for each
available value on the Industry picklist field.
Not supported for record choices. This field is available in API version 35.0 and later. |
| picklistObject | string |
Required for picklist choices. The
object whose field metadata you want to retrieve from the
database and use to generate the picklist choice. For example,
use “Account” to dynamically generate choices from a picklist
field on the Account object. Not supported for record choices. This field is available in API version 35.0 and later. |
| sortField | string |
Field that’s used for sorting
records that meet the filter criteria. If this field isn’t
specified, the returned records aren’t sorted. You can only sort records by fields that have the Sort API field property, as specified in SOAP API. Not supported for picklist choices. This field is available in API version 25.0 and later. |
| sortOrder | SortOrder (enumeration of type string) |
Order in which to sort the records.
If this field isn’t specified, then the results aren’t
sorted.
Not supported for picklist choices. This field is available in API version 25.0 and later. |
| valueField | string | Stored value for the choice, which can differ from what is
displayed to the user as the choice options
(displayField). For example, the
displayField could be the account “Name”
while the valueField is the account “Id.” Not supported for picklist choices. Picklist choices always store the API value for the retrieved picklist values. |
FlowElement
Base class for all flow elements. This class is an abstract class. It extends FlowBaseElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| description | string | Description of the flow element. |
| name | string | Unique name of the flow element. |
FlowBaseElement
Base class for all flow elements that require contextual information in metadata values. This class is an abstract class. FlowBaseElement is available in API version 32.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| processMetadataValues | FlowMetadataValue[] | Contextual information for the element. |
FlowMetadataValue
Defines contextual information that can be passed between elements in a flow. Flow metadata values can be used in an application that produces or consumes flows. FlowMetadataValue is available in API version 31.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| name | string | Required. Name for the metadata value. This name doesn’t need to be unique across all elements. |
| value | FlowElementReferenceOrValue | Reference or value for the metadata value. |
FlowElementReferenceOrValue
Defines a reference to an existing element or a particular value that you specify. Make sure that you specify only one of the fields.
| Field Name | Field Type | Description |
|---|---|---|
| apexValue | string | Use this field to specify a JSON response value of an Apex-defined record. Use this field only for FlowScreenFieldInputParameter and FlowActionCallInputParameter. If you want to specify a different data type or element reference, don’t use this field. |
| booleanValue | boolean | Use this field to specify a boolean value. If you want to specify a different data type or element reference, don’t use this field. |
| dateTimeValue | dateTime | Use this field to specify a dateTime value. If you want to specify a different data type or element reference, don’t use this field. This field is available in API version 30.0 and later. |
| dateValue | date | Use this field to specify a date value. If you want to specify a different data type or element reference, don’t use this field. |
| elementReference | string | Use this field to specify the name of an existing element. If you want to specify a value instead of an element reference, don’t use this field. |
| formulaDataType (beta) | FlowDataType (enumeration of string) | Use this field to specify the formula result’s data type of the
transformed data. Corresponds to the target data field in Flow
Builder. This field requires the
formulaExpression field. This field is
available in API version 59.0 and later. See FlowTransform (Beta) Valid values are:
|
| formulaExpression (beta) | string | Use this field to specify the formula expression that transforms the data in flow. In Flow Builder, it corresponds to the target data field in the Transform element. This field requires the formulaDataType field. This field is available in API version 59.0 and later. See FlowTransform (Beta). |
| numberValue | double | Use this field to specify a double value. If you want to specify a different data type or element reference, don’t use this field. |
| setupReference | string | Use this field to specify the name of an existing setup reference. Required for Omni-Channel elements. If you want to specify a value instead of a setup reference, don’t use this field. Required when setupReferenceType is specified. |
| setupReferenceType | string | Use this field to specify the type of setup reference. Required when setupReference is specified. |
| sobjectValue | string | Use this field to specify a JSON response value of an sObject record. Use this field only for FlowScreenFieldInputParameter and FlowActionCallInputParameter. If you want to specify a different data type or element reference, don’t use this field. |
| stringValue | string | Use this field to specify a string value. If you want to specify a different data type or element reference, don’t use this field. |
FlowFormula
Calculates a value using functions and elements in the flow. It extends FlowElement and inherits all its fields.
FlowInputFieldAssignment
Assigns the value for a record field based on a resource or static value. It extends FlowBaseElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| field | string | Required. Name of the field to be assigned a value while a record is being created or updated. |
| value | FlowElementReferenceOrValue | Value to be assigned to the field. |
FlowInputValidationRule
Validation rules verify that the data entered by the user meets the specified requirements. If the validation rule evaluates to false, then the specified error message is displayed.
FlowLoop
A construct for iterating through a collection. It extends FlowNode and inherits all its fields. FlowLoop is available in API version 30.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| assignNextValueToReference | string | The variable assigned to the current value in the collection before navigating to the target of nextValueConnector. |
| collectionReference | string | Required. The collection being looped through. |
| iterationOrder | iterationOrder (enumeration of type string) | Valid values are:
|
| nextValueConnector | FlowConnector | Points to the element that the flow navigates to for each of the entries in the collection. Where the flow goes for the next value in the collection. |
| noMoreValuesConnector | FlowConnector | Points to the element to navigate to when all entries in the collection have been looped through. |
FlowNode
A node is a type of element that’s visible in the flow diagram. It extends FlowElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| elementSubtype | FlowElementSubtype (enumeration of type string) | Reserved for internal use. |
| label | string | Name of the node. This non-unique label is different from the unique name of the node, which is inherited from FlowElement. |
| locationX | int | Required. Horizontal location of the node, in pixels from the left. |
| locationY | int | Required. Vertical location of the node, in pixels from the top. |
FlowOrchestratedStage
A stage node that contains steps in an orchestration. It extends FlowNode and inherits all its fields. This metadata type is available in API version 53.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| connector | FlowConnector | Specifies which node to execute after this stage. |
| exitActionInputParameters | FlowStageStepExitActionInputParameter[] | An array of input parameters from the stage to the evaluation flow used as an exit condition for the stage. |
| exitActionName | string | Name of the evaluation flow used as an exit condition for the
stage. Valid values are:
|
| exitActionOutputParameters | FlowStageStepExitActionOutputParameter[] | An array of output parameters from the evaluation flow to the stage used as an exit condition for the stage. |
| exitActionType | InvocableActionType (enumeration of type string) | The type of the evaluation flow for the custom exit condition.
Valid values are:
|
| exitConditionLogic | string | Defines how the stage exit conditions are evaluated. Valid values are:
|
| exitConditions | FlowCondition[] | An array of requirements to be met for exiting the stage. |
| faultConnector | FlowConnector | Reserved for future use. |
| runAsUser | boolean | Indicates whether an asynchronous background step is run in the context of the user who completed the most recently completed interactive step. |
| stageSteps | FlowStageStep[] | An array of stage step resources. |
FlowOutputFieldAssignment
Assigns a record field’s value from a record to a variable that can be used elsewhere in the flow. The record could be selected by a record lookup or via a user selection for a choice. It extends FlowBaseElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| assignToReference | string | Required. Reference to the variable where you want to store the value of the record field. |
| field | string | Required. Name of the field whose value is to be assigned after a record lookup. |
FlowRecordCreate
Create a record in the database using values from the flow. It extends FlowNode and inherits all its properties.
| Field Name | Field Type | Description |
|---|---|---|
| assignRecordIdToReference | string | Reference to the variable where you want to store the ID after the record is created. |
| connector | FlowConnector | Specifies which node to execute after creating the record. |
| faultConnector | FlowConnector | Specifies which node to execute if the attempt to create a record results in an error. |
| inputAssignments | FlowInputFieldAssignment[] | An array that assigns values to the specified fields of the record being created. |
| inputReference | string | Specifies the record variable whose field values are used to populate the new record’s fields. |
| object | string | Required. Object for the record to be created by this element |
| storeOutputAutomatically | boolean | Indicates whether the record ID is automatically available in the
flow without creating any variables. When the value is true, you can reference the record
ID by specifying the API name of the Create Records element in the
flow. The default value is false. When the value is false, create a variable to store the record
ID. This field is available in API version 48.0 and later. |
FlowRecordDelete
Deletes one or more records in the database. It extends FlowNode and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| connector | FlowConnector | Specifies which node to execute after deleting the record. |
| faultConnector | FlowConnector | Specifies which node to execute if the attempt to delete a record results in an error. |
| filters | FlowRecordFilter[] | An array that specifies the criteria used to select which records to delete from the database. For example, delete accounts whose last activity was older than a specified date. |
| inputReference | string | Specifies the record variable whose record ID is used to identify which record to delete in the database. |
| object | string | Required. The name of the object whose records are deleted. |
FlowRecordFilter
Sets the criteria for searching records in the database. It extends FlowBaseElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| field | string | Required. The field to be used for filtering records. |
| operator | FlowRecordFilterOperator (enumeration of type string) | Required. Valid values are:
|
| value | FlowElementReferenceOrValue | Reference or value used with the field and operator to filter records. |
FlowRecordLookup
Finds records in the database and stores their field values in the flow. Corresponds to a Get Records element in Flow Builder. It extends FlowNode and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| assignNullValuesIfNoRecordFound | boolean | Specifies that all values are set to null when no record is found. Supported only when
storeOutputAutomatically is false. This field is available in API version 30.0 and later. |
| connector | FlowConnector | Specifies which node to execute after getting records from the database. |
| faultConnector | FlowConnector | Specifies which node to execute if the attempt to get records results in an error. |
| filterLogic | string | The filter logic applied to the filter condition requirements. To require all conditions, use AND. To require any conditions, use OR. For custom condition logic, enter the entire logic string. For example, 1 AND 2 OR (3 AND 4). This field is available in API version 50.0 and later. |
| filters | FlowRecordFilter[] | An array that specifies the criteria used to select the record
from the database. If the filters return more than one record, they’re sorted according to the specified sortField and sortOrder. If outputReference specifies a non-collection record variable or if getFirstRecordOnly is true, only the first record in the sorted list is selected. If sortField or sortOrder isn’t specified, records aren’t returned in any particular order. If outputReference specifies a non-collection record variable or if getFirstRecordOnly is true, only the first record in the unsorted list is selected. |
| getFirstRecordOnly | boolean | Indicates whether to store field values for only one record, even
when multiple records meet the filter criteria. Supported only when
storeOutputAutomatically is true. When
storeOutputAutomatically is false, what determines whether one
or multiple records are stored is whether
outputReference specifies a record variable
or a record collection variable. This field is available in API version 47.0 and later. |
| limit | int | The maximum number of records to return, to limit the amount of data received. This field is available in API version 30.0 and later. |
| object | string | Required. Name of the object from which to select the record. |
| outputAssignments | FlowOutputFieldAssignment[] | An array that assigns fields from the selected record to variables that can be used elsewhere in the flow. Supported only when storeOutputAutomatically is false. |
| outputReference | string | Specifies the record variable or record collection variable that stores the queried fields’ values. Supported only when storeOutputAutomatically is false. |
| queriedFields | string[] | An array that specifies which fields from the selected record are saved to the specified record variable. |
| sortField | string | Field that’s used for sorting the records that meet the filter
criteria. If this field isn’t specified, the returned records aren’t
sorted. You can only sort records by fields that have the Sort API field property, as specified in SOAP API. This field is available in API version 25.0 and later. |
| sortOrder | SortOrder (enumeration of type string) | Order in which to sort the records. If this field isn’t
specified, then the results aren’t sorted. Valid values are:
This field is available in API version 25.0 and later. |
| storeOutputAutomatically | boolean | Indicates whether the returned records’ field values are
automatically available in the flow without creating any variables.
When the value is true, the
flow can reference a field by specifying the
name of the Get Records element and the
record field, such as Get_Contacts.AccountId. Supported only when
processType is Flow or AutoLaunchedFlow. This field is available in API version 47.0 and later. |
FlowRecordRollback
Rolls back the current transaction and cancels its pending record changes. Corresponds to the Roll Back Records element in Flow Builder. Available only in screen flows.
FlowRecordRollback extends FlowNode and inherits all its fields. This metadata type is available in API version 52.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| connector | FlowConnector | Specifies which node to execute after rolling back the current transaction. |
FlowRecordUpdate
Finds records in the database and updates them with values from the flow. It extends FlowNode and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| connector | FlowConnector | Specifies which node to execute after completing the record update. |
| faultConnector | FlowConnector | Specifies which node to execute if the attempt to update a record results in an error. |
| filters | FlowRecordFilter[] | An array that specifies the criteria used to select the records to update in the database. |
| inputAssignments | FlowInputFieldAssignment[] | An array that assigns values to the specified fields of the record being updated. |
| inputReference | string | Specifies the record variable whose field values are used to update the record’s fields. |
| object | string | Required. Name of the object whose records are updated. |
FlowRule
Defines the conditions and logic that would enable a rule to evaluate to true. It extends FlowElement and inherits all of its fields.
| Field Name | Field Type | Description |
|---|---|---|
| conditionLogic | string | Specifies logic for the conditions. Value can be:
|
| conditions | FlowCondition[] | An array of conditions for the rule. |
| connector | FlowConnector | Specifies which node to execute if this rule evaluates to true in a decision first. |
| doesRequireRecordChangedToMeetCriteria | boolean | If set to true, conditions evaluate to true only if the record didn’t meet the required conditions before the triggering update but now meets the conditions after the update. This field is available in API version 50.0 and later. |
| label | string | Required. Label for the connector. |
FlowSchedule
Specifies when and how frequently to run the flow. This metadata type is available in API version 47.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| frequency | FlowStartFrequency (enumeration of type string) | Specifies how frequently to run the flow. Valid values are:
|
| startDate | date | The date when the flow runs, or when the flow’s run schedule starts recurring. |
| startTime | time | The time of day when the flow runs, based on the org’s default time zone. |
FlowScheduledPath
Defines a scheduled path. It extends FlowElement and inherits all its fields. This metadata type is available in API version 51.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| connector | FlowConnector | Specifies which node to execute after this scheduled path. |
| label | string | Label for the scheduled path. |
| maxBatchSize | int | The maximum number of scheduled path interviews to execute in a single batch, from 1 to 200. Default is 200. |
| offsetNumber | int | Number of months, days, hours, or minutes to offset the time that the scheduled path executes. Negative values offset the time to execute before the provided time. Positive values offset the time to execute after the provided time. |
| offsetUnit | FlowScheduledPathOffsetUnit (enumeration of type string) | Specify the time unit used to offset when the scheduled path
executes. Possible values are:
|
| pathType | FlowScheduledPathType (enumeration of type string) | The type of scheduled path. null is used for time-triggered and record-triggered
paths. The default value is null.
|
| recordField | string | Field used to determine when the scheduled path executes. The field’s object is defined in FlowStart. |
| timeSource | FlowScheduledPathTimeSource (enumeration of type string) | Specify if a field or event is used to determine when the
scheduled path executes. Possible values are:
|
FlowScreen
Screens capture information from users and display information to users. It extends FlowNode and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| allowBack | boolean | Indicates whether to show (true) or hide (false) the Previous button on
the screen at runtime. When true, the
Previous button appears only if the user
visited a previous screen in the flow path and if
showFooter for the screen is set to true. Set this field to false when
revisiting the previous screen triggers an action that you don’t
want repeated, such as a credit card transaction. This field is available in API version 26.0 and later. Default: true You can set either allowBack or allowFinish to false, but not both. |
| allowFinish | boolean | Indicates whether to show (true) or hide (false) the Finish button on the
screen at runtime. When true,
the Finish button appears only if the screen
element is the end of a flow path, and if
showFooter for the screen is set to true. The default value is true. Set to false if user is required to go back to a previous screen to continue or complete the flow. For example, don’t include a Finish button on a screen that tells the user to go back and make corrections on a previous screen. You can set allowBack or allowFinish to false, but not both. This field is available in API version 26.0 and later. |
| allowPause | boolean |
Indicates whether to show (true) or hide (false) the
Pause button on the screen at
runtime. The default value is true.
A flow screen displays the Pause button if all these conditions are true.
This field is available in API version 33.0 and later. |
| backButtonLabel | string | A label for the Back button. |
| connector | FlowConnector | Specifies which node to execute after the screen node. |
| fields | FlowScreenField[] | An array of fields to display on the screen. |
| helpText | string | Text that appears if the end user clicks a link for help
text. Supports merge fields in API version 26.0 and later. |
| nextOrFinishButtonLabel | string | A label for the Next or Finish button. |
| pauseButtonLabel | string | A label for the Pause button. |
| pausedText | string |
Confirmation message that appears
when an end user clicks
Pause. This field is available in API version 33.0 and later. |
| rules | FlowScreenRule[] | Reserved for future use. |
| boolean |
The footer includes navigation actions for the screen. If showFooter is hidden, use Lightning components on the screen to show navigation actions. This field is available in API version 42.0 and later. |
|
| showHeader | boolean |
Indicates whether to show (true) or hide (false) the screen’s header at
Lightning runtime. Classic runtime isn’t supported. The
default value is true. The header includes access to help text for the screen. If showHeader is hidden, use Lightning components on the screen to show help text. This field is available in API version 42.0 and later. |
FlowScreenField
Represents a screen component. FlowScreenField extends FlowElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| choiceReferences | string[] | An array of references to FlowChoices or FlowDynamicChoiceSets.
The resulting choice options appear in the order specified in this
array, where the element at index 0 provides the top-most choice
option. Supported for these types of screen components.
Multi-select checkboxes and multi-select picklist fields are available in API version 26.0 and later. |
| dataType | FlowDataType (enumeration of type string) | Data type of the screen component. Only supported for the
InputField, RadioButtons, and DropdownBox types of screen
components. Valid data types are:
Boolean input fields, which appear as checkbox fields at runtime, are available in API version 26.0 and later. Only the string data type is supported for multi-select checkboxes and multi-select picklist fields. Multi-select fields are available in API version 26.0 and later. Date/time input fields are available in API version 43.0 and later. |
| dataTypeMappings | FlowDataTypeMapping[] | Reserved for future use. |
| defaultSelectedChoiceReference | string | The name of the FlowChoice element to use as the default value
for the screen component. Supported for these types of screen components.
For DropdownBox field types only, if defaultSelectedChoiceReference is empty or null, the reference at index 0 of choiceReferences is used as the default value. You can specify only one FlowChoice element as the default value for multi-select checkboxes and multi-select picklist fields. Multi-select fields are available in API version 26.0 and later. |
| defaultValue | FlowElementReferenceOrValue | The value that is used by default when the screen component requires users to provide input. Only supported for InputField, LargeTextArea, and PasswordField. |
| extensionName | string | The name of the Lightning component to display. This field is available in API version 42.0 and later. |
| fields | FlowScreenField[] | An array of columns to display in a section, or an array of fields to display in a column. This field is available in API version 49.0 and later. |
| fieldText | string | Field label that is displayed on the screen. Supports merge fields. |
| fieldType | FlowScreenFieldType (enumeration of type string) | Required. The type of field to display on a flow screen. Valid
values are:
At runtime, each multi-select field stores its field value as a concatenation of the user-selected choice values, separated by semicolons. Any semicolons in the selected choice values are removed when added to the multi-select field value. |
| helpText | string | Text that appears if the end user clicks the help icon ( ) for the screen component. Supports merge fields in API version 26.0 and later. |
| inputParameters | FlowScreenFieldInputParameter[] | An array of input parameters. Supported only when fieldType is ComponentInstance. This field is available in API version 42.0 and later. |
| inputsOnNextNavToAssocScrn | FlowScreenFieldInputsRevisited (enumeration of type string) | Controls whether the flow remembers the input value if the user
moves to any screen and then returns to the screen component. Valid
values are:
The default value is UseStoredValues. Applies to screen components in API version 51.0 and later and to record fields on flow screens in API version 57.0 and later. |
| isRequired | boolean | Indicates whether the user must select a choice or provide input. Not supported for DisplayText or boolean inputField. |
| isVisible | boolean | Reserved for future use. |
| objectFieldReference | string | Specifies the Salesforce object field for an ObjectProvided field. |
| outputParameters | FlowScreenFieldOutputParameter[] | An array of output parameters. Supported only when
fieldType is ComponentInstance and when
storeOutputAutomatically is false. This field is available in API version 42.0 and later. |
| regionContainerType | FlowRegionContainerType (enumeration of type string) | Stores information about a section component header. Possible
values include:
Available only when the component type is Section. This field is available in API version 55.0 and later. |
| scale | int | 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 flow runs. Available only when the data type is Number or Currency. Corresponds to the Decimal Places field in Flow Builder. |
| storeOutputAutomatically | boolean | Indicates whether the screen component’s output parameters are
automatically available in the flow without creating any variables.
When the value is true, you can
reference an output parameter by specifying the
name of the screen component and the output
parameter, such as Mailing_Address.City. Supported only when fieldType is ComponentInstance. This field is available in API version 47.0 and later. |
| validationRule | FlowInputValidationRule | A rule used to validate the user input when the screen component is of type InputField, LargeTextArea, or PasswordField. |
| visibilityRule | FlowVisibilityRule | A rule based on conditions that is used to render or hide the
screen component. This field is available in API version 47.0 and later. |
FlowScreenFieldInputParameter
Defines an input parameter from the flow to the extension. It extends FlowBaseElement and inherits all its fields. FlowScreenFieldInputParameter is available in API version 42.0.
| Field Name | Field Type | Description |
|---|---|---|
| name | string | Required. Unique name for the input parameter. |
| value | FlowElementReferenceOrValue | Defines the value of the input parameter. |
FlowScreenFieldOutputParameter
Defines an output parameter from the extension to the flow. It extends FlowBaseElement and inherits all its fields. FlowScreenFieldOutputParameter is available in API version 42.0.
| Field Name | Field Type | Description |
|---|---|---|
| assignToReference | string | Required. Specifies the variable to which you want to assign the output parameter value. |
| name | string | Required. Unique name for the output parameter. |
FlowStage
A section of your flow that can be represented in the UI, such as with breadcrumbs. It extends FlowElement and inherits all its fields.
When an interview starts, any stages where isActive is true are added to the $Flow.ActiveStages global variable, which holds a collection of stages. Each stage’s stageOrder determines the order they’re added in. The stage with the lowest stageOrder is assigned to the $Flow.CurrentStage global variable.
| Field Name | Field Type | Description |
|---|---|---|
| isActive | boolean | Indicates whether the stage is active by default. |
| label | string | A user-friendly label for this stage. |
| stageOrder | int | Indicates how the stage is ordered against other stages. The stageOrder value must be unique within the flow. |
FlowStageStep
A step resource defines a step within a stage node. This metadata type is available in API version 53.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| actionName | string | Required. Name of the flow associated with the step. |
| actionType | InvocableActionType (enumeration of type string) | Required. The type of the step. Valid values are:
|
| assignees | FlowStageStepAssignee[] | An array of users, groups, or queues assigned to complete the interactive step. |
| entryActionInputParameters | FlowStageStepEntryActionInputParameter[] | An array of input parameters from the step to the evaluation flow used as an entry condition for the step. |
| entryActionName | string | Name of the evaluation flow used as an entry condition for the step. |
| entryActionOutputParameters | FlowStageStepEntryActionOutputParameter[] | An array of output parameters from the evaluation flow to the step used to determine if the step can be started. |
| entryActionType | InvocableActionType (enumeration of type string) | The type of the evaluation flow used as a custom entry condition
for the step. Valid values are:
|
| entryConditionLogic | string | Defines how the entry requirements for a step are evaluated.
Valid values are:
|
| entryConditions | FlowCondition[] | An array of requirements to be met for starting the step. |
| exitActionInputParameters | FlowStageStepExitActionInputParameter[] | An array of input parameters from the step to the evaluation flow used as an exit condition for the step. |
| exitActionName | string | Name of the evaluation flow used as an exit condition for the step. |
| exitActionOutputParameters | FlowStageStepExitActionOutputParameter[] | An array of output parameters from the evaluation flow to the step used to determine if the step meets its exit criteria. |
| exitActionType | InvocableActionType (enumeration of type string) | The type of the evaluation flow used as a custom exit condition
for the step. Valid values are:
|
| exitConditionLogic | string | Defines how the exit requirements for an interactive step are
evaluated. Valid values are:
|
| exitConditions | FlowCondition[] | An array of requirements to be met for exiting an interactive step. |
| inputParameters | FlowStageStepInputParameter[] | An array of input parameters from the step to its associated flow. |
| label | string | Required. The label for the step. |
| outputParameters | FlowStageStepOutputParameter[] | An array of output parameters from a flow to its associated step. |
| requiresAsyncProcessing | boolean | Indicates whether the background step is processed asynchronously. |
FlowStageStepAssignee
An assignee associated with an Interactive step. Applicable only for interactive steps. This metadata type is available in API version 53.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| assignee | FlowElementReferenceOrValue | Required. Names of the user, group, or queue assigned to the interactive step. |
| assigneeType | FlowStageStepAssigneeType (enumeration of type string) | Required. The type of the assignee associated with the
interactive step. Valid values are:
|
FlowStageStepEntryActionInputParameter
Defines an input parameter from the step to its associated evaluation flow. It extends FlowBaseElement and inherits all its fields. This metadata type is available in API version 53.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| name | string | Required. Unique name for the input parameter of the evaluation flow used by a step as an entry condition. |
| value | FlowElementReferenceOrValue | Defines the value of the input parameter of the evaluation flow used by a step as an entry condition. |
FlowStageStepEntryActionOutputParameter
Defines an output parameter from an evaluation flow used to determine if the step meets entry criteria. It extends FlowBaseElement and inherits all its fields. This metadata type is available in API version 53.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| assignToReference | string | Reserved for future use. |
| name | string | Required. Unique name for the output parameter of the evaluation
flow used by a step as an entry condition. Valid values are:
|
FlowStageStepExitActionInputParameter
Defines an input parameter from the stage or step to its associated evaluation flow. It extends FlowBaseElement and inherits all its fields. This metadata type is available in API version 53.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| name | string | Required. Unique name for the input parameter of the evaluation flow used by a stage or step as an exit condition. |
| value | FlowElementReferenceOrValue | Defines the value of the input parameter of the evaluation flow used by a stage or step as an exit condition. |
FlowStageStepExitActionOutputParameter
Defines an output parameter from an evaluation flow used to determine if the stage or step meets exit criteria. It extends FlowBaseElement and inherits all its fields. This metadata type is available in API version 53.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| assignToReference | string | Reserved for future use. |
| name | string | Required. Unique name for the output parameter of the evaluation
flow used by a stage or step as an exit condition. Valid values are:
|
FlowStageStepInputParameter
Defines an input parameter from the step to the flow. It extends FlowBaseElement and inherits all its fields. This metadata type is available in API version 53.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| name | string | Required. Unique name for the input parameter for a flow associated with the step. |
| value | FlowElementReferenceOrValue | Defines the value of the input parameter of the flow associated with a step. |
FlowStageStepOutputParameter
Defines an output parameter from the step to the flow. It extends FlowBaseElement and inherits all its fields. This metadata type is available in API version 53.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| assignToReference | string | Reserved for future use. |
| name | string | Required. Unique name for the output parameter for a flow associated with the step. |
FlowStart
Represents the flow’s Start element, which specifies how the flow starts. In an autolaunched flow, the Start element also defines when and how frequently to run the flow. To run the flow only for specific records, the Start element can define filter criteria.
FlowStart extends FlowNode and inherits all its fields except name and label. This metadata type is available in API version 47.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| connector | FlowConnector | Specifies which element to execute first. |
| doesRequireRecordChangedToMeetCriteria | boolean | If set to true, conditions evaluate to true only if the record didn’t meet the required conditions before the triggering update but now meets the conditions after the update. This field is available in API version 50.0 and later. |
| filterFormula | string | A formula used to filter what records execute the flow during a save. Available only in record-triggered flows. This field is available in API version 55.0 and later. |
| filterLogic | string | The filter logic applied to the filter condition requirements. To require all conditions, use AND. To require any conditions, use OR. For custom condition logic, enter the entire logic string, for example 1 AND 2 OR (3 AND 4). This field is available in API version 50.0 and later. |
| filters | FlowRecordFilter[] | An array of filters to apply when retrieving records from the database. For example, filter accounts to include only the records that haven’t been updated in the last 4 weeks. |
| form | string | Required only for form-triggered flows. The content key value for the form used to trigger the flow. This field is available in API version 59.0 and later. |
| object | string | The object whose records you want to retrieve from the database. A flow interview starts for each record that meets the filter conditions. |
| recordTriggerType | RecordTriggerType (enumeration of type string) | Specifies what type of record changes can start the flow.
Possible values are:
Available only when triggerType is RecordBeforeSave. This field is available in API version 48.0 and later. |
| schedule | FlowSchedule | Required when triggerType is Scheduled. Specifies when and how frequently the flow runs. |
| scheduledPaths | FlowScheduledPath[] | Specifies the flow’s scheduled paths. This field is available in API version 51.0 and later. |
| segment | string | The segment used to trigger the flow. This field is available in API version 56.0 and later. |
| TimeZoneSidKey | string | Reserved for future use. |
| triggerType | FlowTriggerType (enumeration of type string) | Specifies what causes the flow to run. If you exclude this field,
the flow has no trigger and starts only when a user or app launches
the flow. Possible values are:
Available only when processType is AutoLaunchedFlow. This field is available in API version 47.0 and later. |
FlowStep
Steps function as placeholders when you’re building a flow. It extends FlowNode and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| connectors | FlowConnector[] | Specifies which node to execute after the step node. |
FlowSubflow
A subflow element references another flow, which it calls at run time. The flow that contains the subflow element is referred to as the parent flow. FlowSubflow extends FlowNode and inherits all its fields. It’s available in API version 25.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| connector | FlowConnector | Specifies which node to execute after the subflow. |
| flowName | string | References the flow to call at runtime. The value must be an API name of a flow and it can’t contain an appended hyphen and version number. |
| inputAssignments | FlowSubflowInputAssignment[] | An array of input variable assignments that are set at the start of the referenced flow. |
| outputAssignments | FlowSubflowOutputAssignment[] | An array of output variable assignments that are set at the end of the referenced flow. |
| storeOutputAutomatically | boolean | Indicates whether the subflow’s output parameters are
automatically available in the flow without creating any variables.
When the value is true, you can
reference an output parameter by specifying the API name of the
subflow in the flow. When the value is false, create variables manually to store output
values from the subflow. The default value is false. This field is available in API version 49.0 and later. |
FlowSubflowInputAssignment
Assigns an element or value from the parent flow to a variable in the referenced flow. Input assignments occur when the subflow calls the referenced flow. It extends FlowBaseElement and inherits all its fields. It’s available in API version 25.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| name | string | Required. Unique name for the variable in the referenced flow. |
| value | FlowElementReferenceOrValue | Defines the value to assign to the variable. |
FlowSubflowOutputAssignment
Assigns the value of a variable from the referenced flow to a variable in the parent flow. Output assignments occur when the referenced flow is finished running. It extends FlowBaseElement and inherits all its fields. It’s available in API version 25.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| assignToReference | string | Required. Unique name for the variable in the parent flow. |
| name | string | Required. Unique name for the variable in the referenced flow. |
FlowTransform (Beta)
Defines a node that can dynamically transform the value of source data to target data in the flow. It extends FlowNode and inherits all of its fields. This metadata type is available in API version 59.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| apexClass | string | The Apex class of the target data after transformation if its data type is Apex. |
| connector | FlowConnector[] | Specifies which node to execute after this data transformation. |
| dataType | FlowDataType (enumeration of type string) | Required. Specifies the data type of the transformed data . In
Flow Builder, it corresponds to the target data in the Transform
element. Valid types are:
|
| isCollection | boolean | Indicates whether the variable is a collection of values. The default value is false. |
| objectType | string | Object type of this variable resource if its data type is sObject. |
| scale | int | 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 flow runs. Corresponds to the Decimal Places field in Flow Builder. |
| transformValues | FlowTransformValue[] | An array of values for data transformation |
FlowTransformValue (Beta)
Defines the values for transforming specific data in the flow. It extends FlowBaseElement and inherits all its fields. This metadata type is available in API version 59.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| transformValueActions | FlowTransformValueAction[] | An array of actions for data transformation |
FlowTransformValueAction (Beta)
Defines the data and actions to transform in the flow. It extends FlowBaseElement and inherits all its fields. This metadata type is available in API version 59.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| outputFieldApiName | string | API name of the field for transformed data in a data transformation mapping. In Flow Builder, it corresponds to the target data field in the Transform element. |
| transformType | FlowTransformValueActionType (enumeration of type string) | Required. Valid type is Map. Specifies a mapping between the datasets in flows. In Flow Builder, it corresponds to the mapping between source data fields and target data fields. |
| value | FlowElementReferenceOrValue | Defines the value of the transformed data. In Flow Builder, the value of this field corresponds to the result of the target data field in the Transform element. |
FlowTextTemplate
Defines a text template that can be used throughout the flow. It extends FlowElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| isViewedAsPlainText | boolean | If set to true, the flow
resource remembers the View as Plain Text setting used for the text
template after the flow resource is saved. If set to false, the flow resource uses the
View as Rich Text setting. The default value is false. |
| text | string | Actual text of the template. Supports merge fields. |
FlowVariable
With variables, creates updatable values to use in the flow. FlowVariable extends FlowElement and inherits all its fields.
| Field Name | Field Type | Description |
|---|---|---|
| apexClass | string | The Apex class of this variable if its data type is Apex. This field is available in API version 46.0 and later. |
| dataType | FlowDataType (enumeration of type string) | Required. Valid types are:
|
| isCollection | boolean |
Indicates whether the variable
is a collection of values. This field is available in API
version 30.0 and later. In API version 32.0 and later, a collection
variable can be of any data type. The default value is False. |
| isInput | boolean |
Indicates whether the variable can be
set at the start of the flow using URL parameters, Visualforce
controllers, or subflow inputs. This field is available in
API version 25.0 and later. Default value:
Disabling input or output access for an existing variable can break the functionality of applications and pages that call the flow and access the variable. For example, you can access variables from URL parameters, processes, and other flows. |
| isOutput | boolean |
Indicates whether the variable’s
value can be accessed from Visualforce controllers and other
flows. This field is available in API version 25.0 and
later. Default value:
Disabling input or output access for an existing variable can break the functionality of applications and pages that call the flow and access the variable. For example, you can access variables from URL parameters, processes, and other flows. |
| objectType | string | Object type of this variable if its data type is sObject. |
| scale | int | 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 flow runs. Corresponds to the Decimal Places field in Flow Builder. |
| value | FlowElementReferenceOrValue | Default value of this variable. Default values aren’t supported if the variable’s data type is Picklist or Multipicklist. |
FlowVisibilityRule
Visibility rules render a flow screen component when visibility rule conditions are met. Hides a flow screen component when visibility rule conditions aren’t met. This metadata type is available in API version 47.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| conditionLogic | string | Specifies logic for the conditions. Value can be:
|
| conditions | FlowCondition[] | An array of conditions that must be true for the flow to wait for this event. |
FlowWait
Waits for one or more defined events to occur. FlowWait extends FlowNode and inherits all its fields. FlowWait is available in API version 32.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| defaultConnector | FlowConnector | Specifies which node to execute if the conditions are false for every event in the Wait element. |
| defaultConnectorLabel | string | Label for the default connector. |
| faultConnector | FlowConnector | Specifies which node to execute if the attempt to wait results in an error. If any of the wait events fail, the flow takes the fault connector. |
| timeZoneId | string | Reserved for future use. |
| waitEvents | FlowWaitEvent[] | An array of events that the Wait element is waiting for. If the conditions for every event evaluate to false, the defaultConnector is used. |
FlowWaitEvent
An event that a FlowWait element is waiting for. FlowWaitEvent extends FlowElement and inherits all its fields. FlowWaitEvent is available in API version 32.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| conditionLogic | string | Specifies logic for the conditions. Value can be:
|
| conditions | FlowCondition[] | An array of conditions that must be true for the flow to wait for this event. |
| connector | FlowConnector | Specifies which node to execute if this event is the first event that occurs. |
| eventType | string | Required. The event’s type. The type determines which input
parameters are available to define this event. Valid values are:
|
| extendUntil | Time | Reserved for future use. |
| inputParameters | FlowWaitEventInputParameter[] | An array of the event’s input parameters. The parameter values are set by using values from the flow. |
| label | string | Required. Label for the wait event. |
| offset | int | Reserved for future use. |
| offsetUnit | FlowScheduledPathOffsetUnit (enumeration of type string) | Reserved for future use. |
| outputParameters | FlowWaitEventOutputParameter[] | An array of the event’s output parameters. The parameter values are assigned from the event to variables in the flow. |
FlowWaitEventInputParameter
An input parameter for FlowWaitEvent. The parameter’s value is set by using values from the flow. It extends FlowBaseElement and inherits all its fields. FlowWaitEventInputParameter is available in API version 32.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| name | string | Required. Unique name for the input parameter. |
| value | FlowElementReferenceOrValue | Defines the value of the input parameter. |
FlowWaitEventOutputParameter
An output parameter for FlowWaitEvent. The parameter’s value is assigned to a variable in the flow so that it can be referenced in another part of the flow. It extends FlowBaseElement and inherits all its fields. FlowWaitEventOutputParameter is available in API version 32.0 and later.
| Field Name | Field Type | Description |
|---|---|---|
| assignToReference | string | Required. Specifies the variable to which you want to assign the output parameter value. |
| name | string | Required. Unique name for the output parameter. |
Upgrade Flow Files to API Version 44.0 or Later
In API version 43.0 and earlier, the Flow object’s fullName field included the flow’s version number. Starting in API version 44, the field no longer includes the version number. Before you deploy using API version 44.0 via Metadata API or Salesforce CLI, make sure that:
- The flows directory doesn’t include any unused flow versions.
- For each active flow, the status field is Active. Any flow without a status value is deployed or retrieved with a status value of Draft.
- The flowDefinitions directory is empty.
For Metadata API only.
- The package.xml file is set to API version 44.0.
- For the latest version of each flow, the file name doesn’t include a version number. For example, change myflow-3.flow to myflow.flow.
For Salesforce CLI only.
- The sfdx-project.json file is set to "sourceApiVersion": "44.0".
- For the latest version of each flow, the file name doesn’t include a version number. For example, change myflow-1.flow-meta.xml to myflow.flow-meta.xml.
As part of this upgrade, flow definitions are no longer necessary when you deploy or retrieve via Metadata API. If you deploy with flow definitions, the active version numbers in the flow definitions override the status fields in the flows. For example, the active version number in the flow definition is version 3, and the latest version of the flow is version 4 with the status field as Active. After you deploy your flow, the active version is version 3.
After you finished this upgrade, you can integrate with a version control system without worrying about flow file names changing. To reduce deployment issues when you push the source code into a scratch org, make sure that you don’t reuse an existing scratch org.
Wildcard Support in the Manifest File
This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.