Criação e edição de scripts

Você tem várias opções para criar scripts:

  • Editor de scriptdigite sintaxe de script na janela Editor de script
  • Log de comandoscopie sintaxe de script do log de comandos
  • Gravador de Scriptgrave a sintaxe dos comandos à medida que os executa
  • Captura de sintaxeinsira a sintaxe dos comandos à medida que os seleciona na interface do usuário, sem executá-los
  • Histórico da tabelacopie sintaxe de scripts do histórico de uma tabela de saída

Você pode usar essas opções em combinação. Por exemplo, você pode iniciar um script copiando a sintaxe do log de comandos e adicionar mais linhas de sintaxe diretamente na janela Editor de script.

Para editar um script existente no Analytics, você deve usar o Editor de script.

Você também pode usar um editor de texto à sua escolha, e copiar e colar a sintaxe em um script do Analytics.

Preenchimento de código

Enquanto você digita a sintaxe de script no Editor de Scripts, o Analytics executa diferentes tipos de preenchimento de código. O preenchimento de código reduz o trabalho associado à digitação da sintaxe, além de apresentar a forma válida de comandos, funções, palavras-chave e parâmetros do ACLScript.

  • Auto-preenchimento de comandos, funções e palavras-chaveÀ medida que você começa a digitar, o recurso de preenchimento automático oferece uma lista de seleção progressivamente atualizada de comandos, funções e palavras-chave do ACLScript que correspondem aos caracteres digitados. Você pode selecionar um item da lista para preencher o item da sintaxe.

  • Ajuda pop-up para parâmetros de funçãoQuando você digita o parêntese de abertura após um nome de função válido, a ajuda pop-up exibe o tipo dos dados da saída retornada pela função e o formato necessário para os parâmetros da função.

  • Fechamento automático de itens de sintaxe pareadosQuando você digita o caractere de abertura de qualquer um dos itens de sintaxe pareados abaixo, o caractere de fechamento é fornecido automaticamente:

    • Aspas duplas ""

    • Aspas simples ''

    • Aspas invertidas ``

    • Parênteses ()

Você pode desativar o preenchimento automático de comandos, funções e palavras-chave selecionando Desativar preenchimento automático em scripts na guia Interface na caixa de diálogo Opções (Ferramentas > Opções).

A ajuda pop-up para parâmetros de função e o fechamento automático de itens de sintaxe comuns não podem ser desabilitados.

Criar ou editar um script no Editor de script

Crie ou edite scripts digitando diretamente a sintaxe ACLScript necessária no Editor de Scripts ou usando um dos outros métodos compatíveis para inserir sintaxe.

Observação

Ao adicionar comandos do ACLScript a um script, você deve seguir estas regras de sintaxe em relação a quebras de linha:

  • Cada comando deve ser inserido em uma linha separada. Dois comandos não podem ocupar a mesma linha (mesmo número de linha).

  • Quase todos os comandos do ACLScript devem ser inseridos em uma única linha (um único número de linha). Comandos de linha única não podem ser divididos em várias linhas. Comandos de múltiplas linhas devem seguir a sintaxe de múltiplas linhas prescrita. Consulte os tópicos de Ajuda de cada comando para verificar a sintaxe necessária. Consulte Comandos.

