AllocationScreen

The Allocation screen rule controls Policy level allocations. Allocations are used to define how money can be applied to a Policy through persisted Policy level allocations.

Note: The functionality of this element is replaced by the PolicyAllocationScreen rule and configuration should migrate toward using the new rule before the AllocationScreen is removed from the system.

 

AllocationScreen: Elements and Attributes
Element/Tag Attributes Parent Element Description Element/Attribute Values
<AllocationScreen>    

Required:

The opening and closing tag of the AllocationScreen business rule.

The functionality of this element is replaced by the PolicyAllocationScreen rule and configuration should migrate toward using the new rule.

  
<Allocations>   <AllocationScreen>

Required, Repeatable:

This element indicates the Allocation level being defined. The AllocationScreen business rule is used to configure Plan and Policy Allocation screens.  There can only be 1 or 2 of these elements in the rule.  If there is 1 element, it can define either the Plan allocation or Policy allocations.  If there are 2 elements, one element must define the Plan allocation and the other element must define the Policy allocations.

  
  TYPE <Allocations>

Optional:

This attribute indicates the level of allocation being displayed.

Values:

  • Policy

    • This defines the allocation at the Policy level

  • Plan

    • This defines the allocation at the Plan level
  ALWAYSEQUALPERCENT <Allocations>

Optional:

This attribute forces the system to evenly divide 100% among all funds in the allocation.  When not evenly divisible rounding will alter the percentage of the last fund in the allocation either above or below the percentage of the other funds make the whole list sum to 100%.

Values:

  • Yes

    • default

    • The system will evenly divide the percentage value among the funds as closely as possible with a slight rounding difference added to the last fund.

  • No

    • If the system cannot evenly divide the percentage value among the funds where they all have the same value, then the funds will remain at 0 percent.
  ALLOCATIONDATE <Allocations>

Optional:

This attribute indicates that the Funds used in the allocation should be based on the date value specified in the field and not based on the Policy's effective date. 

Values:

  • dynamic policy field name

    • The referenced field must contain a valid date.
  additional attributes continue below <Allocations>

 

  
<Allocation>   <Allocations>

Required, Repeatable:

This element provides definition for a specific allocation type.  It is repeated to define multiple Policy allocation types.

  
  TYPECODE <Allocation>

Required:

This attribute provides the code value for the specific allocation type defined by the parent element.

Values:

  • code value

    • The value must be a valid code from AsCodeAllocationType.
  additional attributes continue below <Allocation>

 

  
<AllocationMethods>   <Allocation>

Required:

This attribute identifies, in a comma delimited list, allocation methods that the user can choose from.

Values:

  • code value

    • comma delimited list

    • Valid values are found in AsCodeAllocationMethod
<AllocationTransfer>   <Allocation>

Optional:

This element creates a structure to define the source and target allocations applicable to a Transfer assignment.

  
  REPEATFUNDS <AllocationTransfer>

Optional:

This attribute indicates that the source and target allocations may contain the same funds.

Values:

  • Yes

    • default

    • The same funds may be repeated in the source and target allocations

  • No

    • The same funds cannot be repeated in the source and target allocations
<AllocationFrom>   <AllocationTransfer>

Required:

This element provides definition for the source funds that are available for a transfer.

  
  additional attributes continue below <AllocationFrom>

 

  
<AllocationTo>   <AllocationTransfer>

Optional:

This element provides definition for the target funds that are available for a transfer.

  
  additional attributes continue below <AllocationTo>

 

  
Additional attributes  
  AMOUNTPRECISION <Allocations>, <Allocation>, <AllocationFrom>, <AllocationTo>

Optional:

This attribute provides the maximum number of decimal places allowed after the decimal point.  It is used when allocating money.

Values:

  • 2

    • default

  • integer
  UNITPRECISION <Allocations>, <Allocation>, <AllocationFrom>, <AllocationTo>

Optional:

This attribute sets the maximum number of decimal places in an percent method allocation.

Values:

  • 6

    • default

  • integer
  PERCENTPRECISION <Allocations>, <Allocation>, <AllocationFrom>, <AllocationTo>

Optional:

This attribute sets the maximum number of decimal places in an percent method allocation.

