AddRequirements (For Transactions)

The AddRequirements business rule is attached to Policy level transactions/activities. This rule generates one or more Requirements during Activity processing. The elements and attributes of this rule are resolved from the values contained in the transaction's/activity's math and field definitions.

This rule has the following functionality:

  • Multiple Requirements can be created

  • New Requirements are associated to a Policy, a Client or a combination of the two, Policy-Client.

  • Requirements are created based on evaluation of up to two conditional features:

    • One or more conditions constructed from data obtained by other parts of the Activity and not related to the defined Requirement criteria

    • Requirement criteria directly related to the new Requirement's definition

  • Requirements can be created with a specific status code value

  • The Requirement's dynamic fields are created at the same time as the new Requirement

The AddRequirements business rule should be configured in the TransactionBusinessRulePacket business rule.

AddRequirements: Elements and Attributes
Element Attributes Parent Element Description Element / Attribute Values
<AddRequirements>     This is the root element for the rule.  
<Requirement>   <AddRequirements>

Required, Repeatable:

This element's structure defines the single Requirement to create.  The element is repeated to create multiple Requirements.

  
  ALLOW_DUPLICATES <Requirement>

Optional:

This attribute allows the system to add multiple Requirements with the same name to the same entity.

  • literal 

    • Yes

      • default 

      • multiple Requirements with the same name are allowed

    • No

      • multiple Requirements with the same name are not allowed

  • math variable

  • field name
<Tests>   <Requirement>

Optional:

This element expresses one or more conditions that, when evaluating to true, will allow the remainder of the parent element's configuration to process.

  
<Test>   <Tests>

Required, Repeatable:

This element provides a condition for the system to evaluate.  The element is repeated to express more than one condition.  All conditions must evaluate to true to allow the remainder of the parent element's configuration to process.

  • condition

    • Activity fields and math variables are available to construct a condition
<RequirementName>   <Requirement>

Required:

This element provides the name of the Requirement to be added.

  • literal

    • valid value is the name of a defined Requirement from AsRequirementDefinition

  • math variable

  • field name
<StatusCode>   <Requirement>

Optional:

This element defines the status value for the created Requirement.

  • literal

    • valid value is a code value from AsCodeRequirementStatus

  • math variable

  • field name
<ClientGUID>   <Requirement>

Optional:

This element provides the Client's guid required for Client and Policy-Client level Requirements.  This element is ignored for Policy level Requirements. 

  • math variable

  • field name
<Criteria>   <Requirement>

Optional, Repeatable:

This element provides a value that is compared to the Requirement's criteria definition.  This comparison provides the conditions to base Requirement creation.  The element is repeated to define multiple conditions where all must evaluate to true in order to add the Requirement.

Each <Criteria> element constructs the condition as the criteria's defined value compared to the configured value in this rule.  The following is the generic description of this construction.

[criteria's defined value] [operator] [<Criteria> value]

  • literal

  • math variable

  • field name
  NAME <Criteria>

Required:

This attribute provides a RequirementDefinition's criteria name for comparison.

  • literal

    • valid value is a criteria name from AsRequirementCriteria
  OPERATOR <Criteria>

Required:

This attribute provides an operator for this criteria's comparison.

  • Equal

  • NotEqual

  • GreaterThan

  • GreaterThanOrEqual

  • LessThan

  • LessThanOrEqual
  DATATYPE <Criteria>

Required:

This attribute provides a data type that influences the comparison method.  

Example:  numbers are compared differently than dates and texts.

  • TEXT

  • DATE

  • INTEGER

  • DECIMAL
<Fields>   <Requirement>

Optional:

This element's structure defines one or more fields to generate and the data source for their initial values.

  
<Field>   <Fields>

Required, Repeatable:

This element defines a single field to generate and the data source for its initial value.  The element is repeated to generate multiple fields.

  
<From>   <Field>

Required:

This element provides a single initial value for the field.

  • math variable

  • field name
<To>   <Field>

Required:

This element provides the field name to generate.

  • field name

     
<OptionText>   <Field>

Optional:

This element provides a single value for the field's option text.  This applies to combo and radio fields only. 

The value of a combo and radio field is not the same as its visible text.  Option text provides the visible text associated to this field's value

  • math variable

XML Schema

<AddRequirements>
    <Requirement ALLOW_DUPLICATES="[Yes | No | variable | field]">
        <Tests>
            <Test>[condition]</Test>
            <Test>...</Test>
        </Tests>
        <RequirementName>[requirement name | variable | field]</RequirementName>
        <StatusCode>[code | variable | field]</StatusCode>
        <ClientGUID>[variable | field]</ClientGUID>
        <Criteria NAME="[criteria name]" OPERATOR="[Equal | GreaterThan | GreaterThanOrEqual | LessThan | LessThanOrEqual]" DATATYPE="[TEXT | DATE | INTEGER | DECIMAL]">[literal | variable | field]</Criteria>
        <Criteria>...</Criteria>
        <Fields>
            <Field>
                <From>[variable | field]</From>
                <To>[field]</To>
            </Field>
            <Field>
                <From>[variable | field]</From>
                <To>[field]</To>
                <OptionText>[variable]</OptionText>
            </Field>
            <Field>...</Field>
        </Fields>
    </Requirement>
    <Requirement>...</Requirement>
</AddRequirements>

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="EffectiveDate" OPERATOR="GreaterThan" DATATYPE="DATE">DateMV</Criteria>
        <Criteria NAME="TaxIDMissing" OPERATOR="Equal" DATATYPE="TEXT">TaxIDMissingMV</Criteria>
        <Fields>
            <Field>
                <From>ClientNameMV</From>
                <To>ClientName</To>
            </Field>
        </Fields>
    </Requirement>
    <Requirement ALLOW_DUPLICATES="NO">
        <Tests>
            <Test> Replacement = '01'</Test>
        </Tests>
        <RequirementName>Replacement Form Missing</RequirementName>
        <StatusCode>00</StatusCode>
    </Requirement>
</AddRequirements>