DeliveryRequirements

The DeliveryRequirements business rule is attached to a Policy level transaction/activity. This rule defines fulfillment criteria for Activity level Requirements create by the GeneratePendingRequirements rule that is also attached to the same transaction/activity. The fulfillment criteria are the Requirement's date values. When the criteria are satisfied, the Requirement is considered complete and the Activity to which it is attached can complete without Requirement interruption.

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 DeliveryRequirements rule should be configured in the TransactionBusinessRulePacket business rule.

Delivery Requirements: Elements and Attributes
Element Attributes Parent Element Description Element / Attribute Values
<DeliveryRequirements>     This is the root element for the rule.  
  PROCESSONCOMPLETE <DeliveryRequirements>

Optional:

This attribute defines when the Activity's EffectiveDate is altered from its user entered date value.

The attribute, NEWACTIVITYDATE, is optional for either value of this attribute.

  • No

    • default

    • the Activity's EffectiveDate remains as the user's initially entered value

  • Yes

    • the Activity's EffectiveDate is set to the greater of

      • the Requirement's CloseDate when it has been Cancelled (05)

      • the user's initially entered value
  NEWACTIVITYDATE <DeliveryRequirements>

Optional:

This attribute provides the Activity with a new EffectiveDate value once all requirements are complete.  The attribute's date value cannot be earlier than the user's entered Activity EffectiveDate.  

When this attribute is configured, PROCESSONCOMPLETE attribute must have a value of "Yes" and NEWACTIVITYDATE value overrides any date determined by the PROCESSONCOMPLETE attribute.

  • math variable

  • activity field
<RequiredDates>   <DeliveryRequirements>

Required:

This element's structure defines all of the date fields from the Requirement that are required to determine Requirement fulfillment that allows the associated Activity to process to Active status.

  
  TYPE <RequiredDates>

Required:

This attribute defines the relationship that multiple dates have to one another.  Either all dates define fulfillment or any one of the dates define fulfillment.

  • AND

    • requirement is fulfilled when all date fields are populated and their values are equal to or less than the system date

  • OR

    • requirement is fulfilled when any one of the date fields are populated and any one of their values is equal to or less than the system date
<Required>   <RequiredDates>

Required, Repeatable:

This element identifies an individual Requirement date to be tested for Activity Requirement fulfillment.  This element is repeated to define fulfillment with multiple dates.  The TYPE attribute defines the relationship between multiple dates.

  • RequestedDate

  • DueDate

  • ReceivedDate

  • WaivedDate

  • OpenDate

  • CloseDate

XML Schema

<DeliveryRequirements PROCESSONCOMPLETE="[No | Yes]" NEWACTIVITYDATE="[variable | activity field]">
    <RequiredDates TYPE="[AND | OR]">
        <RequiredDate>[RequiredDate | DueDate | ReceivedDate | WaivedDate | OpenDate | CloseDate]</RequiredDate>
        <RequiredDate>...</RequiredDate>
    </RequiredDates>
</DeliveryRequirements>

XML Example

<DeliveryRequirements PROCESSONCOMPLETE="Yes">
    <RequiredDates TYPE="AND">
        <RequiredDate>OpenDate</RequiredDate>
        <RequiredDate>CloseDate</RequiredDate>
    </RequiredDates>
</DeliveryRequirements>