Values:

  • 4

    • default

  • integer
  FUNDLIMIT <Allocation>, <AllocationFrom>, <AllocationTo>

Optional:

The element provides a maximum limit on the number of funds that can be allocated.  When the element is not configured, there is no maximum.

Values:

  • integer
  EXCLUDETYPE <Allocation>, <AllocationFrom>, <AllocationTo>

Optional:

This attribute provides a list of fund types that will be excluded from the fund drop down list.

Values:

  • fund type code value

    • comma delimited list

    • code values come from AsCodeFundType
  EXCLUDEFUNDSTATUS <Allocation>, <AllocationFrom>, <AllocationTo>

Optional:

This attribute provides a list of fund statuses so that funds with one of the status values will not populate the fund drop down list.

Values:

  • list of fund statuses

    • comma delimited list

    • code values come from AsCodeFundStatus
  EXCLUDEFUNDNAME <AllocationFrom>, <AllocationTo>

Optional:

This attribute provides a list of fund names that will not populate the fund drop down list.

Values:

  • list of fund names

    • comma delimited list
  METHODCODES <AllocationFrom>, <AllocationTo>

Optional:

This attribute identifies the allocation methods that the user can choose from.

Values:

  • code value

    • comma delimited list

    • Valid values are found in AsCodeAllocationMethod
  ALLOWMIXEDMETHODS <AllocationFrom>, <AllocationTo>

Optional:

This attribute indicates when mixed allocation methods are allowed.  Normally, all funds in an allocation apply a single allocation method chosen by the user.  When mixed methods are allowed, an allocation may apply a different allocation method per fund.

Values:

  • No

    • default

    • Mixed allocations are not allowed.

  • Yes

    • Mixed allocations are allowed.
  AMOUNTMINIMUM <AllocationFrom>, <AllocationTo>

Optional:

This attribute provides the minimum amount for each fund's amount method allocation and generates a validation when that is not reached.

Values:

  • minimum amount
  PERCENTMINIMUM <AllocationFrom>, <AllocationTo>

Optional:

This attribute provides the minimum percentage for each fund's percent method allocation and generates a validation when that is not reached.

Values:

  • minimum percent

    • Percents are configured in their mathematical form (.02 is 2%)
  UNITMINIMUM <AllocationFrom>, <AllocationTo>

Optional:

This attribute provides the minimum number of units for each fund's unit method allocation and generates a validation when that is not reached.

Values:

  • minimum units
  INCLUDEFUNDFIELD <AllocationFrom>, <AllocationTo>

Optional:

This attribute provides a fund's dynamic field name that is used in combination with INCLUDEFUNDFIELDVALUE.  Together the attributes represent a filter that includes funds with matching field name and value.

Values:

  • field name
  INCLUDEFUNDFIELDVALUE <AllocationFrom>, <AllocationTo>

Optional:

This attribute provides a fund's dynamic field value that is used in combination with INCLUDEFUNDFIELD.  Together the attributes represent a filter that includes funds with matching field name and value.

Values:

  • literal
  EXCLUDEFUNDFIELD <AllocationFrom>, <AllocationTo>

Optional:

This attribute provides a fund's dynamic field name that is used in combination with EXCLUDEFUNDFIELDVALUE.  Together the attributes represent a filter that excludes funds with matching field name and value.

Values:

  • field name
  EXCLUDEFUNDFIELDVALUE <AllocationFrom>, <AllocationTo>

Optional:

This attribute provides a fund's dynamic field value that is used in combination with EXCLUDEFUNDFIELD.  Together the attributes represent a filter that excludes funds with matching field name and value.

Values:

  • literal
  IF <AllocationFrom>, <AllocationTo>

Optional:

This attribute defines a condition that when it evaluates to true the allocation will be displayed.

Values:

  • conditional statement
<DisableAllocationFields>   <AllocationScreen>

Optional:

This element may disable the Allocation screen based on the Policy Status listed in its structure

  
<DisablePolicyStatus   <DisableAllocationFields>

Required:

This element provides Policy status codes that disable the Allocation screen.

Values:

  • status code

    • comma delimited list

    • Valid values come from AsCodeStatus
<Events>   <AllocationScreen>

Optional:

See Actions/Events element.

 
<ScreenMath>   <AllocationScreen>

Optional:

