Sintaxe para Fazer Referência a Variáveis

Você pode fazer referência a variáveis em análises e painéis de controle.

Como você faz referência a uma variável depende da tarefa que você está executando. Para tarefas em que é exibida em uma caixa de diálogo com campos, você deverá especificar só o tipo e o nome da variável (não a sintaxe inteira), por exemplo, fazendo referência a uma variável em uma definição de filtro.

Para outras tarefas, como fazer referência a uma variável em uma view de título, você especifica a sintaxe da variável. A sintaxe que você usa depende do tipo de variável, conforme descrito na tabela a seguir.

Tipo Sintaxe Exemplo

Sessão

@{biServer.variables['NQ_SESSION.variablename']}

onde variablename é o nome da variável da sessão, por exemplo, DISPLAYNAME.

@{biServer.variables['NQ_SESSION.SalesRegion']}

Modelo Semântico (Repositório)

@{biServer.variables.variablename}

ou

@{biServer.variables['variablename']}

em que variablename é o nome da variável, por exemplo, prime_begin

@{biServer.variables.prime_begin}

ou

@{biServer.variables['prime_begin']}

Apresentação ou solicitação

@{variables.variablename}[format]{defaultvalue}

ou

@{scope.variables['variablename']}

onde:

variablename é o nome da apresentação ou variável de solicitação, por exemplo, MyFavoriteRegion.

(opcional) format é uma máscara de formato dependente do tipo de dados da variável, por exemplo, #,##0, MM/DD/YY hh:mm:ss. (Observe que o formato do arquivo não é aplicado ao valor padrão.)

(opcional) defaultvalue é uma constante ou referência de variável indicando um valor a ser usado se a variável referenciada por variablename não estiver preenchida.

escopo identifica os qualificadores da variável. Você deve especificar o escopo quando uma variável for usada em vários níveis (análises, páginas do painel de controle e painéis de controle) e você deseja acessar um valor específico. (Se você não especificar o escopo, então a ordem de precedência será análises, páginas do painel de controle e painéis de controle).

Ao usar um prompt do painel de controle com uma variável de apresentação que pode ter vários valores, a sintaxe difere, dependendo do tipo de coluna. Vários valores são formatados em valores separados por vírgulas e, portanto, todas as cláusulas de formato são aplicadas a cada valor antes de serem unidos por vírgulas.

@{variables.MyFavoriteRegion}{EASTERN REGION}

ou

@{dashboard.MyFavoriteRegion}{EASTERN REGION}

ou

@{dashboard.variables['MyFavoriteRegion']}

ou

(@{myNumVar}[#,##0]{1000})

ou

(@{variables.MyOwnTimestamp}[YY-MM-DD hh:mm:ss]{)

ou

(@{myTextVar}{A, B, C})

Global

@{global.variables.variablename}

onde variablename é o nome da variável global, por exemplo, gv_region. Ao fazer referência a uma variável global, use o nome totalmente qualificado conforme indicado no exemplo.

A convenção de nomenclatura para variáveis globais deverá estar em conformidade com as especificações de linguagem de Script ECMA para JavaScript. O nome não deve exceder 200 caracteres nem pode conter espaços embutidos, palavras reservadas e caracteres especiais. Se você não estiver familiarizado com os requisitos da linguagem JavaScript, consulte uma referência terceirizada

@{global.variables.gv_date_n_time}

Você também pode fazer referência a variáveis em expressões. As diretrizes para fazer referência a variáveis em expressões são descritas nos tópicos a seguir:

Variáveis de Sessão

Você pode usar as seguintes diretrizes para fazer referência a variáveis de sessão em expressões.

  • Incluir a variável da sessão como um argumento da função VALUEOF.
  • Colocar o nome da variável entre aspas duplas.
  • Preceder a variável da sessão por NQ_SESSION e um ponto.
  • Coloque NQ_SESSION entre aspas duplas.
  • Colocar a parte de NQ_SESSION e o nome da variável da sessão entre parênteses.

Por exemplo:

"Market"."Region"=VALUEOF("NQ_SESSION"."SalesRegion")

Variáveis de Apresentação

Você pode usar as seguintes diretrizes para fazer referência à variável de apresentação em expressões.

Ao fazer referência a uma variável de apresentação, use esta sintaxe:

@{variablename}{defaultvalue}

em que variablename é o nome da variável de apresentação e defaultvalue (opcional) é uma constante ou referência de variável indicando um valor a ser usado, se a variável referenciada por variablename não for preenchida.

Para converter a variável em uma string ou incluir diversas variáveis, coloque toda a variável entre aspas simples, por exemplo:

'@{user.displayName}'

Se o sinal @ não for seguido por uma {, ele será tratado como um sinal @. Durante a utilização de uma variável de apresentação que pode ter vários valores, a sintaxe diferirá, dependendo do tipo de coluna.

Use a seguinte sintaxe em SQL para o tipo de coluna especificado a fim de gerar instruções SQL válidas:

  • Texto — (@{variablename}['@']{'defaultvalue'})

  • Numérico — (@{variablename}{defaultvalue})

  • Data e horário — (@{variablename}{timestamp 'defaultvalue'})

  • Data (somente a data) — (@{variablename}{date 'defaultvalue'})

  • Horário (somente o horário) — (@{variablename}{time 'defaultvalue'})

Por exemplo:

'@{user.displayName}'

Variáveis do Modelo Semântico (Repositório)

Você pode usar as seguintes diretrizes para fazer referência a variáveis de modelo semântico (repositório) em expressões.

  • Inclui a variável como um argumento da função VALUEOF.
  • Colocar o nome da variável entre aspas duplas.
  • Consulte uma variável estática do modelo semântico (repositório) pelo nome.
  • Consulte uma variável dinâmica do modelo semântico (repositório) por seu nome totalmente qualificado.

Por exemplo:

CASE WHEN "Hour" >= VALUEOF("prime_begin") AND "Hour" < VALUEOF("prime_end") THEN 'Prime Time' WHEN ... ELSE...END