Annotations de création et de fonction

Liste des annotations de création et de fonction disponibles.

Annotation : BotCommand

Permet au type d'être traité en tant qu'action. Vous pouvez définir trois types d'actions de propriété commandType.

  • Commande\Action
  • Condition
  • Itérateur
Exemples :
  • @BotCommand(commandType = BotCommand.CommandType.Iterator)
  • @BotCommand(commandType = Condition)
  • @BotCommand(commandType = Varialbe)
  • @BotCommand(commandType = Trigger)

Annotation : CommandPkg

Rend le type admissible pour la création de package.json d'actions. Cette annotation doit être utilisée avec BotCommand pour prendre effet. Pkg ne participe à l'activité que si cette annotation est présente.

Exemple :
@CommandPkg(label = "Create", name = "createFile", 
description = "Creates a file", node_label = "{{filePath}}", 
icon = "file.svg")

Annotation : ConditionTest

Participe à l'exécution de la condition. Cette annotation ne peut être utilisée que lorsque BotCommand a commandType défini sur Condition. Seule une méthode précise doit être annotée lorsque l'annotation BotCommand est présente sur le type. Le non-respect de cette consigne entraînera une erreur de compilation.

Annotation : Exécuter

Participe à l'exécution de BotCommand. Une seule méthode précise doit être annotée lorsque l'annotation BotCommand est présente sur le type. Le non-respect de cette consigne entraînera une erreur de compilation.

Exemple :
@Execute public void create( @Idx(index = "1", type = FILE) @LocalFile @Pkg(label = 
"File", description = "e.g. C:\\MyDoc\\MyFile.doc") @NotEmpty String filePath, 
@Idx(index = "2", type = CHECKBOX) @Pkg(label = "Overwrite an existing file") 
@NotEmpty Boolean isOverwrite) { createFile(filePath, isOverwrite); }

Annotation : GlobalSessionContext

Peut uniquement être appliquée aux variables membres et récupère GlobalSessionContext via un sélecteur.

Exemple :
@com.automationanywhere.commandsdk.annotations.GlobalSessionContext
    private GlobalSessionContext globalSessionContext;

    public void setSessionMap(Map < String, Object > sessionMap) {
     this.sessionMap = sessionMap;
    }
    public void setGlobalSessionContext(com.automationanywhere.bot.service.GlobalSessionContext globalSessionContext) {
     this.globalSessionContext = globalSessionContext;
    }

Annotation : HasNext

Participe à l'exécution de l'itérateur. Cette annotation ne peut être utilisée que lorsque BotCommand a commandType défini sur Itérateur. Nécessite l'annotation Suivant pour être présent. Une méthode doit être annotée lorsque l'annotation BotCommand est présente sur le type. Le non-respect de cette consigne entraînera une erreur de compilation.

Annotation : Index

Fait de l'élément annoté une partie de la hiérarchie utilisée pour le code et la génération de ressources. Sans cette annotation, aucune annotation d'élément connexe à BotCommand ne serait traitée.

Annotation : Idx.Option

Une option représente les éléments qui seraient exécutés dans la hiérarchie, mais qui attribueraient également les valeurs aux parents.

Exemples :
  • CASE D'OPTION
    @Idx(index = "1", type = RADIO, options = {
    @Idx.Option(index = "1.1", pkg = @Pkg(node_label = "[[Delay.delayType.1.1.node_label]]", label = "[[Delay.delayType.1.1.label]]", value = REGULAR)),
    @Idx.Option(index = "1.2", pkg = @Pkg(node_label = "[[Delay.delayType.1.2.node_label]]", label = "[[Delay.delayType.1.2.label]]", value = RANDOM))
})
@Pkg(label = "[[Delay.delayType.label]]", default_value = "REGULAR", default_value_type = DataType.STRING)
@Inject
private String delayType;
  • SELECT
    @Idx(index = "2", type = SELECT, options = {
@Idx.Option(index = "2.1", pkg = @Pkg(label = "[[LaunchWebsite.browser.2.1.label]]", value = "DEFAULT")),
@Idx.Option(index = "2.2", pkg = @Pkg(label = "[[LaunchWebsite.browser.2.2.label]]", value = "INTERNET_EXPLORER")),
@Idx.Option(index = "2.3", pkg = @Pkg(label = "[[LaunchWebsite.browser.2.3.label]]", value = "FIREFOX")),
@Idx.Option(index = "2.4", pkg = @Pkg(label = "[[LaunchWebsite.browser.2.4.label]]", value = "CHROME"))
}) @Pkg(label = "[[LaunchWebsite.browser.label]]", default_value = "DEFAULT", default_value_type = DataType.STRING) @NotEmptyStringbrowser)

Annotation : Inject

Rend un élément admissible à l'injection dans l'objet du type annoté. L'injection est basée sur le setter, donc un setter correspondant au type est obligatoire. Les valeurs injectées formeraient le mappage de paramètres BotCommand avec le nom fourni en Idx.

Annotation : Suivant

Participe à l'exécution de l'itérateur. Cette annotation ne peut être utilisée que lorsque BotCommand a commandType défini sur Itérateur. Nécessite l'annotation HasNext pour être présent. Une méthode doit être annotée lorsque l'annotation BotCommand est présente sur le type. Le non-respect de cette consigne entraînera une erreur de compilation.

Annotation : Pkg

Active un élément pour qu'il participe à la création du package.json. Cette annotation est ignorée lorsque Idx n'est pas présent.