Práticas recomendadas para o desenvolvimento de análises

Os scripts de análise oferecem suporte à maioria dos comandos que podem ser usados em um script normal. No entanto, você deve garantir que os scripts de análise sejam executados sem a interação do usuário e que eles não incluam comandos não compatíveis com o mecanismo que processa os scripts de análise no aplicativo Robôs no HighBond.

Os scripts de análise oferecem suporte a todas as funções do ACLScript.

Práticas recomendadas gerais

Usar um projeto do Analytics por robô

Crie um novo projeto do Analytics para cada robô. O projeto deve conter todos os scripts de análise que compõem o robô e todos os subscripts necessários.

Teste localmente

Teste todos os scripts de análise localmente antes de implantá-los no aplicativo Robôs. Verifique se os scripts de análise executam da forma esperada e se não exigem interação com o usuário.

Para obter mais informações, consulte Desenvolvendo scripts de análise.

Use conexões de dados consistentes para testes

Para testar localmente se um script de análise usa uma origem de dados ODBC, você deve configurar uma conexão ODBC no computador local idêntica à conexão do ambiente onde o script de análise será executado.

Evite caminhos absolutos de arquivo

Evite usar caminhos de arquivo absolutos no script de análise (por exemplo, C:\resultados), a menos que você tenha certeza de que caminhos de arquivo idênticos existam no ambiente onde o script de análise será executado.

O uso dos caminhos relativos de arquivos como \resultados permite o desenvolvimento e teste local dos scripts de análise e sua implantação em outro ambiente, sem exigir o outro ambiente tenha uma estrutura de diretórios idêntica.

Use SET para definir preferências

Utilize o comando SET para especificar as configurações de preferências exigidas pelo script de análise. Se não forem especificadas preferências no script de análise, as preferências padrão do Analytics serão utilizadas. Posicione o comando SET após o cabeçalho de análise e antes de qualquer lógica do script de análise.

Não use campos calculados em tabelas de resultados ou saída de dados

Não use campos calculados em nenhuma tabela de saída que você pretenda manter além da sessão em que o script de análise é executado.

As tabelas de resultados e dados mantidos para uso em interpretações ou como entrada para scripts subsequentes poderão exibir valores inesperados se tiverem campos calculados. Os campos calculados dependem das configurações definidas no arquivo de preferências (.prf) ou pelo comando SET. Portanto, ambientes diferentes podem gerar valores diferentes.

Se você precisar manter os valores de um campo calculado, use o comando EXTRACT com as opções FIELDS ou ALL para converter o campo em um campo físico em uma tabela de resultados ou dados. Para obter mais informações, consulte Comando EXTRACT.

Criptografe senhas de conexão de dados

Para evitar a presença de senhas de origens de dados em texto livre no script de análise, utilize a tag de análise //PASSWORD. Essa tag solicita ao usuário a senha antes da execução do script de análise e criptografa o valor inserido.

Use uma senha para exportar/importar de/para o HighBond

O parâmetro PASSWORD é obrigatório em qualquer comando que exporta/importa de/para o HighBond:

  • IMPORT GRCRESULTS
  • IMPORT GRCPROJECT
  • EXPORT... ACLGRC
  • EXPORT... HBDATA

Sem o parâmetro PASSWORD, o comando falhará no Robôs.

Quando você usa o parâmetro PASSWORD em um comando, também precisa especificar uma tag //PASSWORD associada no cabeçalho de análise. Para obter mais informações, consulte Tag PASSWORD.

Nota

O parâmetro PASSWORD não é necessário na execução de comandos de importação e exportação no Analytics porque o token de acesso do HighBond do usuário atual, armazenado localmente no registro do Windows, é usado automaticamente.

Evite a interação do usuário

Os scripts de análise devem ser executados sem interação com o usuário. Se um comando em um script de análise tentar criar uma caixa de diálogo, o mecanismo do ambiente de implantação interromperá o processamento do script de análise e uma mensagem de erro será inserida no log.

Substitua comandos de interação do usuário por tags de análise

Não use comandos do Analytics que exigem interação com o usuário. Substitua esses comandos por tags de análise equivalentes no cabeçalho de análise. As tags de análise permitem que os usuários forneçam valores de entrada antes da execução do script de análise.

Não utilize Substituir por
DIALOG //PARAM , //TABLE , //FIELD
ACCEPT //PARAM , //TABLE , //FIELD
PASSWORD //PASSWORD
PAUSE sem equivalente

Diretrizes

  • Comandos interativos Para evitar falhas no processamento de scripts de análise, remova todos os comandos interativos.
  • SET SAFETY Para garantir que os arquivos possam ser sobrescritos como necessário sem a exibição das caixas de diálogo de confirmação, adicione o comando SET SAFETY OFF no início do script de análise.

    Adicione o comando SET SAFETY ON no final do script de análise para restaurar o comportamento anterior.

  • Parâmetro OK Para evitar que os diálogos de confirmação causem falha no script de análise, adicione o parâmetro OK após todos os comandos que normalmente exibem uma caixa de diálogo de confirmação:
    • RENAME
    • DELETE

Verificação da sintaxe do script

O Analytics oferece uma ferramenta para detectar a sintaxe de script que causa falha nos scripts de análise ou que exige alinhamento entre o ambiente local e o ambiente onde os scripts de análise são implantados. A ferramenta se limita a emitir um aviso. Você pode confirmar ou importar scripts de análise que têm avisos.

O que a ferramenta verifica

A ferramenta verifica todos os scripts de um projeto buscando os seguintes itens:

  • qualquer comando que exija interação com o usuário
  • qualquer caminho de arquivo absoluto
  • qualquer chamada de um script externo

Quando a verificação é executada

A verificação de sintaxe do script é executada automaticamente quando você confirma scripts para o Robôs.

A verificação de sintaxe automática é ativada por padrão. Se você quiser desativá-la, selecione Desative a verificação de sintaxe de scripts antes da confirmação de scripts na caixa de diálogo Opções (Ferramentas > Opções > Interface).

Executar manualmente a verificação

Você pode executar manualmente a verificação de sintaxe do script. Antes, pode ser necessário adicionar o botão Verificar scripts à barra de ferramentas do Analytics.

  1. Se necessário, adicione o botão Verificar scripts à barra de ferramentas do Analytics:
    1. Clique duas vezes em uma parte vazia da barra de ferramentas para abrir a caixa de diálogo Personalizar barra de ferramentas.
    2. Na lista Botões disponíveis da barra de ferramentas, selecione o botão Verificar scripts e clique em Adicionar.
    3. Na lista Botões atuais da barra de ferramentas, selecione o botão Verificar scripts e clique em Mover para cima ou Mover para baixo para alterar a localização do botão.

      A ordem dos botões de cima para baixo corresponde à sua localização da esquerda para a direita na barra de ferramentas.

    4. Clique em Fechar para salvar suas alterações.

  2. Na barra de ferramentas, clique em Verificar scripts .

    Uma mensagem é exibida informando que a sintaxe do script no projeto é válida ou especificando um ou mais avisos.

  3. Execute uma das seguintes ações:
    • Corrija toda a sintaxe de script que gera um aviso e clique em Verificar scripts novamente para garantir que os avisos não são mais exibidos.
    • Verifique se o ambiente de implantação contém uma estrutura de diretório ou scripts externos alinhados aos caminhos ou scripts externos especificados no script de análise.