Ir para conteúdo principal Pular para conteúdo complementar

GetSysAttr – função de script e gráfico

A função GetSysAttr() é usada para retornar informações sobre o locatário e o espaço em que um aplicativo está localizado. Com a função GetSysAttr(), você pode avaliar o ID e o nome do locatário, o ID e o nome do espaço e outros detalhes sobre o ambiente em que o aplicativo reside. Essa função simplifica a identificação do espaço e do locatário de um aplicativo Qlik Sense que pode ser movido entre diferentes ambientes. A função facilita a identificação do ambiente específico em que você está trabalhando. Isso é particularmente útil durante os estágios de desenvolvimento, teste, aceitação e produção (DTAP) do ciclo de vida de um aplicativo.

Essa função pode ser usada no script de carregamento do aplicativo ou em expressões de gráfico, diretamente como uma expressão ou em uma expressão armazenada como uma variável. Se você antecipa que seu aplicativo será movido entre espaços ou locatários durante seu ciclo de vida, use a função em uma expressão de gráfico para obter dinamicamente informações de espaço e locatário sem recarregar o aplicativo. Ao fazer isso, armazene a expressão da função em uma variável fora do script de carregamento ou use a função diretamente na expressão do gráfico.

Use o GetSysAttr() para determinar as seguintes informações sobre seu aplicativo:

  • O ID do locatário onde o aplicativo está localizado.

  • O nome do locatário onde o aplicativo está localizado.

  • A URL do locatário onde o aplicativo está localizado.

  • A URL do alias que foi definida para o locatário que contém o aplicativo.

  • A região do locatário que contém o aplicativo.

  • O ID do espaço onde o aplicativo está localizado.

  • O nome do espaço onde o aplicativo está localizado.

  • O tipo de espaço (compartilhado ou gerenciado) onde o aplicativo está localizado.

A função GetSysAttr() pode ser usada diretamente no script de carregamento ou em uma expressão de gráfico. Em ambos os casos, você pode usar a função para armazenar atributos em uma variável ou diretamente sem uma variável.

Se você usar essa função no Qlik Sense Client-Managed, ela retornará apenas valores de dados vazios. Portanto, você pode usar a função para desenvolver scripts no Qlik Sense Client-Managed sem encontrar erros, com a intenção de posteriormente carregar os aplicativos para o Qlik Cloud.

Sintaxe:  

GetSysAttr(name)

Tipo de dados de retorno: dual

Argumentos
ArgumentoDescrição
nameO nome do atributo a ser retornado. Insira como um valor de string na expressão. O valor da string inserido diferencia maiúsculas de minúsculas.

Você pode usar a função para carregar determinados atributos de ambiente no seu aplicativo. A função pode retornar os seguintes atributos:

Atributos de ambiente que podem ser retornados pela função GetSysAttr()
AtributoDescriçãoExemplo de variável de script de carregamentoExemplo de expressão de gráfico (sem variável)
tenantIdO ID do locatário.Let vTenantID = GetSysAttr('tenantId')=GetSysAttr('tenantId')
tenantNameO nome do locatário.Let vTenantName = GetSysAttr('tenantName')=GetSysAttr('tenantName')
tenantUrlA URL padrão do locatário.Let vTenantUrl = GetSysAttr('tenantUrl')=GetSysAttr('tenantUrl')
tenantUrlAliasA URL do alias que foi definida para o locatário.Let vTenantUrlAlias = GetSysAttr('tenantUrlAlias')=GetSysAttr('tenantUrlAlias')
tenantRegionA região em que o locatário reside.Let vTenantRegion = GetSysAttr('tenantRegion')=GetSysAttr('tenantRegion')
spaceId

O ID do espaço. Isso é definido apenas para um aplicativo em um espaço compartilhado ou gerenciado.

Nota informativa

Se a função GetSysAttr() retornar um valor de spaceId vazio no Qlik Cloud, isso indicará que o aplicativo está localizado em um espaço pessoal.

A função GetSysAttr() sempre retorna um valor de spaceId vazio quando usado no Qlik Sense Client-Managed.

Let vSpaceId = GetSysAttr('spaceId')=GetSysAttr('spaceId')
spaceName

O nome do espaço. Isso é definido apenas para um aplicativo em um espaço compartilhado ou gerenciado.

Nota informativa

Se a função GetSysAttr() retornar um valor de spaceName vazio no Qlik Cloud, isso indicará que o aplicativo está localizado em um espaço pessoal.

A função GetSysAttr() sempre retorna um valor de spaceName vazio quando usado no Qlik Sense Client-Managed.

Let vSpaceName = GetSysAttr('spaceName')=GetSysAttr('spaceName')
spaceType

O tipo de espaço em que o aplicativo está localizado. Isso é definido apenas para um aplicativo em um espaço compartilhado ou gerenciado.

Nota informativa

Se a função GetSysAttr() retornar um valor de spaceType vazio no Qlik Cloud, isso indicará que o aplicativo está localizado em um espaço pessoal.

A função GetSysAttr() sempre retorna um valor de spaceType vazio quando usado no Qlik Sense Client-Managed.

Let vSpaceType = GetSysAttr('spaceType')=GetSysAttr('spaceType')

Exemplo 1 – Armazenando atributos de ambiente como variáveis de script de carregamento

Exemplo 2 – Armazenando atributos de ambiente como variáveis e usando-os em expressões de gráfico

Exemplo 3 – Usando a função diretamente no script de carregamento

Exemplo 4 – Usando a função diretamente em expressões de gráfico

Esta página ajudou?

Se você encontrar algum problema com esta página ou seu conteúdo - um erro de digitação, uma etapa ausente ou um erro técnico - informe-nos como podemos melhorar!