RemoveByFund
The RemoveByFund Assignment element, located in the transaction XML, is used to direct removals from specific funds and also collections of funds and amounts may be specified.
A user can configure RemoveByFund assignment for money withdrawal from a specific bucket of one or more indexed funds. RemoveByFund assignment allows an activity to remove money from one or more funds without the use of an allocation. The activity will use its configured logic to determine which funds and the amount to remove from each.
Type = RemoveByFund | |
---|---|
Allocations needed? |
No |
Attributes |
None |
Element Value |
One or more MoneyType tags that define the amount and type of money to be applied. Each MoneyType must have a FUND attribute set to a FundGUID value. |
Note: Assignment values must be positive. |
|
Used when |
To direct removals from specific funds. |
Examples |
LoanRepayment |
Element | Parent Element | Attribute Value | Element Value | Definition |
<Assignment> | Required: Root element. | |||
<Assignment> | TYPE | RemoveByFund | Required: The RemoveByFund assignment removes money from the policy by providing the funds and amounts in the configuration. No allocations will be used by this assignment. | |
<MoneyType> | <Assignment> | money type code | Required & Repeatable: The MoneyType element identifies the money type code for the money change records. This money type code applies while the fund's or deposit's cash value is 0 or positive. It also applies to money change records while fund's or deposit's cash value is negative and the attribute NEGATIVEDEPOSITMONEYTYPE is not configured. | |
<MoneyType> | ASSIGNMENTFUNDCOLLECTION | A math collection of fund GUIDs and amounts | Defines a collection of parent fund GUIDs and amounts to use in the assignment. Takes precedence over legacy NAME and FUND attributes for these assignments. | |
<MoneyType> | NAME | math variable containing an amount | Optional: The attribute provides the name of the math variable holding the amount of change for this money type code. This attribute must be used with the FUND attribute. This attribute is not to be configured with ASSIGNMENTFUNDCOLLECTION. If it is, this attribute will be ignored. | |
<MoneyType> | BUCKET | math variable containing an integer | Optional: This attribute identifies the bucket from which to pull money from Indexed funds where buckets are part of the deposit information. A BUCKET value is only applicable to indexed fund types. For fund types where a bucket has not been established, the bucket value is ignored. The bucket is identified by the integer value provided by this attribute. | |
<MoneyType> | FUND | math variable containing a string | Optional: The attribute provides the FundGUID that will be used in the assignment. This attribute requires the NAME attribute. This attribute is not to be used with ASSIGNMENTFUNDCOLLECTION. If the two are configured, this attribute will be ignored. | |
<MoneyType> | VALUATIONCOLLECTION | Yes, No | Optional: Indicator for the ASSIGNMENTFUNDCOLLECTION to use ValuationGUID/Amount (or DepositValuGUID/Amount if the plan is PIT) as the key value pairing. The default value is "No". This attribute has no meaning without the ASSIGNMENTFUNDCOLLECTION attribute. |
XML Schema
<Assignment TYPE="[RemoveByFund]">
<MoneyType NAME="[MathVariable Amount]" FUND="[MathVariable FundGUID]" VALUATIONCOLLECTION="[Yes|No]" ASSIGNMENTFUNDCOLLECTION="[Math Collection]">[Code Value]</MoneyType>
<MoneyType NAME="[math variable]" BUCKET="[integer]" RATELOCKDATE="[date]" ASSIGNFUNDCOLLECTION="[collection]" FUND="[fundguid]" VALUATIONCOLLECTION="[Yes|No]">[money type code]</MoneyType>
<MoneyType>...</MoneyType>
</Assignment>
XML Example
<Assignment TYPE="RemoveByFund">
<MoneyType NAME="DBGRMonthlySale" FUND="ShadowDBGFund">87</MoneyType>
<MoneyType NAME="GuarInterestMonthlySale" FUND="ShadowGUARFund">86</MoneyType>
<MoneyType NAME="NewDeficit" FUND="PolicyDeficit">69</MoneyType>
<MoneyType NAME="NewDBGDeficit" FUND="ShadowDBGDeficit">69</MoneyType>
<MoneyType NAME="NewGUARDeficit" FUND="ShadowGUARDeficit">69</MoneyType>
<MoneyType NAME="DCVDeficitNetApplied" FUND="DCVDeficitFund">69</MoneyType>
<MoneyType NAME="DBGDeficit" FUND="ShadowDBGDeficit">69</MoneyType>
<MoneyType NAME="GUARDeficit" FUND="ShadowGUARDeficit">69</MoneyType>
<MoneyType NAME="DCVDeficitNet" FUND="DCVDeficitFund">69</MoneyType>
</Assignment>
OR
<Assignment TYPE="RemoveByFund">
<MoneyType ASSIGNMENTFUNDCOLLECTION="AssignmentFundCollection">69</MoneyType>
</Assignment>