Cabeçalhos e das tags da análise

O cabeçalho de análise é uma série de tags analíticas incluídas em um bloco de comentários no início de um script do Analytics. As tags de análise especificam os parâmetros de entrada preenchidos por um usuário antes de agendar ou executar uma análise e os parâmetros de saída.

Um cabeçalho de análise é obrigatório para qualquer script de análise que você pretenda executar no Robôs, no Servidor AX ou na janela Aplicativo de análise.

Definição de cabeçalhos de análise

Os cabeçalhos de análise devem ser definidos em um bloco de comentários que começa na primeira linha do script. As tags podem ser dispostas em qualquer ordem no cabeçalho de análise, exceto:

a tag ANALYTIC, que deve ser a primeira
tags FIELD, que devem seguir imediatamente a tag TABLE associada

Exemplo

Este cabeçalho de análise a seguir identifica uma tabela e campo para uso no script, bem como um parâmetro de data inicial:

COMMENT 
//ANALYTIC Identificação de cheques perdidos 
  Esta análise identifica números de cheques perdidos 
//TABLE v_tabela_pagamentos Tabela de Pagamentos 
  Selecione uma tabela que exibe os pagamentos e contém uma coluna de número do cheque 
//FIELD v_num_cheque CN Número do Cheque 
  Selecione o campo que contém os números de cheques 
//PARAM v_data_inicial D OPTIONAL Data Inicial (opcional) 
  Insira a data inicial da análise
END

Formato da tag

Cada tag no cabeçalho usa o seguinte formato:

//nome_tag atributos
  texto_descritivo_opcional

O indicador de tag // deve ser o primeiro caractere não branco na linha de script. nome_tag deve seguir imediatamente o indicador de tag, sem qualquer espaço ou caracteres entre os dois.

O texto descritivo opcional deve ser inserido na próxima linha, depois da tag. O texto pode conter várias linhas, mas não pode pular nenhuma. As quebras de linha não são preservadas quando o texto descritivo é exibido nos aplicativos cliente.

Convenções de tags

Componente	Convenção
Nomes de tag	O nome da tag não diferencia maiúsculas de minúsculas. Ao contrário dos nomes de comandos e funções do Analytics, os nomes de tags não podem ser abreviados.
Atributos de tag	Ao especificar valores de atributo para uma tag, você pode incluir espaços e, opcionalmente, colocar o valor entre aspas.
Descrições de tag	As descrições são opcionais. Se uma descrição for especificada, ela pode conter diversas linhas, mas as quebras de linhas não são mantidas no aplicativo cliente.

Componente

Convenção

Nomes de tag

O nome da tag não diferencia maiúsculas de minúsculas.

Ao contrário dos nomes de comandos e funções do Analytics, os nomes de tags não podem ser abreviados.

Atributos de tag

Ao especificar valores de atributo para uma tag, você pode incluir espaços e, opcionalmente, colocar o valor entre aspas.

Descrições de tag

As descrições são opcionais. Se uma descrição for especificada, ela pode conter diversas linhas, mas as quebras de linhas não são mantidas no aplicativo cliente.

Especificação de valores de entrada de teste no Analytics

Você pode usar um operador de atribuição especial := para especificar valores de entrada de teste em qualquer tag de análise que exija definição:

FILE
TABLE
FIELD
PARAM

Use esta sintaxe para testar scripts de análise no Analytics:

//TABLE v_TabelaAnalise “Tabela a ser classificada" := “Trans_Maio"

Quando o script for executado no Analytics, o parâmetro assumirá o valor especificado na atribuição. Quando a análise é executada em um aplicativo cliente, o valor de teste é ignorado e os parâmetros de entrada definidos pelos usuários são usados.

Você deve deixar um espaço entre o operador de atribuição e a sintaxe de tag que o precede. Os valores de atribuição devem usar o qualificador correto para o tipo de dados, como exigido em todo o Analytics. Para obter mais informações, consulte Tipos de dados.

Lista completa das tags de análise disponíveis

Tag	Descrição
ANALYTIC	Designa um script do Analytics como uma análise que pode ser executada no Robôs, no Servidor AX ou na janela Aplicativo de análise.
Tags de entrada
FILE	Especifica um arquivo não Analytics, como arquivos Excel ou de texto delimitado, que fornece entradas para a análise executada no Robôs ou no Servidor AX. Robôs: o arquivo deve estar localizado na guia Entrada/Saída no mesmo robô da análise Servidor AX: o arquivo deve estar localizado na subpasta Arquivos relacionados na pasta em que a análise está localizada
TABLE	Define uma tabela do Analytics que o usuário seleciona como entrada para a análise. A tag TABLE pode ser seguida de zero ou mais tags FIELD inseridas em linhas sequenciais.
FIELD	Define um campo que o usuário seleciona como entrada para a análise. O campo deve fazer parte de uma tabela definida na tag TABLE precedente. A primeira tag FIELD deve vir imediatamente após uma tag TABLE e pode ser seguida por tags FIELD adicionais digitadas em linhas sequenciais.
PARAM	Cria um parâmetro de entrada para uma análise e define os requisitos para o valor de entrada. Um parâmetro de entrada é um espaço reservado que permite que o usuário especifique o valor real quando agenda ou executa uma análise.
PASSWORD	Cria um parâmetro de entrada de senha para uma análise. O parâmetro fornece armazenamento criptografado da senha para uso subsequente em um comando do ACLScript. O usuário é solicitado a especificar o valor de senha necessário quando agenda ou inicia uma análise para que não seja necessária a intervenção do usuário durante a execução da análise.
Tags de saída
DATA	Especifica que a tabela do Analytics gerada pela análise é copiada para a subpasta de dados (um local de armazenamento) no ambiente de implantação. Tipicamente, as tabelas do Analytics são armazenadas para que possam ser usadas como tabelas de entrada nas análises subsequentes.
RESULT	Especifica os resultados de saída da análise que você quer disponibilizar aos usuários finais em aplicativos cliente. Os resultados de saída, mesmo quando existentes, não são automaticamente disponibilizados.
PUBLISH	Especifica um arquivo contendo metadados que determinam as tabelas do Analytics que serão publicadas para o AX Exception na conclusão do processamento da análise.

[ Voltar ao início ]