See Actions/Events element.

 
<Actions>   <AllocationScreen>

Optional:

See Actions/Events element.

 

XML Schema 

<AllocationScreen>
    <Allocations TYPE="[Policy | Plan]" ALWAYSEQUALPERCENT="[Yes | No]" ALLOCATIONDATE="[field name]" AMOUNTPRECISION="[2 | integer]" UNITPRECISION="[6 | integer]" PERCENTPRECISION="[4 | integer]">
        <Allocation TYPECODE="[code value]" FUNDLIMIT="[integer]" AMOUNTPRECISION="[2 | integer]" UNITPRECISION="[6 | integer]" PERCENTPRECISION="[4 | integer]" EXCLUDETYPE="[[code  value],...]" EXCLUDEFUNDSTATUS="[[status code],...]">
            <AllocationMethods>[[code value],...]</AllocationMethods>
            <AllocationTransfer REPEATFUNDS="[Yes | No]">
                <AllocationFrom FUNDLIMIT="[integer]" IF="[condition]" METHODCODES="[[code value],...]" ALLOWMIXEDMETHODS="[No | Yes]" AMOUNTPRECISION="[2 | integer]" UNITPRECISION="[6 | integer]" PERCENTPRECISION="[4 | integer]" AMOUNTMINIMUM="[amount]" PERCENTMINIMUM="[amount]" UNITMINIMUM="[amount]" EXCLUDETYPE="[[code  value],...]" EXCLUDEFUNDNAME="[[fund name],...]" EXCLUDEFUNDSTATUS="[[fund status],...]" EXCLUDEFUNDFIELD="[field name]" EXCLUDEFUNDFIELDVALUE="[literal]" INCLUDEFUNDFIELD="[field name]" INCLUDEFUNDFIELDVALUE="[literal]"/>
                <AllocationTo FUNDLIMIT="[integer]" IF="[condition]" METHODCODES="[[code value],...]" ALLOWMIXEDMETHODS="[No | Yes]" AMOUNTPRECISION="[2 | integer]" UNITPRECISION="[6 | integer]" PERCENTPRECISION="[4 | integer]" AMOUNTMINIMUM="[amount]" PERCENTMINIMUM="[amount]" UNITMINIMUM="[amount]" EXCLUDETYPE="[[code  value],...]" EXCLUDEFUNDNAME="[[fund name],...]" EXCLUDEFUNDSTATUS="[[fund status],...]" EXCLUDEFUNDFIELD="[field name]" EXCLUDEFUNDFIELDVALUE="[literal]" INCLUDEFUNDFIELD="[field name]" INCLUDEFUNDFIELDVALUE="[literal]"/>
            </AllocationTransfer>
        </Allocation>
        <Allocation>...</Allocation>
    </Allocations>
    <Allocations>...</Allocations>
    <DisableAllocationFields>
        <DisablePolicyStatus>[[status code],...]</DisablePolicyStatus>
    </DisableAllocationFields>
    <Events>...</Events>
    <ScreenMath>...</ScreenMath>
    <Actions>...</Actions>
</AllocationScreen>

XML Example

<AllocationScreen>
    <Allocations TYPE="Plan" AMOUNTPRECISION="2" PERCENTPRECISION="2">
        <Allocation TYPECODE="01" FUNDLIMIT="01">
            <AllocationMethods>01,02,034,05</AllocationMethods>
        </Allocation>
    </Allocations>
    <Allocations TYPE="Policy" AMOUNTPRECISION="2" PERCENTPRECISION="2">
        <!-- Money In -->
        <Allocation TYPECODE="02" FUNDLIMIT="20">
            <AllocationMethods>01</AllocationMethods>
        </Allocation>
        <!-- Money Out -->
        <Allocation TYPECODE="61" FUNDLIMIT="20">
            <AllocationMethods>01,02,03,04,05</AllocationMethods>
        </Allocation>
        <!-- Asset Rebalance Target -->
        <Allocation TYPECODE="09" FUNDLIMIT="20">
            <AllocationMethods>01</AllocationMethods>
        </Allocation>
        <!-- Cost Averaging Source -->
        <Allocation TYPECODE="13" FUNDLIMIT="01" EXCLUDETYPE="10">
            <AllocationMethods>02</AllocationMethods>
        </Allocation>
        <!-- Cost Averaging Target -->
        <Allocation TYPECODE="16" FUNDLIMIT="20">
            <AllocationMethods>01</AllocationMethods>
        </Allocation>
    </Allocations>
    <DisableAllocationFields>
        <DisabledPolicyStatus>99,98</DisabledPolicyStatus>
    </DisableAllocationFields>
