Padrões para o conteúdo de qualidade

Identificação do caso de uso

O caso de uso ideal para uma automação pronta para execução são os processos de automação assistida que capacita cada funcionário de uma organização ou departamento a se beneficiar dessa automação.

Antes de zerar um caso de uso específico, o desenvolvedor deve se perguntar:

• se isso permitiria aos funcionários delegar tarefas do dia a dia ao robô de automação, como agendar reuniões, realizar pesquisas e gerar relatórios ou analisar, gerenciar e manter dados.
• se ela daria acesso fácil à automação aos funcionários.

Um exemplo típico de tal processo são os casos de uso relacionados à produtividade no trabalho em que um funcionário dispara um robô assistido usando o Assistant, que envia rapidamente um formulário sobre os participantes, a descrição e as restrições de tempo da reunião. O robô recebe essas informações e compara automaticamente as opções entre os convidados e os calendários das salas de reunião. As opções de dia, horário e sala da reunião são apresentadas para a validação final pelo usuário e, quando confirmada, o robô envia convites de reunião.

Recomendações para alto valor comercial

• Um caso de uso que possa ser executado com software de uso geral, como o MS Office, Adobe Acrobat Reader, Google Chrome, etc. é altamente recomendado, pois, se funcionar com software raramente usado, talvez apenas usuários finais limitados possam aproveitar seus benefícios .
• Se a automação exigir uma necessidade anormalmente alta de treinamento para configurá-la ou usá-la, seria um impedimento para o citizen developer executá-la, mesmo que uma vez. Há grandes chances de que outra categoria, como Atividade Personalizada, Solução ou Ferramentas, seja potencialmente mais adequada para desenvolver esse caso de uso.
• O caso de uso deve ser universal e escalável. Por exemplo, considere uma automação pronta para execução que realiza o login automático para aplicativos usados diariamente. A vantagem será limitada se o escopo for mantido restrito a apenas um ou dois aplicativos. Portanto, ele deve fornecer logon automático para mais aplicativos ou deve haver espaço para adicionar mais aplicativos.

Desenvolver a automação

Como regra geral, os processos de automação assistida devem ser executados usando o Assistant. Esses processos devem ser projetados para que sejam pequenos, fragmentados e possam ser executados com supervisão humana.

A nomenclatura da automação pronta para uso

• Ao desenvolver o processo de automação pronta para execução através do UiPath Studio, o “Nome” e a “Descrição” do projeto são de extrema importância. Cada automação pronta para uso:

  1. Deve ter "Nome" começando com uma palavra de ação ou um verbo. Ele deve ser descritivo para que os usuários entendam facilmente o valor imediatamente.
  2. Deve ter uma "Descrição" relevante e concisa da funcionalidade.

  3. Ao desenvolver a automação, o “Nome” e a “Descrição” podem ser inseridos por meio do assistente de “Configurações do Projeto” no UiPath Studio, conforme mostrado abaixo.

     
     

     

     
     
     Importante:

     Para que uma listagem seja publicada no UiPath Marketplace, você deve incluir na Descrição da listagem todos os detalhes sobre os produtos da UiPath que são usados na automação ou que são compatíveis com sua automação, bem como a função que eles desempenham.

     Os Parceiros não podem incluir os nomes de terceiros, aplicativos ou outros produtos de terceiros no texto da listagem ou na descrição do produto no UiPath Marketplace sem a autorização expressa do terceiro.

Configuração e inicialização

Na primeira execução, a automação pronta deve exibir uma tela de “Informações de Inicialização”, que sugere aos usuários o que esperar dessa automação, menciona quaisquer pré-requisitos antes de executar a automação e fornecerá instruções de uso.

• Alguns processos de automação assistida são executados da mesma forma para todos, ou seja, quando o usuário clica em Iniciar no Assistant, as etapas pré-definidas são realizadas sem nenhuma variação. Mas em outros casos, a execução de um processo depende de parâmetros exclusivos para o usuário ou o contexto, como endereço de email, local da pasta ou uma string de mensagem. Nesses casos, o processo deve ser criado pelo desenvolvedor no UiPath Studio com argumentos ou campos de entrada personalizáveis.
• Os detalhes de configuração que geralmente não mudam para os usuários em uma máquina na qual a automação pronta é executada, por exemplo, Servidor de e-mail, Porta, Caminho de Arquivo etc. devem estar disponíveis como argumentos para o UiPath Assistant na tela “Mostrar Detalhes do Processo”.

