Guia do usuário do Marketplace

Última atualização 5 de set de 2024

Conteúdo

Estrutura do seu Acelerador de Solução

Seu Acelerador de Solução precisa estar em conformidade com a seguinte estrutura de pastas para manter uma experiência consistente em todos os Aceleradores de Soluções. Ele pode incluir quatro pastas:

Implantação (se a experiência do usuário for Assistida, como Test Data Management, isso pode não ser incluído)
Documentação
Bibliotecas (se o processo não incluir qualquer Biblioteca, talvez não esteja incluída)
Processos

Embora certos elementos sejam consistentes em cada Acelerador de Solução (como a estrutura da pasta), seu Acelerador de Solução pode ser influenciado pelo caso de uso específico e pelos produtos da UiPath utilizados no Acelerador de Solução. A tabela abaixo são destacados os itens consistentes dentro de cada Acelerador de Solução:

Implantação	Documentação	Bibliotecas	Processos
Detalhes do Ativo Detalhes da Fila Pacote de gerenciamento de solução Quaisquer arquivos da Biblioteca NUPKG Quaisquer atividades personalizadas adicionais	Acelerador de solução — Visão geral do acelerador Acelerador de solução — Guia de implantação Acelerador de solução — Documentação técnica Design de Solução de Alto Nível (.pdf e arquivo de edição original, como .vsdx) Design de Solução Detalhado (.pdf e arquivo de edição original, como .vsdx)	Subpastas individuais para cada biblioteca	Subpastas individuais para cada processo

2. Pasta de implantação

a. Detalhes do Ativo

Os ativos representam variáveis ou credenciais compartilhadas que podem ser usadas em diferentes projetos de automação em um Acelerador de Solução. O Asset Detalhes é um arquivo de Pasta de Trabalho do Microsoft Excel (.xlsx) que é compatível com o Orchestrator Manager, uma ferramenta que aproveita a API do Orchestrator para manipular entidades. Esta pasta de trabalho permite que os usuários vejam e adicionem facilmente ativos que são usados em todo seu Acelerador de Solução.

Conforme o exemplo abaixo, espera-se que essa pasta de trabalho tenha duas planilhas: Criar para criar ativos Text, Bool e Integer e Criar Credencial para criar ativos de credenciais. Os cabeçalhos necessários e a ordem dos cabeçalhos para cada planilha, juntamente com as informações dentro de cada linha, são definidos nas tabelas abaixo.

Nome da Pasta¹	Nome do Ativo¹	Descrição¹	Escopo¹	Nome do Robô ou Nome de Usuário do Usuário¹	Tipo¹	Valor¹	ID²do ativo	Resultado²
Processamento de ordens de compra	`Dispatcher_PurchaseOrdersEmailsSourceAccount`	A caixa de correio onde os E-mails de Documentos de PurchaseOrders que precisamos processar estão localizados.	Global		Texto	PARA Substituir por um valor específico

¹⁾ A coluna recebe entrada da operação - como nomes, tipos e valores de ativos a serem criados.

²⁾ Coluna usada pelo Orchestrator Manager para escrever dados recuperados do Orchestrator, como as IDs de ativos criados. Os valores aqui serão substituídos na próxima operação Criar/Criar Credencial .

Criar

