Sobre o Analisador de Fluxo de Trabalho

O Analisador de Fluxo de Trabalho é um analisador de código estático, que garante que seu projeto cumpra as normas de qualidade e confiabilidade. Um analisador de código estático verifica inconsistências, sem de fato executar o projeto, diferente dos analisadores dinâmicos, que verificam durante a execução.

O Analisador de Fluxo de Trabalho usa um conjunto de regras para verificar várias inconsistências não relacionadas à execução do projeto. As regras são baseadas nas Práticas recomendadas de automação e levam em consideração a nomenclatura da variável e do argumento, as sequências ou os fluxos de trabalho vazios, as restrições de pacotes, etc. O analisador não identifica erros na execução ou compilação.

Ela fica disponível na aba Design da faixa de opções, nos botões Analisar Arquivo e Analisar Projeto. O primeiro executa uma análise no arquivo que está focado atualmente no painel Designer, já o segundo analisa todos os arquivos no projeto de automação.

O Studio tem um conjunto de regras integradas, identificáveis pelo prefixo ST-. UIAutomation.Activities, Excel.Activities, Atividades de teste e Mail.Activities também têm suas próprias regras identificáveis por prefixo. Veja mais na tabela abaixo:

Categoria da regra	Description	Origem
Nomenclatura	Verifica o arquivo ou o projeto quanto a quaisquer inconsistências relacionadas à nomenclatura.	Studio
Criar	Garante que seu projeto atenda a um conjunto geral de práticas recomendadas.	Studio
Anatomia do projeto	Garante que seu projeto atenda aos requisitos gerais em termos de anatomia.	Studio
Capacidade de manutenção e legibilidade	Confirma que os projetos são de fácil entendimento para que a capacidade de manutenção seja garantida.	Studio
Uso	Garante que os elementos definidos em seu projeto sejam realmente usados.	Studio
Desempenho e reutilização	Verifica o arquivo ou o projeto quanto a quaisquer inconsistências relacionadas ao desempenho e à capacidade de reutilização.	Studio
Confiabilidade	Verifica o arquivo ou o projeto quanto a quaisquer inconsistências relacionadas à confiabilidade.	Studio
Segurança	Verifica o arquivo ou o projeto quanto a quaisquer inconsistências relacionadas à segurança.	Studio
Teste de Aplicativo	Testa os fluxos de trabalho e projetos de automação.	Atividades
Atividades do UIAutomation	Validar fluxos de trabalho que consomem atividades Classic ou Modern UI Automation.	Atividades
Atividades do Excel	Valida fluxos de trabalho que consomem Atividades do Excel.	Atividades
Atividades de Envio	Valida fluxos de trabalho que consomem Atividades de envio.	Atividades

Também é possível criar regras personalizadas. Para obter mais informações, consulte Criação de regras do Analisador de Fluxo de Trabalho no Guia do desenvolvedor.

As regras também podem ser configuradas ao criar uma política do Studio no Automation Ops. Para obter mais informações, consulte o guiado Automation Ops.

Observação: não há portabilidade das regras integradas do Studio às versões mais antigas dele. No entanto, as regras de pacotes de atividades compatíveis podem ser usadas em versões mais antigas do Studio que vêm com o Analisador de Fluxo de Trabalho.

Convenção de Nomenclatura de Regras

Cada regra tem um ID, nome, descrição e recomendação. O ID contém a origem, a categoria e o número. Por exemplo, a Convenção de Nomenclatura de Variáveis tem o ID ST-NMG-001 :

• ST – Revela que a regra está integrada no Studio.
• NMG – Mostra que a regra faz parte da categoria Regras de Nomenclatura . As regras que fazem parte da categoria Regras de Anatomia do Projeto têm a abreviação ANA , as que fazem parte da Práticas Recomendadas de Design a DBP, e assim por diante.
• 001 – É o número da regra.
  
  

  

  
  

Escopo

Cada regra tem um escopo ao qual ela se aplica:

• Atividade: as regras são impostas no nível da atividade, verificando variáveis, argumentos, propriedades. A Convenção de Nomenclatura das Variáveis é uma dessas regras.
• Fluxo de trabalho: as regras realizam verificações em um único arquivo do projeto, por exemplo Variáveis Não Utilizadas.
• Projeto: as verificações são realizadas no nível do projeto.

