Understanding Scenario-based Data Collection

A scenario is a named set of validation rules, that can be activated at the product level.
In the API output, under the field "business_processes", for one requested product, you will get the list of all scenarios defined for your organization with the calculated state of your scenario.
You can find in the following table all the attributes of a scenario.

Attributes description

Attribute	Definition	Type
total	The number of validation rules defined in your scenario	positive integer
successful	The number of validation rules successful for your scenario, for the requested product.	positive integer
requested	Indicates if the scenario has been activated for the requested product.	boolean
status	Indicates if all validation rules of the scenario are successful. It is a shortcut, it can be calculated with (total=successful)	boolean
label	The name of the scenario.	string

An improvement with scenario-based data collection is the capability to indicate deadlines for scenarios. There is one new attribute

Attribute	Definition	Type
applicability_deadline	Indicates the deadline chosen when the scenario has been activated. null* means no deadline has been applied for the scenario	date

Attribute

Definition

Type

applicability_deadline

Indicates the deadline chosen when the scenario has been activated.

*null** means no deadline has been applied for the scenario

date

Example

"business_processes": [
        {
          "successful": 1,
          "requested": true,
          "total": 3,
          "status": false,
          "label": "Business Process 1"
        },
        {
          "successful": 0,
          "requested": false,
          "total": 3,
          "status": false,
          "label": "Business Process 2"
        },
        {
          "successful": 3,
          "requested": true,
          "total": 3,
          "status": true,
          "label": "Business Process 3",
          "applicability_deadline": "2022-06-03T21:59:00+00:00"
        }
      ],