Nome da Pasta¹	Nome do Ativo¹	Descrição¹	Escopo¹	Nome do Robô¹ ou Nome de Usuário¹do Usuário	Tipo¹	Valor¹	ID²do ativo	Resultado²
Ao especificar nomes de subpastas de Pastas Modernas, é necessário inserir o nome completo da Pasta pai, incluindo seus ancestrais, separados pelo caractere de barra (/). Exemplo: se uma Pasta Moderna chamada “GrupoDeTrabalho1” é uma subpasta de uma Pasta Moderna chamada “DepartamentoA”, o nome completo do GrupoDeTrabalho1 será “DepartamentoA/GrupoDeTrabalho1”.	O nome do ativo. O nome deve ter no máximo 256 caracteres.	Descrição do ativo. A descrição deve ter no máximo 250 caracteres.	O campo Escopo tem um número fixo de valores possíveis, de acordo com os escopos do ativo disponíveis no Orchestrator: Global Robô (disponível apenas em Pastas Clássicas) Usuário (disponível apenas em Pastas Modernas).	Ao criar Ativos por Robô, use o campo Nome do Robô ou Nome de Usuário do Usuário para especificar o nome do Robô que deve ter acesso ao valor do Ativo que está sendo definido. O Robô deve estar na mesma Pasta que o Ativo por Robô criado. Os valores de vários Robôs devem ser especificados em linhas separadas com o mesmo nome da Pasta, do Ativo, do escopo e do tipo.	O campo Tipo tem um número fixo de valores possíveis, de acordo com os tipos de Ativos disponíveis no Orchestrator: Texto Bool Número inteiro	O valor global do ativo. Se os valores dos ativos precisarem ser definidos pelo usuário, eles devem ser escritos como “PARA RESubstituir por valor específico”. Este campo deve ter: um máximo de 1.000.000 de caracteres para os tipos de texto um valor entre 2147483648 e 2147483648 para tipos Integer um valor de TRUE ou FALSE para tipos de Bool.	O ID do Ativo criado se ele for criado com sucesso.	O resultado da criação do Ativo — bem-sucedido ou falho.

¹⁾ A coluna recebe entrada da operação - como nomes, tipos e valores de ativos a serem criados.

Criar credencial

Nome da Pasta¹	Nome do Ativo¹	Descrição¹	Escopo¹	Nome do Robô ou Nome de Usuário do Usuário¹	Nome de Usuário¹	Senha¹	ID²do ativo	Resultado²
Ao especificar nomes de subpastas de Pastas Modernas, é necessário inserir o nome completo da Pasta pai, incluindo seus ancestrais, separados pelo caractere de barra (/). Exemplo: se uma Pasta Moderna chamada “GrupoDeTrabalho1” é uma subpasta de uma Pasta Moderna chamada “DepartamentoA”, então o nome completo de “GrupoDeTrabalho1” será “DepartamentoA/GrupoDeTrabalho1”.	O nome do ativo. O nome deve ter no máximo 256 caracteres.	Descrição do ativo. A descrição deve ter no máximo 250 caracteres.	O campo Escopo tem um número fixo de valores possíveis, de acordo com os escopos do ativo disponíveis no Orchestrator: Global Robô (disponível apenas em Pastas Clássicas) Usuário (disponível apenas em Pastas Modernas).	Ao criar Ativos por Robô, use o campo Nome do Robô ou Nome de Usuário do Usuário para especificar o nome do Robô que deve ter acesso ao valor do Ativo que está sendo definido. O Robô deve estar na mesma Pasta que o Ativo por Robô criado. Os valores de vários Robôs devem ser especificados em linhas separadas com o mesmo nome da Pasta, do Ativo, do escopo e do tipo.	O campo nome de usuário. Como isso é fornecido pelos usuários finais, esse campo deve sempre conter "PARA REPLACE FROM SPECIFIC VALUE" em cada linha.	O campo de senha. Como isso é fornecido pelos usuários finais, esse campo deve sempre conter "PARA REPLACE FROM SPECIFIC VALUE" em cada linha.	O ID do Ativo criado se ele for criado com sucesso.	O resultado da criação do Ativo — bem-sucedido ou falho.

¹⁾ A coluna recebe entrada da operação - como nomes, tipos e valores de ativos a serem criados.

b. Detalhes da Fila

Uma fila é um contêiner que permite que você mantenha um número ilimitado de itens. Os itens da fila podem armazenar vários tipos de dados, como informações de fatura ou detalhes do cliente. As filas permitem que você crie grandes projetos de automação, como os Aceleradores de Soluções, com uma lógica complexa subjacente.

Os Detalhes da Fila são um arquivo de pasta de trabalho do Microsoft Excel (.xlsx) que é compatível com o Orchestrator Manager, uma ferramenta que aproveita a API do Orchestrator para manipular entidades. Esta pasta de trabalho permite que os usuários vejam e adicionem facilmente filas que são usadas em todo o seu Acelerador de Soluções

