EffectiveDate Element

Every activity has an effective date associated with it, which is controlled by this element. It will be the first field displayed when an activity is added by a User through the Activity screen. It is important to process activities in an effective date order and therefore this is a required element for all transaction configurations.

EffectiveDate: Elements and Attributes

Element

Parent Element

Attribute

Description

<EffectiveDate>

<Transaction>

 

Required:

This element defines the initial effective date value and is the required configuration in a transaction. 

Values:

SQL statement when the TYPE attribute is SQL, otherwise, empty.
 

<EffectiveDate>

STATUS

Required:

The attribute enables and disables the effective date entry field.  This can allow the user to change the initial value or prevent the user from modifying the effective date of the activity.

Values:

EnableddefaultThe effective date field will be enabled for user modification of the date value.DisabledThe effective date field will be disabled and its initial value cannot be modified.
 

<EffectiveDate>

TITLE

Optional:

The attribute defines an alternate label for the effective date.  The default label is "Effective Date" and configuration can modify the label to whatever the business requirements may need.

Values:

  • literal text

 

<EffectiveDate>

TYPE

Required:

This defines the source for the initial effective date value.

Values:

  • SYSTEM

    • default

    • The effective date's initial value will be sourced from OIPA's system date.

  • SQL

    • The effective date's initial value will be the returned date value from a SQL statement.

XML Schema

<Transaction>
...
    <EffectiveDate STATUS="[Enabled | Disabled]" TITLE="[literal]" TYPE="SQL">[sql]</EffectiveDate>
...
</Transaction>
OR
<Transaction>
...
    <EffectiveDate STATUS="[Enabled | Disabled]" TITLE="[literal]" TYPE="SYSTEM"/>
...
</Transaction>

XML Example

<Transaction>
...
    <EffectiveDate STATUS="Enabled" TYPE="SYSTEM"></EffectiveDate>
...
</Transaction>

<Transaction>
...    
    <EffectiveDate STATUS="Disabled" TITLE="Effective Date" TYPE="SYSTEM"></EffectiveDate>
...
</Transaction>

<Transaction>
...     
    <EffectiveDate STATUS="Enabled" TITLE="Composite Date" TYPE="SQL">SELECT DateValue FROM AsPolicyField WHERE FieldName = 'PolicyEffectiveDate' AND PolicyGUID = '[PolicyGUID]'</EffectiveDate>
...
</Transaction>