WriteValuationElements

This business rule limits the amount of an activity's valuation information that is persisted to the database. Valuation generates data that can be written to the system's database to supplement the normal data persistence. These data values are divided into sets and distinguished in this by the sections Policy, Fund and Deposit. These is also a PolicyValues section in which any math variable generated by the PolicyValues business rule can be persisted by valuation. For a specific Activity Valuation, the configured data value may not exist in the calculated data. In this scenario, the data value will be an appropriate initial value such as 0 for numeric data, blank for text and date data. For example, configuration may define persistence of the MVAAmount. If the Policy has invested in funds other than MVA Funds and the Activity processes a Valuation, the MVAAmount will persist a 0 value because it is not calculated.

The contents of this rule can be configured in one or more copybooks.

This is a System rule that can be overridden within the levels defined by the Plan override rules context. That context covers overrides by Plan, Product hierarchy, Subsidiary Company and Global scopes.

WriteValuationElements: Elements and Attributes
Element Attibutes Parent Element Description Element/Attribute Value
<WriteValuationElements>  
This is the root element for this rule.
<Policy>   <WriteValuationElements>

Optional:

This element dictates the Policy level valuation data to persist with every Activity's Valuation. 


<Element>   <Policy>

Required, Repeatable:

This element identifies a single data value to persist with every Valuation.  The data value may be an accumulation of a lower level data values (Fund or Deposit) to result in a single Policy level data value.  This element is repeated to identify multiple data values to persist at a Policy level. 

  • BeginNetGain
    • value is the Policy level difference between BeginCashValue and BeginPrincipal data values
  • EndNetGain
    • value is the Policy level difference between EndCashValue and EndPrincipal data values
  • NetGain
    • this value will cause the Policy level BeginNetGain and EndNetGain data values to be persisted
    • when used in combination with BeginNetGain or EndNetGain, only one BeginNetGain data value and one EndNetGain data value will be persisted
  • InterestBonus
    • value is the Policy level accumulation of Fund level Interest Bonus values generated by Valuation that processes the InterestRateCalculation business rule
  • GuaranteedAmount
    • value is the Policy level accumulation of Fund level Guaranteed interest values generated by Valuation that processes the InterestRateCalculation business rule
  • MVAAmount
    • value is the Policy level accumulation of Fund level MVA Amount values generated by Valuation that processes the MVAAmountFormula business rule
  • RedemptionAmount
    • value is the Policy level accumulation of Fund level Redemption Amount values generated by Valuation that processes the RedemptionAmountFormula business rule
  • ShortTermRedemptionUnits
    • value is the Policy level accumulation of Fund level Short Term Redemption Units values generated by Valuation that processes the RedemptionAmountFormula business rule
<Fund>   <WriteValuationElements>

Optional:

This element dictates the Fund level valuation data to persist with every Activity's Valuation. 


<Element>   <Fund>

Required, Repeatable:

This element identifies a single data value to persist with every Valuation.  The data value may be an accumulation of a lower level data values (Deposit) to result in a single Fund level data value.  This element is repeated to identify multiple data values to persist at a Fund level. 

  • FundName
    • value is the name of the Fund
  • TypeCode
    • value is the Fund's TypeCode
  • UnitValue
    • value is the UnitValue used during Valuation of the Fund
  • BeginNetGain
    • value is the Fund level difference between BeginCashValue and BeginPrincipal data values
  • EndNetGain
    • value is the Fund level difference between EndCashValue and EndPrincipal data values
  • NetGain
    • this value will cause the Fund level BeginNetGain and EndNetGain data values to be persisted
    • when used in combination with BeginNetGain or EndNetGain, only one BeginNetGain data value and one EndNetGain data value will be persisted
  • MVAAmount
    • value is the Fund level accumulation of Deposit level MVA Amount values generated by Valuation that processes the MVAAmountFormula business rule
  • RedemptionAmount
    • value is the Fund level accumulation of Deposit level Redemption Amount values generated by Valuation that processes the RedemptionAmountFormula business rule
  • ShortTermRedemptionUnits
    • value is the Fund level accumulation of Deposit level Short Term Redemption Units values generated by Valuation that processes the RedemptionAmountFormula business rule
  • GuaranteedAmount
    • value is the Fund level accumulation of Deposit level Guaranteed interest values generated by Valuation that processes the InterestRateCalculation business rule