De acordo com o exemplo abaixo, espera-se que esta pasta de trabalho tenha uma planilha: Criar para criar todas as filas. Os cabeçalhos necessários e a ordem dos cabeçalhos para a planilha, juntamente com as informações dentro de cada linha, são definidos na tabela abaixo. As colunas de cabeçalho laranja recebem entrada da operação - como nomes, descrição e número máximo de repetições de filas a serem criadas. As colunas de cabeçalho cinza são usadas pelo Orchestrator Manager para gravar dados recuperados do Orchestrator, como os IDs das filas criadas. Os valores aqui serão substituídos na próxima operação Criar.

Nome da pasta	Nome da fila	Description	Unique Reference	Auto Retry	Max # of Retries	ID do ativo	Resultado
Ao especificar nomes de subpastas de Pastas Modernas, é necessário inserir o nome completo da Pasta pai, incluindo seus ancestrais, separados pelo caractere de barra (/). Exemplo: se uma Pasta Moderna chamada “GrupoDeTrabalho1” é uma subpasta de uma Pasta Moderna chamada “DepartamentoA”, o nome completo do GrupoDeTrabalho1 será “DepartamentoA/GrupoDeTrabalho1”.	O nome da Fila. O nome não pode ter nenhum espaço em branco. O nome deve ter no máximo 50 caracteres.	Descrição da Fila. A descrição deve ter no máximo 250 caracteres.	Obriga as transações a terem referências exclusivas. Deve ser Sim ou Não.	Permite que um item de transação na Fila que falha com uma exceção do sistema seja repetido automaticamente. Deve ser Sim ou Não.	O Número Máximo de Repetições de um item de transação na Fila. Deve ser pelo menos 1 se Repetição automática for Sim. Pode ser um Integer entre 1 e 50.	O ID da Fila criada se a Fila for criada com sucesso.	O resultado da criação da Fila – Sucesso ou falha.

C. Pacote de gerenciamento de soluções

Um acelerador de solução é um pacote de vários componentes (processos, ativos, filas, etc.) desenvolvidos na plataforma UiPath, que trabalham juntos para automatizar um caso de uso de negócios. O Gerenciamento de Soluções da UiPath fornece um meio pronto para usar para gerenciar o ciclo de vida dos componentes do Acelerador de Solução depois de criados. Esse conjunto de recursos entra em ação assim que o desenvolvimento é concluído para seu Acelerador de Solução e você deseja promover facilmente seus componentes para um novo ambiente.

O Gerenciamento de Soluções permite que você empacote convenientemente esses componentes em um único arquivo dentro do ambiente do Orchestrator no qual o Acelerador de Solução foi desenvolvido. Para obter um guia sobre como criar um Pacote de gerenciamento de soluções, consulte Criação de um projeto de solução.

Alguns requisitos e considerações ao criar um Pacote de gerenciamento de soluções para seu Acelerador de Soluções:

Quaisquer Ativos que são Credenciais devem conter os campos Nome de Usuário e Senha com valores de "PARA RESubstituir por valor específico", uma vez que são fornecidos pelos usuários finais.
Quaisquer Ativos que sejam específicos do usuário final, como endereços de e-mail de destino ou URLs de ambiente, também devem ter valores de “PARA RESubstituir por valor específico”.
A convenção de nomenclatura para o CEP de gerenciamento da solução deve ser "Nome do Acelerador de Solução 1.0.0" onde Nome do Acelerador de Solução é o nome do Acelerador de Solução, e 1.0.0 é a versão do projeto de solução para o zip do Gerenciamento de solução.
Quaisquer buckets e gatilhos de armazenamento serão incluídos no zip do Solution Management. Buckets e gatilhos de armazenamento não podem ser incluídos em implantações manuais e devem ser declarados para serem criados manualmente na documentação do Guia de implantação.
Os processos NÃO devem ser incluídos dentro do zip do Solution Management. Espera-se que os processos não funcionem imediatamente sem modificação para aprimoramentos específicos de ambiente e procedimento para um Acelerador de Solução.
Se você esperar que uma biblioteca personalizada seja modificada de qualquer maneira, ela não deve ser incluída no Pacote de Gerenciamento de Soluções, pois não funcionará imediatamente sem modificação.

