CopyToSegmentFields

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 business rule.

CopyToSegmentFields: Elements and Attributes
Element/Tag	Attributes	Parent Element	Description	Element/Attribute Values
<CopyToSegmentFields>			The required opening and closing elements of this business rule.	Enter actual GUID for SEGMENTGUID value.
<CopyToSegmentFields>	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>		<CopyToSegmentFields>	Required / Repeatable Element: Defines a section to contain the fields that will be updated.
<Field>		<Fields>	Required / Repeatable Element: Identifies a field that is updated and its data source. <From> and <FromCollection> elements are mutually exclusive.
<From>		<Field>	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>		<Field>	Required: Identifies the field that is updated.	A literal name for a segment field.
<OptionText>		<Field>	Optional element: Identifies the source of the data that will update the OptionText for the field defined in the <To> element. Note: This element and the <OptionTextCollection> element are mutually exclusive.	MathVariable
<OptionTextCollection>		<Field>	Optional element: Specifies a collection of key-value pairs, where the key is an Entity GUID and the value is a supported value for the OPTIONTEXT for field defined in the <To> element. This element can only be paired with the <FromCollection> element. Note: This element and the <OptionText> element are mutually exclusive. This element is also mutually exclusive with the <From> element.	MathVariable
<MultiFields>			Optional, repeatable element: Defines the multifields to be updated/inserted. Note: The system will validate named "To" fields against the field name in the MultiField rule for the SEGMENTNAME (AsSegmentName) the specified SegmentGUID.
	NAME		Required: Specifies the named section of the related entity's Multifield rule.	Literal name
	END		Required: Specifies the total number of instances of multifields for the named section of the related entity's Multifield rule. If NAME is omitted or does not exist in the MultiField rule, all the fields in the MultiField rule will be repeated for "END" number of times.	Literal Integer or Integer Math Variable.
<Field>		<Fields>	Optional, repeatable element: Contains the instructions for the specified "To" field. This element (and sub elements) may be omitted if the default field values are desired.
<FromIndexCollection>		<Field>	Required: A collection of index/value pairs for the target fields. Indices must be unique integers	Math variable collection of index/values.
<To>		<Field>	Required: The target named field in the entity multifield rule	Literal field name

XML Schema

<CopyToSegmentFields>

<Fields>

<Field>

<FromCollection>SegmentModalPremiumAmt</FromCollection>

<To>SegmentModalPremium</To>

<OptionTextCollection>SegmentModalPremiumAmtOptionText<OptionTextCollection>

</Field>

<Field>

<FromCollection>SegmentNextYearsModalPremiumAmt</FromCollection>

<To>SegmentNextYearsModalPremium</To>

<OptionTextCollection>SegmentNextYearsModalPremiumAmtOptionText<OptionTextCollection>

</Field>

<Field>

<FromCollection>SegmentAnnPremiumAmt</FromCollection>

<To>SegmentAnnualPremium</To>

<OptionTextCollection>SegmentAnnPremiumAmtOptionText<OptionTextCollection>

</Field>

<Field>

<FromCollection>SegmentNextYearsAnnPremiumAmt</FromCollection>

<To>SegmentNextYearsAnnualPremium</To>

<OptionTextCollection>SegmentNextYearsAnnualPremiumAmtOptionText<OptionTextCollection>

</Field>

</Fields>

</CopyToSegmentFields>

XML Example

<CopyToSegmentFields SEGMENTGUID="DeferredAnnuityGUID">

<Fields>

<Field>

<From>Yes</From>

<To>DollarCostAveragingProgram</To>

<OptionText>DollarCostAveragingProgramOptionText</OptionText>

</Field>

<Field>

<From>Activity:Amount</From>

<To>DCAAmount</To>

<OptionText>DCAAmountOptionText</OptionText>

</Field>

<Field>

<From>Activity:Frequency</From>

<To>DCAFrequency</To>

<OptionText>DCAFrequencyOptionText</OptionText>

</Field>

<Field>

<From>ValidStartDate</From>

<To>DCAStartDate</To>

<OptionText>DCAStartDateOptionText</OptionText>

</Field>

<Field>

<From>ValidStartDate</From>

<To>DCANextTransferDate</To>

<OptionText>DCANextTransferDateOptionText</OptionText>

</Field>

<Field>

<From>DCATransafersRemaining</From>

<To>DCATransfersRemaining</To>

<OptionText>DCATransfersRemainingOptionText</OptionText>

</Field>

</Fields>

</CopyToSegmentFields>