CopyToSegmentFields

Description

This business rule is used to copy one or more activity values to a segment field. A MathVariable or a field name can be used to place a single value into a segment field and a collection can be used to place multiple values onto multiple segments.

In addition to field values, CopyToSegmentFields will automatically update the OptionText of combo box and radio button fields.

This rule must be listed in the TransactionBusinessRulePacket.

CopyToSegmentFields Element/Attribute Table

Element/Tag

Definition

Attribute

Element/Attribute Value and Description

<CopyToSegmentFields>

The required opening and closing elements of this business rule.

 

Enter actual GUID for SEGMENTGUID value.

 

SEGMENTGUID

A MathVariable that contains the value of a segment GUID.

Identifies the segment by its GUID that will be updated. This attribute cannot be used in combination with the <FromCollection> element.

<Fields>

Required / Repeatable Element:
Defines a section to contain the fields that will be updated.

 

 

<Field>

Required / Repeatable Element:

Identifies a field that is updated and its data source.

<From> and <FromCollection> elements are mutually exclusive.

 

 

<From>

Required:

Identifies the MathVariable or activity field as the source value.

 

A MathVariable or activity field from the transaction to which the rule is attached.

<FromCollection>

Required:

This element is used to update multiple segments, each with their own individual value. This element cannot be used in combination with the SEGMENTGUID attribute.

 

A MathVariable of variable type Collection. The keys are segment GUIDs and the values are the updated values.

<To>

Required:

Identifies the field that is updated.

 

A literal name for a segment field.

XML Example

<CopyToSegmentFields SEGMENTGUID="DeferredAnnuityGUID">
<Fields>
<Field>
<From>Yes</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>ValidStartDate</From>
<To>DCAStartDate</To>
</Field>
<Field>
<From>ValidStartDate</From>
<To>DCANextTransferDate</To>
</Field>
<Field>
<From>DCATransafersRemaining</From>
<To>DCATransfersRemaining</To>
</Field>
</Fields>
</CopyToSegmentFields>
 
<CopyToSegmentFields>
<Fields>
<Field>
<FromCollection>SegmentModalPremiumAmt</FromCollection>
<To>SegmentModalPremium</To>
</Field>
<Field>
<FromCollection>SegmentNextYearsModalPremiumAmt</FromCollection>
<To>SegmentNextYearsModalPremium</To>
</Field>
<Field>
<FromCollection>SegmentAnnPremiumAmt</FromCollection>
<To>SegmentAnnualPremium</To>
</Field>
<Field>
<FromCollection>SegmentNextYearsAnnPremiumAmt</FromCollection>
<To>SegmentNextYearsAnnualPremium</To>
</Field>
</Fields>
</CopyToSegmentFields>