Allocation Element

The Allocation element allows configuration development to specify settings for allocations that move money into funds.

This is used in conjunction with <Allocation> and for a transfer allocation. The <Allocation> element defines the funds and characteristics available to the transfer's targets and <AllocationFrom> element defines the funds and characteristics available to the transfer's sources.

Note: The functionality of this element is replaced by the TransactionAllocationScreen attached rule and configuration should migrate toward using the new rule.

Allocation: Elements and Attributes
Element/Tag Attributes Parent Element Description Element/Attribute Value

<Allocation>

 

 

 

<Transaction>

 

Optional Element:

This element should be used when there must be different configuration for the 'From' and 'To' funds.

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

  • Yes

    • default

    • The element and its values will be executed and defines the allocation details.

  • No

    • The element will not be executed.

ALLOCATIONTYPES

<Allocation>

 

Required Element:

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

  • Percent

  • Amount

  • PercentOfFund

  • Units

ALLOWMIXEDMETHODS

  

Optional Elements:

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.

  • No

    • default

    • Mixed allocations are not allowed.

  • Yes

    • Mixed allocations are allowed.

EXCLUDEFUNDFIELD

  

Optional Element:

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.

field name

EXCLUDEFUNDFIELDVALUE

  

Optional Element:

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.

 literal

EXCLUDEFUNDNAME

  

Optional Element

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

  • list of fund names

    • comma delimited list

EXCLUDEFUNDSTATUS

  

Optional Element

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. This is a comma delimited list of status codes from AsCodeFundStatus.

  • list of fund statuses

    • comma delimited list

    • code values come from AsCodeFundStatus

EXCLUDEFUNDSTATUSERROR

  

Optional Element:

  • No

    • default

  • Yes

EXCLUDETYPE

  

Optional Element:

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

  • fund type code value

  • code values come from AsCodeFundType

FUNDLIMIT

  

Optional Element:

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.

 integer

INCLUDEFUNDFIELD

  

Optional Element:

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.

 field name

INCLUDEFUNDFIELDVALUE

  

Optional Element:

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.

 literal

MIXEDALLOCATIONTYPES

  

Optional Element:

This attribute provides a comma delimited list of the allocation methods available for the individual funds when the allocation is allowed mixed allocation methods to be entered. The ALLOWMIXEDMETHODS attribute must be "Yes".

  • Percent

  • Amount

  • PercentOfFund

  • Units

SHOWVALUATION

  

Optional Element:

This attribute allows fund valuation to be displayed and may indicate that the funds available for user choice in the funds' drop down list is limited to non-zero cash values.

  • No

    • default

    • Fund valuation is not displayed

    • Funds regardless of their cash value are available to the allocation

  • Yes

    • Fund valuation is displayed

    • Funds available to the allocation are limited to those with non-zero cash value

    • The SHOWVALUATION attributes in elements <FundAllocation> and <AllocationFrom> must also have a value of "Yes".

XML Schema

<Allocation ALLOCATIONTYPES="[[Percent | Amount | PercentOfFund | Units],...]" ALLOWMIXEDMETHODS="[No | Yes]" EXCLUDEFUNDFIELD="[literal]" EXCLUDEFUNDFIELDVALUE="[literal]" EXCLUDEFUNDNAME="[[list fund name],...]" EXCLUEDFUNDSTATUS="[[list fund status],...]" EXCLUDEFUNDSTATUSERROR="[No | Yes]" EXCULDETYPE="[[list fund types],...]" FUNDLIMIT="[integer]" INCLUDEFUNDFIELD="[field name]" INCLUDEFUNDFIELDVALUE="[literal]" MIXEDALLOCATIONTYPES="[[Mixed | Percent | Amount | Units],...]" SHOWVALUATION="[No | Yes]">[Yes | No]</Allocation>

XML Example

<Allocation EXCLUDETYPE="01,02,05" EXCLUDEFUNDNAME="Suspense,AIMFund">Yes</Allocation>
<Allocation ALLOWMIXEDMETHODS="Yes" FUNDLIMIT="18"></Allocation>
<Allocation EXCLUDEFUNDSTATUS="01,02,03"></Allocation>