AddRequirements (For Requirements)
This business rule is attached to a requirement in order to add requirements based on the configured requirement criteria. AddRequirements will automatically set the OptionText of combo box or radio button fields.
| Element/Tag | Definition | Attribute | Element/Attribute Value and Description |
|---|---|---|---|
| <AddRequirements> |
Required element: The opening and closing tags of the business rule. |
||
| <Requirement> |
Required, repeatable element: The container element for the requirement configuration. |
ALLOW_DUPLICATES |
Optional attribute: This attribute defines whether duplicate requirements are allowed. Yes: Duplicate requirements are allowed. This is the default behavior. No: Duplicate requirements are not allowed. |
| <Tests> |
Optional element: The container element for the test expression configuration. |
Note: when multiple <Test> elements are configured, it is expected that all Test elements resolve to TRUE for the overall <Tests> to be considered TRUE (logical AND operation) and the other parts of the configuration in relation to <Tests> element is executed | |
| <Test> |
Required, repeatable element: This element defines an expression that, if it resolves to true, will invoke the remainder of the rule's configuration. Note: This element is required if the <Tests> element is present. |
An expression that, if it resolves to true, will invoke the remainder of the rule's configuration. |
|
| <RequirementName> |
Required element: This element specifies the requirement to be added to the transaction. |
The name of the requirement, exactly as it appears in AsRequirementDefinition, to be added to the transaction. | |
| <StatusCode> |
Optional element: This element defines the status that the requirement should be in if it's added to the transaction. |
A status code from AsCodeRequirementStatus. | |
| <ClientGUID> |
Optional element: This element defines the client that should be added to the requirement. The element will be ignored when used with Activity at Policy level requirements. Note: It is a mandatory element for Policy Client level requirements. |
A client GUID for the client that should be added to the requirement. | |
|
<Criteria> |
Optional, repeatable element: This element defines the criteria that will determine whether the requirement is added. |
||
| NAME | |||
| OPERATOR | |||
| DATATYPE | |||
| <Fields> |
Optional element: This element contains configuration specifying the fields to be copied to the newly created requirement. |
||
| <Field> | This element specifies the field to be copied to the newly created requirement and the field to which it should be copied. | ||
| <From> | This element specifies the field whose value should be copied to the new requirement. | The name of the field from which value should be copied, or a MathVariable that resolves to the name of this field. | |
| <To> | This element specifies the field to which the value should be copied. | The name of the requirement field that should be given the value. |
XML Example
<AddRequirements>
<Requirement ALLOW_DUPLICATES="NO">
<Tests>
<Test> ClientSSN= '01'</Test>
</Tests>
<RequirementName>Missing TaxID</RequirementName>
<StatusCode>00</StatusCode>
<ClientGUID>ClientGuidMV</ClientGUID>
<Criteria NAME="Criteria1" OPERATOR="GreaterThan" DATATYPE="DATE">DateMV</Criteria>
<Criteria NAME="Criteria2" DATATYPE="TEXT">TextMV</Criteria>
<Fields>
<Field>
<From>MV</From>
<To>FieldName</To>
</Field>
</Fields>
</Requirement>
<Requirement ALLOW_DUPLICATES="NO">
<Tests>
<Test> Replacement = '01'</Test>
</Tests>
<RequirementName>Replacement Form Missing</RequirementName>
<StatusCode>00</StatusCode>
</Requirement>
</AddRequirements>