AddRequirements (For Requirements)

The AddRequirements business rule is attached to a Policy, Client or Policy-Client level Requirement to create one or more new Requirements during an existing Requirement's status processing. The elements and attributes of this rule are resolved by the math variables contained in the parent Requirement's <State> element and the <Fields> from the Requirement's Data Detail definition.

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 Requirement

The AddRequirements business rule processes during execution of the <Rule> element configured under the Requirement's Definition 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 Requirement that is created.  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 provides one or more conditions that, when all evaluate to true, allow the processing of the remainder of the parent element's configuration.

  
<Test>   <Tests>

Required, Repeatable:

This element provides a single condition.  The element is repeated to provide multiple conditions where all must evaluate to true to continue creating the parent Requirement.

  • condition

    • Requirement fields and <State> 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 express 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 criteria's 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 defined criteria name for comparison.

  • literal

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

Required:

This attribute provides an operator for this criteria comparison.

  • Equal

  • NotEqual

  • GreaterThan

  • GreaterThanOrEqual

  • LessThanLessThanOrEqual
  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 created for the new Requirement.

  
<Field>   <Fields>

Required, Repeatable:

This element defines a single dynamic field that is created.  A dynamic field requires a field name, <To>, and a value from a data source, <From>, that is accessible by this rule.  The Requirement's Data Detail defines its fields and data types.

The element is repeated to create multiple fields.

  
<From>   <Field>

Required:

This element identifies the source of the value that is applied to the field.

  • math variable

  • field name
<To>   <Field>

Required:

This element identifies the dynamic field name that is created.

  • field name

     
<OptionText>   <Field>

Optional:

This element provides the option text associated to the field.  Fields of Combo or Radio data types are code values whose values should be associated to more human recognizable text.

Example:  AsCodeXXX values are associated to short and long descriptions which are more easily recognized information.

  • 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 | NotEqual | 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>