SvcCatalogFulfillmentFlow | Metadata API Developer Guide

File Suffix and Directory Location

SvcCatalogFulfillmentFlow components have the suffix fulfillmentFlow and are stored in the svcCatalogFulfillmentFlows folder.

Version

SvcCatalogFulfillmentFlows components are available in API version 53.0 and later.

Fields

Field Name	Description
description	Field Type string Description Required. Free-text description of the fulfillment flow.
flow	Field Type string Description Required. The name of the flow represented by this SvcCatalogFulfillmentFlow.
icon	Field Type string Description Represents the details of an icon.
isProtected	Field Type boolean Description An auto-generated value. This value currently has no impact.
items	Field Type SvcCatalogFulfillFlowItem[] Description The list of variables in the flow that can accept a value as input.
masterLabel	Field Type string Description Required. The primary label for the fulfillment flow record.

SvcCatalogFulfillFlowItem

Represents a variable in a fulfillment flow that can accept input. Describes what type of value it accepts.

Field Name	Description
catalogInputVariable	Field Type string Description Required. The FlowVariable the fulfillment flow property represents.
displayType	Field Type PropertyDisplayType (enumeration of type string) Description The display options available. Values are: `Checkbox` `Date` (available in API version 59.0 and later) `DateTime` (available in API version 59.0 and later) `Lookup` `Number` `Picklist` `Queue` (available in API version 57.0 and later) `Text`
fieldDefinition	Field Type string Description The name of a field in the object provided in objectLookupDomain that specifies the value for this variable. If displayType is `Picklist`, this value must be the name of a picklist field. If displayType is `Lookup` and fieldLookupDomain is FieldDefinition, this value must be the name of a relationship field.
fieldLookupDomain	Field Type string Description The name of a standard or custom object that specifies the domain of that lookup or picklist. This value is relevant only if displayType is `Lookup` or `Picklist`.
isAdditionalQuestionsInputVariable	Field Type boolean Description Determines if this variable accepts input for all additional questions that were asked to a user. This value can only be `true` if the displayType for this item is `Text`. Only one item per SvcCatalogFulfillmentFlow component can set this attribute to `true`.
isRequired	Field Type boolean Description Determines if the field is required for the related fulfillment flow to be executed.
lookupDomainFieldType	Field Type string Description This value specifies the fields for the object specified by objectLookupDomain that are displayed in the Catalog Builder by type. This value is only relevant if displayType is `Lookup` and fieldLookupDomain is `FieldDefinition`.
masterLabel	Field Type string Description Required. The primary label for the fulfillment flow record.
objectLookupDomain	Field Type string Description The name of a custom or standard object. If displayType is `Lookup` or `Picklist`, this value filters the available options to a specific object.

Declarative Metadata Sample Definition

The following is an example of a SvcCatalogFulfillmentFlow component.

1<?xml version="1.0" encoding="UTF-8"?>
2<SvcCatalogFulfillmentFlow xmlns="http://soap.sforce.com/2006/04/metadata">
3    <description>Creates a Case record related to the Contact belonging to the current User. If this will be used by Users without related Contacts, provide an Account Id below. This Account Id will be used instead of a Contact.</description>
4    <flow>Create_Case_by_Record_Type</flow>
5    <isProtected>false</isProtected>
6    <items>
7        <catalogInputVariable>Input_RecordTypeApiName</catalogInputVariable>
8        <displayType>Text</displayType>
9        <isAdditionalQuestionsInputVariable>false</isAdditionalQuestionsInputVariable>
10        <isRequired>true</isRequired>
11        <masterLabel>Record Type Developer Name</masterLabel>
12    </items>
13    <items>
14        <catalogInputVariable>Input_AccountId</catalogInputVariable>
15        <displayType>Lookup</displayType>
16        <fieldDefinition>AccountId</fieldDefinition>
17        <fieldLookupDomain>Account</fieldLookupDomain>
18        <isAdditionalQuestionsInputVariable>false</isAdditionalQuestionsInputVariable>
19        <isRequired>false</isRequired>
20        <masterLabel>(Optional) Related Account</masterLabel>
21        <objectLookupDomain>Contact</objectLookupDomain>
22    </items>
23    <items>
24        <catalogInputVariable>Input_Origin</catalogInputVariable>
25        <displayType>Picklist</displayType>
26        <fieldDefinition>Origin</fieldDefinition>
27        <isAdditionalQuestionsInputVariable>false</isAdditionalQuestionsInputVariable>
28        <isRequired>true</isRequired>
29        <masterLabel>Case Origin</masterLabel>
30        <objectLookupDomain>Case</objectLookupDomain>
31    </items>
32    <items>
33        <catalogInputVariable>Input_Priority</catalogInputVariable>
34        <displayType>Picklist</displayType>
35        <fieldDefinition>Priority</fieldDefinition>
36        <isAdditionalQuestionsInputVariable>false</isAdditionalQuestionsInputVariable>
37        <isRequired>false</isRequired>
38        <masterLabel>Case Priority</masterLabel>
39        <objectLookupDomain>Case</objectLookupDomain>
40    </items>
41    <items>
42        <catalogInputVariable>Input_Status</catalogInputVariable>
43        <displayType>Picklist</displayType>
44        <fieldDefinition>Status</fieldDefinition>
45        <isAdditionalQuestionsInputVariable>false</isAdditionalQuestionsInputVariable>
46        <isRequired>true</isRequired>
47        <masterLabel>Case Status</masterLabel>
48        <objectLookupDomain>Case</objectLookupDomain>
49    </items>
50    <items>
51        <catalogInputVariable>Input_Subject</catalogInputVariable>
52        <displayType>Text</displayType>
53        <isAdditionalQuestionsInputVariable>false</isAdditionalQuestionsInputVariable>
54        <isRequired>true</isRequired>
55        <masterLabel>Case Subject</masterLabel>
56    </items>
57    <items>
58        <catalogInputVariable>Input_Description</catalogInputVariable>
59        <displayType>Text</displayType>
60        <isAdditionalQuestionsInputVariable>true</isAdditionalQuestionsInputVariable>
61        <isRequired>false</isRequired>
62        <masterLabel>Case Description</masterLabel>
63    </items>
64    <masterLabel>Create Case by Record Type</masterLabel>
65</SvcCatalogFulfillmentFlow>

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.