DoBenefitSplitChange
The DoBenefitSplitChange rule updates benefit split allocations based on Allocations used by assignment in the case of Transfer (Switch) or Withdrawal. It supports Variable to Variable transfers as well as Variable to Fixed, and ABL purchases.
Element | Attribute | Definition | Value and Description |
---|---|---|---|
<DoBenefitSplitChange> |
|
|
|
<AssignmentMethod> |
|
The AssignmentMethod element indicates the type of action the rule is to perform. These are not assignment types, they are general directions of money movement (in, out or refactor/recalculation). |
Factor: Factor element values are read and allocations are considered negative. Switch: allocations are considered positive or negative as entered. Rebuild: Rebuild element values are read and activity allocations are not used. ABLSwitch: ]the ABLSwitch element contains the amount of the new ABL Benefit to replace the existing one. |
<CommonElements> |
|
Groups together common elements used by all assignment methods. |
|
<SyncOriginalUnits> |
|
Optional element Holds a literal or math variable value that determines whether the original benefit split records should also be updated. |
Yes | No The default value is Yes. |
<SegmentGUID> |
|
Required element Holds a math variable with the SegmentGUID of the related split records to change. The split type is assumed to be '05' |
SegmentGUID |
<ABLFundGUID> |
|
Optional element Holds a math variable with the Fund GUID of the plan's ABL fund – not required if plan does not support the ABL feature. |
FundGUID |
<EffectiveDate> |
|
Required element Holds a math variable or field that specifies the effective date to use for Benefit Fund unit values. |
Date |
<Relation> |
|
Required element Contains relation keys to link benefit funds to the parent/child allocations. |
|
<Criteria>
|
|
Required, repeatable element Identifies the fund field with which to match the Input Math value. The value of the Criteria is a Math Variable from the CalculateGeneral input math, or a literal value for matching the criteria name. |
|
NAME |
Identifies the Fund Field. |
|
|
DATATYPE |
Specifies the data type of the criteria value and Fund Field. |
|
|
<FixedBenefitFund> |
|
Required if the segment supports fixed benefit payouts. The element holds a variable containing a fund type code 03 FundGUID that all fund type code 01 fixed allocation(s) will merge to. |
FundGUID |
<Rebuild> |
|
Optional element Defines recalculating based on an input allocation set. No external activity allocation records are used and will be ignored if they exist. Rebuild is mutually exclusive with the Factor element. Only one can be configured in the rule. |
|
<BenefitSplit> |
|
Optional element Allows a specified Parent Fund/percentage allocation collection. This section is similar to the CalculateGeneral but excludes the allocation merge logic and does not write a segment allocation record. |
|
<AllocationCollection>
|
Required element Holds a math variable collection with a Parent FundGUID/Percentage key/value pair. |
||
ALLOCATIONMETHOD |
Contains a literal code value or math variable to specify the allocation method. Percentage (01) is the only supported method at present. |
01 literal code value or math variable. | |
<CreateDeferredSplit> |
|
Optional element Holds a Math Variable or literal value of Yes or No indicating whether Type 51 benefit split records are to be created. |
Yes | No The default value is No. |
<VariableBenefit> |
|
Required element Holds a Math Variable amount (currency or decimal) representing the calculated variable benefit amount |
|
<FixedBenefit> |
|
Required element Holds a Math Variable amount (currency or decimal) representing the calculated fixed benefit amount. |
|
<ABLSwitch> |
|
Optional element Indicates the new ABL benefit amount to insert into the active type 05 benefit split group. |
|
<ABLBenefit> |
|
Required element Defines a non-negative value of the new ABL benefit. It replaces the ABL benefit amount if one exists, or inserts it if it does not. If the value is zero (0), the ABL Fund record on the Benefit Split is removed. All other active type 05 benefit split group records are copied to the new group along with the ABL Fund and its amount. If the ABLBenefit element is not defined, or is a negative number, a system error is displayed: “Invalid ABL benefit amount defined”. |
|
<Factor>
|
|
Optional element Indicates that the activity allocation amounts are all negative and a reduction of the benefit split is expected. This percentage is applied to the benefit amount/units of the benefit split records (e.g. 75 would be 75% and each benefit fund record would be multiplied by this value to get the new benefit). Factor is mutually exclusive with the Rebuild element. Only one can be configured in the rule. |
A literal or math variable with a decimal percent value of 0 to 100. |
MONEYTYPE |
Specifies a money type code to use when writing the removal benefit units/amounts to the database. |
CodeValue | |
<FixedFundRemovalPercent> |
|
Optional element Defines the ratio of the current amount of the Fixed Fund benefit split record to remove. This element is used only if fixed allocation removals are supported by the plan. Holds a math variable with the percentage of the fixed fund benefit split record to remove. |
Math variable containing a percentage. The default value is 0. |
<ABLFundRemovalPercent> |
|
Optional element Defines the ratio of the current amount of the ABL Fund benefit split record to remove. This element is used only if ABL removals are supported by the plan. Holds a math variable with the percentage of the ABL fund benefit split record to remove. ABLFundGUID must be defined in the common elements if this element is used. |
Math variable containing a percentage. The default value is 0. |
<VariableFundRemovalPercent> |
|
Optional element Defines the ratio of the current units of the Variable Fund benefit split records to remove. This element is used only if Variable allocation removals are supported by the plan. Holds a math variable with the percentage of the variable fund benefit split record to remove. |
Math variable containing a percentage. The default value is 0. |
XML Example
<DoBenefitSplitChange>
<AssignmentMethod>Factor</AssignmentMethod>
<CommonElements>
<SyncOriginalUnits>Yes</SyncOriginalUnits>
<SegmentGUID>OriginalSegmentGuid</SegmentGUID>
<EffectiveDate>Activity:SettlementDate</EffectiveDate>
<Relation>
<Criteria NAME="BandVariable" DATATYPE="TEXT">Policy:BandVariable</Criteria>
<Criteria NAME="InterestRate" DATATYPE="TEXT">BenefitSplitBand</Criteria>
<FixedBenefitFund>FixedBenefitFundGUID</FixedBenefitFund>
</Relation>
</CommonElements>
<Factor MONEYTYPE="01">
<FixedFundRemovalPercent>Activity:SettlementPercent</FixedFundRemovalPercent>
<VariableFundRemovalPercent>Activity:SettlementPercent</VariableFundRemovalPercent>
</Factor>
</DoBenefitSplitChange>
XML Schema
<DoBenefitSplitChange>
<AssignmentMethod>[Factor|Switch|Rebuild|ABLSwitch]</AssignmentMethod>
<CommonElements>
<SyncOriginalUnits>[Yes|No]</SyncOriginalUnits>
<SegmentGUID>[SegmentGUID]</SegmentGUID>
<ABLFundGUID>[FundGUID]</ABLFundGUID>
<EffectiveDate>[Date]</EffectiveDate>
<Relation>
<Criteria NAME="" DATATYPE="" />
<FixedBenefitFund />
</Relation>
</CommonElements>
<Rebuild>
<BenefitSplit>
<AllocationCollection ALLOCATIONMETHOD="[01]"/>
<CreateDeferredSplit>[Yes|No]</CreateDeferredSplit>
<VariableBenefit />
<FixedBenefit />
</BenefitSplit>
</Rebuild>
<ABLSwitch>
<ABLBenefit/>
</ABLSwitch>
<Factor MONEYTYPE="[CodeValue]">
<FixedFundRemovalPercent/>
<ABLFundRemovalPercent/>
<VariableFundRemovalPercent/>
</Factor>
</DoBenefitSplitChange>