---
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


---

# Workflow - Dans le champ d'application

# Workflow - Dans le champ d'application {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes de lecture

L'API de workflow incluse dans le périmètre 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 périmètre. 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 périmètre : debug(chaîne, message, objet, args) {#ariaid-title2}

Ajoute un message de débogage au journal.
{#r_SWF-debug_S_O__table_q3h_rqz_lt__entry__3}

| Nom | Type | Description |
|-|-|-|
| message | Chaîne | Message à ajouter au journal. |
| args | Objet | Arguments à ajouter au message. |
[Tableau 1. Paramètres]

{#r_SWF-debug_S_O__table_q3h_rqz_lt} {#r_SWF-debug_S_O__table_r3h_rqz_lt__entry__2}

| Type | Description |
|-|-|
| Chaîne | Message ajouté au journal. |
[Tableau 2. Renvoie]

{#r_SWF-debug_S_O__table_r3h_rqz_lt}  

    var loggedMessage = workflow.debug("All is well");

## Workflow inclus dans le périmètre : erreur (chaîne, message, objet, args) {#ariaid-title3}

Ajoute un message d'erreur au journal.
{#r_SWF-error_S_O__table_ttc_2rz_lt__entry__3}

| Nom | Type | Description |
|-|-|-|
| message | Chaîne | Message à ajouter au journal. |
| args | Objet | Arguments à ajouter au message. |
[Tableau 3. Paramètres]

{#r_SWF-error_S_O__table_ttc_2rz_lt} {#r_SWF-error_S_O__table_utc_2rz_lt__entry__2}

| Type | Description |
|-|-|
| Chaîne | Le message journalisé |
[Tableau 4. Renvoie]

{#r_SWF-error_S_O__table_utc_2rz_lt}  

    var loggedMessage = workflow.error("An error has occurred. ");

## Workflow inclus dans le périmètre : getVariable(nom de chaîne) {#ariaid-title4}

Renvoie la valeur de la variable spécifiée.
{#r_SWF-getVariable_S__table_rsb_psz_lt__entry__3}

| Nom | Type | Description |
|-|-|-|
| nom | Chaîne | Nom de variable |
[Tableau 5. Paramètres]

{#r_SWF-getVariable_S__table_rsb_psz_lt} {#r_SWF-getVariable_S__table_ssb_psz_lt__entry__2}

| Type | Description |
|-|-|
| Objet | La valeur de la variable |
[Tableau 6. Renvoie]

{#r_SWF-getVariable_S__table_ssb_psz_lt}  

    var value = workflow.getVariable("task");

## Workflow inclus dans le périmètre : info (chaîne, message, objet, args) {#ariaid-title5}

Ajoute un message d'information au journal.
{#r_SWF-info_S_O__table_rz5_1qz_lt__entry__3}

| Nom | Type | Description |
|-|-|-|
| message | Chaîne | Message à ajouter au journal. |
| args | Objet | Arguments à ajouter au message. |
[Tableau 7. Paramètres]

{#r_SWF-info_S_O__table_rz5_1qz_lt} {#r_SWF-info_S_O__table_sz5_1qz_lt__entry__2}

| Type | Description |
|-|-|
| Chaîne | Le message qui est consigné. |
[Tableau 8. Renvoie]

{#r_SWF-info_S_O__table_sz5_1qz_lt}  

    var loggedMessage = workflow.info("All is well");

## Workflow inclus dans le périmètre : entrées {#ariaid-title6}

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 dans un objet de workflow, tel que l'utilisateur. Les variables de workflow sont définies dans les propriétés du workflow ou par des activités scriptées.
{#SWF-inputs__table_ry3_4h1_qfb__entry__3}

| 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. |
[Tableau 9. Champ]

{#SWF-inputs__table_ry3_4h1_qfb}  

    var user = workflow.inputs.u_user;

## Workflow inclus dans le périmètre : name() {#ariaid-title7}

Renvoie le nom du workflow.
{#r_SWF-name__table_wm2_spz_lt__entry__3}

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

{#r_SWF-name__table_wm2_spz_lt} {#r_SWF-name__table_xm2_spz_lt__entry__2}

| Type | Description |
|-|-|
| Chaîne | Nom du workflow |
[Tableau 11. Renvoie]

{#r_SWF-name__table_xm2_spz_lt}  

    var name = workflow.name();

## Workflow inclus dans le périmètre : removeVariable(nom de chaîne) {#ariaid-title8}

Supprime la variable spécifiée du workflow.
{#r_SWF-removeVariable_S__table_d2r_ysz_lt__entry__3}

| Nom | Type | Description |
|-|-|-|
| nom | Chaîne | Nom de variable |
[Tableau 12. Paramètres]

{#r_SWF-removeVariable_S__table_d2r_ysz_lt} {#r_SWF-removeVariable_S__table_e2r_ysz_lt__entry__2}

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

{#r_SWF-removeVariable_S__table_e2r_ysz_lt}  

    var value = workflow.removeVariable("task");

## Workflow inclus dans le périmètre : résultat {#ariaid-title9}

É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 workflow qui contient les résultats d'un workflow.
{#SWF-result__table_grb_p31_qfb__entry__3}

| Nom | Type | Description |
|-|-|-|
| résultat | Chaîne | Résultats du workflow. |
[Tableau 14. Champ]

{#SWF-result__table_grb_p31_qfb}  

    var wfResult = workflow.result;

## Workflow inclus dans le périmètre : bloc-notes() {#ariaid-title10}

Renvoie l'objet bloc-notes du workflow.
{#r_SWF-scratchpad__table_tfn_hpz_lt__entry__3}

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

{#r_SWF-scratchpad__table_tfn_hpz_lt} {#r_SWF-scratchpad__table_ufn_hpz_lt__entry__2}

| Type | Description |
|-|-|
| Objet | L'objet bloc-notes. |
[Tableau 16. Renvoie]

{#r_SWF-scratchpad__table_ufn_hpz_lt}  

    var scratchpad = workflow.scratchpad();

## Workflow inclus dans le périmètre : setResult(résultat de chaîne) {#ariaid-title11}

Définit le résultat du workflow.
{#r_SWF-setResult_S__table_zvp_stz_lt__entry__3}

| Nom | Type | Description |
|-|-|-|
| résultat | Chaîne | Le résultat du workflow |
[Tableau 17. Paramètres]

{#r_SWF-setResult_S__table_zvp_stz_lt} {#r_SWF-setResult_S__table_awp_stz_lt__entry__2}

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

{#r_SWF-setResult_S__table_awp_stz_lt}  

    workflow.setResult("Success");

## Workflow inclus dans le périmètre : setVariable(nom de chaîne, valeur d'objet) {#ariaid-title12}

Définit la variable spécifiée sur la valeur spécifiée.
{#r_SWF-setVariable_S_O__table_spj_2sz_lt__entry__3}

| Nom | Type | Description |
|-|-|-|
| nom | Chaîne | Nom de variable |
| valide | Objet | Valeur à affecter à la variable. |
[Tableau 19. Paramètres]

{#r_SWF-setVariable_S_O__table_spj_2sz_lt} {#r_SWF-setVariable_S_O__table_tpj_2sz_lt__entry__2}

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

{#r_SWF-setVariable_S_O__table_tpj_2sz_lt}  

    workflow.setVariable("task", "terrible");

## Workflow inclus dans le périmètre : warn(chaîne, message, objet args) {#ariaid-title13}

Ajoute un message d'avertissement au journal.
{#r_SWF-warn_S_O__table_gxm_qrz_lt__entry__3}

| Nom | Type | Description |
|-|-|-|
| message | Chaîne | Message à ajouter au journal. |
| args | Objet | Arguments à ajouter au message. |
[Tableau 21. Paramètres]

{#r_SWF-warn_S_O__table_gxm_qrz_lt} {#r_SWF-warn_S_O__table_hxm_qrz_lt__entry__2}

| Type | Description |
|-|-|
| Chaîne | Le message journalisé |
[Tableau 22. Renvoie]

{#r_SWF-warn_S_O__table_hxm_qrz_lt}  

    var loggedMessage = workflow.warn("Check your permissions.");