---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Workflow -- Umfang

# Workflow -- Umfang {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

Der Umfang ist festgelegt Workflow Die API stellt Methoden bereit, die in einem Aktivitätsdefinitionsskript verwendet werden können.

Es gibt keine Konstruktoren zum Erstellen einer Instanz eines bereichsbezogenen Workflow-Objekts. Verwenden Sie stattdessen das globale Workflow-Objekt, das in Aktivitätsskripts verfügbar ist. Dieses Workflow-Objekt ist an jedem Skriptspeicherort in einem Workflow verfügbar.

## Bereichsbezogener Workflow -- Debuggen (Zeichenfolgennachricht, Objektargumente) {#ariaid-title2}

Fügt dem Protokoll eine Debug-Nachricht hinzu.
{#r_SWF-debug_S_O__table_q3h_rqz_lt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Nachricht | Zeichenfolge | Die Nachricht, die dem Protokoll hinzugefügt werden soll. |
| args | Objekt | Argumente, die der Nachricht hinzugefügt werden sollen. |
[Tabelle : 1. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Die Nachricht, die dem Protokoll hinzugefügt wurde. |
[Tabelle : 2. Rückgaben]

{#r_SWF-debug_S_O__table_r3h_rqz_lt}  

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

## Bereichsbezogener Workflow -- Fehler (Zeichenfolgennachricht, Objektargumente) {#ariaid-title3}

Fügt dem Protokoll eine Fehlermeldung hinzu.
{#r_SWF-error_S_O__table_ttc_2rz_lt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Nachricht | Zeichenfolge | Die Nachricht, die dem Protokoll hinzugefügt werden soll. |
| args | Objekt | Argumente, die der Nachricht hinzugefügt werden sollen. |
[Tabelle : 3. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Die protokollierte Nachricht |
[Tabelle : 4. Rückgaben]

{#r_SWF-error_S_O__table_utc_2rz_lt}  

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

## Bereichsbezogener Workflow -- getVariable(Zeichenfolgenname) {#ariaid-title4}

Gibt den Wert der angegebenen Variable zurück.
{#r_SWF-getVariable_S__table_rsb_psz_lt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| name | Zeichenfolge | Der Variablenname |
[Tabelle : 5. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Objekt | Der Wert der Variable |
[Tabelle : 6. Rückgaben]

{#r_SWF-getVariable_S__table_ssb_psz_lt}  

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

## Bereichsbezogener Workflow -- Info (Zeichenfolgennachricht, Objektargumente) {#ariaid-title5}

Fügt dem Protokoll eine Informationsnachricht hinzu.
{#r_SWF-info_S_O__table_rz5_1qz_lt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Nachricht | Zeichenfolge | Die Nachricht, die dem Protokoll hinzugefügt werden soll. |
| args | Objekt | Argumente, die der Nachricht hinzugefügt werden sollen. |
[Tabelle : 7. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Die protokollierte Nachricht. |
[Tabelle : 8. Rückgaben]

{#r_SWF-info_S_O__table_sz5_1qz_lt}  

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

## Bereichsbezogener Workflow: Eingaben {#ariaid-title6}

Objekt, das die Workflow-Variablen enthält.
Dies ist keine Methode, sondern eine Möglichkeit, auf die Variablen in einem Workflow-Objekt wie dem Anwender zu verweisen. Workflow-Variablen werden in den Eigenschaften des Workflows oder durch geskriptete Aktivitäten definiert.
{#SWF-inputs__table_ry3_4h1_qfb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| inputs | Objekt | Workflow-Variablen als Name-Wert-Paare. Die Variablen eines Workflow-Objekts sind für die Implementierung eines Integrators anwenderdefiniert. |
[Tabelle : 9. Feld]

{#SWF-inputs__table_ry3_4h1_qfb}  

    var user = workflow.inputs.u_user;

## Bereichsbezogener Workflow -- Name() {#ariaid-title7}

Gibt den Workflow-Namen zurück.
{#r_SWF-name__table_wm2_spz_lt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 10. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Der Workflow-Name |
[Tabelle : 11. Rückgaben]

{#r_SWF-name__table_xm2_spz_lt}  

    var name = workflow.name();

## Bereichsbezogener Workflow -- removeVariable(Zeichenfolgenname) {#ariaid-title8}

Entfernt die angegebene Variable aus dem Workflow.
{#r_SWF-removeVariable_S__table_d2r_ysz_lt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| name | Zeichenfolge | Der Variablenname |
[Tabelle : 12. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 13. Rückgaben]

{#r_SWF-removeVariable_S__table_e2r_ysz_lt}  

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

## Bereichsbezogener Workflow: Ergebnis {#ariaid-title9}

Element des Workflow-Objekts, das die Workflow-Ergebnisse enthält.
Dies ist keine Methode, sondern das Element im Workflow-Objekt, das die Ergebnisse eines Workflows enthält.
{#SWF-result__table_grb_p31_qfb__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Ergebnis | Zeichenfolge | Workflow-Ergebnisse. |
[Tabelle : 14. Feld]

{#SWF-result__table_grb_p31_qfb}  

    var wfResult = workflow.result;

## Bereichsbezogener Workflow -- Scratchpad() {#ariaid-title10}

Gibt das Scratchpad-Objekt des Workflows zurück.
{#r_SWF-scratchpad__table_tfn_hpz_lt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 15. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Objekt | Das Scratchpad-Objekt. |
[Tabelle : 16. Rückgaben]

{#r_SWF-scratchpad__table_ufn_hpz_lt}  

    var scratchpad = workflow.scratchpad();

## Bereichsbezogener Workflow -- setResult(Zeichenfolgenergebnis) {#ariaid-title11}

Legt das Ergebnis des Workflows fest.
{#r_SWF-setResult_S__table_zvp_stz_lt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Ergebnis | Zeichenfolge | Das Ergebnis des Workflows |
[Tabelle : 17. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 18. Rückgaben]

{#r_SWF-setResult_S__table_awp_stz_lt}  

    workflow.setResult("Success");

## Bereichsbezogener Workflow -- setVariable (Zeichenfolgenname, Objektwert) {#ariaid-title12}

Legt die angegebene Variable auf den angegebenen Wert fest.
{#r_SWF-setVariable_S_O__table_spj_2sz_lt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| name | Zeichenfolge | Der Variablenname |
| Wert | Objekt | Der Wert, der der Variable zugewiesen werden soll. |
[Tabelle : 19. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 20. Rückgaben]

{#r_SWF-setVariable_S_O__table_tpj_2sz_lt}  

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

## Bereichsbezogener Workflow -- Warnung (Zeichenfolgennachricht, Objektargumente) {#ariaid-title13}

Fügt dem Protokoll eine Warnmeldung hinzu.
{#r_SWF-warn_S_O__table_gxm_qrz_lt__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Nachricht | Zeichenfolge | Die Nachricht, die dem Protokoll hinzugefügt werden soll. |
| args | Objekt | Argumente, die der Nachricht hinzugefügt werden sollen. |
[Tabelle : 21. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Zeichenfolge | Die protokollierte Nachricht |
[Tabelle : 22. Rückgaben]

{#r_SWF-warn_S_O__table_hxm_qrz_lt}  

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