Ação

As regras têm algumas ações que podem ser definidas:

• Error: gera um erro no painel Lista de Erros.
• Warning: gera um aviso no painel Lista de Erros.
• Info: gera uma mensagem no painel Lista de Erros.
• Verbose: cria arquivos de log grandes.

Verifique a página Níveis de registro em log para saber mais sobre o registro em log com o Studio.

Como gerenciar as regras

O projeto ou o arquivo é analisado baseado em um conjunto de regras disponíveis na janela Configurações do Projeto:

• No painel Projeto, clique no ícone e selecione o Analisador de Fluxo de Trabalho.
• Na faixa de opções, clique no botão Analisar Arquivo, e selecione Configurações do Analisador de Fluxo de Trabalho no menu suspenso.

Por padrão, as regras são organizadas por código na janela, as regras habilitadas são exibidas primeiro.

Use a caixa de pesquisa na parte superior da janela para pesquisar regras por nome ou código. Para filtrar regras por escopo e ação padrão, clique no botão à direita da caixa de pesquisa.

Configurar Regras

Você pode habilitar/desabilitar uma regra usando a caixa de seleção à sua esquerda ou alterar a ação padrão usando o menu suspenso à sua direita.

Algumas regras não exigem nenhuma configuração adicional, enquanto outras contêm parâmetros que você pode configurar, como limiares que não devem ser excedidos ou listas de itens específicos que são permitidos ou proibidos. Observe que quando você configura regras que contêm campos de texto (por exemplo, Uso Incorreto de SecureString ou Restrições do Pacote), o texto não deve ser inserido entre aspas.

Redefinir para o padrão

Após alguma alteração ter sido feita nos valores padrão das regras, seja ela Regex ou de limite, os valores podem ser revertidos para o padrão clicando com o botão direito do mouse e selecionando Redefinir para o Padrão.

Validação

A validação do arquivo ou projeto será realizada sempre que o Analisador de Fluxo de Trabalho for disparado. As opções de validação ficam disponíveis nos botões Validar Arquivo e Validar Projeto, da faixa de opções Analisar Arquivo.

Essa ação verifica se as variáveis, os argumentos, as expressões e as importações foram configuradas corretamente. A ação Validar Arquivo pode ser disparada usando o atalho F8, e a de Validar Projeto, usando Shift + F8. A validação pode ser cancelada a qualquer momento.

Os arquivos que contêm erros são marcados no painel Projeto com um ponto vermelho, e os erros são exibidos nos painéis Lista de Erros e Saída.

Clicar duas vezes em um item no painel Lista de Erros abre o .xaml e destaca o elemento que gerou o erro, que pode ser uma atividade, um argumento ou uma variável.

A menos que todos os arquivos .xaml sejam validados, o projeto não pode ser depurado, executado ou publicado. As condições de ponto de interrupção não são avaliadas.

Como gerenciar os erros

Quando disparado, o Analisador de Fluxo de Trabalho usa o conjunto de regras configurado para verificar o projeto ou arquivo, e registra em log os erros encontrados no painel Lista de Erros, de acordo com a ação da regra.

O painel Lista de Erros filtra os itens por Erros, Avisos e Mensagens. O menu suspenso de escopo é útil para filtrar os erros por projeto, arquivo atual ou um arquivo específico na automação. Além disso, os itens podem ser filtrados pelo ID da regra.

Clique em um aviso ou erro encontrado para exibir a recomendação da regra e um link para a página de documentação de cada regra.

Além das violações de regras, o painel Lista de Erros também exibe os erros que podem ocorrer na execução da análise do fluxo de trabalho. Quando o Analisador de Fluxo de Trabalho ou uma das regras configuradas falhar na execução, um erro será registrado em log com os detalhes sobre sua causa.

Suporte de Linha de Comando

A interface do usuário da linha de comando UiPath.Studio.CommandLine.exe contém um conjunto de parâmetros para verificar os arquivos ou os projetos com relação a determinadas regras, mesmo nas configurações do pipeline de CI/CD.

