Modelo de guia do usuário para listagens

Informações gerais para todos os tipos de listagens

Introdução – Finalidade da listagem

• Nesta seção, descreva resumidamente sua listagem e qual é a finalidade dela.
• Adicione vídeos, demonstrações e capturas de tela relevantes que mostrem os recursos da listagem.
• Especifique a compatibilidade com o UiPath Studio.

Casos de uso

Nesta seção, explique como a listagem será usada em um processo de negócios e seus benefícios. Que problema ele soluciona?

Pré-requisitos, se aplicável

Nesta seção, mencione quaisquer artefatos ou software a serem baixados de outras fontes antes da configuração. Por exemplo:

• URL para baixar software ou plataforma de terceiros
• URL para obter a chave de API ou licença;
• Versão do Software;
• Qualquer outra dependência, onde encontrá-la e como instalá-la e configurá-la.

Configuração se aplicável

Nesta seção, mencione as etapas para preparar o ambiente antes de usar a listagem.

Se uma nova chave ou licença precisar ser gerada, forneça as etapas.

Exemplo: aqui estão as etapas para gerar a chave para usar a API de direção do Google:

• Faça logon em sua conta do Google.
• Acesse https://console.developers.google.com.
• Ative sua avaliação gratuita.
• Concordo e continue.
• Forneça seu endereço e os detalhes do cartão (sem cobrança automática após o término da avaliação gratuita).
• Clique no logotipo "API do Google" para acessar a página inicial.
• Clique em 'Credenciais' > Criar credenciais.
• Escolha "Chave de API".
• Anote a Chave de API (essa é a Chave a ser usada na automação).
• Para Habilitar a API de Direção, clique no logotipo da API do Google para chegar à página inicial.
• Clique em "Habilitar APIs e serviços".
• Pesquise "API de direção".
• Habilite-o.

Se qualquer script do PowerShell precisar ser executado, inclua uma captura de tela relevante com a execução do script.

Quaisquer outras etapas de configuração necessárias, com capturas de tela quando aplicável.

Informações por tipo de listagem

Atividades personalizadas

Nesta seção, forneça uma breve descrição de cada atividade incluída. Além disso, é necessário explicar em detalhes os parâmetros de cada atividade.

Capturas de tela para mostrar diferentes atividades e formas de configurá-las também ajudam a receber as informações com facilidade.

Escopo da plataforma

• Forneça uma breve descrição da atividade.
• Essa atividade é a que garante a conexão entre cada atividade contida nesse pacote e a plataforma. Cada atividade precisa ser colocada dentro dessa atividade pai.

Entrada

• URL (string) - Esta é a URL da plataforma que você pode obter acessando seu Perfil da conta > API > URL
• Token de API (string) — esse é o token de API disponível em Perfil da conta > API > Credenciais

Saída

• Token (String) - Este é o token que será gerado para que possa ser usado em cada solicitação

Exemplos:

• Nesta seção, mencione as etapas sobre como usar a automação usando o UiPath Studio.
• Para Atividades personalizadas, um exemplo dos valores do formato de entrada passados para as propriedades.
• Para Atividades personalizadas contendo várias atividades, se houver alguma ordem específica em que essas atividades devam ser usadas, inclua uma captura de tela de um fluxo de trabalho de amostra mostrando esse uso de atividades, como na captura de tela a seguir, Scope Activity, Create Document, Create Recipient, Define Envelhepe , Send Envelhepe e Download Envelhepe fazem parte do mesmo pacote de atividades personalizadas.

Fragmentos

Nesta seção, adicione o seguinte:

• Uma breve descrição de cada um dos arquivos de fluxo de trabalho.
• Uma breve descrição do arquivo de configuração (se houver).
• Todos os parâmetros para cada um dos XAML devem ser explicados em detalhes.

Modelo de Fluxo de Trabalho/Solução

Nesta seção, forneça uma breve descrição do modelo. Quais são as práticas recomendadas usadas, a quantidade e a finalidade dos diferentes fluxos de trabalho?

Resumo sobre os argumentos e as variáveis usados e as etapas necessárias para a configuração.

Exemplo:

Estrutura Empresarial Robótica é um modelo de projeto baseado em máquinas de estado. Ele foi criado para atender às práticas recomendadas de registro em log, gerenciamento de exceções, inicialização de aplicativos e entre outras, pronto para lidar com um cenário de negócios complexo.

O modelo contém vários contêineres de estado pré-criados para inicializar aplicativos, recuperar dados de entrada, processá-los e encerrar a transação. Todos esses estados estão conectados por meio de várias transições que abrangem quase todas as necessidades de um cenário de automação padrão. Há também vários fluxos de trabalho invocados, cada um processando aspectos específicos do projeto.