---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# WFActivityHandler - Global

# WFActivityHandler - Global {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 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) {#ariaid-title2}

Consigne un message de débogage.
{#r_WFAH-debug_S_S__table_xdr_nf5_4t__entry__3}

| Nom | Type | Description |
|-|-|-|
| msg | Chaîne | Message à envoyer au journal. |
| args | Chaîne | Chaîne à envoyer au journal |
[Tableau 1. Paramètres]

{#r_WFAH-debug_S_S__table_xdr_nf5_4t} {#r_WFAH-debug_S_S__table_ydr_nf5_4t__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 2. Renvoie]

{#r_WFAH-debug_S_S__table_ydr_nf5_4t}

## WFActivityHandler : debug(String, msg, Array, args) {#ariaid-title3}

Consigne un message de débogage.
{#r_WFAH-debug_S_A__table_bv2_sh5_4t__entry__3}

| Nom | Type | Description |
|-|-|-|
| msg | Chaîne | Message à envoyer au journal. |
| args | Tableau | Tableau de valeurs à envoyer au journal |
[Tableau 3. Paramètres]

{#r_WFAH-debug_S_A__table_bv2_sh5_4t} {#r_WFAH-debug_S_A__table_cv2_sh5_4t__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 4. Renvoie]

{#r_WFAH-debug_S_A__table_cv2_sh5_4t}

## WFActivityHandler : generate(String, activityId, String, ordre, GlideDateTime, startAtDspValue, booléen : noCreateFlag) {#ariaid-title4}

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](https://www.servicenow.com/docs/access?context=r_Generate&version=xanadu&pubname=xanadu-build-workflows&ft:locale=en-US).
{#r_WFAH-generate_S_S_GDT_B__table_dv2_sh5_4t__entry__3}

| 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](https://servicenow-prod.fluidtopics.net/EQWIH40KGH23bhO6fK_1pA#c_GlideDateTimeAPI "La classe GlideDateTime fournit des méthodes permettant d’effectuer des opérations sur les objets 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. {#r_WFAH-generate_S_S_GDT_B__ul_cbr_ds4_f4b} Valeur par défaut : vrai |
[Tableau 5. Paramètres]

{#r_WFAH-generate_S_S_GDT_B__table_dv2_sh5_4t} {#r_WFAH-generate_S_S_GDT_B__table_ev2_sh5_4t__entry__2}

| 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 . {#r_WFAH-generate_S_S_GDT_B__ul_u13_mdp_f4b} |
[Tableau 6. Renvoie]

{#r_WFAH-generate_S_S_GDT_B__table_ev2_sh5_4t}

## WFActivityHandler : info(String msg, String args) {#ariaid-title5}

Consigne un message d'information.
{#r_WFAH-info_S_S__table_pdr_nf5_4t__entry__3}

| Nom | Type | Description |
|-|-|-|
| msg | Chaîne | Message à envoyer au journal. |
| args | Chaîne | Chaîne à envoyer au journal. |
[Tableau 7. Paramètres]

{#r_WFAH-info_S_S__table_pdr_nf5_4t} {#r_WFAH-info_S_S__table_qdr_nf5_4t__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 8. Renvoie]

{#r_WFAH-info_S_S__table_qdr_nf5_4t}

## WFActivityHandler : info(String msg, Array args) {#ariaid-title6}

Consigne un message d'information.
{#r_WFAH-info_S_A__table_rdr_nf5_4t__entry__3}

| Nom | Type | Description |
|-|-|-|
| msg | Chaîne | Message à envoyer au journal. |
| args | Tableau | Tableau de valeurs à envoyer au journal |
[Tableau 9. Paramètres]

{#r_WFAH-info_S_A__table_rdr_nf5_4t} {#r_WFAH-info_S_A__table_qdr_nf5_4t__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 10. Renvoie]

{#r_WFAH-info_S_A__table_qdr_nf5_4t}

## WFActivityHandler : js(str. chaîne) {#ariaid-title7}

É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.
{#r_WFAH-js_S__table_ndr_nf5_4t__entry__3}

| Nom | Type | Description |
|-|-|-|
| str | Chaîne | Chaîne qui contient éventuellement el incorporé. |
[Tableau 11. Paramètres]

{#r_WFAH-js_S__table_ndr_nf5_4t} {#r_WFAH-js_S__table_odr_nf5_4t__entry__2}

| Type | Description |
|-|-|
| Chaîne | Chaîne évaluée. |
[Tableau 12. Renvoie]

{#r_WFAH-js_S__table_odr_nf5_4t}

## WFActivityHandler : onCancel( ) {#ariaid-title8}

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é.
{#r_WFAH-onCancel__table_pqd_1b5_4t__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 13. Paramètres]

{#r_WFAH-onCancel__table_pqd_1b5_4t} {#r_WFAH-onCancel__table_qqd_1b5_4t__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 14. Renvoie]

{#r_WFAH-onCancel__table_qqd_1b5_4t}

## WFActivityHandler : onExecute( ) {#ariaid-title9}

Méthode virtuelle. Les sous-classes d'activité doivent remplacer cette méthode pour effectuer un travail approprié à l'activité.
{#r_WFAH-onExecute__table_nqd_1b5_4t__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 15. Paramètres]

{#r_WFAH-onExecute__table_nqd_1b5_4t} {#r_WFAH-onExecute__table_oqd_1b5_4t__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 16. Renvoie]

{#r_WFAH-onExecute__table_oqd_1b5_4t}

## WFActivityHandler : runScript(script de chaîne) {#ariaid-title10}

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.
{#r_WFAH-runScript_S__table_rqd_1b5_4t__entry__3}

| Nom | Type | Description |
|-|-|-|
| script | Chaîne | Chaîne contenant un Javascript valide. |
[Tableau 17. Paramètres]

{#r_WFAH-runScript_S__table_rqd_1b5_4t} {#r_WFAH-runScript_S__table_sqd_1b5_4t__entry__2}

| Type | Description |
|-|-|
| variable | Si le script définit la <var class="keyword varname">réponse</var> 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é. |
[Tableau 18. Renvoie]

{#r_WFAH-runScript_S__table_sqd_1b5_4t}

## WFActivityHandler : setActivityOutput( ) {#ariaid-title11}

Définit la propriété de sortie de l'activité.
Voir l'activité SOAP Message.
{#r_WFAH-setActivityOutput__table_lqd_1b5_4t__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 19. Paramètres]

{#r_WFAH-setActivityOutput__table_lqd_1b5_4t} {#r_WFAH-setActivityOutput__table_mqd_1b5_4t__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 20. Renvoie]

{#r_WFAH-setActivityOutput__table_mqd_1b5_4t}

## WFActivityHandler : setResultFailed(motif de la chaîne) {#ariaid-title12}

Définit le résultat de l'activité comme ayant échoué avec une chaîne de motif facultative.
Voir Activité SOAP Message.
{#r_WFAH-setResultFailed_S__table_hqd_1b5_4t__entry__3}

| Nom | Type | Description |
|-|-|-|
| motif | Chaîne | (Facultatif) Description du motif de l'échec de cette activité. |
[Tableau 21. Paramètres]

{#r_WFAH-setResultFailed_S__table_hqd_1b5_4t} {#r_WFAH-setResultFailed_S__table_iqd_1b5_4t__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 22. Renvoie]

{#r_WFAH-setResultFailed_S__table_iqd_1b5_4t}

## WFActivityHandler : setResultSucceeded( ) {#ariaid-title13}

Définit le résultat de cette activité comme réussi.
{#r_WFAH-setResultSucceeded__table_jqd_1b5_4t__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 23. Paramètres]

{#r_WFAH-setResultSucceeded__table_jqd_1b5_4t} {#r_WFAH-setResultSucceeded__table_kqd_1b5_4t__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 24. Renvoie]

{#r_WFAH-setResultSucceeded__table_kqd_1b5_4t}

## WFActivityHandler : warn(String msg, String args) {#ariaid-title14}

Consigne un message d'avertissement.
{#r_WFAH-warn_S_S__table_tdr_nf5_4t__entry__3}

| Nom | Type | Description |
|-|-|-|
| msg | Chaîne | Message à envoyer au journal. |
| args | Chaîne | Chaîne à envoyer au journal |
[Tableau 25. Paramètres]

{#r_WFAH-warn_S_S__table_tdr_nf5_4t} {#r_WFAH-warn_S_S__table_udr_nf5_4t__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 26. Renvoie]

{#r_WFAH-warn_S_S__table_udr_nf5_4t}

## WFActivityHandler : warn(String msg, Array args) {#ariaid-title15}

Consigne un message d'avertissement.
{#r_WFAH-warn_S_A__table_vdr_nf5_4t__entry__3}

| Nom | Type | Description |
|-|-|-|
| msg | Chaîne | Message à envoyer au journal. |
| args | Tableau | Tableau de valeurs à envoyer au journal |
[Tableau 27. Paramètres]

{#r_WFAH-warn_S_A__table_vdr_nf5_4t} {#r_WFAH-warn_S_A__table_udr_nf5_4t__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 28. Renvoie]

{#r_WFAH-warn_S_A__table_udr_nf5_4t}