• O UiPath Assistant pode exibir apenas os seguintes tipos de argumento na tela “Mostrar detalhes do processo”, portanto, se houver um requisito para passar qualquer outro tipo como argumento, um formulário pode ser usado para essa finalidade:

  • Int32 - insira um número.
  • String - insira texto.
  • Boolean - selecione ou desmarque uma caixa de seleção.
  • DateTime - escolha uma data ou hora.
• Senhas ou informações confidenciais não devem ser expostas ou gravadas pelo fluxo de trabalho.

Fornecer o status da execução

O status provisório de execução da automação pronta deve ser transmitido na tela por meio de textos explicativos, caixa de mensagem de fechamento automático ou painéis no canto da tela. Essa janela deve ficar no topo da tela enquanto a automação estiver em andamento. Ele deve fornecer mensagens curtas de atualização ou uma barra de progresso para o usuário que interage com o Assistant.

• Implemente o tratamento de exceções para que os usuários recebam mensagens significativas quando ocorrerem erros.

• Se o resultado da execução for um texto de saída, ele deverá ser exibido em uma caixa de mensagem ou formulário para o usuário final como uma string copiável.

  • Por exemplo, a listagem a seguir Link Encurtar minha URL - Componente RPA | O UiPath Marketplace gera a saída que pode ser copiada para uso posterior.

    
    

    

    
    

• Considere outra listagem Obter o caminho completo para o meu arquivo - Componente de RPA | UiPath Marketplace. Todos os caminhos de arquivo de saída são legíveis e copiáveis.

  
  

  

  
  

Publicar o processo

Todas as automações prontas para uso do UiPath Assistant devem ser publicadas como um pacote NuGet no UiPath Studio, pois o UiPath Assistant pode consumir apenas pacotes NuGet.

Melhores práticas

O pacote NuGet deve conter os seguintes metadados:

• Tags: estes são os rótulos relevantes que indicam a categoria/funcionalidade da automação.
• URL da licença: especifique a URL da licença com base no tipo de licença que você selecionou para sua automação.
• A marca de seleção para Aceitar a Licença precisa ser marcada.
• O nome do pacote NuGet deve usar a seguinte convenção: CompanyName.<PackageName>. Se você não for associado a nenhuma empresa, use a seguinte convenção: <PackageName> .
• A versão do NuGet começa na 0.0. Cada alteração feita antes da publicação aumenta seu índice "decimal". Por exemplo, quando publicamos a primeira ou uma nova versão do NuGet, nós a consideramos uma atualização MAIOR e, portanto, ela se torna 1.0.
• O nome da tag da UiPath não deve estar presente nas ID/dlls.
• Se o conteúdo for localizado, os "Idiomas" devem ser especificados, mesmo que o campo esteja marcado como Opcional.
• Caso haja necessidade de editar os metadados após publicar a automação em um NuGet, isso poderá ser feito usando o NuGet Package Explorer.
• É necessário fornecer um documento de guia do usuário com as informações necessárias para executar a automação. Aqui está um exemplo de modelo de guia do usuário que pode ser baixado e atualizado com as informações relevantes.
• É necessário fornecer uma demonstração em vídeo mostrando a execução da automação com o UiPath Studio ou o UiPath Assistant. As diretrizes para a criação do vídeo podem ser encontradas nesta página.

Teste do NuGet com Assistant

Para testar se um processo desenvolvido usando o UiPath Studio é compatível com o UiPath Assistant, a primeira etapa é instalar o pacote NuGet desse processo no UiPath Assistant.

• Para instalar ou atualizar o pacote NuGet a partir do feed do Orchestrator, o Robot deve estar conectado ao Orchestrator.
• Após o pacote NuGet ser instalado com sucesso, a próxima etapa é configurar qualquer campo de entrada personalizável.
• Se o processo for desenvolvido no UiPath Studio com algum argumento, os parâmetros deverão ser fornecidos nos campos de entrada personalizáveis no UiPath Assistant. Esses campos podem ser acessados no Assistant clicando em "Mostrar detalhes do processo", no menu de três pontos do processo correspondente.

• Os valores fornecidos para esses campos podem ser salvos para que a próxima vez que a automação for executada, esses valores serão usados.