Criar ou editar o script

  1. Execute um dos seguintes passos para abrir o script no Editor de script:
    • Para criar um novo script, selecione Arquivo > Novo> Script.

      O script é criado com o nome Novo_Script. Clique com o botão direito do mouse e selecione Renomear para renomear o script.

      Observação

      Os nomes de script são limitados a 64 caracteres alfanuméricos. O nome pode incluir o caractere de sublinhado ( _ ) mas nenhum outro caractere especial e nenhum espaço. O nome não pode começar com um número.

    • Para abrir um script existente, clique duas vezes no script na guia Visão geral no Navegador.
  2. Adicione, modifique ou exclua sintaxe do ACLScript no Editor de script.

    Dica

    Você pode usar essas teclas de atalho para ações comuns:

    • Ctrl+Zdesfazer uma ou mais ações
    • Ctrl+Yrefazer uma ou mais ações
    • Ctrl+Ssalva o projeto do Analytics, incluindo o script aberto
  3. (Opcional) Posicione o cursor em um local adequado no script e conclua um dos seguintes passos para inserir um ou mais itens específicos:
    ItemEtapas

    Nome do item do projeto

    (tabela, script, visualização, área de trabalho ou índice)

    1. Clique com o botão direito do mouse e selecione Inserir > Item de projeto.
    2. Selecione o tipo de item na lista suspensa Tipo de item.
    3. Selecione um ou mais nomes de item e clique em OK.
    Nome do campo
    1. Na barra de ferramentas do Editor de script, clique em Inserir campo .
    2. Selecione um ou mais nomes de campos e clique em OK.
    Expressão
    1. Na barra de ferramentas do Editor de script, clique em Inserir Expressão .
    2. Crie uma expressão e clique em OK.
    Caixa de diálogo
    1. Na barra de ferramentas do Editor de script, clique em Construir novo diálogo .
    2. Crie uma caixa de diálogo personalizada, clique em Fechar, e clique em OK.

    Para obter mais informações, consulte Criar caixas de diálogo personalizadas.

    Data e hora
    1. Clique com o botão direito do mouse e selecione Inserir > Data e hora.
    2. Insira ou selecione uma data, datahora ou hora e clique em OK.
    Token de Diligent One

    Para obter mais informações, consulte Adquira um token de acesso da Token de acesso da Diligent One.

  4. Selecione Arquivo > Salvar projeto.
  5. Clique em Sim na caixa de diálogo de confirmação.

Destacar termos repetidos ou itens de sintaxe

Você pode destacar termos repetidos em um script, como nomes de tabelas, campos, variáveis ​​ou palavras-chave. Você também pode destacar itens de sintaxe repetidos, como parênteses ou aspas.

A capacidade de destacar todas as ocorrências de um termo ou item de sintaxe específico é um recurso de desenvolvimento e depuração de scripts útil.

  • PrazosPara destacar várias instâncias de um termo, clique duas vezes em uma única instância do termo em qualquer lugar do script.

  • FrasesPara destacar várias instâncias de uma frase, selecione uma única instância da frase em qualquer lugar do script.

Observação

O comportamento de destaque pode nem sempre estar alinhado com suas expectativas. Por exemplo, se você selecionar os sinais de porcentagem % ao redor de um nome de variável, instâncias adicionais da variável podem não ser destacadas. Clique duas vezes no nome da variável para obter mais consistência nos destaques em todo o script.

Destacar parênteses correspondentes

Você pode destacar parênteses correspondentes em uma expressão, como uma função com parâmetros aninhados. A capacidade de destacar parênteses de abertura e fechamento correspondentes em expressões complexas agiliza a codificação e reduz a chance de você introduzir um bug ao criar uma expressão com parênteses incompatíveis.

Para criar destaques em parênteses correspondentes, posicione o cursor imediatamente antes ou imediatamente depois de um único parêntese em um script. Tanto os parênteses de abertura quanto os de fechamento são destacados. Se os parênteses correspondentes não forem destacados, você saberá que falta um dos pares de parênteses.

Editar sintaxe de comando usando uma caixa de diálogo

Em vez de editar manualmente comandos em um script, você pode editá-los usando a caixa de diálogo associada.

Observação

Esse método somente está disponível para comandos que têm caixas de diálogo.

  1. Selecione um comando em um ACLScript existente.
  2. Na barra de ferramentas do Editor de script, clique em Editar comando .

    A caixa de diálogo do comando é exibida.

  3. Na caixa de diálogo, faça as alterações necessárias nos parâmetros do comando e clique em OK.

    A sintaxe do script é atualizada.

Abra dois scripts lado a lado

