Financial Services Cloud Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
StageDefinition
Parent Type
File Suffix and Directory Location
StageDefinition components have the suffix .stageDefinition and are stored in the stageDefinitions folder.
Version
StageDefinition components are available in API version 62.0 and later.
Fields
| Field Name | Description |
|---|---|
| active |
|
| description |
|
| masterLabel |
|
| referenceObject |
|
| referenceObjectField |
|
| referenceObjectRecordType |
|
| stageTransition |
|
| stageValue |
|
StageTransition
Represents a collection of fields to set up transitions between two states.
| Field Name | Description |
|---|---|
| criteria |
|
| customPermission |
|
| fromStageValue |
|
| stepGroup |
|
| toStageValue |
|
| userPermission |
|
StageCriteria
Represents a collection of fields to set up the criteria for the object stage transition and object stage change.
| Field Name | Description |
|---|---|
| condition |
|
| criteriaType |
|
| executionType |
|
| logicalExpression |
|
| targetObject |
|
StageCondition
Represents a collection of fields to set up the rules in transition criteria and stage change, including the object state, logic, and values.
| Field Name | Description |
|---|---|
| operator |
|
| sequenceNumber |
|
| sourceField |
|
| value |
|
StgFulfillmentStepDefGrp
Represents a collection of fields to set up the stage fulfillment step definition.
| Field Name | Description |
|---|---|
| name |
|
| step |
|
StgFulfillmentStepDef
Represents a collection of fields to set up fullfillment step definitions for stages and transitions.
| Field Name | Description |
|---|---|
| apiName |
|
| assignedToQueue |
|
| assignedToUser |
|
| dependency |
|
| flowDefinitionName |
|
| integrationDefinitionName |
|
| name |
|
| omniscriptName |
|
| runAsUser |
|
| stepType |
|
StgFulfillmentStepDpndDef
Represents a collection of fields to set up the stage fulfillment step dependency between two steps.
| Field Name | Description |
|---|---|
| step |
|
StageValue
Represents a collection of fields to set up the field values of an object for which stages are defined.
| Field Name | Description |
|---|---|
| criteria |
|
| stepGroup |
|
| value |
|
Declarative Metadata Sample Definition
The following is an example of a StageDefinition component.
<?xml version="1.0" encoding="UTF-8"?>
<StageDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
<active>false</active>
<description>Application form Stage transitions</description>
<masterLabel>basic</masterLabel>
<referenceObject>ApplicationForm</referenceObject>
<referenceObjectField>Stage</referenceObjectField>
<stageTransition>
<criteria>
<condition>
<operator>Equals</operator>
<sequenceNumber>1</sequenceNumber>
<sourceField>ApplicationForm.Name</sourceField>
<value>test</value>
</condition>
<criteriaType>AND</criteriaType>
<executionType>CONDITION</executionType>
<logicalExpression>1</logicalExpression>
<targetObject>ApplicationForm</targetObject>
</criteria>
<userPermission>ProcessOrder</userPermission>
<fromStageValue>Initiated</fromStageValue>
<toStageValue>On Hold</toStageValue>
<stepGroup>
<name>Initiated-On Hold</name>
<step>
<apiName>Autotask_step_defn</apiName>
<flowDefinitionName>disputemanagement__InvokeAsyncAction</flowDefinitionName>
<name>Autotask step defn</name>
<runAsUser>testuser@salesforce.com</runAsUser>
<stepType>AutoTask</stepType>
</step>
<step>
<apiName>testScreenFlow</apiName>
<assignedToUser>testuser@salesforce.com</assignedToUser>
<flowDefinitionName>cms_orch__CMS_NotifyRequester</flowDefinitionName>
<name>testScreenFlow</name>
<stepType>ManualTask</stepType>
<dependency>
<step>Autotask_step_defn</step>
</dependency>
</step>
</stepGroup>
</stageTransition>
<stageValue>
<value>Initiated</value>
<criteria>
<condition>
<operator>Equals</operator>
<sequenceNumber>1</sequenceNumber>
<sourceField>ApplicationForm.Name</sourceField>
<value>test</value>
</condition>
<criteriaType>AND</criteriaType>
<executionType>CONDITION</executionType>
<logicalExpression>1</logicalExpression>
<targetObject>ApplicationForm</targetObject>
</criteria>
<stepGroup>
<name>Initiated</name>
<step>
<apiName>Autotask_step_defn</apiName>
<flowDefinitionName>disputemanagement__InvokeAsyncAction</flowDefinitionName>
<name>Autotask step defn</name>
<runAsUser>testuser@salesforce.com</runAsUser>
<stepType>AutoTask</stepType>
</step>
<step>
<apiName>testScreenFlow</apiName>
<assignedToUser>testuser@salesforce.com</assignedToUser>
<flowDefinitionName>cms_orch__CMS_NotifyRequester</flowDefinitionName>
<name>testScreenFlow</name>
<stepType>ManualTask</stepType>
<dependency>
<step>Autotask_step_defn</step>
</dependency>
</step>
</stepGroup>
</stageValue>
<stageValue>
<value>On Hold</value>
</stageValue>
</StageDefinition>The following is an example package.xml that references the previous definition.
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>*</members>
<name>StageDefinition</name>
</types>
<version>62.0</version>
</Package>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.