Referência: notação de pontos para propriedades

Adaptive Planning

De forma semelhante às referências de objeto em linguagens de programação, você pode usar a notação de ponto
em fórmulas. A notação de ponto é particularmente útil em fórmulas com

IFF

porque permite que a fórmula varie com base no local atual. Como exemplo, a fórmula a seguir calcula uma métrica de forma diferente em uma versão de valores reais e em uma versão de plano:

Exemplo: a fórmula calcula uma métrica de uma forma nos valores reais e de outra forma nas versões de plano:

IFF(this.Version.IsActuals, ACCT.ActualsValue, ACCT.PlanValue)

Exemplo: para navegadores que usam vírgulas para decimais:

IFF(this.Version.IsActuals; ACCT.ActualsValue; ACCT.PlanValue)

As fórmulas que usam propriedades de notação de ponto para fazer referência a valores de dimensão, valores de atributo e níveis devem se referir a elas usando o Código para evitar ambiguidade quando os nomes corresponderem. Se você alterar o Código de um valor de dimensão, valor de atributo ou nível, atualize as fórmulas para corresponderem ao Código.

Operandos

A sintaxe da expressão do operando usa a sintaxe padronizada

this

termo para indicar a localização atual de uma célula.

Propriedade	Descrição
this.Version	Retorna um objeto de versão, que pode ser combinado com pontos adicionais ( . ) como this.Version.Name . Consulte a seção Tipos de objeto abaixo.
this.Level	Retorna um objeto de nível, que pode ser combinado com pontos adicionais ( . ) propriedades.
this.Account	Retorna um objeto de conta, quando pode ser combinado com ponto adicional ( . ) propriedades.
this. dimension_name	Retorna o valor da dimensão da célula atual na dimensão especificada. Se a célula atual não tem valor para a dimensão especificada, retorna um objeto vazio (em branco). Essa propriedade está acessível apenas se a dimensão tem um nome que seja um identificador legal (não começa com um número e consiste apenas em letras, números e sublinhado). Dimensões com nomes que não sejam de identificação (como aquelas com mais de uma palavra no nome) não podem ser recuperadas em uma fórmula.
this. attribute_name	Retorna o valor do atributo da célula atual no atributo especificado. Se a célula atual não tem valor para o atributo especificado, retorna um objeto vazio. Essa propriedade está acessível apenas se o atributo tem um nome que seja um identificador legal (não começa com um número e consiste apenas em letras, números e sublinhado). Atributos com nomes que não sejam de identificação (como aqueles com mais de uma palavra no nome) não podem ser recuperados em uma fórmula.
this.<stratum_code>	Retorna o Timeperiod do tipo de estrato solicitado que contém a coordenada de tempo da célula atual. Se os estratos solicitados estão abaixo (mais detalhados do que) o status da célula atual, essa função retorna o primeiro Timeperiod desse estrato encontrado no escopo do estrato da célula atual.

Tipos de objeto

Os tipos de dados representam objetos, permitindo que a "notação de ponto" acesse as propriedades desses objetos. As propriedades disponíveis do objeto são:

Versão

Refere-se a várias propriedades da versão atual em um

declaração.

Exemplo:

IF (this.Version.Name = "Budget 2018", x, y)

Exemplo: para navegadores que usam vírgulas para decimais:

IF (this.Version.Name = "Budget 2018"; x; y)

Propriedade	Descrição
Version.Name	Retorna a cadeia de caracteres que representa o nome da versão. Se uma célula de valores reais está sendo sobreposta em uma versão de plano, a versão de valores reais é considerada a versão da célula.
Version.ShortName	Retorna a cadeia de caracteres que representa o nome curto da versão.
Version.Description	Retorna a cadeia de caracteres que representa a descrição da versão.
Version.Type	Retorna uma cadeia de caracteres que representa o tipo da versão, conforme retornado no exportVersions API Retorna um dos itens a seguir: PLANNING, ACTUALS, VERSION_FOLDER, JOURNAL_ENTRY .
Version.StartDate	Retorna um valor de data que representa o primeiro dia do período que é o início da versão.
Version.EndDate	Retorna um valor de data que representa o último dia do período, que é o término da versão.
Version.PositionOf	Retorna a ordem relativa do período informado dentro de todo o intervalo da versão. A sequência inicial começa com 0 (não 1) e o número da sequência pode ser negativo se o período ocorre antes do início da versão. Essa função também funciona com um período posterior ao término da versão.
Version.IsActuals	Retorna um valor booliano que indica se esta versão é uma versão de valores reais ou não (isso inclui os tipos ACTUALS , SUBACTUALS e JOURNAL_ENTRY ).
Version.IsGroup	Retorna um valor booliano que indica se essa versão é um grupo de versões (e não uma versão que contém dados).
Version.IsParent	Retorna um valor booliano que indica se essa versão tem versões filho.
Version.Parent	Retorna a versão pai dessa versão.

Nível

Refere-se a várias propriedades do nível atual em um

declaração.

Exemplo:

IF (this.Level.Name = "Sales", x, y)

Exemplo: para navegadores que usam vírgulas para decimais:

IF (this.Level.Name = "Sales"; x; y)