Você pode abrir dois scripts lado a lado no Editor de Script, o que permite comparar e copiar a sintaxe do script antes e depois com facilidade.

  1. Na guia Visão geral do Navegador, selecione os dois scripts que você deseja abrir lado a lado.

    Você pode apertar Ctrl+clique para selecionar dois scripts não adjacentes ou Shift+clique para selecionar scripts adjacentes.

  2. Clique com o botão direito do mouse em um dos scripts selecionados e selecione Editar lado a lado.

    Os dois scripts são abertos lado a lado.

  3. Clique no texto de qualquer script para alternar entre eles.

    Se você estiver usando a cor do plano de fundo padrão no Editor de Scripts, o script ativo no momento terá um fundo mais claro.

  4. Para salvar alterações em um ou ambos os scripts, siga um destes procedimentos:

    • Aperte Ctrl+S e clique em Sim na caixa de diálogo de confirmação ou nas caixas que são exibidas.

    • Na barra de ferramentas do Analytics, clique em Salvar o projeto aberto e clique em Sim na caixa de diálogo de confirmação ou nas caixas que são exibidas.

  5. Para sair do modo lado a lado, clique no ícone fechar na guia script.

    Os dois scripts são abertos em guias separadas do Editor de Scripts.

Testar o script

Se você deseja testar o script ao executá-lo integralmente ou passo a passo, clique em Executar  ou em Etapa  na barra de ferramentas do Editor de Script.

Observação

Ao executar um script integralmente ou passo a passo, todos os scripts atualmente abertos são automaticamente salvos.

Criar um script na linha de comando

Você pode copiar as entradas do log na guia Log no Navegador como ponto de partida para criar um novo script ou adicioná-las a um script existente. A sintaxe de cada comando executado anteriormente no Analytics é gravada no log como uma entrada de log individual.

Você pode selecionar os seguintes tipos de entradas e copiá-los para um script novo ou existente:

  • entradas individuais
  • uma série de entradas associadas a uma tabela
  • grupos maiores de entradas associadas a uma sessão ou a um período
  1. No Navegador, clique na guia Log para exibir o log.
  2. Selecione a entrada do log ou o grupo de entradas que você quer incluir no script.

    Se você selecionar itens de nível superior na exibição em árvore, as subentradas serão automaticamente selecionadas.

  3. Execute uma das seguintes ações:
    Criar um novo script
    1. Clique com o botão direito do mouse na exibição em árvore do Log e selecione Salvar itens selecionados > Script.
    2. Na caixa de diálogo Salvar script como, digite um nome para o novo script e clique em OK.

      Observação

      Os nomes de script são limitados a 64 caracteres alfanuméricos. O nome pode incluir o caractere de sublinhado ( _ ) mas nenhum outro caractere especial e nenhum espaço. O nome não pode começar com um número.

      O novo script é adicionado à guia Visão geral no Navegador. O script é salvo na pasta que contém a tabela do Analytics ativa ou na pasta do projeto raiz, se nenhuma tabela está aberta.

    Copiar a sintaxe para um script existente
    1. Clique com o botão direito do mouse na guia Log e selecione Copiar.
    2. Abra um script existente, se ainda não estiver aberto.
    3. No Editor de Script, posicione o cursor no local onde deseja inserir a sintaxe copiada.
    4. Clique com o botão direito do mouse e selecione Colar.

Criar um script com o Gravador de script

O Gravador de script do Analytics permite criar um script registrando suas ações conforme você trabalha com tabelas e comandos na interface do usuário do Analytics. A vantagem de usar o Gravador de Script para criar scripts é que não há necessidade de inserir manualmente a sintaxe necessária para cada comando do ACLScript nem de conhecer essa sintaxe.

Somente comandos são capturados pelo Gravador de Script. Como regra geral, se o comando for exibido no log de comandos, poderá ser capturado em pelo Gravador de Script.

Dica

O Gravador de Script também é uma ferramenta útil para aprender o ACLScript. Você pode gravar uma série de etapas de análise através do Gravador de Script e exibir os scripts resultantes posteriormente a fim de exibir a série de comandos e sintaxes necessárias para reproduzir o comportamento em um script.

  1. No menu principal do Analytics, selecione Ferramentas > Gravador de script Ativado.

    O ícone do Gravador de Script é exibido na barra de status e uma caixa de seleção é exibida à esquerda do item de menu para indicar que o Gravador de Script está ativado.

  2. Execute as etapas de análise ou processamento que você deseja gravar.

    Analytics registra cada comando processado em um novo script.

  3. Quando você terminar de analisar ou processar os dados, selecione Ferramentas > Gravador de script Ativado novamente para desativar o Gravador de script.

    Analytics solicitará que você salve o script.

  4. Digite um nome significativo para o script na caixa de texto e clique em OK.

    Observação

    Os nomes de script são limitados a 64 caracteres alfanuméricos. O nome pode incluir o caractere de sublinhado ( _ ) mas nenhum outro caractere especial e nenhum espaço. O nome não pode começar com um número.

