BusinessProcessGroup

Represents the surveys used to track customers’ experiences across different stages in their lifecycle.

This type extends Metadata and inherits its fields.

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

Introduced in API version 49.0.

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

• Type: BusinessProcessDefinition[]
• Required: No
• Description: A list that defines stages in a customer lifecycle map.

• Type: SurveyQuestionType (enumeration of type string)
• Required: Yes
• Description: Required. Types of questions that can be associated with stages in a customer lifecycle map.
• Possible values:
  • Attachment
  • Boolean
  • CSAT
  • Currency
  • Date
  • DateTime
  • FreeText
  • Image
  • NPS
  • Matrix
  • MultiChoice
  • MultiSelectPicklist
  • Number
  • Picklist
  • Rating
  • ShortText
  • Slider
  • StackRank
  • Toggle

• Type: string
• Required: No
• Description: A description of the customer lifecycle map.

• Type: string
• Required: Yes
• Description: Required. The name of the customer lifecycle map.

• Type: BusinessProcessFeedback[]
• Required: No
• Description: A list of stages in a customer lifecycle map.

• Type: string
• Required: No
• Description: A description of a stage in the customer lifecycle map.

• Type: string

• Required: Yes

• Description: Required. The API name of a stage in the customer lifecycle map.

  Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

• Type: string
• Required: Yes
• Description: Required. The name of a stage in the customer lifecycle map.

• Type: int
• Required: Yes
• Description: Required. The position of a stage in the customer lifecycle map.

• Type: string
• Required: Yes
• Description: Required. The name of the survey used to collect feedback

• Type: string
• Required: Yes
• Description: Required. The name of the survey question used to collect feedback.

• Type: ExpFeedbackCollType (enumeration of type string)
• Required: Yes
• Description: Required. The mode of feedback collection.
• Possible values:
  • PHONE_CALL
  • SURVEY

The following is an example of a BusinessProcessGroup component.

1<?xml version="1.0" encoding="UTF-8"?>
2<BusinessProcessGroup xmlns="http://soap.sforce.com/2006/04/metadata">
3    <businessProcessDefinitions>
4        <developerName>Customer_Onboarding</developerName>
5        <masterLabel>Customer Onboarding</masterLabel>
6        <description>A stage in a customer's lifecycle.</description>
7        <sequenceNumber>0</sequenceNumber>
8        <businessProcessFeedbacks>
9            <actionType>Survey</actionType>
10            <actionName>New Customer CSAT</actionName>
11            <actionParam>How would you rate our service?</actionParam>
12        </businessProcessFeedbacks>
13    </businessProcessDefinitions>
14    <customerSatisfactionMetric>NPS</customerSatisfactionMetric>
15    <masterLabel>Customer Lifecycle</masterLabel>
16    <description>This map tracks the feedback provided by customers' at different stages during their lifecycle.</description>
17</BusinessProcessGroup>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>policyholder</members>
5        <name>BusinessProcessGroup</name>
6    </types>
7    <version>49.0</version>
8</Package>

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.