UiPath.Studio.CommandLine.exe está disponível na pasta de instalação:

• Para as instalações por máquina, o caminho padrão é %ProgramFiles%\UiPath\Studio\
• Para instalações por usuário, o caminho padrão é %LocalAppData%\Programs\UiPath\Studio

Observação: UiPath.Studio.CommandLine.exe não requer uma licença do Studio.

Configurar Regras

Por padrão, todas as regras do Analisador de Fluxo de Trabalho são habilitadas ao instalar o Studio, com exceção da seguinte:

• Valores Padrão do Argumento
• Propriedades de Saída Indefinidas

Você pode configurar as regras:

• Na janela Configurações do Analisador de Fluxo de Trabalho, habilite ou desabilite as regras clicando na caixa de seleção ao lado de cada uma delas.
• Do arquivo RuleConfig.json, caminho %LocalAppData%\UiPath\Rules. Encontre uma regra específica, modifique parâmetro respectivo, altere o parâmetro IsEnabled para false para desativar a regra. Opcionalmente, se o caminho não estiver acessível, coloque o arquivo RuleConfig.json em um local personalizado e inclua o caminho para ele no comando. Para obter mais informações, consulte Analisar arquivos e projetos.

As regras são organizadas de acordo com seu ID exclusivo, visível também nas Configurações do Analisador de Fluxo de Trabalho.

Por exemplo, na imagem abaixo apenas a regra Convenção de Nomenclatura das Variáveis foi habilitada e recebeu a expressão Regex ([A-Z]) . Isso significa que os nomes de variáveis devem ser escritos com letras maiúsculas. Todas as outras regras foram desabilitadas neste exemplo.

Os parâmetros a seguir estão disponíveis para cada regra:

Parâmetro	Description
RuleId	O ID da regra.
IsEnabled	Se a regra está habilitada ou desabilitada. Se definido como nulo, o valor do parâmetro DefaultIsEnabled será aplicado.
DefaultIsEnabled	Se a regra é habilitada ou desabilitada por padrão.
DefaultErrorLevel	O nível padrão da mensagem de log (Error, Warning, Info, Verbose).
Parameters	Parâmetros adicionais que a regra pode conter (por exemplo, Nome ou Valor).
ErrorLevel	O nível da mensagem de log. Se definido como nulo, o valor do parâmetro DefaultErrorLevel será aplicado.

Como analisar arquivos e projetos

Depois de configurar as regras, acesse a interface do usuário da linha de comando UiPath.Studio.CommandLine.exe.

Os seguintes comandos do Analisador de Fluxo de Trabalho estão disponíveis:

• analyze – Analisa o projeto completo. Requer o caminho para o arquivo project.json.
• analyze-file – Analisa um único arquivo. Requer o caminho para o arquivo .xaml.

Os seguintes argumentos estão disponíveis para os comandos do Analisador de Fluxo de Trabalho:

Argumento	Description
-p, --project-path	Para analisar um arquivo, forneça o caminho para o .xaml. Para analisar o projeto completo, especifique o caminho para o arquivo project.json.
-c, --config-path	O caminho para o arquivo RuleConfig.json. Especifique o caminho apenas se o arquivo de configuração de regras não estiver no local padrão (%LocalAppData%\UiPath\Rules).
--help	Exibe os argumentos disponíveis para cada comando.
--version	Verifica a versão de UiPath.Studio.CommandLine.exe.

Por exemplo, o comando UiPath.Studio.CommandLine.exe analyze-file -p "C:\BlankProcess\Main.xaml" analisa apenas um arquivo em um projeto, Main.xaml. A saída do comando retorna um dicionário codificado json, com as seguintes informações para cada violação da regra:

• FilePath: o caminho para o arquivo analisado.
• ErrorCode: o ID da regra.
• ActivityDisplayName: o nome de exibição da atividade (null, se não for aplicável).
• Item – O nome e o tipo do item (por exemplo, atividade ou variável) em que a mensagem de erro foi gerada.
• ErrorSeverity: o valor do parâmetro DefaultAction, que é a mensagem de log configurada para cada regra, seja Warning, Error, Info ou Verbose.
• Description: a descrição da regra.
• Recommendation e URL: as alterações recomendadas para solucionar o problema, juntamente com o link da documentação com mais informações.
  
  

  

  
  