Criar um script com captura de sintaxe

A captura de sintaxe permite usar os menus e as caixas de diálogo do Analytics para inserir automaticamente sintaxe do ACLScript em um script.

  1. Abra o script com o qual você quer trabalhar.
  2. (Opcional) Abra a tabela com a qual você quer trabalhar.

    Dica

    Se você iniciar a captura de sintaxe antes de abrir uma tabela, a tabela não abrirá fisicamente na guia Exibição porque os comandos não são realmente executados durante a captura de sintaxe. Pode ser difícil visualizar os comandos subsequentes em uma tabela aberta para orientação.

  3. Na barra de ferramentas do Editor de script, clique em Iniciar captura da sintaxe .
  4. Execute as etapas de análise ou processamento que você deseja gravar.

    A sintaxe associada será inserida automaticamente no script. Os comandos em si não são executados.

  5. Clique em Interromper captura de sintaxe  para interromper a inserção da sintaxe de comandos no script.

Cria um script do histórico da tabela

Você pode criar um script com base no histórico associado a uma tabela de saída ou resultados do Analytics.

Por exemplo, se você adicionar uma tabela de inventário mensal a um projeto do Analytics e extrair divisões e itens relevantes para uma nova tabela, você poderá criar um script para esse processo com base no histórico da tabela associado à primeira tabela de saída criada.

Cada tabela criada como resultado de um comando do Analytics mantém um registro dos comandos usados para criá-la, incluindo os comandos que criaram tabelas intermediárias entre a tabela original do Analytics e a tabela resultante. Você pode copiar esse histórico da tabela para um novo script que pode então ser usado para automatizar a criação de tabelas de saída subsequentes.

  1. Abra uma tabela de saída que é resultado de um processo que você deseja automatizar em um script.

  2. Selecione Ferramentas > Criar script no Histórico de tabelas.

    Se a Exibição_padrão está ativa, o Analytics pede que você renomeie a exibição para impedir que ela seja substituída ao executar o novo script.

  3. Se o Analytics solicitar que a exibição seja renomeada, clique em Renomear, insira um novo nome e clique em OK.

  4. Insira um nome do novo script na caixa de diálogo Salvar como e clique em OK.

    Observação

    Os nomes de script são limitados a 64 caracteres alfanuméricos. O nome pode incluir o caractere de sublinhado ( _ ) mas nenhum outro caractere especial e nenhum espaço. O nome não pode começar com um número.

  5. (Opcional) Abra e edite o novo script se quiser ajustar seu comportamento.

    Por exemplo, em vez de sobrescrever a tabela original, você poderia optar por salvar a saída em uma tabela com um nome diferente.

Importar scripts ou snippets do Portal de Desenvolvedores da Diligent

Outra opção para criar scripts é utilizar os exemplos de código do ACLScript disponíveis no Portal de Desenvolvedores da Diligent. O portal contém diversos recursos para desenvolvedores que trabalham com produtos Diligent, incluindo uma biblioteca online de itens com script do Analytics desenvolvidos por funcionários da Diligent. Como parte da sua assinatura, você pode baixar e usar qualquer um desses itens com script.

Baixe itens com script do Portal de Desenvolvedores da Diligent e depois importe-os para o Analytics.

Observação

Você pode conseguir usar um item com script como está ou pode precisar personalizá-lo para atender às suas necessidades.

Baixar itens com script na página Amostras de Código

  1. Acesse a página Amostras de Código no Portal de Desenvolvedores da Diligent.

  2. Selecione Logon no canto superior direito e entre usando sua conta do Diligent One.

  3. Na página Amostras de Código, localize o item que deseja usar e selecione-o.

  4. Revise as informações sobre pré-requisitos, requisitos de dados e limitações.

  5. Se o item atender às suas necessidades, selecione o ícone de download no painel c para baixar o item como um arquivo *.aclscript para o seu computador.

    Se existir mais de um item em Arquivos, baixe todos. Existe uma dependência entre os itens.

  6. Se a seção Trechos de Código Dependentes existir no painel Arquivos, você também pode navegar até esses itens e baixá-los.

