IDFromMember

Gets the ID number for the specified member. This function can be used in these types of rules:

Syntax

HS.<Object>.IDFromMember("Element")

Table 62. Syntax for IDFromMember Function

Parameter

Description

<Object>

One of these object keywords:

  • Account

  • Custom1...4

  • Custom (Custom Dimension Label)

  • Entity

  • ICP

  • Parent

  • Period

  • Scenario

  • Value

  • Year

  • View

Element

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

  • Account

  • Custom1...4

  • Custom

  • Entity

  • ICP

  • Parent

  • Period

  • Scenario

  • Value

  • Year

Return Value

The ID number of the specified member. If the member entry is not a valid member, the return value will be -1.

Example

This example gets the ID number for Connecticut:

1EntityID = HS.Entity.IDFromMember("Connecticut")
1CustomID=HS.Custom("Prod").IDFromMember("P3000-Phones")