CopyToPlanSegmentNameField

This rule will update data on Group Customer's SegmentName entity: AsPlanSegmentName and AsPlanSegmentNameField tables. The actual records that will be updated are identified in the rule through the PLANSEGMENTNAMEGUID attribute or by collections associated with each field.

CopyToPlanSegmentNameFields: Elements and Attributes
Element/Tab Attributes Parent Element Description Element/Attributes Values

<CopyToPlanSegmentNameFields>

 

    

This is the opening element that matches the name of the business rule.

  

PLANSEGMENTNAMEGUID

<CopyToPlanSegmentNameFields>

Optional:

This attribute identifies the PlanSegmentName record to update in this rule by its record GUID. The attribute cannot be used in combination with the element <FromCollection>.

  • math variable

  • field

<Fields>

 

<CopyToPlanSegmentNameFields>

Required:

This structure identifies all the fields to update and their new values.

  

<Field>

  

<Fields>

Required, Repeatable:

This structure identifies one of the fields to update. This is repeated for each field the rule will update.

  
<From>   <Field>

Optional:

This element provides the updated value for the field. This element can only be used in combination with the PLANSEGMENTNAMEGUID attribute.

  • math

  • variable field
<FromCollection>   <Field>

Optional:

This element provides the updated values for a field on multiple PlanSegmentName records. A collection contains multiple sets of key/value pairs where this element expects keys as PlanSegmentNameGUIDs and values as updated field values for the PlanSegmentName record identified by the key. This element cannot be used in combination with the PLANSEGMENTNAMEGUID attribute.

  • math variable

    • key = PlanSegmentNameGUID

    • value = updated field value
<To>   <Field>

Required:

This element provides the name of the field to update. The field name must exist in the Segment rule.

  • field name
<MultiFields>   <Fields>

Optional, Repeatable:

This structure will allow the rule to update one of the multifield structures identified by its NAME attribute. The element is repeated for each named multifield structure that is expected to be updated by this rule. This element can only be used with PLANSEGMENTNAMEGUID. It cannot be combined when there are updates to multiple PlanSegmentName records.

  
  END <MultiFields>

Required:

The attribute provides the total number of multifield instances in the resulting named structure. The only appropriate value is an integer.

  • literal

  • math variable

  • activity field name
<Field>   <MultiFields>

Required, Repeatable:

This structure identifies one of the multifield fields to update. This is repeated for each multifield field the rule expects to update.

  
<FromIndexCollection>   <Field>

Required:

This element provides the updated values for multiple multifield instances. A collection contains multiple sets of key/value pairs where this element expects keys as an index value identifying a multifield instance and values as the updated field values for the multifield instance identified by the key. Multifield indexes start with a value of 1.

  • math variable

    • key =index to the multifield instance.

      • The first instance is a value of 1.

    • value = updated field value
<To>   <Field>

Required:

This element provides the name of the multifield field to update. The field name must exist in the named multifield configuration.

  • field name

XML Schema

<CopyToPlanSegmentNameFields PLANSEGEMTNNAMEGUID="[variable | field]">
<Fields>
<Field>
<From>[variable | field]</From>
<To>[field name]</To>
</Field>
<Field>...</Field>
<MultiFields NAME="[literal | variable | field]" END="[literal | variable | field]">
<Field>
<FromIndexCollection>[variable]</FromIndexCollection>
<To>[field name]</To>
</Field>
<Field>...</Field>
</MultiFields>
<MultiFields>...</MultiFields>
</Fields>
</CopyToPlanSegmentNameFields>

OR

<CopyToPlanSegmentNameFields>
<Fields>
<Field>
<FromCollection>[variable | field]</FromCollection>
<To>[field name]</To>
</Field>
<Field>...</Field>
<MultiFields NAME="[literal | variable | field]" END="[literal | variable | field]">
<Field>
<FromIndexCollection>[variable]</FromIndexCollection>
<To>[field name]</To>
</Field>
<Field>...</Field>
</MultiFields>
<MultiFields>...</MultiFields>
</Fields>
</CopyToPlanSegmentNameFields>

XML Example

<CopyToPlanSegmentNameFields PLANSEGEMTNNAMEGUID="PlanSementNameGUID">
<Fields>
<Field>
<From>YesMV</From>
<To>DollarCostAveragingProgram</To>
</Field>
<Field>
<From>Activity:Amount</From>
<To>DCAAmount</To>
</Field>
<Field>
<From>Activity:Frequency</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>
<MultiFields NAME="MultiFieldPlanYearTotals" END="UpdatedInstanceCountMV">
<Field>
<FromIndexCollection>CollectionForPlanYearMV</FromIndexCollection>
<To>PlanYear</To>
</Field>
<Field>
<FromIndexCollection>CollectionForContributionsMV</FromIndexCollection>
<To>Contributions</To>
</Field>
<Field>
<FromIndexCollection>CollectionForClaimsMV</FromIndexCollection>
<To>Claims</To>
</Field>
</MultiFields>
</Fields>
</CopyToPlanSegmentNameFields>

OR

<CopyToPlanSegmentNameFields>
<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>
</CopyToPlanSegmentNameFields>