Verificação dos resultados da análise de código

Como um Bot Creator (desenvolvedor de RPA) ou Desenvolvedor cidadão, você pode usar a análise de código para verificar e corrigir qualquer erro de codificação nos arquivos de automação (Task Bot ou Tarefa de API). Você pode desenvolver automação com base em políticas de análise de código configuradas e regras pré-definidas.

Com a análise de código, você pode melhorar a confiabilidade das automações implementando as melhores práticas de codificação, tais como convenções de nomenclatura de variáveis, cobertura de comentários e tratamento de erros. A construção de automações em conformidade com as diretrizes ou regras predefinidas ajuda a identificar possíveis erros durante o desenvolvimento da automação. Isso reduz as falhas de automação no ambiente de produção. Você pode executar a análise de código tanto em seus espaços de trabalho públicos como privados e visualizar os resultados.

Com análise de código (disponível no Editor de bot), você obtém os seguintes benefícios:
  • Executar análise de código conforme necessário.
  • Obter orientação de dica de ferramenta para o conformidade com as regras.
  • Integração com Assistente para contabilidade e orientação.

Resultados da análise do código

Para ver os resultados da análise de código, vá para a página Automação e verifique a página Resultados da análise do código. Esta coluna mostra um estado resumido dos resultados da análise do código para cada arquivo de automação (Task Bot ou Tarefa de API). Os seguintes detalhes de cada status estão disponíveis:
  • N/A: Você verá o status não aplicável por qualquer uma das seguintes razões:
    • A análise do código não se aplica ao objeto porque o objeto não é um Task Bot ou Tarefa de API.
    • Não há nenhuma política atribuída ao arquivo ou pasta Task Bot ou Tarefa de API. Quando um arquivo ou pasta Task Bot ou Tarefa de API está no status N/A, as ações de nível de linha para análise de código de execução não são mostradas. A análise do código não tem execução automática nas automações com estado N/A.
  • Não escaneado: A análise do código não foi executada no Task Bot ou Tarefa de API.
  • Alta severidade: O Task Bot ou Tarefa de API tem pelo menos uma violação de alta severidade.
  • Baixa severidade: O Task Bot ou Tarefa de API tem pelo menos uma violação de baixa severidade, mas nenhuma violação de alta severidade.
  • Nenhuma violação: Não há violações de análise de código no Task Bot ou Tarefa de API.

A imagem a seguir mostra um exemplo de resultado da análise de código:


coluna de resultados da análise de código

Nota: O status do Task Bots ou Tarefas de API na coluna de resultados da análise de código é definido como não verificado para os seguintes cenários:
  • O arquivo de automação foi editado no desktop privado e ainda não foi salvo.
  • A análise do código teve habilitação recente pelo administrador ou há uma alteração em qualquer configuração de regra na política aplicável ao arquivo de automação e o arquivo está aguardando para ser verificado.

Revisão dos resultados no Editor de bot

Quando você cria um arquivo de automação (Task Bot ou Tarefa de API) ou modifica um arquivo de automação existente e depois o salva no Editor de bot, a análise do código é iniciada em segundo plano e os resultados são exibidos no Assistente. O cabeçalho de análise de código mostra a contagem total de violações no arquivo de automação. Você pode expandir a opção de análise de código, selecionar um objeto específico e visualizar os seguintes atributos:
  • Objeto aplicável: Exibe o arquivo de automação, a variável, a ação e o atributo de ação.
  • Código da regra: ID RULE_CODE exclusivo.
  • Severidade: Alta ou baixa.
  • Texto da regra: Descrição para indicar a natureza da avaliação a ser realizada sobre o código.

A imagem a seguir mostra um exemplo de análise de código exibida no Assistente do :


resultados da análise de código no Assistente

Os resultados da análise do código são exibidos na seguinte ordem:
Atributo Regras violadas
Bot
  • Comentário de cabeçalho obrigatório
  • Cobertura de comentários
  • Ação máxima
Variável
  • Padrão de nome variável
  • Comprimento do nome variável
  • Variáveis não usadas
Ação
  • Sem atraso codificado
  • Sem caminho de arquivo codificado
  • Sem endereço de e-mail codificado
  • Sem captura vazia
  • Log de captura obrigatório
  • Captura obrigatória da tela

O cabeçalho de análise de código exibe a contagem de objetos com um erro de violação dentro do arquivo de automação. Cada objeto pode ter gravidade baixa ou alta. A violação é exibida com o atributo seguido pelo número da linha e a gravidade. Todos os erros de alta gravidade são exibidos primeiro. Navegue até a linha correspondente no arquivo de automação que contém a violação, corrija a violação e salve o arquivo de automação.

Você deve salvar o arquivo de automação para ver os últimos resultados da análise de código no Assistente.

Violações de análise de código e detalhes de política em Editor de bot

Profissionais e Desenvolvedor cidadão podem ver as violações de análise de código em ações no nível da tela. Um indicador de violação está disponível para visualizações de fluxo e lista, permitindo que profissionais e Desenvolvedor cidadão vejam e façam uma correção rápida de quaisquer ações nas automações que tenham violações de análise de código. A qualidade do código é aprimorada quando os desenvolvedores podem determinar facilmente as violações e aderir às práticas recomendadas quando estão desenvolvendo automações.

Profissionais e Desenvolvedor cidadão não precisam mais navegar até a página de políticas para visualizar a política aplicada e as regras contidas na política. Eles podem ver a política de análise de código atual e suas regras diretamente no menu suspenso do Editor de bot (acesso a partir das três elipses verticais no canto superior direito do Editor de bot). Isso ajuda os usuários que não têm permissão para Ver políticas e Gerenciar políticas a visualizar a política atual e suas regras enquanto editam a automação no próprio Editor de bot em vez de apenas visualizar a violação.

opção de política de análise de código no editor de bots

Variáveis criadas pelo sistema

As variáveis criadas pelo sistema, como variáveis de entrada ou saída, variáveis sugeridas pelo pacote ou variáveis geradas automaticamente (variáveis de janela) usam a convenção padrão de nome de caso de variável da análise de código ou caso Pascal se nenhum formato for definido na regra de análise de código.

Log de auditoria

Quando a análise de código é iniciada salvando um arquivo de automação ou executando a análise de código no Editor de bot, as informações são capturadas no log de auditoria. Os seguintes detalhes são capturados:
  • O nome do Bot
  • Informações ao usuário
  • O método pelo qual a análise de código é iniciada (opção salvar ou opção executar análise de código)
  • Tempo gasto para a execução da análise de código, incluindo detalhes como o número de linhas de código, se capturado pelo processo de análise de código
  • Número total de violações
  • Detalhes das violações