IsBase

Determines if the current member or a specified member is a base member of the application or of the specified parent. This function can be used in these types of rules:

Syntax

HS.<Object>.IsBase("Parent","Element")
HS.Node.IsBase("Parent"."Entity"."S#Scenario.Y#Year.P#Period")
HS.<Object>.IsBase("","")
HS.Custom(Dimension).IsBase(Member)

Note:

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

Table 64. Syntax for IsBase Function

Parameter

Description

<Object>

One of these object keywords:

  • Account

  • Custom1...4

  • Custom (Custom Dimension Label)

  • Entity

  • Parent

Parent

A valid Parent member.

Note:

Parent is mandatory only when used with Node.

Element

Depending on the object selected, the name of a valid member of one of these dimensions:

  • Account

  • Custom1...4

  • Custom

  • Entity

  • Parent

Entity

Name of a valid Entity dimension member.

Scenario

Name of a valid Scenario dimension member.

Year

A valid year.

Period

A valid period.

Note:

For Node, determines if the element is an active base member of the specified parent.

Return Value

A Boolean expression that is True if the element is a base member below the specified parent or, when no parent is specified, is a base member in the application. False if the element is not a base member.

For Node, True if the element is an active base entity below the parent in the specified point of view. False if the element is not an active base entity.

Example

In this example, if Connecticut is a base entity under EastRegion, then statements between the If...Then and End If lines are executed.

If HS.Entity.IsBase("EastRegion","Connecticut") = TRUE Then
  ...
End If
If HS.Custom("Prod").IsBase("P3000-Phones") = TRUE Then
...
End If