DefCurrency

Gets the default currency for the current entity or parent member, or for the specified entity or parent member. If you specify an entity, the system returns the entity currency. To obtain the parent currency, you must specify the parent entity. This function can be used in these types of rules:

  • Calculation

  • Translation

  • Consolidation

  • Allocation

Syntax

HS.<Object>.DefCurrency("Entity")
HS.<Object>.DefCurrency("")

Note:

Use a blank string ("") to apply this function to the current member.

Table 11-17 Syntax for DefCurrency Function

Parameter Description

<Object>

One of these object keywords:

  • Entity

  • Parent

Entity

Name of a valid Entity member

Return Value

A string that contains the default currency for the specified entity or parent.

Example

In this example, if the default currency for Connecticut is different from the default currency for EastRegion, then statements between the If...Then and End If statements are executed.

If HS.Entity.DefCurrency("Connecticut")<> HS.Parent.DefCurrency("EastRegion") Then
  ...
End If