Documento de Design de Processo (PDD)#
O Documento de Design de Processo (PDD) é um modelo para documentar processos automatizados no Sherpa Designer.
O PDD é gerado ao clicar no botão "Documentar..." no menu "Projeto".
O modelo PDD é carregado automaticamente pelo Sherpa Designer no campo "Modelo PDD" e não é alterado durante o processo de geração do documento.
O PDD é destinado a descrever os processos atuais (AS IS) e os processos alvo (TO BE), parâmetros e configurações.
- AS IS no modelo contém o diagrama e a descrição do processo atual manual ou parcialmente automatizado. Registra os passos reais, aplicativos, funções dos funcionários e gargalos para análise antes da robotização.
- TO BE inclui o diagrama com o processo automatizado (blocos do Sherpa Designer, sequência de ações, número de etapas) e reflete o processo final com integrações do Sherpa Orchestrator e estatísticas dos blocos.
- Parâmetros incluem tabelas que contêm dados destinados à transferência entre blocos e esquemas JSON.
- Configurações incluem: credenciais, flags, estatísticas sobre o funcionamento dos blocos e sua interação, dados do Sherpa Orchestrator e registro.
Estrutura do modelo#
O modelo inclui seções com tabelas e imagens de diagramas:
- Propósito do documento — a seção define o objetivo do PDD (documentação padronizada dos processos RPA do Sherpa RPA para transferência de conhecimento entre desenvolvedores, analistas e partes interessadas).
- Controle do documento — a seção permite rastrear cada alteração no documento.
Contém informações sobre:
2.1. Histórico de alterações — tabela com colunas “Data”, “Versão”, “Descrição resumida das alterações”, “Autor”, “Função”. Registra a evolução do documento para auditoria e controle.
 (1).png)
2.2. Contatos — tabela que contém uma lista de responsáveis: “Nome Completo”, “Função”, “E-mail”, o que facilita a comunicação sobre o projeto.
 (1).png)
- Glossário — tabela para registrar termos, suas abreviações e definições, que permite padronizar a terminologia dentro do projeto.
 (1).png)
- Informações gerais sobre o processo — tabela com métricas e características-chave para avaliar a eficácia da robotização.
 (1).png)
- Descrição do processo AS IS — seção que apresenta informações sobre o processo atual antes da automação.
5.1. Informações gerais — descrição do processo atual com blocos e integrações.
5.2. Diagrama de alto nível do processo AS IS — imagem (650px) que mostra o diagrama do processo atual.
5.3. Descrição das etapas do processo AS IS — tabela com a detalhamento das etapas do processo atual, ações dos usuários e software utilizado.
 (1).png)
- Descrição do processo TO BE — seção que apresenta informações sobre o processo automatizado.
6.1. Descrição geral do processo robotizado — descrição do processo otimizado com blocos e integrações.
6.2. Diagrama de alto nível do processo TO BE — imagem (650px) que mostra o diagrama do processo automatizado.
 (1).png)
- Ambiente e sistemas de TI interagentes — tabela que descreve os sistemas envolvidos no processo: nomes dos sistemas, logins e senhas para acesso do robô, além de serviços externos e os respectivos blocos do Sherpa Designer: nomes dos serviços, nomes dos blocos de automação, paletas.
 (1).png)
- Dados de entrada — tabela que descreve os parâmetros que chegam ao robô para execução de tarefas dentro do processo, bem como o local de armazenamento dos dados e um exemplo do arquivo que os contém.
 (1).png)
- Dados de saída (Relatórios de trabalho dos robôs) — tabela que descreve os parâmetros gerados como resultado do trabalho do robô e transmitidos na forma de relatórios do processo, além do local de armazenamento dos dados e um exemplo do arquivo que os contém.
.png)
- Estrutura de pastas do projeto — tabela que descreve a estrutura de pastas do projeto.
.png)
- Diagramas do projeto — duas tabelas, a primeira das quais descreve os diagramas-chave no processo apresentado, e a segunda descreve cada diagrama separadamente, bem como a quantidade de diferentes blocos que o compõem.
.png)
- Estatísticas dos blocos — tabela que contém dados sobre o número de execuções dos blocos do Sherpa Designer envolvidos neste processo.
.png)
- Bibliotecas dependentes — tabela que contém dados sobre as bibliotecas utilizadas pelo robô durante seu funcionamento, bem como seu idioma e finalidade.
.png)
- Trabalho com o Orquestrador — seção que contém informações sobre a configuração de filas, ativos, agendamentos do Sherpa Orchestrator.
14.1. Lista de filas utilizadas no projeto — tabela que descreve a configuração das filas do Sherpa Orchestrator para cada bloco do robô.
.png)
14.2. Ativos. Variáveis do Orchestrator (Assets) — subseção que registra a vinculação dos blocos do Sherpa Designer aos ativos do Sherpa Orchestrator.
14.3. Credenciais — tabela que descreve as credenciais utilizadas pelo robô para interagir com o Sherpa Orchestrator.
.png)
14.4. Outras variáveis — tabela que descreve as variáveis utilizadas pelo robô no processo (ao trabalhar com o Sherpa Orchestrator).
.png)
- Registro — seção na qual são documentados todos os pontos de registro do robô Sherpa RPA para monitoramento, depuração e auditoria.
15.1. Registro NLog — configuração nlog.config.xml, contendo caminhos de logs. Define a rotação e os níveis (Info, Error, Debug) do registro em arquivo.
15.2. Pontos de registro local — tabela que descreve os blocos, ao executar o robô localmente, que coletam dados sobre os diagramas e os erros que ocorrem neles.
.png)
15.3. Pontos de registro no Orquestrador — tabela que descreve os blocos, ao registrar no Sherpa Orchestrator, que coletam dados sobre os diagramas e os erros que ocorrem neles. Também apresenta capturas de tela e níveis de mensagens de saída.
.png)
- Logins e senhas para sistemas — tabela que apresenta todos os logins e senhas necessários para acessar os sistemas e serviços utilizados no trabalho do robô.
.png)
Modo de operação do robô — tabela que descreve os agendamentos e configurações de inicialização do robô no Sherpa Orchestrator.
.png)
Erros durante a operação do robô — nesta seção são apresentadas descrições de erros que são tratados pelo robô ou são falhas sistêmicas, o que permite entender o algoritmo de ações em diferentes incidentes.
18.1. Tratados pelos robôs (incorporados na lógica do processo) — tabela que descreve o comportamento do usuário em caso de falhas incorporadas na lógica do processo.
.png)
18.2. Falhas sistêmicas e outros erros — tabela que descreve o comportamento do usuário em caso de falhas sistêmicas.
.png)
Geração de PDD#
Informações detalhadas sobre a geração do documento estão disponíveis no link: