Como criar pacotes reutilizáveis

Revise as diretrizes para entender como construir pacotes para reutilização.

Conheça seus dados de entrada
Ao definir campos que seu pacote de ação requer do usuário, forneça detalhes específicos na configuração do tipo de atributo para limitar os tipos de dados que seu pacote recebe.
  • Limite a entrada para reduzir a carga de verificações que precisam ser feitas quando o pacote é recebido.
  • O Javadoc inclui 34 tipos de atributos definidos, portanto, revise-os quando criar seu pacote para selecionar os tipos de campo apropriados.
  • Defina seu pacote para que ele use um valor armazenado. Por exemplo, em nome do bot, seu pacote está fazendo chamadas de API, verifique se o AttributeType do campo de entrada de ação para a chave de API ou um token está definido como credential. Dessa forma, os usuários são incentivados a usar um valor armazenado no Cofre de credenciais para dados de entrada confidenciais exigidos pelo pacote.
Use rótulos de forma adequada
Na anotação CommandPkg, use rótulos diferentes, node_labels e descrições de forma adequada.
  • Use esses rótulos como breves descrições de sua ação e use apenas algumas palavras para descrever uma ação.
  • Replique o mesmo estilo de nomenclatura que é apresentado nos pacotes de ação padrão.
  • Cada ação é um elemento filho de um pacote, e o rótulo da ação é exibido junto com o ícone pacote no painel Ações. Use nomes curtos para descrever cada ação.
  • Documente um formato de entrada esperado para determinados campos. Use a descrição de parâmetro para a anotação @Pkg. Isso permite que os desenvolvedores de pacote revisem o formato, requisito ou dados que devem ser usados para um campo de entrada específico. Por exemplo:
    @Pkg(label = "Start Date", description="Date Format as MM/DD/YYYY"
Teste os componentes da unidade
Durante o desenvolvimento de pacote, crie testes de unidade para validar se cada componente e ação do pacote está funcionando como esperado.
  • Valide o comportamento da unidade de teste individual, uma única classe ou uma única ação, para garantir que ela esteja funcionando como esperado.
  • Revise e documente qualquer defeito de recurso ou funcionalidade nos estágios iniciais do processo de desenvolvimento.
Como tratar erros
Inclua o tratamento de erros na lógica do bot para garantir que todos os erros sejam tratados com tranquilidade. Se um erro não for tratado, ele poderá impedir que um executor de bot execute outras tarefas.
  • Crie mensagens de erro significativas que possam ajudar os consumidores de bot com resoluções de erro.
  • Como desenvolvedor de pacote, lembre-se destas recomendações:
    • Use o bloco Tentar/Capturar para acomodar um erro.
    • Use um bloco de multicaptura para encontrar erros específicos e use o BotCommandException para retornar mensagens de erro personalizadas. Por exemplo:
      //create array of 3 items
int[] myIntArray = new int[]{1, 0, 7};
try {
    //print 4th item in array
    System.out.println(myIntArray[3]);
    //Perform operation on first and second items in array
    int result = myIntArray[0] / myIntArray[1];
} catch (ArrayIndexOutOfBoundsException e) {
    //Throw custom message for IndexOutofBounds
    throw new BotCommandException("The array does have the number of expected items.");
} catch (ArithmeticException e) {
    //Throw custom message on Atithmetic Exception
    throw new BotCommandException("Math Operation Error with " + Integer.toString(myIntArray[0]) + " and " + Integer.toString(myIntArray[1]));
}
Siga o princípio de responsabilidade única
Um pacote é uma coleção de ações. Cada ação dentro de um pacote deve ter uma única responsabilidade e essa responsabilidade deve ser encapsulada por essa ação.
  • Seguir o princípio de responsabilidade única ajuda seus consumidores de pacote a implementá-los facilmente, simplifica os testes e evita modificações desnecessárias.
  • As ações que você oferece permitem que os consumidores de pacote personalizem a maneira como usam seu pacote dentro dos bots, e podem ajudar seus bots a serem o mais eficientes possível.
Forneça exemplos
Ao enviar pacotes para a Bot Store, inclua um bot de demonstração que mostre o uso do pacote.
  • Use as ações do Automation 360 e permita que os consumidores do pacote usem essas ações para usarem as capacidades do bot.
  • Forneça sempre um bots de amostra com descrições para ajudar os consumidores de seu pacote com o conhecimento necessário para entender o uso adequado.
See also: Best practices: Building reusable and secure Automation 360 bots and packages