GeneratePendingRequirements

The GeneratePendingRequirements business rule is attached to a Policy level transaction/activity. This rule generates Activity level Requirements after a true comparison of the configured criteria identified by this rule and the Activity's math variables.

Generated Activity level Requirements prevent an Activity from ending in an Active status until they are fulfilled by the definition of the DeliveryRequirements attached business rule. GeneratePendingRequirements and DeliveryRequirements business rules must be attached to the same transaction/activity to behave is a coordinated pattern that prevents Activity processing upon Requirement generation and completes Activity processing upon fulfillment of all Requirements.

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

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

Required:

This attribute indicates the type of Requirement the rule will create.

  • Activity
<PendingRequirement>   <GeneratePendingRequirements>

Required, Repeatable:

The element's structure defines the Requirement to generate, the criteria that, when satisfied, generates the Requirement and the Requirement's dynamic field population.  This element is repeated to define generation for other Activity Requirements.

  
<RequirementName>   <PendingRequirement>

Required:

This element provides the name of the RequirementDefinition to generate from this rule.

  • math variable

  • literal
<Criteria>   <PendingRequirement>

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 generate the Requirement.

Each <Criteria> element constructs a 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> element's value]

  • math variable
  NAME <Criteria>

Required:

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

  • literal

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

Optional:

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

  • Equal

    • default

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

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 of 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
<WorkflowTask>   <PendingRequirement>

Optional:

This element Identifies the workflow task definition to generate when this rule is successfully processed.  The element is ignored if the workflow feature is "turned off" (system property). 

  •  task name
  CREATEONUSEREXECUTION <WorkflowTask>

Optional:

The attribute indicates when the Workflow Task is generated.

By default, workflow tasks are generated by cycle, DI and AsFile post insert processes and not by user initiated activity execution.  This attribute can allow the workflow tasks to be generated by user initiated activity execution.

  • No

    • default 

    • workflow task is generate only by AsFile post insert processes, cycle and DI.

  • Yes

    • workflow task is generated by all execution methods including user initiated activity execution.

XML Schema

<GeneratePendingRequirements LEVEL="Activity">
    <PendingRequirement>
        <RequirenemtName>[variable]</RequirenemtName>
        <Criteria NAME="[criteria name]" OPERATOR="[Equal | NotEqual | GreaterThan | GreaterThanOrEqual | LessThan | LessThanOrEqual]" DATATYPE="[TEXT | DATE | INTEGER | DECIMAL]">[variable]</Criteria>
        <Criteria>...</Criteria>
        <WorkflowTask CREATEONUSEREXECUTION="[No | Yes]">[task name]</WorkflowTask>
        <Fields>
            <Field>
                <From>[variable | activity field]</From>
                <To>[field name]</To>
                <OptionText>[variable]</OptionText>
            </Field>
            <Field>...</Field>
        </Fields>
    </PendingRequirement>
    <PendingRequirement>...</PendingRequirement>
</GeneratePendingRequirements>

XML Example

 <GeneratePendingRequirements LEVEL="Activity">
    <PendingRequirement>
        <RequirementName>SignedAcceptanceOfOffer</RequirementName>
    </PendingRequirement>
</GeneratePendingRequirements>
 
OR
 
<GeneratePendingRequirements LEVEL="Activity">
    <PendingRequirement>
        <RequirementName>RequirementName</RequirementName>
        <Criteria NAME="SignedDate" OPERATOR="GreaterThan" DATATYPE="DATE">SignedDateMV</Criteria>
        <Criteria NAME="CoSign" DATATYPE="TEXT">CoSignMV</Criteria>
        <Criteria NAME="PlanGUID" DATATYPE="TEXT">PlanGUIDMV</Criteria>
        <Fields>
            <Field>
                <From>SignedDateMV</From>
                <To>SignedDate</To>
            </Field>
            <Field>
                <From>CoSignMV</From>
                <To>CoSign</To>
            </Field>
        </Fields>
    </PendingRequirement>
    <PendingRequirement>
        <RequirementName>IRSCheck</RequirementName>
        <Criteria NAME="PlanGUID" DATATYPE="TEXT">PlanGUIDMV</Criteria>
        <Fields>
            <Field>
                <From>RenewalDateMV</From>
                <To>RenewalDate</To>
            </Field>
            <Field>
                <From>DueDateMV</From>
                <To>DueDate</To>
            </Field>
        </Fields>
    </PendingRequirement>
</GeneratePendingRequirements>