FlowValueMap

Represents the metadata associated with creating a reusable entity for defining and managing mappings between source and target values used within a flow.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

FlowValueMap components have the suffix .flowvaluemap and are stored in the flowvaluemaps folder.

Version

FlowValueMap components are available in API version 66.0 and later.

Special Access Rules

Only authenticated users can access this metadata type.

Fields

Field Name	Field Type	Description
defaultValue	text	Specifies the default target value used when no source value is found in the value map. A value is required if the defaultValueStrategy field is set to FixedValue.
defaultValueStrategy	FlowValueMapDefaultStrategy (enumeration of type string)	Required. Specifies the strategy used to apply the default target value if the source value is not found in the value map. Valid values are: PassThrough: Pass the original source value through if no mapping is found. FixedValue: Use the defined DefaultValue if no mapping is found. FailFlow: Fail the flow if no mapping is found.
description	text	User-provided description for the value map.
label	text	Required. Label for the value map.
sourceType	FlowValueMapDataType (enumeration of type string)	Required. Specifies the supported data types for value map source data. Valid types are: Boolean Date DateTime Number String
targetType	FlowValueMapDataType (enumeration of type string)	Required. Specifies the supported data types for value map target data. Valid types are: Boolean Date DateTime Number String
valueMapEntries	FlowValueMapEntry[]	List of source-target mappings in the value map.

FlowValueMapEntry

Stores an individual record linking a specific source value to a target value. This entity maintains a relationship to its parent FlowValueMap definition and makes sure that each sourceValue is unique within that parent definition.

Field Name	Field Type	Description
sourceValue	text	Required. Specifies the source value in this FlowValueMap definition.
targetValue	text	Required. Specifies the target value in this FlowValueMap definition.

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.

Metadata API Developer Guide