Diseño de packagesreutilizables

Revise las pautas para comprender cómo diseñar packages para reutilización.

Conozca sus datos entrantes
Al configurar los campos que su package de acción requiere del usuario, proporcione detalles específicos al configurar el tipo de atributo para limitar los tipos de datos que recibe su package.
  • Limite la entrada para reducir la carga de los controles que deben realizarse cuando se recibe el paquete.
  • Javadoc incluye 34 tipos de atributos definidos, así que revíselos cuando diseñe su package para seleccionar los tipos de campos adecuados.
  • Configure su package para que tome un valor almacenado. Por ejemplo, en nombre del bot, su package está realizando llamadas a la API; verifique que AttributeType del campo de entrada de la acción para la clave de API o un token esté establecido en credential. De esta manera, se alienta a los usuarios a utilizar un valor almacenado en la Credential Vault para los datos de entrada confidenciales que requiere el package.
Use las etiquetas adecuadamente
En la anotación CommandPkg, utilice diferentes etiquetas, node_labels y descripciones de manera adecuada.
  • Use estas etiquetas como descripciones breves de su acción y use solo unas pocas palabras para describir una acción.
  • Replique el mismo estilo de nomenclatura que se presenta en el packagesAcción predeterminado.
  • Cada acción es un elemento secundario de un package, y la etiqueta de acción se muestra junto con el ícono del package en el panel Acciones. Use nombres cortos para describir cada acción.
  • Documente un formato de entrada esperado para ciertos campos. Utilice la descripción del parámetro para la anotación @Pkg. Esto les permite a los desarrolladores de package revisar el formato, el requisito o los datos que deben utilizarse para un campo de entrada específico. Por ejemplo:
    @Pkg(label = "Start Date", description="Date Format as MM/DD/YYYY"
Pruebe unitariamente sus componentes
Durante el desarrollo del package, cree pruebas unitarias para validar que cada componente y la acción del package funcionen como se espera.
  • Valide el comportamiento de la unidad individual probada, una clase individual o una acción individual para asegurarse de que funcione como se espera.
  • Revise y documente cualquier característica o defecto de funcionalidad en las primeras etapas del proceso de desarrollo.
Manejo de errores
Incluya el manejo de errores en la lógica del bot para garantizar que todos los errores se manejen fácilmente. Si no se maneja un error, podría impedir que un bot runner ejecute otras tareas.
  • Cree mensajes de error significativos que puedan ayudar a los consumidores del bot con las resoluciones de errores.
  • Como desarrollador de packages, tenga en cuenta estas recomendaciones:
    • Use el bloque Intentar/Capturar para adaptar un error.
    • Utilice un bloque de múltiples capturas para encontrar errores específicos y utilice BotCommandException para devolver mensajes de error personalizados. Por ejemplo:
      //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 el principio de responsabilidad individual
Un package es un conjunto de acciones. Cada acción dentro de un package debe tener una única responsabilidad y esa responsabilidad debe ser encapsulada por esa acción.
  • Seguir el principio de responsabilidad única ayuda a los consumidores de sus package a implementarlo fácilmente, simplifica las pruebas y evita modificaciones innecesarias.
  • Las acciones que usted ofrece les permiten a los consumidores de los package personalizar la forma en que usan su package dentro de sus bots, y pueden ayudar a sus bots a ser lo más eficientes posible.
Proporcionar ejemplos
Al enviar packages a la Bot Store, incluya un bot de demostración que demuestre el uso del package.
  • Utilice las acciones de Automation 360 y permita a los consumidores de package que utilicen estas acciones para gastar las capacidades de su bot.
  • Proporcione siempre bots de muestra con descripciones para ayudar a los consumidores de sus package con el conocimiento que necesitan para comprender su uso adecuado.
See also: Best practices: Building reusable and secure Automation 360 bots and packages