Variáveis de Substituição em Tempo de Execução nos Scripts de Cálculo Executados no Smart View

Você pode usar variáveis de substituição de runtime (RTSVs) em scripts de cálculo do Essbase que você cria para execução no Smart View. Os RTSVs permitem que a região de foco do cálculo seja dinâmica, dependendo do contexto de grade (PDV) ativo.

Para usar um script de cálculo que inclua variáveis de substituição de runtime no Smart View, a declaração da variável de substituição de runtime no comando de cálculo SET RUNTIMESUBVARS deve incluir a tag <RTSV_HINT>. Além disso, a tag <RTSV_HINT> deve incluir a tag <svLaunch>. Geralmente, a tag <svLaunch> inclui tags XML adicionais que fornecem metadados para executar o script de cálculo no Smart View.

Use a seguinte sintaxe para definir uma definição de variável de substituição de runtime para uso no Smart View:

SET RUNTIMESUBVARS
{
   rtsvName = POV
   <RTSV_HINT>
      <svLaunch>
         <description>rtsv_description</description>
         <type>member | string | number</type>
         <dimension>dimName</dimension>
         <choice>single | multiple</choice>
         <allowMissing>true | false</allowMissing>
      </svLaunch>
   </RTSV_HINT>
};

Na definição acima, o nome da variável de substituição de runtime é rtsvName, mas você pode usar qualquer nome. O valor da variável deve ser definido como POV, para indicar que somente a fatia de dados atual presente na grade da planilha deve ser calculada.

O elemento <RTSV_HINT> também deve fazer parte da declaração da variável. Seu conteúdo inclui:

• <description>: Um descritor para ajudar os usuários do Smart View a entender a seleção de membros
• <type>: Uma especificação se a variável se destina a um membro, string ou número
• <allowMissing>: true se dados ausentes tiverem que ser incluídos; false caso contrário
• <dimension>: O nome da dimensão da qual essa variável extrai informações
• <choice>: single se apenas uma seleção puder ser passada para a variável de substituição de runtime; caso contrário, multiple.

Para obter uma descrição completa das tags XML listadas acima, consulte Referência de Tag XML — Scripts de Cálculo com Variáveis de Substituição de Runtime para Smart View.

No Smart View, quando você seleciona um script de cálculo que inclui variáveis de substituição de runtime na caixa de diálogo Scripts de Cálculo, a área Prompts de Runtime é preenchida com campos com base na forma como as variáveis de substituição de runtime são definidas no comando de cálculo SET RUNTIMESUBVARS. É possível executar o script de cálculo conforme definido ou usar os prompts de tempo de execução para inserir informações de variáveis diferentes com base no tipo de dados.

Observação:

No Smart View, você não poderá executar um script de cálculo que inclua variáveis de substituição de runtime se o comando SET RUNTIMESUBVARS não incluir as tags <RTSV_HINT><svLaunch>...</svLaunch></RTSV_HINT>.

Exemplo: Conjunto de Variáveis de Substituição de Tempo de Execução para PDV

Para definir a variável de substituição de tempo de execução de um script de cálculo do Essbase para o contexto de grade (PDV) ativo do Smart View, o valor da variável de substituição de tempo de execução deve ser definido como POV e o tipo de dados deve ser definido como member, conforme mostrado neste exemplo.

Por padrão, o script de cálculo usa o membro ativo no PDV no runtime, a menos que o usuário do Smart View especifique um membro diferente no runtime prompt.

Neste exemplo, suponha que o banco de dados tenha estas dimensões: Conta, Entidade, Período e Cenário. Três variáveis de substituição de runtime são definidas (denominadas rtsvEntity, rtsvScenario e rtsvPeriod), e o valor de cada variável é definido como PDV. As variáveis de substituição de runtime são referenciadas na instrução FIX como &rtsvEntity, &rtsvScenario e &rtsvPeriod.

