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 Metadata and inherits its fields.

File Suffix and Directory Location 

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

Version 

Introduced in API version 66.0.

Special Access Rules 

Only authenticated users can access this metadata type.

Fields 

defaultValue 

• Type: string

• Required: No

• Description: 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 

• Type: FlowValueMapDefaultStrategy (enumeration of type string)
• Required: Yes
• Description: Required. Specifies the strategy used to apply the default target value if the source value is not found in the value map.
• Possible values:
  • 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 

• Type: string
• Required: No
• Description: User-provided description for the value map.

label 

• Type: string
• Required: Yes
• Description: Required. Label for the value map.

sourceType 

• Type: FlowValueMapDataType (enumeration of type string)
• Required: Yes
• Description: Required. Specifies the supported data types for value map source data. Valid types are:
• Possible values:
  • Boolean
  • Date
  • DateTime
  • Number
  • String

targetType 

• Type: FlowValueMapDataType (enumeration of type string)
• Required: Yes
• Description: Required. Specifies the supported data types for value map target data. Valid types are:
• Possible values:
  • Boolean
  • Date
  • DateTime
  • Number
  • String

valueMapEntries 

• Type: FlowValueMapEntry[]
• Required: No
• Description: List of source-target mappings in the value map.

FlowValueMapEntry Type 

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.

Fields 

sourceValue 

• Type: string
• Required: Yes
• Description: Required. Specifies the source value in this FlowValueMap definition.

targetValue 

• Type: string
• Required: Yes
• Description: 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.