Para usar um arquivo RuleConfig.json num local personalizado, adicione o local ao comando. Usando o comando anterior como um exemplo, para configurar regras com o arquivo em C:\CustomFolder\RuleConfig.json, execute o comando a seguir: UiPath.Studio.CommandLine.exe analyze-file -c "C:\CustomFolder\RuleConfig.json" -p "C:\BlankProcess\Main.xaml".

Para retornar o código de saída do comando, execute echo %errorlevel% após você executá-lo. Se não houver mensagens com o erro ErrorSeverity, o código 0 será retornado. Caso contrário, 1 será retornado.

Observe que algumas entradas podem não estar associadas a uma regra, mas podem ser erros gerados pelo Analisador de Fluxo de Trabalho. Por exemplo, no caso de um arquivo .xaml vazio, um erro será exibido.

Os GUID (identificadores globais exclusivos) usados como prefixos para uma entrada são gerados em cada execução e aplicados apenas no resultado atual.

Exportar resultados do Analisador de Fluxo de Trabalho

Para configurar o Studio para exportar os resultados de cada análise de fluxo de trabalho para a pasta do projeto, acesse Exibição Backstage do Studio > Configurações > Design, e habilite a opção Exportar resultados do Analisador.

Quando essa opção está habilitada, os resultados de cada análise de fluxo de trabalho são salvos na subpasta \.local\.analysis\ da pasta do projeto em um arquivo cujo nome é o registro de data e hora seguido por project_analysis_results.json (quando a opção Analisar Projeto é usada), ou file_analysis_results.json (quando a opção Analisar Arquivo é usada) .

Observação: a pasta .local está oculta. Você pode habilitar a visualização de itens ocultos a partir das configurações do Explorador de Arquivos do Windows.

Os arquivos contém as seguintes informações sobre cada regra habilitada:

• RuleId – O ID da regra.
• RuleName – O nome da regra.
• Parameters – Os parâmetros personalizados na regra, se aplicável.
• Severity — a ação da regra, se a regra for violada.
• ErrorsDescription – Uma lista de mensagens de erro geradas pela regra, se aplicável.

Imposição do Workflow Analyzer antes de executar, publicar ou enviar por push/verificar

Você pode impedir a execução, publicação e envio por push/verificação em projetos de repositórios remotos que contêm erros do Workflow Analyzer, habilitando as seguintes opções a partir de Studio Backstage View > Configurações > Design:

• Impor o Analisador antes de Executar – Sempre a execução/depuração de um arquivo ou projeto for iniciada, o Analisador de Fluxo de Trabalho verifica todas as regras com a ação Error e a execução é permitida apenas se nenhum erro for encontrado.
• Impor o Analisador antes de Publicar – Sempre que a publicação for iniciada, o Analisador de Fluxo de Trabalho verifica todas as regras habilitadas, independentemente da sua ação, e a publicação é permitida apenas se não houver violações de regra com a ação Error.
• Enforce Analyzer before Push/Check-in - Sempre que o envio de um projeto para um repositório remoto for iniciado (Commit and Push para GIT, Check in para SVN e TFS), o Workflow Analyzer verifica todas as regras habilitadas, independentemente de sua ação, e a operação é permitida apenas se não houver violações de regras com a ação Error.

Quando Impor o Analisador antes de Publicar estiver habilitado, se a publicação tiver êxito (não há violações de regra com a ação Error), os resultados da análise do fluxo de trabalho serão incluídos no pacote .nupkg publicado no arquivo project_analysis_results.json, localizado em \lib\net45\.analysis\. O arquivo contém as seguintes informações sobre cada regra habilitada:

• RuleId – O ID da regra.
• RuleName – O nome da regra.
• Parameters – Os parâmetros personalizados na regra, se aplicável.
• Severity — a ação da regra (se a regra for violada).
• ErrorsDescription – Uma lista de mensagens de erro geradas pela regra, se aplicável.