{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"sub_types",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "BusinessProcessGroup - Metadata API",
"description": "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.",
"file_information": ".businessProcessGroup",
"directory_location": "businessProcessGroups",
"fields_columns": [
"type",
"description"
],
"fields": {
"businessProcessDefinitions": {
"type": "BusinessProcessDefinition[]",
"description": "A list that defines stages in a customer lifecycle map."
},
"customerSatisfactionMetric": {
"type": "SurveyQuestionType(enumeration of type string)",
"description": "Types of questions that can be associated with stages in a customer lifecycle map. Valid values are: Attachment Boolean CSAT Currency Date DateTime FreeText Image NPS Matrix MultiChoice MultiSelectPicklist NPS Number Picklist Rating ShortText Slider StackRank Toggle",
"required": true
},
"description": {
"type": "string",
"description": "A description of the customer lifecycle map."
},
"masterLabel": {
"type": "string",
"description": "The name of the customer lifecycle map.",
"required": true
}
},
"sub_types": {
"BusinessProcessDefinition": {
"businessProcessFeedbacks": {
"type": "BusinessProcessFeedback[]",
"description": "A list of stages in a customer lifecycle map."
},
"description": {
"type": "string",
"description": "A description of a stage in the customer lifecycle map."
},
"developerName": {
"type": "string",
"description": "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.",
"required": true
},
"masterLabel": {
"type": "string",
"description": "The name of a stage in the customer lifecycle map.",
"required": true
},
"sequenceNumber": {
"type": "int",
"description": "The position of a stage in the customer lifecycle map.",
"required": true
}
},
"BusinessProcessFeedback": {
"actionName": {
"type": "string",
"description": "The name of the survey used to collect feedback",
"required": true
},
"actionParam": {
"type": "string",
"description": "The name of the survey question used to collect feedback.",
"required": true
},
"actionType": {
"type": "ExpFeedbackCollType(enumeration of type string)",
"description": "The mode of feedback collection. Valid values are: PHONE_CALL SURVEY",
"required": true
}
}
},
"wsdl_segment": "```xml\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n```",
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of a BusinessProcessGroup component.",
"code": "\n\n \n Customer_Onboarding\n Customer Onboarding\n A stage in a customer's lifecycle.\n 0\n \n Survey\n New Customer CSAT\n How would you rate our service?\n \n \n NPS\n Customer Lifecycle\n This map tracks the feedback provided by customers' at different stages during their lifecycle.\n"
}
]
}