BusinessProcessGroup

Represents the surveys used to track customers’ experiences across different stages in their lifecycle.This type extends the Metadata metadata type and inherits its fullName field.

Where possible, we changed noninclusive terms to align with our company value of Equality. Because changing terms in our code can break current implementations, we maintained this metadata type’s name.

Important

File Suffix and Directory Location

BusinessProcessGroup components have the suffix .businessProcessGroup and are stored in the businessProcessGroups folder.

Version

BusinessProcessGroup components are available in API version 49.0 and later.

Special Access Rules

This metadata type is available in orgs with Surveys enabled with the Customer Lifecycle Designer license.

Fields

Field Name	Field Type	Description
businessProcessDefinitions	BusinessProcessDefinition[]	A list that defines stages in a customer lifecycle map.
customerSatisfactionMetric	SurveyQuestionType(enumeration of type string)	Required. Types of questions that can be associated with stages in a customer lifecycle map. Valid values are: `CSAT` `NPS`
description	string	A description of the customer lifecycle map.
masterLabel	string	Required. The name of the customer lifecycle map.

BusinessProcessDefinition

Field Name	Field Type	Description
businessProcessFeedbacks	BusinessProcessFeedback[]	A list of stages in a customer lifecycle map.
description	string	A description of a stage in the customer lifecycle map.
developerName	string	Required. The API name of a stage in the customer lifecycle map.
masterLabel	string	Required. The name of a stage in the customer lifecycle map.
sequenceNumber	int	Required. The position of a stage in the customer lifecycle map.

BusinessProcessFeedback

Field Name	Field Type	Description
actionName	string	Required. The name of the survey used to collect feedback
actionParam	string	Required. The name of the survey question used to collect feedback.
actionType	ExpFeedbackCollType(enumeration of type string)	Required. The mode of feedback collection. Valid values are: `SURVEY`

Declarative Metadata Sample Definition

The following is an example of a BusinessProcessGroup component.

The following is an example package.xml that references the previous 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