Sintaxe para Referenciar Variáveis

Pode referenciar variáveis em análises e dashboards.

A forma como referencia uma variável depende da tarefa que está a executar. Para as tarefas onde são apresentados campos numa caixa de diálogo, só deve especificar o tipo e o nome da variável (e não a sintaxe completa), por exemplo, referenciar uma variável numa definição de filtro.

Para outras tarefas, como referenciar uma variável numa visualização de título, a sintaxe da variável é especificada. A sintaxe que utiliza depende do tipo de variável descrita na seguinte tabela.

Tipo Sintaxe Exemplo

Sessão

@{biServer.variables['NQ_SESSION.nomedavariável']}

em que nomedavariável é o nome da variável da sessão, por exemplo DISPLAYNAME.

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

Modelo Semântico (Repositório)

@{biServer.variables.nomedavariável}

ou

@{biServer.variables['nomedavariável']}

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

@{biServer.variables.prime_begin}

ou

@{biServer.variables['prime_begin']}

Apresentação ou pedido

@{variables.nomedavariável}[formato]{valorporomissão}

ou

@{âmbito.variables['nomedavariável']}

em que:

nomedavariável é o nome da variável da apresentação ou pedido, por exemplo, MyFavoriteRegion.

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

(opcional) valorporomissão é uma referência de constante ou variável que indica um valor a utilizar se a variável referenciada por nomedavariável não for preenchida.

âmbito identifica os qualificadores para a variável. Deve especificar o âmbito quando uma variável for utilizada em múltiplos níveis (análises, páginas de dashboard e dashboards) e pretende ter acesso a um valor específico. (Se não especificar o âmbito, a ordem de precedência é análises, páginas de dashboard e dashboards.)

Quando utilizar um prompt do dashboard com uma variável de apresentação que pode ter múltiplos valores, a sintaxe difere consoante o tipo de coluna. Múltiplos valores são formatados em valores separados por vírgulas e, por conseguinte, qualquer cláusula de formato é aplicada a cada valor antes de ter uma junção com vírgulas.

@{variables.MyFavoriteRegion}{EASTERN REGION}

ou

@{dashboard.MyFavoriteRegion}{EASTERN REGION}

ou

@{dashboard.variables['MyFavoriteRegion']}

ou

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

ou

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

ou

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

Global

@{global.variables.nomedavariável}

em que nomedavariável é o nome da variável global, por exemplo, gv_region. Quando referenciar uma variável global, deve utilizar o nome totalmente qualificado conforme indicado no exemplo.

A convenção de nomenclatura para variáveis globais deve estar em conformidade com as especificações da linguagem de scripts ECMA para JavaScript. O nome não deve exceder 200 caracteres, nem conter espaços incorporados, palavras reservadas e caracteres especiais. Se não conhecer os requisitos da linguagem JavaScripting, consulte uma referência independente

@{global.variables.gv_date_n_time}

Também pode referenciar variáveis em expressões. As diretrizes para referenciar variáveis em expressões são descritas nos seguintes tópicos:

Variáveis da Sessão

Pode utilizar as seguintes diretrizes para referenciar variáveis de sessão em expressões.

  • Inclua a variável de sessão como um argumento da função VALUEOF.
  • Coloque o nome da variável entre aspas.
  • Preceda a variável de sessão com NQ_SESSION e um ponto.
  • Coloque NQ_SESSION entre aspas.
  • Coloque entre parênteses a parte NQ_SESSION e o nome da variável de sessão.

Por exemplo:

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

Variáveis da Apresentação

Pode utilizar as seguintes diretrizes para referenciar variáveis de apresentação em expressões.

Quando referenciar uma variável de apresentação, utilize esta sintaxe:

@{variablename}{defaultvalue}

em que nomedavariável é o nome da variável de apresentação e valorporomissão (opcional) é uma referência de constante ou variável que indica um valor a utilizar caso a variável referenciada pelo nomedavariável não seja preenchida.

Para efetuar a conversão de tipos da variável numa cadeia de caracteres ou incluir múltiplas variáveis, coloque toda a variável entre plicas, por exemplo:

'@{user.displayName}'

Se o símbolo @ não for seguido de {, é tratado como um símbolo @. Quando utilizar uma variável de apresentação com múltiplos valores, a sintaxe difere consoante o tipo de coluna.

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

  • Texto — (@{nomedavariável}['@']{'valorporomissão'})

  • Numérico — (@{nomedavariável}{valorporomissão})

  • Data-hora — (@{nomedavariável}{timestamp 'valorporomissão'})

  • Data (apenas a data) — (@{nomedavariável}{date 'valorporomissão'})

  • Hora (apenas a hora) — (@{nomedavariável}{time 'valorporomissão'})

Por exemplo:

'@{user.displayName}'

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

Pode utilizar as seguintes diretrizes para referenciar variáveis de modelo semântico (repositório) em expressões.

  • Inclua a variável como um argumento da função VALUEOF.
  • Coloque o nome da variável entre aspas.
  • Consulte uma variável de modelo semântico (repositório) estática pelo nome.
  • Consulte uma variável de modelo semântico (repositório) dinâmica pelo respetivo nome totalmente qualificado.

Por exemplo:

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