<Deposit>   <WriteValuationElements>

Optional:

This element dictates the Deposit level valuation data to persist with every Activity's Valuation. 


<Element>   <Deposit>

Required, Repeatable:

This element identifies a single data value to persist with every Activity Valuation.  This element is repeated to identify multiple data values to persist at a Deposit level. 

  • InitialUnits
    • value is the number of units used to established the deposit
    • this is pertinent data with Inception based valuation only
  • InitialCashValue
    • value is the cash value of the investment that established the deposit
    • this is pertinent data with Inception based valuation only
  • BeginNetGain
    • value is the Deposit level difference between BeginCashValue and BeginPrincipal data values
  • EndNetGain
    • value is the Deposit level difference between EndCashValue and EndPrincipal data values
  • NetGain
    • this value will cause the Deposit level BeginNetGain and EndNetGain data values to be persisted
    • when used in combination with BeginNetGain or EndNetGain, only one BeginNetGain data value and one EndNetGain data value will be persisted
  • InterestBonus
    • value is the Deposit level Interest Bonus value generated by Valuation that processes the InterestRateCalculation business rule
  • GuaranteedAmount
    • value is the Deposit level Guaranteed interest value generated by Valuation that processes the InterestRateCalculation business rule
  • MVAAmount
    • value is the Deposit level MVA Amount value generated by Valuation that processes the MVAAmountFormula business rule
  • MoneyTypeCode
    • value is the Money Type Code persisted when the Deposit was established
    • this is pertinent data with Inception based valuation only
  • RateLockDate
    • value is the Rate Lock date persisted when the Deposit was established
  • RedemptionAmount
    • value is the Deposit level Redemption Amount value generated by Valuation that processes the RedemptionAmountFormula business rule
  • ShortTermRedemptionUnits
    • value is the Deposit level Short Term Redemption Units value generated by Valuation that processes the RedemptionAmountFormula business rule
<PolicyValues>   <WriteValuationElements>

Optional:

This element dictates the PolicyValues math data to persist with every Activity's Valuation. 

Note: Any values referenced in WriteValuationElements from PolicyValues Business rule will be calculated only once and will display same value in Begin Values and End Values.


<Element>   <PolicyValues>

Required, Repeatable:

This element identifies a single math variable from the PolicyValues business rule to persist with every Activity's Valuation.  This element is repeated to identify multiple values to persist. 

  • math variable
    • the variable data comes from the PolicyValues business rule

XML Schema

<WriteValuationElements>
    <Policy>
        <Element>[BeginNetGain | EndNetGain | NetGain | InterestBonus | GuaranteedAmount | MVAAmount | RedemptionAmount | ShortTermRedemptionUnits]</Element>
        <Element>...</Element>
    </Policy>
    <Fund>
        <Element>[FundName | TypeCode | UnitValue | BeginNetGain | EndNetGain | NetGain | GuaranteedAmount | MVAAmount | RedemptionAmount | ShortTermRedemptionUnits]</Element>
        <Element>...</Element>
    </Fund>
    <Deposit>
        <Element>[InitialUnits | InitialCashValue | BeginNetGain | EndNetGain | NetGain | InterestBonus | GuaranteedAmount | MVAAmount | MoneyTypeCode | RateLockDate | RedemptionAmount | ShortTermRedemptionUnits]</Element>
        <Element>...</Element>
    </Deposit>
    <PolicyValues>
        <Element>[math variable]</Element>
        <Element>...</Element>
    </PolicyValues>
</WriteValuationElements>
 

XML Example:

<WriteValuationElements>
    <Fund>
        <Element>FundName</Element>
        <Element>UnitValue</Element>
        <Element>NetGain</Element>
    </Fund>
    <Deposit>
        <Element>BeginNetGain</Element>
        <Element>EndNetGain</Element>
    </Deposit>
    <PolicyValues>
        <Element>MaxLoanAmount</Element>
    </PolicyValues>
</WriteValuationElements>