SET RUNTIMESUBVARS {
   rtsvEntity = POV
      <RTSV_HINT>
         <svLaunch>
            <description>Entities to Copy</description>
            <type>member</type>
            <dimension>Entity</dimension>
            <allowMissing>false</allowMissing>
            <choice>multiple</choice>
         </svLaunch>
      </RTSV_HINT>;
   rtsvScenario = POV
      <RTSV_HINT>
         <svLaunch>
            <description>Scenarios to Copy</description>
            <type>member</type> 
            <allowMissing>false</allowMissing>
            <dimension>Scenario</dimension>
            <choice>multiple</choice>
         </svLaunch>
      </RTSV_HINT>;
   rtsvPeriod   = POV
      <RTSV_HINT>
         <svLaunch>
            <description>Period to Copy</description>
            <type>member</type>
            <allowMissing>false</allowMissing>
            <dimension>Period</dimension>
            <choice>single</choice>
         </svLaunch>
      </RTSV_HINT>;
}
FIX(&rtsvEntity, &rtsvScenario, &rtsvPeriod)
"Opening Balance" (
@PREV("Closing Balance");
)

Abaixo das declarações de variáveis, há um bloco FIX, que seleciona a região de foco do cálculo e executa um comando para definir o saldo inicial do período. As variáveis de substituição de runtime são passadas para o bloco FIX usando esta sintaxe: &varname. A região de foco do cálculo é, portanto, dinâmica, dependendo do PDV no Smart View.

Observação:

Ao usar a interface de jobs do Essbase, a instrução de cálculo de execução MaxL ou APIs (como o ponto final Executar Jobs da API REST), você não pode executar um script de cálculo que inclua uma variável de substituição de runtime definida como PDV. Como eles dependem do contexto de grade atual do Smart View, eles devem ser executados no Smart View.

Referência de Tag XML — Scripts de Cálculo com Variáveis de Substituição de Runtime para o Smart View

Ao criar scripts de cálculo do Essbase com variáveis de substituição de tempo de execução projetadas para execução com base no contexto de PDV/grade do Smart View, você precisa usar algumas tags XML explicadas aqui.

• <RTSV_HINT>

  Tag obrigatória para definir variáveis de substituição de runtime para uso no Smart View.

• <svLaunch>

  Tag obrigatória que indica que a variável de substituição de runtime está definida para uso no Smart View.

  Essa tag é a tag pai dessas tags: <description>, <type>, <dimension>, <choice> e <allowMissing>.

• <description>rtsv_description</description>

  A rtsv_description é uma string que descreve a variável de substituição de runtime. A string não é usada no cálculo.

• <type>value</type>

  Os valores válidos de tipo de dados são:

  • membro — O valor da variável de substituição de runtime deve ser definido como um membro (um nome de membro único ou uma lista de nomes de membros separados por vírgulas) ou PDV.

    Observação:

    Os nomes de membros devem ser colocados entre aspas; por exemplo, "New York" (membro único) ou "New York","Florida" (uma lista separada por vírgulas de nomes de membros).

    Se o valor da variável de substituição de runtime for definido como PDV, o valor <type> deverá ser membro. Consulte também a tag <choice>.

    Usando jobs do Essbase ou MaxL, você não pode executar um script de cálculo que inclua uma variável de substituição de tempo de execução definida para o PDV. Esses scripts de cálculo devem ser executados no Smart View, pois o PDV depende do contexto de grade atual para determinar o segmento.

  • string — O valor da variável de substituição de runtime pode ser definido como um nome de membro único, uma lista separada por vírgulas de nomes de membros (por exemplo, "New York", "Florida") ou uma data.

    Ao usar o tipo de dados da string, a caixa de diálogo Seleção de Membros não está disponível; portanto, o usuário do Smart View deve usar a sintaxe correta (anexando um nome de membro entre aspas, separando vários nomes de membros com uma vírgula ou, para uma data, correspondendo o formato da string de data ao formato definido no script de cálculo — mm-dd-yyyy ou dd-mm-yyyy).

  • number — O valor da variável de substituição de runtime deve ser definido como um número

• <dimension>dimName</dimension>

  Nome da dimensão.

  Observação:

  Esta tag XML só será suportada se o valor <type> for membro.

• <choice>value</choice>

  Os valores de opção válidos são:

  • single:

    • Se houver um único membro na grade ou no PDV, esse membro será usado.

    • Se uma dimensão estiver no PDV, o membro ativo será usado.

    • Se uma dimensão estiver no PDV e houver vários membros, ocorrerá um erro.

  • múltiplo — Todos os membros da dimensão na grade ou no PDV são usados.

  Observação:

  Esta tag XML só será suportada se o valor <type> for membro.

• <allowMissing>boolean</allowMissing>

  Especifica se deseja permitir ou suprimir células de dados para as quais não existem dados no banco de dados.

  Valores válidos: verdadeiro e falso.