Propriedade	Descrição
Level.Code	Retorna a cadeia de caracteres que representa o código do nível.
Level.Name	Retorna a cadeia de caracteres que representa o nome do nível.
Level.ShortName	Retorna a cadeia de caracteres que representa o nome curto do nível.
Level.InWorkflow	Retorna um valor booliano que indica se o nível está incluído no fluxo de trabalho. Para instâncias com fluxo de trabalho desabilitado, todos os níveis retornam falso.
Level.IsElimination	Retorna um valor booliano que indica se é um nível de Eliminação. Para instâncias sem o recurso Eliminações, todos os níveis retornam falso.
Level.IsTradingPartner	Retorna um valor booliano que indica se é um nível de Parceiro comercial de eliminação. Para instâncias sem o recurso Eliminações, todos os níveis retornam falso.
Level.Currency	Retorna a cadeia de caracteres que representa o código ISO de moeda do nível (por exemplo, EUR ou USD ).
Level.Parent	Retorna o código do nível pai desse nível ou o objeto de nível "nulo" se esse nível não tem nenhum pai (nível raiz).
Level.IsLeaf	Retorna um valor booliano que indica se o nível é folha (ou seja, essa propriedade retorna verdadeiro se o nível não tem filhos).

Conta

Refere-se às várias propriedades (não ao valor
) da conta atual em um

declaração.

Exemplo:

IF (this.Account.IFRS_Category.Name = "Assets", 1, 0)

Exemplo: para navegadores que usam vírgulas como decimais:

IF (this.Account.IFRS_Category.Name = "Assets"; 1; 0)

Propriedade	Descrição
Account.Code	Retorna a cadeia de caracteres que representa o código da conta.
Account.Name	Retorna a cadeia de caracteres que representa o nome da conta.
Account.ShortName	Retorna a cadeia de caracteres que representa o nome curto da conta.
Account.Description	Retorna a cadeia de caracteres que representa a descrição da conta.
Account.Parent	Retorna uma conta filho dessa conta ou o objeto de conta "nulo" se essa conta não tem pai (conta raiz).
Account.<attribute_name >	Retorna um objeto de valor de dimensão associado ao atributo especificado. Essa propriedade está acessível somente se o atributo tem um nome que seja um identificador legal (não começa com um número e consiste apenas em letras, números e sublinhado). Atributos com nomes que não sejam de identificação (como aqueles com mais de uma palavra no nome) não podem ser recuperados em uma fórmula.
Account.isCredit	Retorna um valor booliano se a conta tem umBalanceType deCRÉDITO ou não. Observe que algumas contas (por exemplo, contas de métrica) não serão nem de débito nem de crédito.
Account.isDebit	Retorna um valor booliano se a conta tem umBalanceType deDEBIT ou não. Observe que algumas contas (por exemplo, contas de métrica) não serão nem de débito nem de crédito.

Dimensões e atributos

Propriedade	Descrição
DimensionValue .Code	Retorna a cadeia de caracteres que representa o código do valor da dimensão na dimensão especificada. Exemplo: IF (this.Region.Code = "East01", 1, 0)
DimensionValue .Name	Retorna a cadeia de caracteres que representa o nome do valor da dimensão na dimensão especificada. Exemplo: IF (this.Region.Name = "East", 1, 0)
DimensionValue .ShortName	Retorna a cadeia de caracteres que representa o nome curto do valor da dimensão.
DimensionValue .Description	Retorna a cadeia de caracteres que representa a descrição do valor da dimensão.
DimensionValue .Parent	Retorna o valor da dimensão pai desse valor ou o objeto vazio se esse valor não tem pai na dimensão (por exemplo, o "pai" é a raiz da própria dimensão). Exemplo: this.DimensionValue.Parent.Name retornaria o nome do pai para esse valor de dimensão.
DimensionValue .IsLeaf	Retorna um valor booliano que indica se o valor na dimensão especificada é um valor folha nessa dimensão.
DimensionValue .<attribute_code >	Retorna o código de valor do atributo especificado (que corresponde ao valor da dimensão).
DimensionValue .<attribute_name >	Retorna o valor do atributo especificado (que corresponde ao valor da dimensão).
AttributeValue .Code	Retorna a cadeia de caracteres que representa o código do valor do atributo.
AttributeValue .Name	Retorna a cadeia de caracteres que representa o nome do valor do atributo.
AttributeValue .ShortName	Retorna a cadeia de caracteres que representa o nome curto do valor do atributo.
AttributeValue .Description	Retorna a cadeia de caracteres que representa a descrição do valor do atributo.
AttributeValue .Parent	Retorna o código do valor do atributo pai desse valor ou o objeto vazio se esse valor não tem um pai na dimensão (por exemplo, o "pai" é a raiz da própria dimensão).
AttributeValue .IsLeaf	Retorna um valor booliano que indica se o valor do atributo no atributo especificado é um valor folha nesse atributo.

Período

Representa um período específico de um estrato de calendário configurado. Os tipos de dados de período não podem ser comparados a nenhum outro tipo de dados.

Exemplos:

IF (this.Month.NumberOfDays > 30, 1, 0) IF (this.Year.PositionOf (this.Month) > 6, "Past sixth month", "Not") IF (this.Quarter.PositionOf (this.Week) = 1, "First week of qtr", "Not")

Propriedade	Descrição
Timeper .Code	Retorna o código do período. Isso corresponderá à forma como o período é referenciado nos discriminantes de tempo.
Timeper .NumberOfDays	Retorna o número total de dias no período, inclusive. Exemplo: IF (this.Month.NumberOfDays > 30, 1, 0)
Timeper .Parent	Retorna o período que contém o período atual e está um estrato acima (mais geral) na sequência de estratos. Se não há estratos acima, retorna o período atual.
Timeper .StartDate	Retorna uma data que representa o primeiro dia do período (igual a Version.StartDate).
Timeper .EndDate	Retorna uma data que representa o último dia do período (igual a Version.EndDate).
Timeper .PositionOf(tp)	Retorna um número inteiro que representa a posição do período ( tp ) no período de origem (em relação aos outros membros do estrato). Devoluções 0 se o período especificado ( tp ) não é um estrato menor que o Timeper especificado ou se tp não está dentro do Timeper especificado.