List

Lê os elementos contidos em uma lista especificada. Esta função pode ser usada nos seguintes tipos de regras:

  • Cálculo

  • Conversão

  • Consolidação

  • Alocação

Sintaxe

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

Tabela 11-35 Sintaxe da função List

Parâmetro Descrição

<Object>

Uma das seguintes palavras-chave de objeto:

  • Account

  • Custom1...4

  • Personalizada (Rótulo da Dimensão Personalizada)

  • Entity

  • Parent

  • ICP

  • Scenario

Pai

Nome de um membro Pai válido.

Listname

Nome de uma lista de sistema válida ou de uma lista definida pelo usuário válida.

Para o nó, deve ser uma lista de sistema de entidade válida.

Cenário

Nome de um membro válido da dimensão Cenário.

Ano

Um ano válido.

Period

Um período válido.

Valor de Retorno

Uma matriz que contém todos os elementos da lista especificada. Para Nó, apenas os elementos ativos na lista.

Exemplo

Este exemplo lê os elementos da lista definida pelo usuário MyBaseList da conta atual:

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

Este exemplo lê os elementos da lista de sistema [Base] da conta TotalAssets:

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