Cabeçalhos e tags da análise

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

Um cabeçalho de análise é necessário para qualquer script de análise que você pretende executar no Robôs.

Para obter uma visão geral das entradas e saídas de scripts de análise, bem como das tags de análise associadas, consulte Entradas e saídas de script – visão geral.

Note

Version 16 of Analytics, and all subsequent versions, are not intended for use with Analytics Exchange (AX). Diligent ended support for Analytics Exchange on January 1, 2023. Learn more or upgrade to Robots.

For information about using Analytics in conjunction with Analytics Exchange, see Analytics and ACLScript 15.1 Help.

Adição ou modificação de um cabeçalho de análise

A maneira mais fácil de adicionar ou modificar um cabeçalho de análise é usar o Designer de Cabeçalho da Análise. O Designer oferece verificação automatizada de erros e a orientação incorporada para ajudar a garantir que o cabeçalho criado seja válido e funcione corretamente. Para obter mais informações, consulte Trabalhando com cabeçalhos de análise.

Você também pode criar um cabeçalho de análise inserindo manualmente as tags de análise necessárias. Também é possível usar uma combinação de entrada manual e Designer.

Requisitos básicos do cabeçalho 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 faltantes
  Este script de análise identifica números de cheques perdidos
//TABLE v_tabela_pagamentos Tabela de Pagamentos
  Selecione uma tabela que exibe os pagamentos e inclui 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)
  Informe 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 no Robôs.

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 Robôs.

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 Robôs.

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
PARAM
TABLE
FIELD

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 o script de análise é executado no Robôs, o valor de teste é ignorado e os parâmetros de entrada definidos pelo usuário 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
Tag ANALYTIC	Designa um script como um script de análise que pode ser executado no Robôs.
Tags de entrada
tag FILE	Especifica um arquivo não Analytics, como arquivos Excel ou de texto delimitado, que fornece entradas para o script de análise executado no Robôs. O arquivo deve estar localizado na guia Entrada/Saída no mesmo robô do script de análise.
Tag PARAM	Cria um parâmetro de entrada para um script de 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 um script de análise.
Tag PASSWORD	Cria um parâmetro de entrada de senha para um script de 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 o script de análise para que não seja necessária a intervenção do usuário durante a execução do script de análise.
Tag TABLE	Define uma tabela do Analytics que o usuário seleciona como entrada para o script de análise. A tag TABLE pode ser seguida de zero ou mais tags FIELD inseridas em linhas sequenciais.
Tag FIELD	Define um campo que o usuário seleciona como entrada para um script de 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.
Tags de saída
Tag RESULT	Especifica que os resultados gerados por um script de análise estão disponíveis no Robôs para os usuários finais. Os resultados de saída, mesmo quando existentes, não são automaticamente disponibilizados.
Tag DATA	Especifica que a tabela de saída do Analytics gerada pelo script de análise é copiada para um local de armazenamento de dados central no Robôs. Tipicamente, as tabelas do Analytics são armazenadas para que possam ser usadas como tabelas de entrada nos scripts de análise subsequentes.