d. Arquivos NUPKG de biblioteca

Uma biblioteca é um projeto que contém um ou mais fluxos de trabalho que podem ser reutilizados como atividades em outros projetos. Isso permite que seu Acelerador de Solução use código comum em todo cada processo individual. Para informações sobre como criar uma biblioteca, consulte a seção Criando uma Biblioteca na documentação da biblioteca. Para obter informações sobre padrões de desenvolvimento na criação de uma biblioteca para Aceleradores de Solução, consulte a seção desenvolvimento de bibliotecas. Uma biblioteca é salva como arquivo NUPKG quando publicada e pode ser instalada como uma dependência a partir do Gerenciador de Pacotes. Você pode publicar uma biblioteca em uma pasta local ou publicar e baixar a partir do feed de pacote NuGet para recuperar o arquivo NUPKG relevante.

Importante:

Se uma biblioteca reutilizável foi projetada para funcionar automaticamente sem nenhuma modificação necessária, inclua-a na pasta Implantação.

Se a biblioteca for modificada para funcionar corretamente dentro do projeto, espera-se que ela não seja incluída na pasta Implantação, e o Guia de Implantação deve deixar claro que a biblioteca precisa ser modificada, publicada e as dependências atualizadas em qualquer projeto usando essa biblioteca.

Se uma biblioteca reutilizável for publicada separadamente em um feed, como os UiPath Solution Accelerators Generic Reusables, você não precisa incluir o arquivo NUPKG.

e.e Qualquer Atividades Personalizada Adicional

Você pode criar suas próprias atividades personalizadas, que podem ser usadas em projetos do UiPath Studio. Para usar atividades personalizadas criadas, você deve instalar o pacote NuGet que o contém no(s) projeto(s) do Acelerador de Soluções acessando o Gerenciador de Pacotes a partir do UiPath Studio e instalando o NUPKG. Esse pacote NuGet deve ser criado ao finalizar a atividade personalizada. O NUPKG pode ser incluído dentro da pasta Deployment do Acelerador de Solução.

3. Documentação

A estrutura de Documentação deve seguir as diretrizes abaixo:

Acelerador de solução — Visão geral do acelerador
Acelerador de solução — Guia de implantação
Acelerador de solução — Documentação técnica
Design de Solução de Alto Nível (.pdf e arquivo de edição original, como .vsdx)
Design de Solução Detalhado (.pdf e arquivo de edição original, como .vsdx)

4. Bibliotecas

Uma Biblioteca da UiPath é um projeto que contém um ou mais fluxos de trabalho que podem ser reutilizados como atividades em outros projetos. As bibliotecas são salvas como arquivos NUPKG quando publicadas e podem ser instaladas como dependências a partir do gerenciador de pacotes. Uma Biblioteca só pode ser desenvolvida usando um tipo de projeto Biblioteca. Quaisquer componentes de IU reutilizáveis também precisam ser implementados em uma Biblioteca usando o Repositório de Objetos. Qualquer entidade do Data Service deve ser importada dentro de uma Biblioteca , para que a mesma referência/namespace possa ser usada em todo o Acelerador de Solução importando uma Biblioteca. Ao importar o de uma biblioteca, os namespaces não entrarão em conflito em diferentes processos.

Uma Biblioteca tem os seguintes requisitos:

