IsDescendant

Determina se o membro atual ou um membro especificado é um descendente do pai especificado. Esta função pode ser usada nos seguintes tipos de regras:

  • Cálculo

  • Conversão

  • Consolidação

  • Alocação

    Nota:

    Um membro é um descendente se estiver um nível abaixo de um pai em uma hierarquia de árvore. Os descendentes estão no mesmo ramo da árvore.

Por exemplo, nesta hierarquia, FosterCity e Sunnyvale são descendentes de Califórnia e UnitedStates.


Descendentes na Hierarquia

Sintaxe

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

Nota:

Use uma string em branco ("") para aplicar esta função ao membro atual.

Tabela 11-33 Sintaxe da Função IsDescendant

Parâmetro Descrição

<Object>

Uma das seguintes palavras-chave de objeto:

  • Account

  • Custom1...4

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

  • Entity

  • Parent

Pai

Nome de um membro Pai válido. O Pai é obrigatório.

Element

Dependendo do objeto selecionado, o nome de um membro válido de uma das seguintes dimensões:

  • Account

  • Custom1...4

  • Personalizado

  • Entity

  • Parent

Entity

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

Cenário

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

Ano

Um ano válido.

Period

Um período válido.

Nota:

Quando você utilizar ‘nó’ como objeto, a função determina se o membro é um descendente ativo ou o pai especificado.

Valor de Retorno

Uma expressão Booliana que é Verdadeira se o elemento for descendente do pai especificado; Falsa se o elemento não for descendente do pai especificado.

Para o Nó, Verdadeiro se o elemento for um descendente ativo do pai especificado; Falso se o elemento não for um descendente ativo do pai especificado.

Exemplo

Neste exemplo, se Connecticut for descendente de Regional, os comandos entre as linhas If...Then e End If serão executados.

If HS.Entity.IsDescendant("Regional","Connecticut") = TRUE Then
  ...
End If
If HS.Custom("Prod").IsDescendant("All_Phones", P3000_Phones")
...
End If