WFActivityHandler - Global

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 4 minutes de lecture

    • Le script include WFActivityHandler est la classe de base pour toutes les activités de workflow.

    En tant que classe de base pour toutes les activités de workflow, ce code s’exécute toujours dans le cadre d’une activité.

    Lorsque vous développez vos propres activités de workflow, créez votre objet de script en dérivant de cette classe et en remplaçant les méthodes si nécessaire pour obtenir les fonctionnalités souhaitées. Le code client doit remplacer la méthode onExecute() pour effectuer un traitement significatif de l’activité.

    WFActivityHandler : debug(String msg, String args)

    Consigne un message de débogage.

    Tableau 1. Paramètres
    Nom Type Description
    msg Chaîne Message à envoyer au journal.
    args Chaîne Chaîne à envoyer au journal
    Tableau 2. Renvoie
    Type Description
    nul

    WFActivityHandler : debug(String, msg, Array, args)

    Consigne un message de débogage.

    Tableau 3. Paramètres
    Nom Type Description
    msg Chaîne Message à envoyer au journal.
    args Tableau Tableau de valeurs à envoyer au journal
    Tableau 4. Renvoie
    Type Description
    nul

    WFActivityHandler : generate(String, activityId, String, ordre, GlideDateTime, startAtDspValue, booléen : noCreateFlag)

    Génère des approbations et des tâches avant l’exécution de l’activité pour un aperçu du travail à venir.

    Permet de générer des objets au début d’un workflow dans un état En attente . Pour plus d’informations connexes, consultez Générer une activité de workflow.

    Tableau 5. Paramètres
    Nom Type Description
    activityId Chaîne Sys_id de cette activité en cours d’exécution. Situé dans la table Activités du workflow [wf_activity].
    order Chaîne Numéro de commande associé à la tâche ou à l’approbation.
    startAtDspValue Chaîne L’heure de début de la tâche ou de l’approbation au format GlideDateTime .
    noCreateFlag (en anglais seulement) Booléen

    Marqueur indiquant s’il faut ignorer la création d’un enregistrement d’approbation.

    Valeurs valides :
    • vrai : ne pas créer d’enregistrement d’approbation.
    • faux : créer un enregistrement d’approbation.

    Valeur par défaut : vrai
    Tableau 6. Renvoie
    Type Description
    Objet Objet de pré-génération enregistré dans le bloc-notes du workflow. Par exemple, l’objet peut être un tableau d’ID d’approbation. Lorsque l’activité exécute la fonction onExecute , elle peut demander à l’objet de prégénération de déterminer l’une des conditions suivantes :
    • Des approbations ont déjà été créées à l’état En attente.
    • L’activité doit créer les approbations à l’aide de la fonction onExecute .

    WFActivityHandler : info(String msg, String args)

    Consigne un message d’information.

    Tableau 7. Paramètres
    Nom Type Description
    msg Chaîne Message à envoyer au journal.
    args Chaîne Chaîne à envoyer au journal.
    Tableau 8. Renvoie
    Type Description
    nul

    WFActivityHandler : info(String msg, Array args)

    Consigne un message d’information.

    Tableau 9. Paramètres
    Nom Type Description
    msg Chaîne Message à envoyer au journal.
    args Tableau Tableau de valeurs à envoyer au journal
    Tableau 10. Renvoie
    Type Description
    nul

    WFActivityHandler : js(str. chaîne)

    Évalue les variables d’activité dans le script.

    Utilisé pour évaluer les chaînes qui contiennent el telles que ${some script} ou les chaînes commençant par javascript :. Affichez presque toutes les activités existantes, par exemple l’utilisation.

    Tableau 11. Paramètres
    Nom Type Description
    str Chaîne Chaîne qui contient éventuellement el incorporé.
    Tableau 12. Renvoie
    Type Description
    Chaîne Chaîne évaluée.

    WFActivityHandler : onCancel( )

    Gestionnaire d’événements pour cancel l’événement.

    La classe de base du script d’activité définit cette activité sur annulation. Les classes dérivées (activités) peuvent remplacer cette méthode si un traitement supplémentaire est requis pour annuler cette activité. L’activité Manual Approvals est un exemple de remplacement de cette méthode pour effectuer un traitement supplémentaire afin d’annuler cette activité.

    Tableau 13. Paramètres
    Nom Type Description
    Aucun
    Tableau 14. Renvoie
    Type Description
    nul

    WFActivityHandler : onExecute( )

    Méthode virtuelle. Les sous-classes d’activité doivent remplacer cette méthode pour effectuer un travail approprié à l’activité.

    Tableau 15. Paramètres
    Nom Type Description
    Aucun
    Tableau 16. Renvoie
    Type Description
    nul

    WFActivityHandler : runScript(script de chaîne)

    Permet aux activités d’exécuter un script contenu dans une variable d’activité de type script.

    Les exemples d’activités qui utilisent cette méthode incluent If, Wait for condition, et Approval - User.

    Tableau 17. Paramètres
    Nom Type Description
    script Chaîne Chaîne contenant un Javascript valide.
    Tableau 18. Renvoie
    Type Description
    variable Si le script définit la réponse de variable de workflow, cette valeur est renvoyée. Si ce n’est pas le cas, le résultat de l’exécution du script est renvoyé.

    WFActivityHandler : setActivityOutput( )

    Définit la propriété de sortie de l’activité.

    Voir l’activité SOAP Message.

    Tableau 19. Paramètres
    Nom Type Description
    Aucun
    Tableau 20. Renvoie
    Type Description
    nul

    WFActivityHandler : setResultFailed(motif de la chaîne)

    Définit le résultat de l’activité comme ayant échoué avec une chaîne de motif facultative.

    Voir Activité SOAP Message.

    Tableau 21. Paramètres
    Nom Type Description
    motif Chaîne (Facultatif) Description du motif de l’échec de cette activité.
    Tableau 22. Renvoie
    Type Description
    nul

    WFActivityHandler : setResultSucceeded( )

    Définit le résultat de cette activité comme réussi.

    Tableau 23. Paramètres
    Nom Type Description
    Aucun
    Tableau 24. Renvoie
    Type Description
    nul

    WFActivityHandler : warn(String msg, String args)

    Consigne un message d’avertissement.

    Tableau 25. Paramètres
    Nom Type Description
    msg Chaîne Message à envoyer au journal.
    args Chaîne Chaîne à envoyer au journal
    Tableau 26. Renvoie
    Type Description
    nul

    WFActivityHandler : warn(String msg, Array args)

    Consigne un message d’avertissement.

    Tableau 27. Paramètres
    Nom Type Description
    msg Chaîne Message à envoyer au journal.
    args Tableau Tableau de valeurs à envoyer au journal
    Tableau 28. Renvoie
    Type Description
    nul