</AllocationScreen>
 
<AllocationScreen>
    <Allocations TYPE="Policy" FUNDLIMIT="1" AMOUNTPRECISION="2" PERCENTPRECISION="2" ALWAYSEQUALPERCENT="">
        <Allocation TYPECODE="02" FUNDLIMIT="20" EXCLUDEFUNDNAME="Interim Account">
            <AllocationMethods>01</AllocationMethods>
        </Allocation>
    </Allocations>
</AllocationScreen>
 
<AllocationScreen>
    <Allocations TYPE="Plan" AMOUNTPRECISION="2" UNITPRECISION="5" PERCENTPRECISION="2" USEEFFECTIVEDATE="Yes" ALWAYSEQUALPERCENT="No">
        <Allocation TYPECODE="01" EXCLUDETYPE="03,04,05,06,07,09" FUNDLIMIT="3" AMOUNTPRECISION="2" UNITPRECISION="5" PERCENTPRECISION="2">
            <AllocationMethods>01,02,03,04,05</AllocationMethods>
        </Allocation>
    </Allocations>
    <Allocations TYPE="Policy" AMOUNTPRECISION="2" UNITPRECISION="5" PERCENTPRECISION="2" USEEFFECTIVEDATE="Yes" ALWAYSEQUALPERCENT="No">
        <Allocation TYPECODE="02" EXCLUDETYPE="03,04,05,06,07,09" FUNDLIMIT="3" AMOUNTPRECISION="2" UNITPRECISION="5" PERCENTPRECISION="2">
            <AllocationMethods>01,02</AllocationMethods>
        </Allocation>
        <Allocation TYPECODE="61" EXCLUDETYPE="03,04,05,06,07,09" FUNDLIMIT="3" AMOUNTPRECISION="2" UNITPRECISION="5" PERCENTPRECISION="2">
            <AllocationMethods>01,02,03,04,05</AllocationMethods>
        </Allocation>
        <Allocation TYPECODE="09" EXCLUDETYPE="03,04,05,06,07,09" FUNDLIMIT="3" AMOUNTPRECISION="2" UNITPRECISION="5" PERCENTPRECISION="2">
            <AllocationMethods>01,02,03,04,05</AllocationMethods>
        </Allocation>
        <Allocation TYPECODE="14" EXCLUDETYPE="03,04,05,06,07,09,10" FUNDLIMIT="3" AMOUNTPRECISION="2" UNITPRECISION="5" PERCENTPRECISION="2">
            <AllocationMethods>02,05</AllocationMethods>
            <AllocationTransfer RepeatFunds="Yes">
                <AllocationFrom EXCLUDETYPE="03,04,05,06,07,09,10" FUNDLIMIT="1" AMOUNTPRECISION="2" UNITPRECISION="5" PERCENTPRECISION="2" ALLOWMIXEDMETHODS="No" AMOUNTMINIMUM="100" UNITMINIMUM="2" METHODCODES="02,05"/>
                <AllocationTo EXCLUDETYPE="02,03,04,05,06,07,09" FUNDLIMIT="3" AMOUNTPRECISION="2" UNITPRECISION="5" PERCENTPRECISION="2" ALLOWMIXEDMETHODS="No" UNITMINIMUM="2" METHODCODES="01"/>
            </AllocationTransfer>
        </Allocation>
        <!--<Allocation TYPECODE="03" EXCLUDETYPE="01,03,04,05,06,07,09,10" FUNDLIMIT="1" AMOUNTPRECISION="2" UNITPRECISION="5" PERCENTPRECISION="2" ALLOWMIXEDMETHODS="No"></Allocation>-->
    </Allocations>
    <DisableAllocationFields>
        <DisabledPolicyStatus>01,03,04,07,13,14,21,98,99</DisabledPolicyStatus>
    </DisableAllocationFields>
</AllocationScreen>