List

Gets the elements contained in the specified list. This function can be used in these types of rules:

Syntax

HS.<Object>.List("Parent","Listname")
HS.Node.List("Parent"."Listname"."S#Scenario.Y#Year.P#Period")
HS.Custom("Dimension").List("Parent","Listname")

Table 68. Syntax for List Function

Parameter

Description

<Object>

One of these object keywords:

  • Account

  • Custom1...4

  • Custom (Custom Dimension Label)

  • Entity

  • Parent

  • ICP

  • Scenario

Parent

Name of a valid Parent member.

Listname

Name of a valid system list or user-defined list.

Note:

For node, must be a valid entity system list.

Scenario

Name of a valid Scenario dimension member.

Year

A valid year.

Period

A valid period.

Return Value

An array that contains all elements of the specified list. For Node, only the active elements in the list.

Example

This example gets the elements of the user-defined list MyBaseList for the current account:

HS.Account.List("","MyBaseList")

This example gets the elements of the system list [Base] for the TotalAssets account:

HS.Account.List("TotalAssets","[Base]")
Hs.Custom("Prod").List("Products","[Base]")