Importar um item com script para o Analytics

  1. Abra o projeto do Analytics no qual deseja importar o item com script.

  2. Na guia Visão Geral no Navegador, clique com o botão direito na pasta que deseja usar para o item com script e selecione Importar Item do Projeto > Script.

  3. Navegue até o item baixado, selecione-o e clique em Abrir.

    O item com script é importado para o Analytics e localizado na pasta que você especificou.

  4. Selecione OK na caixa de diálogo de confirmação.

  5. Repita o processo para quaisquer itens adicionais que você tenha baixado.

  6. Clique duas vezes em um item importado para visualizá-lo no Editor de Script.

Adquira um token de acesso da Token de acesso da Diligent One

Cuidado

O token de acesso gerado corresponde à conta usada para fazer login no Diligent One. Como um autor de scripts, pode não ser apropriado especificar seu próprio token de acesso em um script se ele for usado por outras pessoas.

Proteja os tokens de acesso como qualquer senha de conta.

Use um token existente, a menos que você tenha um motivo para criar um novo. Se o token existente não funcionar, crie um novo. O uso de um token existente reduz o número de tokens que você precisa gerenciar.

  1. Execute uma das seguintes ações:

    • No menu principal do Analytics, selecione Ferramentas > Token de acesso da Diligent One.

    • No Editor de Script, clique com o botão direito e selecione Inserir > Token da Token da Diligent One.

    A página Gerenciar tokens da API abre no navegador. Pode ser necessário fazer antes o login no Diligent One.

    O acesso à página Gerenciar Tokens da API por meio do Analytics é um recurso de conveniência. Você também pode fazer login no Diligent One e acessar a página por meio do seu perfil de usuário sem usar o Analytics.

  2. Execute uma das seguintes ações:

    • Usar um token existente

      1. Na coluna Token, clique no token parcialmente mascarado que deseja usar.

      2. Digite a senha da conta do Diligent One e clique em Confirmar.

        O token não mascarado é exibido.

      3. Clique em Copiar para copiar o token.

        Dica

        Não feche a caixa de diálogo que contém o token até colar corretamente o token.

    • Criar um novo token

      1. Clique em Adicionar token > Analytics.

      2. No painel lateral Novo token do Analytics, especifique estas informações:

        Campo ou opção Descrição
        Descrição

        Insira uma descrição que forneça informações úteis, como:

        • O propósito do token
        • Onde o token é usado – por exemplo, o nome e a localização do script do Analytics, ou o nome e a localização da tarefa do robô
        Expiração do token
        • Habilitadoo token expira após um número de dias especificado
        • Desabilitadoo token nunca expira

        Observação

        Sua organização pode ter uma política de segurança que exige a expiração de tokens após um determinado período. É recomendado criar tokens com expiração. O Diligent One enviará uma notificação automática por e-mail antes da data de expiração.
        Expiração em Especifique o número de dias até a expiração do token (1 a 365).
        Senha Digite a senha da conta do Diligent One.

      3. Clique em Gerar token.

      4. Clique em Copiar para copiar o token.

        Dica

        Não feche o painel lateral que contém o token até colar corretamente o token.

  3. Dependendo do método de definição de senha que você está usando, faça uma das seguintes opções:

    • Tag de análise PASSWORDNo Designer de Tarefa em um Robô ACL, cole o token copiado em um campo de parâmetro de senha.

    • Comando PASSWORDNo Analytics, cole o token copiado em um prompt de senha exibido durante a execução de scripts.

    • Comando SET PASSWORDNo Analytics, cole o token no ponto apropriado na sintaxe do comando SET PASSWORD em um script.

  4. No Launchpad, feche a caixa de diálogo ou o painel lateral que contém o token.

    Se tiver criado um novo token, uma versão parcialmente mascarada do token é adicionada ao início da lista de tokens.

    Para obter mais informações, consulte Criar e gerenciar tokens de acesso da Tokens de acesso da Diligent One.