Obtain a decision report from a web service

What do you want to do ?

Get a decision report showing the rules used to reach a decision

Control the information included in a decision report

 

Get a decision report showing the rules used to reach a decision

When you request an outcome from the Determinations Server, you have control over what information is returned:

 

You can also ask for different information to be returned depending on the whether the outcome in known or unknown; for example, if the outcome is known, you may just want the value, but, if the outcome is unknown, you may want a full decision report.

When you request an attribute or relationship outcome you can specify what information you want displayed by setting the following XML attributes on the attribute or relationship element in the Assess request.

outcome-style:

this attribute controls the style of the outcome generally (regardless of when it is known or unknown.

known-outcome-style:

this attribute controls the style of the outcome when the outcome is known.

unknown-outcome-style:

this attribute controls the style of the outcome when the outcome is known.

 

For every outcome, you must specify either the outcome-style, or both the known-outcome-style and unknown-outcome-style.

The valid values for outcome styles are value-only, decision-report and base-attributes.

value-only

will return only the value for the outcome.

decision-report

will return a full decision report including all inferred attributes and relationships relationships that are relevant to the outcome.

base-attributes

will return a decision report, but only base level (non-inferred) attributes and relationships that are relevant to the outcome.

 

Request - Attribute outcome with decision report

 

Request - Relationship outcome with decision report
Response with Decision report

In the example response below, you can see that the requested attribute eligible_teenage_child_allowance is unknown.

The decision report explains that the contributing entities, attributes and relationships are:

 

By examining the decision report you can see that the reason that the attribute is unknown is because the child’s age in unknown for child_3.

 

Example


Control the information included in a decision report

There are several ways in which you can control information included in a decision report. The first way is to set the silent and invisible options on the attribute (see authoring > attributes > silent and invisible).

In addition to controlling the attributes that appear through their silent/invisible properties when authoring the rulebase, for the Determinations Server you can also set a decision report to base-attributes. This is specified when you request an attribute or relationship outcome in an Assess operation. When this value is set for the decision report style no inferred attributes will be returned, only base level attributes.

See Get a decision report showing the rules used to reach a decision for more information on outcome-styles.

Example Generic

<attribute id="eligible_teenage_child_allowance" outcome-style="base-attributes"/> 
<relationship id="eligible_children" outcome-style="base-attributes"/>

Example Specific

<eligible_teenage_child_allowance outcome-style="base-attributes"/> 
<eligible_children outcome-style="base-attributes"/>