Alloc

Allocates data from one point of view to another. This function can be used in Allocation rules.

Syntax

HS.Alloc ("SourcePOV","DestPOV","EntityList","AllocExp","PlugAccount")

Table 11-6 Syntax for Alloc Function

Parameter Description

SourcePOV

A source point of view for the data that is being allocated.

You must specify an Account member, and you can optionally specify ICP and Custom members. If you do not specify ICP and Custom members:

  • The default ICP member is ICP Top.

  • The default Custom member is TopMember for that account.

DestPOV

A destination point of view that identifies where to allocate the data.

You must specify an Account member, and you can optionally specify ICP and Custom members. Note these usage rules:

  • If you do not specify an ICP member, the default is [ICP None].

  • If you do not specify Custom members, the default is [None].

  • If you specify an Entity member, it is used as the parent if the EntityList argument is [Base].

EntityList

A member list that identifies the entities to which the data is be allocated. You can use the system-defined [Base] entity list or you can use a user-defined list.

If you use the [Base] system-defined list, the system uses the entity specified in the destination point of view as the parent member. If you use a user-defined list and that list contains parent members, they are skipped.

AllocExp

An expression that identifies the data to be allocated to each entity. This expression can contain these types of values:

  • Numbers

  • Account Expressions that identify a numeric value. You can specify an Account member, and you can optionally specify members of the ICP and Custom dimensions. Note these usage rules:

    If you do not specify Custom members, the default is TopMember.

    If you do not specify an ICP member, the default is ICP Top.

    If you do not specify Scenario, Year, Period, View, or Value members, the default is Current.

    If you do not specify an Entity member, the default is the destination entity.

PlugAccount

The name of a plug account. This argument is optional, and is used to reverse the source point of view amount, taking into consideration the attribute of the source point of view account versus the plug account.

You must specify an Account member, and you can optionally specify ICP and Custom members. Note these usage rules:

  • You cannot use this argument if the source point of view Entity member is a parent, or if the source point of view Value member is not Entity Currency.

  • If you do not specify an ICP member, the default is ICP None.

  • If you do not specify Custom members, the default is None.

Return Value

None.

Example

In this example, data from the TangibleAssets account is allocated to the Cash account.

Call HS.ALLOC ("A#TangibleAssets","A#Cash","NewEngland","A#TangibleAssets","A#Plug")