Tipo de Projeto	Projetos da biblioteca
Convenção de Nomenclatura do Tamanho do Processo e do Fluxo de Trabalho	XAMLs pequenos e bem definidos Nomenclatura: use a nomenclatura "Maiúsculas Cada Palavra" (espaços entre elas) e não PascalCase. Se PascalCase for a preferência para fluxos de trabalho, a convenção "Maiúsculas Cada Palavra" (restaurando os espaços no nome da atividade) ainda pode ser feita no campo "Nome de Exibição" do "Layout da Atividades" (clique com o botão direito do mouse na opção do menu Fluxo de Trabalho no Explorador de Projeto ).
Anotações	Adicionar anotações fixadas em cada arquivo do fluxo de trabalho como um aviso de exoneração de responsabilidade/explicação Anotar Atividades com explicação descritiva adequada
Convenção de Nomenclatura das Variáveis	Camel Minúsculas (por exemplo, firstName, LastName, myOrganizationStructure)
Convenção de Nomenclatura dos Argumentos	Os argumentos devem ser nomeados usando o padrão PascalCase . Os nomes dos argumentos NÃO devem conter os prefixos in_/out_/io_ porque esses argumentos aparecerão como propriedades quando a Biblioteca estiver sendo criada. As anotações devem existir para cada argumento, pois isso é exibido quando uma atividade da biblioteca é utilizada
Resultados do argumento	Um fluxo de trabalho de biblioteca deve corresponder ao nome do fluxo de trabalho Um fluxo de trabalho deve analisar qualquer resultado de API ou GUI e retornar o resultado dos dados específicos
Comments	Adicione comentários para aumentar a legibilidade dos projetos de Biblioteca
Entidade do Data Service	Entidades do Data Service podem ser importadas de uma Biblioteca. O namespace deve ser o nome da entidade. As operações do Data Service podem ocorrer em uma Biblioteca para melhorar a reusabilidade da entidade em todo o Acelerador de Solução.
Manuseio de exceção	Os erros dentro de uma biblioteca devem ser gerados como exceções, em vez de serem sinalizados por meio de argumentos de saída. Confirme o resultado de um componente de biblioteca no final, verificando se a ação desejada ocorreu, e gere uma exceção caso não tenha acontecido.

5. Processos

Um processo é um projeto da UiPath desenvolvido usando a opção de design de processo que pode ser executado por um UiPath Robot. Qualquer novo projeto de Processo precisa ser um Projeto Multiplataforma ou um Projeto do Windows. Windows - Legado usa uma versão mais antiga do .NET Framework e não será mais uma opção para novos projetos em um futuro próximo. As entidades do Data Service não devem ser importadas dentro de um processo. A importação dentro de um processo individual pode causar namespaces conflitantes em todo um Acelerador de Solução.

Um processo tem os seguintes requisitos:

Tipo de Projeto	Projetos do Windows Projetos multiplataforma
Tamanho do Processo	Processos pequenos e bem delimitados
Anotações	Adicionar anotações fixadas em cada arquivo do fluxo de trabalho como um aviso de exoneração de responsabilidade/explicação. O formato típico descreve qual é o propósito do Fluxo de Trabalho, ao lado de uma explicação de cada Argumento para enviar para dentro, para fora e para dentro/fora Anotar Atividades com explicação descritiva adequada
Convenção de Nomenclatura das Variáveis	Manter uma convenção de nomenclatura de variáveis consistente ao longo de um processo de automação é importante para legibilidade e clareza O padrão típico que os desenvolvedores da UiPath seguem são Minúsculas Minúsculas (por exemplo, firstName, myFirstName, LastName, myOrganizationStructure)
Convenção de Nomenclatura dos Argumentos	Camel Minúsculas com um prefixo que indica o tipo de argumento como in, out ou in/out, como in_defaultTimeout, in_fileName, out_textResult e io_retryNumber. As anotações devem existir para todos os argumentos, pois elas são exibidas quando um fluxo de trabalho é invocado
Comments	Adicione atividades de comentário em lugares apropriados para destacar áreas de configuração/onde a lógica precisa ser alterada com base nos cenários do cliente
Entidade do Data Service	As Entidades do Data Service não devem ser importadas dentro de um processo. Uma Entidade do Data Service deve ser importada dentro de uma Biblioteca comum para evitar namespaces conflitantes. As operações do Data Service podem ocorrer em um processo com um namespace importado de uma Biblioteca.
Camadas	Camada de aplicativo (é possível usar a API ou a Automação de interface gráfica para um aplicativo específico, mas isso fica a critério do desenvolvedor) Camada de Lógica de Negócios / Camada de Implementação