Création de packages réutilisables

Passez en revue les instructions suivantes pour comprendre comment créer des packages réutilisables.

Connaître ses données entrantes
Lorsque vous définissez les champs que votre package d'actions requiert de l'utilisateur, définissez en détail le type d'attribut pour limiter les types de données que votre package reçoit.
  • Limitez les entrées pour réduire la charge des vérifications devant être effectuées lors de la réception du package.
  • Javadoc inclut 34 types d'attributs définis ; passez-les en revue lorsque vous créez votre package pour sélectionner les types de champs appropriés.
  • Configurez votre package pour qu'il utilise une valeur stockée. Par exemple, si votre package effectue des appels d'API pour le compte du robot, vérifiez que la valeur AttributeType du champ d'entrée d'action pour la clé d'API ou un jeton est définie sur credential. De cette façon, les utilisateurs sont encouragés à utiliser une valeur stockée dans le Credential Vault pour les données d'entrée sensibles requises par le package.
Utiliser les étiquettes de façon appropriée
Dans l'annotation CommandPkg, utilisez correctement les étiquettes, node_labels et descriptions disponibles.
  • Utilisez ces étiquettes pour décrire brièvement votre action en quelques mots.
  • Utilisez la convention d'affectation de noms telle qu'elle est présentée dans les packages d'actions.
  • Chaque action est un élément enfant d'un package, et l'étiquette d'action s'affiche avec l'icône du package dans le volet Actions. Utilisez des noms courts pour décrire chaque action.
  • Spécifiez un format d'entrée attendu pour certains champs. Utilisez la description du paramètre pour l'annotation @Pkg. Les développeurs du package peuvent ainsi examiner le format, les exigences ou les données à utiliser pour une zone de saisie spécifique. Par exemple :
    @Pkg(label = "Start Date", description="Date Format as MM/DD/YYYY"
Effectuer des tests unitaires des composants
Lors du développement de votre package, créez des tests unitaires pour vérifier que l'action du package et tous ses composants fonctionnent comme prévu.
  • Validez le comportement de chaque test unitaire (classe ou action unique) pour vous assurer qu'il fonctionne comme prévu.
  • Examinez et documentez tout défaut de fonctionnalité dès les premiers stades de votre processus de développement.
Gestion des erreurs
Incluez la gestion des erreurs dans la logique du robot pour vous assurer que toutes les erreurs sont traitées correctement. Si une erreur n'est pas gérée, elle risque d'empêcher un robot runner d'exécuter d'autres tâches.
  • Créez des messages d'erreur significatifs qui peuvent aider les utilisateurs de votre robot à résoudre les erreurs.
  • En tant que développeur de package, gardez à l'esprit les recommandations suivantes :
    • Utilisez un bloc Essayer/Capturer pour traiter une erreur.
    • Utilisez un bloc de capture multiple pour rechercher des erreurs spécifiques et utilisez BotCommandException pour renvoyer des messages d'erreur personnalisés. Par exemple :
      //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]));
}
Suivre le principe de responsabilité unique
Un package est un ensemble d'actions. Chaque action dans un package doit avoir une seule responsabilité et cette responsabilité doit être encapsulée par cette action.
  • Suivre le principe de responsabilité unique aide les utilisateurs à implémenter facilement votre package, simplifie les tests et évite les modifications inutiles.
  • Les actions que vous proposez permettent aux utilisateurs de votre package d'optimiser l'efficacité de leurs robots et de personnaliser la façon dont ils utilisent votre package dans leurs robots.
Fournir des exemples
Lorsque vous soumettez des packages au Bot Store, incluez un robot de démonstration qui explique l'utilisation du package.
  • Utilisez les actions de Automation 360 et autorisez les utilisateurs de votre package à utiliser ces actions pour étendre les fonctionnalités de leur robot.
  • Veillez à toujours fournir des exemples de robots avec des descriptions pour que les utilisateurs de votre package sachent comment l'utiliser correctement.
See also : Best practices: Building reusable and secure Automation 360 bots and packages