Workflow - Dans le champ d’application

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 3 minutes de lecture

    • L’API de workflow incluse dans le champ d’application fournit des méthodes qui peuvent être utilisées dans un script de définition d’activité.

    Il n’existe aucun constructeur pour créer une instance d’un objet de workflow inclus dans le champ d’application. Utilisez plutôt l’objet de workflow global disponible dans les scripts d’activité. Cet objet de workflow est disponible dans n’importe quel emplacement de script à l’intérieur d’un workflow.

    Workflow inclus dans le champ d’application : debug(message de chaîne, arguments d’objet)

    Ajoute un message de débogage au journal.

    Tableau 1. Paramètres
    Nom Type Description
    message Chaîne Message à ajouter au journal.
    args Objet Arguments à ajouter au message.
    Tableau 2. Renvoie
    Type Description
    Chaîne Message ajouté au journal. 
    var loggedMessage = workflow.debug("All is well");

    Workflow inclus dans le champ d’application : erreur (message de chaîne, arguments d’objet)

    Ajoute un message d’erreur au journal.

    Tableau 3. Paramètres
    Nom Type Description
    message Chaîne Message à ajouter au journal.
    args Objet Arguments à ajouter au message.
    Tableau 4. Renvoie
    Type Description
    Chaîne Message consigné 
    var loggedMessage = workflow.error("An error has occurred. ");

    Workflow inclus dans le champ d’application : getVariable(String name)

    Renvoie la valeur de la variable spécifiée.

    Tableau 5. Paramètres
    Nom Type Description
    nom Chaîne Le nom de variable
    Tableau 6. Renvoie
    Type Description
    Objet La valeur de la variable 
    var value = workflow.getVariable("task");

    Workflow inclus dans le champ d’application : info (message de chaîne, arguments d’objet)

    Ajoute un message d’information au journal.

    Tableau 7. Paramètres
    Nom Type Description
    message Chaîne Message à ajouter au journal.
    args Objet Arguments à ajouter au message.
    Tableau 8. Renvoie
    Type Description
    Chaîne Message consigné. 
    var loggedMessage = workflow.info("All is well");

    Workflow inclus dans le champ d’application - entrées

    Objet contenant les variables du workflow.

    Il ne s’agit pas d’une méthode, mais plutôt d’un moyen de référencer les variables d’un objet de workflow, par exemple l’utilisateur. Les variables de workflow sont définies dans les propriétés du workflow ou par des activités scriptées.

    Tableau 9. Champ
    Nom Type Description
    entrées Objet Variables de workflow en tant que paires nom-valeur. Les variables d’un objet de workflow sont personnalisées pour l’implémentation d’un intégrateur. 
    var user = workflow.inputs.u_user;

    Workflow inclus dans le champ d’application : name()

    Renvoie le nom du workflow.

    Tableau 10. Paramètres
    Nom Type Description
    Aucun
    Tableau 11. Renvoie
    Type Description
    Chaîne Nom du workflow 
    var name = workflow.name();

    Workflow inclus dans le champ d’application : removeVariable(nom de chaîne)

    Supprime la variable spécifiée du workflow.

    Tableau 12. Paramètres
    Nom Type Description
    nom Chaîne Le nom de variable
    Tableau 13. Renvoie
    Type Description
    nul 
    var value = workflow.removeVariable("task");

    Workflow inclus dans le champ d’application : résultat

    Élément de l’objet de workflow qui contient les résultats du workflow.

    Il ne s’agit pas d’une méthode, mais plutôt de l’élément de l’objet de workflow qui contient les résultats d’un workflow.

    Tableau 14. Champ
    Nom Type Description
    résultat Chaîne Résultats du workflow. 
    var wfResult = workflow.result;

    Workflow inclus dans le périmètre : bloc-notes()

    Renvoie l’objet bloc-notes du workflow.

    Tableau 15. Paramètres
    Nom Type Description
    Aucun
    Tableau 16. Renvoie
    Type Description
    Objet L’objet bloc-notes. 
    var scratchpad = workflow.scratchpad();

    Workflow inclus dans le champ d’application : setResult(String result)

    Définit le résultat du workflow.

    Tableau 17. Paramètres
    Nom Type Description
    résultat Chaîne Le résultat du workflow
    Tableau 18. Renvoie
    Type Description
    nul 
    workflow.setResult("Success");

    Workflow inclus dans le champ d’application : setVariable(nom de chaîne, valeur de l’objet)

    Définit la variable spécifiée sur la valeur spécifiée.

    Tableau 19. Paramètres
    Nom Type Description
    nom Chaîne Le nom de variable
    valide Objet Valeur à affecter à la variable.
    Tableau 20. Renvoie
    Type Description
    nul 
    workflow.setVariable("task", "terrible");

    Workflow inclus dans le champ d’application : warn(message de chaîne, arguments d’objet)

    Ajoute un message d’avertissement au journal.

    Tableau 21. Paramètres
    Nom Type Description
    message Chaîne Message à ajouter au journal.
    args Objet Arguments à ajouter au message.
    Tableau 22. Renvoie
    Type Description
    Chaîne Message consigné 
    var loggedMessage = workflow.warn("Check your permissions.");