CopyToPlanFields

This attached rule allows the data for the Plan to be updated or inserted. The rule has the following qualities.

  • Must be attached to a Plan level transaction.

  • Must be configured in TransactionBusinessRulePacket in order to execute.

  • Copybooks referenced in the rule can be overridden following the Plan context definition.

  • One or more versions of the Plan may be updated.

    • The Plan version, called a Plan time slice, must exist prior to updating through this rule.

    • All versions referenced by the rule must be related to the same Plan.

CopyToPlanFields Elements and Attributes

Element

Attributes

Parent Element

Description

Element/Attribute Values

<CopyToPlanFields>

   

Required:

This is the root element of the rule.

 
 

PLANSLICEGUID

<CopyToPlanFields>

Optional:

The attribute identifies the version of a Plan to update by the Plan's PlanSliceGUID.  This attribute is applicable in combination with the <From> element and cannot be used in combination with the <FromCollection> element.

Values:

  • math

  • variablefield

<Fields>

 

<CopyToPlanFields>

Required:

This element is the standard container that defines the fields that are updated by the rule.

 

<Field>

 

<Fields>

Required, Repeatable:

This element's structure identifies a field to update and provides the updated value.

 

<From>

 

<Field>

Optional:

This element identifies the updated value by referencing the data source that contains its value. The element must be used in combination with the attribute PLANSLICEGUID. The element cannot be used in combination with element <FromCollection>.

Values:

  • math variable

  • field

<FromCollection>

 

<Field>

Optional:

This element provides modified data for one or more of the Plan's versions where modification should apply. The element must reference a collection of math variable. A collection contains multiple sets of key/value pairs where this element expects keys as PlanSliceGUIDs and values as updated field values for the Plan Slice identified by the key. All PlanSliceGUIDs in the collection must be versions of the same Plan. This attribute cannot be used in combination with element <From> or attribute PLANSLICEGUID.

Values:

  • math variable

    • key = PlanSliceGUID

    • value = updated field value

<To>

 

<Field>

Required:

This element provides the name of the field to update.

Values:

  • filed name

XML Schema

<CopyToPlanFields PLANSLICEGUID="[guid]">
<Fields>
<Field>
<From>[variable | field]</From>
<To>[field name]</To>
</Field>
<Field>...</Field>
</Fields>
</CopyToPlanFields>
 
<CopyToPlanFields>
<Fields>
<Field>
<FromCollection>[collection]</FromCollection>
<To>[field name]</To>
</Field>
<Field>...</Field>
</Fields>
</CopyToPlanFields>

XML Example

<CopyToPlanFields PLANSLICEGUID="PlanSliceGUID">
<Fields>
<Field>
<From>YesMV</From>
<To>DollarCostAveragingProgram</To>
</Field>
<Field>
<From>AmountMV</From>
<To>DCAAmount</To>
</Field>
<Field>
<From>FrequencyMV</From>
<To>DCAFrequency</To>
</Field>
<Field>
<From>ValidStartDateMV</From>
<To>DCAStartDate</To>
</Field>
<Field>
<From>ValidStartDateMV</From>
<To>DCANextTransferDate</To>
</Field>
<Field>
<From>DCATransafersRemainingMV</From>
<To>DCATransfersRemaining</To>
</Field>
</Fields>
</CopyToPlanFields>

 

OR

 

<CopyToPlanFields>
<Fields>
<Field>
<FromCollection>SegmentModalPremiumAmtMV</FromCollection>
<To>SegmentModalPremium</To>
</Field>
<Field>
<FromCollection>SegmentNextYearsModalPremiumAmtMV</FromCollection>
<To>SegmentNextYearsModalPremium</To>
</Field>
<Field>
<FromCollection>SegmentAnnPremiumAmtMV</FromCollection>
<To>SegmentAnnualPremium</To>
</Field>
<Field>
<FromCollection>SegmentNextYearsAnnPremiumAmtMV</FromCollection>
<To>SegmentNextYearsAnnualPremium</To>
</Field>
</Fields>
</CopyToPlanFields>