Decision Framework: Data

     SpringboardThis topic is related to Springboard.   |     Form Builder |    23.10This feature was updated in 23.10 

The Decision Framework relies on an external source to provide it with data for decision making. The external source can be any other Fluent Function that returns a FormFuncResult. The data Map in the FormFuncResult object is passed directly into the Decision Engine at run-time to generate results.

Configuring the Data function

There are two approaches for configuring the Data function:

  • Global configuration
  • (Recommended) Form-specific configuration

Global / Default configuration

By default the Decision Framework will take the name and version of the Data Fluent Function from its Service parameters. This can be useful if the mechanism for data retrieval is consistent across multiple forms.

Form-specific configuration

If you require a specific Data function for your application or form, you can configure the following two form properties and the Decision Framework will read from these properties at run-time to determine the correct service. These properties take precedence over the Narrator properties listed below.

Property Description
decisionDataModelSvcName String

A data model service name.

For example, the DataModel service.

decisionDataModelSvcVersion String

A decisionDataModelSvcName service version.

For example, "1.0.1".

If you are using the same data model service for both Narrator and the Decision Framework then you can set the following two Form Properties. This is how Springboard configures the data model service.

Property Description
dataModelSvcName String

A data model service name.

For example, the DataModel service.

dataModelSvcVersion String

A decisionDataModelSvcName service version.

For example, "1.0.1".

Accessing data

You can access data from your configured Data Model, TXN Property Map, or via Parameters passed into the service.

To access the data in your rules logic, use the var operator. You'll find the data Map returned by your configured data model inside the dataModel object.

The syntax for referring to data varies depending on the source of the data:

  • Data model: data.<modelPath>
  • TXN properties: txn.propertyMap.<property>
  • Parameters: params.<paramName>

For more examples, see Decision Framework: Rules logic > Retrieving data and Decision Framework example configurations.

Next, learn about the Decision Framework result.