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


---

# PDAutomationProvider: Bereichsbezogen, global

# PDAutomationProvider: Bereichsbezogen, global {#ariaid-title1}

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

Die PDAutomationProvider API ermöglicht das Einfügen einer optionalen Aktivität in einen Prozess während der Ausführung.

Diese API ist Teil von PlaybooksPlugin (com.Glide.Pad.Core) und wird in ausgeführt `sn_Pad `Namespace.  
Das Aufrufen von Skripts mit dieser API erfordert mindestens eines der folgenden Elemente:

* Der Anrufer muss sich im selben Bereich befinden, in dem der optionale Aktivitätsauslöser erstellt wurde.
* Administratorrechte.
{#PDAutomationProviderBothAPI__ul_glp_zx2_5rb}

Ein Prozess ist eine Reihe von Aktivitäten, die nach Spuren sortiert sind. Eine optionale Aktivität ist während des Prozessdesigns vordefiniert. Die Ausführung der Aktivitäten ist nicht zu einem genauen Zeitpunkt geplant. Eine Aktivität kann einer Spalte zugewiesen und zur Ausführung während der Spaltenausführung verfügbar gemacht werden. Eine Aktivität kann einem Prozess zugewiesen und zur Ausführung während der Spaltenausführung verfügbar gemacht werden.

Zum Erstellen einer optionalen Aktivität muss sie über verfügen Startregel Auf festlegen Manuell In der Tabelle „Aktivitäten" \[sys_pd_activity\]. Playbooks Unterstützt derzeit die Erstellung manueller Aktivitäten nicht.

Ein Service Desk-Mitarbeiter fügt die optionale Aktivität einer Spalte oder Aktivität relativ zu einer anderen Aktivität hinzu. Der Prozess muss ausgeführt werden, um eine optionale Aktivität einzufügen.  
Siehe auch:

* [Entwerfen Sie einen automatisierten Prozess](https://www.servicenow.com/docs/access?context=design-automated-process&version=yokohama&pubname=yokohama-build-workflows&ft:locale=en-US)
* [Prozessautomatisierungs-Designer -- Spuren und Aktivitäten](https://www.servicenow.com/docs/access?context=process-automation-designer-lanes-activities&version=yokohama&pubname=yokohama-build-workflows&ft:locale=en-US)
{#PDAutomationProviderBothAPI__ul_a1m_lxj_5rb}

## PDAutomationProvider -- activateProcess(String processDefinitionSysId) {#ariaid-title2}

Aktiviert ein Playbook.
{#PDAuto-activateProcess_S__table_zkb_lbs_1cc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| ProcessDefinitionSysId | Zeichenfolge | SYS_ID eines Playbooks. Tabelle: Prozessdefinitionen \[sys_pd_process_definition\] |
[Tabelle : 1. Parameter]

{#PDAuto-activateProcess_S__table_zkb_lbs_1cc} {#PDAuto-activateProcess_S__table_alb_lbs_1cc__entry__2}

| Eigenschaft | Beschreibung |
|-|-|
| Objekt | Objekt mit Aktivierungsdetails zur Prozessdefinition. { "errors": [Array] "process_definition": {Object}, "state": "String" } |
| Fehler | Liste der Fehler. Leer, wenn erfolgreich. Datentyp: Array von Zeichenfolgen |
| Process_Definition | Das aktivierte Playbook und seine Eigenschaften. Datentyp: Objekt "process_definition": { "active": Boolean, "snapshot": {Object}, "status": "String" } |
| Process_Definition.Active | Kennzeichnung, die angibt, ob die Prozessdefinition für das deaktivierte Playbook aktiv ist. Suchen Sie Prozessdefinitionen in der Liste Prozessdefinitionen \[sys_pd_process_definition\]. Gültige Werte: * Wahr: Die Prozessdefinition für das deaktivierte Playbook ist aktiv. * Falsch: Die Prozessdefinition für das deaktivierte Playbook ist inaktiv. {#PDAuto-activateProcess_S__ul_vl4_xtp_ccc} Datentyp: Boolescher Wert |
| Process_Definition.Snapshot | Enthält Details zur Prozessdefinition zum Zeitpunkt der Aktivierung. Datentyp: Objekt { "snapshot": { "created": "String", "processDefinitionSysId": "String" } } |
| Process_Definition. Snapshot. Erstellt | Das Datum, an dem das Playbook erstellt wurde. Datentyp: Zeichenfolge |
| Process_Definition. Snapshot. ProcessDefinitionSysId | Die sys_ID des aktivierten Playbooks. Datentyp: Zeichenfolge |
| Process_Definition.Status | Gibt den Veröffentlichungsstatus des Playbooks an. Mögliche Werte: * Entwurf: Das Playbook befindet sich im Entwurfsstatus. * Veröffentlicht: Das Playbook befindet sich im Status „veröffentlicht". {#PDAuto-activateProcess_S__ul_exj_hj3_2cc} Datentyp: Zeichenfolge |
| Staat | Gibt an, ob Ihre Anforderung zur Aktivierung erfolgreich war oder nicht. Mögliche Werte: * ERFOLG: Das Playbook wurde erfolgreich aktiviert. * FEHLER: Die ID für das Playbook wurde nicht gefunden. Datentyp: Objekt |
[Tabelle : 2. Rückgaben]

{#PDAuto-activateProcess_S__table_alb_lbs_1cc}  
Das folgende Beispiel zeigt, wie ein Playbook aktiviert wird.

    var myPlaybook = sn_pad.PDAutomationProvider.activateProcess('cdd1b85e43000210d96e29c28ab8f275');
    gs.info(JSON.stringify(myPlaybook));

Ausgabe:

    {
      "process_definition": {
        "active": true,
        "snapshot": {
          "processDefinitionId": "cdd1b85e43000210d96e29c28ab8f275",
          "created": "2024-02-19 22:58:12"
        },
        "status": "published"
      },
      "state": "SUCCESS",
      "errors": []
    }

## PDAutomationProvider -- addOptionalActivityRelativeToActivityContext(ZeichenfolgenkontextID, Zeichenfolgenaktivitäts-ID, Zeichenfolge, ZeichenfolgenrelativeToId) {#ariaid-title3}

Fügt einem Prozess eine angegebene optionale Aktivität hinzu, die während der Prozessausführung relativ zu einer anderen Aktivität ausgeführt werden soll.
Bei der Ausführung eines Prozesses wird für jede Aktivität ein Aktivitätskontext erstellt. Der Kontext behandelt auch, wie die Aktivität die Ausführung verarbeitet. Informationen finden Sie unter [Prozessautomatisierungs-Designer -- Spuren und Aktivitäten](https://www.servicenow.com/docs/access?context=process-automation-designer-lanes-activities&version=yokohama&pubname=yokohama-build-workflows&ft:locale=en-US).
{#PDAuto-addRelToActvtyCntxt_S_S_S_S__PDAutoParms__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| contextID | Zeichenfolge | SYS_ID der Aktivitätsausführung, der die optionale Aktivität hinzugefügt werden soll. Klicken Sie für den Zugriff auf den Prozess, der in der Tabelle „Prozessausführungen" \[sys_pd_context\] aufgeführt ist. Die ausgewählte Ausführung muss sich im Status von befinden In Bearbeitung . |
| activityId | Zeichenfolge | SYS_ID der optionalen Aktivität, die in der Tabelle „Aktivitäten" \[sys_pd_activity\] aufgeführt ist. Hinweis: Zum Erstellen einer optionalen Aktivität muss sie über verfügen Startregel Auf festlegen Manuell In der Tabelle „Aktivitäten" \[sys_pd_activity\]. |
| wo | Zeichenfolge | Gibt an, wo die Aktivität im Prozess platziert werden soll. Gültige Werte: * NACH: Führen Sie diese Aktivität nach der relativen Aktivität aus Kontext. * MIT: Führen Sie die Aktivität gleichzeitig mit einer anderen relativen Aktivität aus Kontext. {#PDAuto-addRelToActvtyCntxt_S_S_S_S__ul_tlq_mdl_lrb} |
| Relativezu Id | Zeichenfolge | ID des relativen Aktivitätskontexts, nach dem die optionale Aktivität oder mit ausgeführt wird. In der Tabelle „Aktivitätskontext" \[sys_pd_activity_context\] aufgeführt. |
[Tabelle : 3. Parameter]

{#PDAuto-addRelToActvtyCntxt_S_S_S_S__PDAutoParms} {#PDAuto-addRelToActvtyCntxt_S_S_S_S__PDAutoReturns__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob die Ausführung der Aktivität erfolgreich geplant wurde. Mögliche Werte: * Wahr: Die Ausführung der Aktivität wurde erfolgreich geplant. Die Ausgabe ist eine Zeichenfolge, die angibt Erfolg . * Falsch: Die Ausführung der Aktivität wurde nicht erfolgreich geplant. Die Ausgabe ist ein Array aus einer oder mehreren Fehlermeldungen. {#PDAuto-addRelToActvtyCntxt_S_S_S_S__ul_a4j_yvl_nrb} Bei Fehlern: Liste einer oder mehrerer Fehlermeldungen. Nachricht mit der Angabe Array von 0 oder mehr Elementen Andernfalls. |
| Array | Bei Fehlern: Liste einer oder mehrerer Fehlermeldungen. Nachricht mit der Angabe Array von 0 oder mehr Elementen Andernfalls. Mögliche Fehlermeldungen: * Ungültige optionale Aktivitäts-ID : Die sys_ID, die für angegeben wurde activityIdParameter ist ungültig. * Ungültige PD-Kontext-ID : Die sys_ID des Prozessdesigners (PD), die in angegeben wird contextIDParameter ist ungültig. * Ungültiger Positionstyp : Der angegebene Positionstyp ist ungültig. Siehe Beschreibung von whereParameter für gültige Typen. * Ungültige relative-to-ID : Die sys_ID, die für angegeben wurde relativeToIdParameter ist ungültig. * Optionale Aktivität nicht gefunden : Die sys_ID, die für angegeben wurde activityIdParameter wurde nicht gefunden. * Der Prozess muss noch aktiv sein : Der Prozess, der diese Aktivität enthält, muss aktiv sein, um die optionale Aktivität auszuführen. * Relativer Aktivitätskontext nicht gefunden : Die sys_ID, die für angegeben wurde relativeToIdParameter wurde nicht gefunden. {#PDAuto-addRelToActvtyCntxt_S_S_S_S__ul_o5f_p12_5rb} |
[Tabelle : 4. Rückgaben]

{#PDAuto-addRelToActvtyCntxt_S_S_S_S__PDAutoReturns}  
Das folgende Beispiel zeigt, wie eine optionale Aktivität gleichzeitig mit dem relativen Aktivitätskontext ausgeführt wird.

    var contextId = '<context_id>';
    var optionalActivityId = '<optional_activity_id>';
    var where = 'WITH'; // options AFTER, WITH
    var relativeToId = '<relative_activity_context_id>'; // relative activity context ID

    var response = sn_pad.PDAutomationProvider.addOptionalActivityRelativeToActivityContext(contextId, optionalActivityId, where, relativeToId);

    gs.info(JSUtil.describeObject(response));

Ausgabe (Erfolg):

    success: boolean = true
    errors: Array of 0 elements

## PDAutomationProvider -- addOptionalActivityRelativeToLaneContext(Zeichenfolge contextID, Zeichenfolge activityId, Zeichenfolge, Zeichenfolge relativeToId) {#ariaid-title4}

Weist einer Spalte eine optionale Aktivität zu, die während des Ausführungskontexts dieser Spalte ausgeführt werden soll.
Bei der Ausführung eines Prozesses wird für jede Spalte ein Spaltenkontext erstellt. Der Kontext behandelt auch, wie die Spalte die Ausführung verarbeitet. Informationen finden Sie unter [Prozessautomatisierungs-Designer -- Spuren und Aktivitäten](https://www.servicenow.com/docs/access?context=process-automation-designer-lanes-activities&version=yokohama&pubname=yokohama-build-workflows&ft:locale=en-US).
{#PDAuto-addRelToLaneContext_S_S_S_S__PDAutoParms__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| contextID | Zeichenfolge | SYS_ID der Aktivitätsausführung, der die optionale Aktivität hinzugefügt werden soll. Klicken Sie für den Zugriff auf den Prozess, der in der Tabelle „Prozessausführungen" \[sys_pd_context\] aufgeführt ist. Die ausgewählte Ausführung muss sich im Status von befinden In Bearbeitung . |
| activityId | Zeichenfolge | SYS_ID der optionalen Aktivität, die in der Tabelle „Aktivitäten" \[sys_pd_activity\] aufgeführt ist. Hinweis: Zum Erstellen einer optionalen Aktivität muss sie über verfügen Startregel Auf festlegen Manuell In der Tabelle „Aktivitäten" \[sys_pd_activity\]. |
| wo | Zeichenfolge | Gibt an, wo die Aktivität im Prozess platziert werden soll. Gültige Werte: * LETZTE: Als LETZTE Aktivität in einer Spalte ausführen Kontext. * WEITER: In der nächsten Aktivität in einer Spalte ausführen Kontext. {#PDAuto-addRelToLaneContext_S_S_S_S__ul_tlq_mdl_lrb} |
| Relativezu Id | Zeichenfolge | ID des relativen Spaltenkontexts, in dem die optionale Aktivität ausgeführt werden soll. In der Spaltenkontexttabelle \[sys_pd_lane_context\] aufgeführt. |
[Tabelle : 5. Parameter]

{#PDAuto-addRelToLaneContext_S_S_S_S__PDAutoParms} {#PDAuto-addRelToLaneContext_S_S_S_S__PDAutoReturns__entry__2}

| Typ | Beschreibung |
|-|-|
| Boolean | Kennzeichnung, die angibt, ob die Ausführung der Aktivität erfolgreich geplant wurde. Mögliche Werte: * Wahr: Die Ausführung der Aktivität wurde erfolgreich geplant. Die Ausgabe ist eine Zeichenfolge, die angibt Erfolg . * Falsch: Die Ausführung der Aktivität wurde nicht erfolgreich geplant. Die Ausgabe ist ein Array aus einer oder mehreren Fehlermeldungen. {#PDAuto-addRelToLaneContext_S_S_S_S__ul_a4j_yvl_nrb} |
| Array | Bei Fehlern: Liste einer oder mehrerer Fehlermeldungen. Nachricht mit der Angabe Array von 0 oder mehr Elementen Andernfalls. Mögliche Fehlermeldungen: * Ungültige optionale Aktivitäts-ID : Die sys_ID, die für angegeben wurde activityIdParameter ist ungültig. * Ungültige PD-Kontext-ID : Die sys_ID des Prozessdesigners (PD), die in angegeben wird contextIDParameter ist ungültig. * Ungültiger Positionstyp : Der angegebene Positionstyp ist ungültig. Siehe Beschreibung von whereParameter für gültige Typen. * Ungültige relative-to-ID : Die sys_ID, die für angegeben wurde relativeToIdParameter ist ungültig. * Optionale Aktivität kann der Spalte nicht hinzugefügt werden : Die optionale Aktivität, die in bereitgestellt wird activityIdParameter kann nicht relativ zur in angegebenen Spalte hinzugefügt werden relativeToIdParameter. Stellen Sie sicher, dass Aktivitätsausführung Ausgewählt befindet sich in In Bearbeitung status. * Optionale Aktivität nicht gefunden : Die sys_ID, die für angegeben wurde activityIdParameter wurde nicht gefunden. * Der Prozess muss noch aktiv sein : Der Prozess, der diese Aktivität enthält, muss aktiv sein, um die optionale Aktivität auszuführen. * Relativer Spaltenkontext nicht gefunden : Die sys_ID, die für angegeben wurde relativeToIdParameter wurde nicht gefunden. {#PDAuto-addRelToLaneContext_S_S_S_S__ul_xw3_422_5rb} |
[Tabelle : 6. Rückgaben]

{#PDAuto-addRelToLaneContext_S_S_S_S__PDAutoReturns}  
Das folgende Beispiel zeigt, wie eine optionale Aktivität als letzte Aktivität in einem Spaltenkontext ausgeführt wird.

    var contextId = '<context_id>';
    var optionalActivityId = '<optional_activity_id>';
    var where = 'LAST'; // options LAST, NEXT
    var relativeToId = '<relative_lane_context_id>'; // relative lane context ID

    var response = sn_pad.PDAutomationProvider.addOptionalActivityRelativeToLaneContext(contextId, optionalActivityId, where, relativeToId);

    gs.info(JSUtil.describeObject(response));

Ausgabe (Erfolg):

    success: boolean = true
    errors: Array of 0 elements

## PDAutomationProvider -- deactivateProcess(Zeichenfolge processDefinitionSysId) {#ariaid-title5}

Deaktiviert ein Playbook.
{#PDAuto-deactivateProcess_S__table_zkb_lbs_1cc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| ProcessDefinitionSysId | Zeichenfolge | SYS_ID eines Playbooks. Tabelle: Prozessdefinitionen \[sys_pd_process_definition\] |
[Tabelle : 7. Parameter]

{#PDAuto-deactivateProcess_S__table_zkb_lbs_1cc} {#PDAuto-deactivateProcess_S__table_alb_lbs_1cc__entry__2}

| Eigenschaft | Beschreibung |
|-|-|
| Objekt | Objekt mit Details zur Deaktivierung der Prozessdefinition. { "errors": [Array] "process_definition": {Object}, "state": "String" } |
| Fehler | Liste der Fehler. Leer, wenn erfolgreich. Datentyp: Array von Zeichenfolgen |
| Process_Definition | Das deaktivierte Playbook und seine Eigenschaften. Datentyp: Objekt "process_definition": { "active": Boolean, "snapshot": {Object}, "status": "String" } |
| Process_Definition.Active | Gibt an, ob die Prozessdefinition für das deaktivierte Playbook aktiv ist. Suchen Sie Prozessdefinitionen in der Liste Prozessdefinitionen \[sys_pd_process_definition\]. Mögliche Werte: * Wahr: Die Prozessdefinition für das deaktivierte Playbook ist aktiv. * Falsch: Die Prozessdefinition für das deaktivierte Playbook ist inaktiv. {#PDAuto-deactivateProcess_S__ul_idr_br3_2cc} Datentyp: Boolescher Wert |
| process_definition.description | Details zu Ihrem deaktivierten Playbook. Datentyp: Zeichenfolge |
| Process_Definition.label | Der Name des deaktivierten Playbooks, das Anwender auf der Benutzeroberfläche sehen. Datentyp: Zeichenfolge |
| process_definition.name | Der Name für das deaktivierte Playbook im Code. Wird nur als Anforderungsparameter beim Skripting verwendet. Datentyp: Zeichenfolge |
| Process_Definition.scope | Die sys_ID des Anwendungsbereichs, für den Ihr Playbook deaktiviert ist. Datentyp: Zeichenfolge |
| Process_Definition.Status | Wenn das Playbook veröffentlicht wird, wird es in einen Entwurf zurückgesetzt. Datentyp: Zeichenfolge |
| Staat | Gibt an, ob die Deaktivierung erfolgreich war. Mögliche Werte: * ERFOLG: Das Playbook wurde erfolgreich deaktiviert. * FEHLER: Die ID für das Playbook wurde nicht gefunden. {#PDAuto-deactivateProcess_S__ul_zfl_k34_2cc} Datentyp: Zeichenfolge |
[Tabelle : 8. Rückgaben]

{#PDAuto-deactivateProcess_S__table_alb_lbs_1cc}  
Deaktivieren Sie das Playbook.

    sn_pad.PDAutomationProvider.deactivateProcess('cdd1b85e43000210d96e29c28ab8f275')

Ausgaben:

    {"process_definition":{"scope":"global","name":"test","active":true,"description":"","label":"test","status":"draft"},"state":"SUCCESS"}

## PDAutomationProvider -- duplicateProcess(String processDefinitionSysId, Zeichenfolgenbezeichnung, Zeichenfolgenbeschreibung, Zeichenfolgenbereich-ID, Zeichenfolge triggerTypeId) {#ariaid-title6}

Dupliziert ein Playbook.
{#PDAuto-duplicateProcess_S_S_S_S_S__table_zkb_lbs_1cc__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| ProcessDefinitionSysId | Zeichenfolge | SYS_ID eines Playbooks. Tabelle: Prozessdefinitionen \[sys_pd_process_definition\] |
| label | Zeichenfolge | Der Name des duplizierten Playbooks. |
| Beschreibung | Zeichenfolge | Optional. Fügen Sie Details zu Ihrem Playbook hinzu. |
| scopeId | Zeichenfolge | Die sys_ID des Anwendungsbereichs, in dem Ihr Playbook ausgeführt werden soll. Der bereichsbezogene Name stammt aus der Tabelle „Prozessdefinition" \[sys_pd_process_definition\] im Format `scope.name `. Durch Eingabe der sys_ID für den globalen Bereich kann Ihr Playbook in jedem Anwendungsbereich ausgeführt werden. |
| TriggerTypeId | Zeichenfolge | Die sys_ID des Auslösers, über den Playbook-Ausführungen initiiert werden sollen. Suchen Sie den Auslösertyp in der Tabelle „Auslösertyp" \[sys_pd_trigger_type\], und kopieren Sie seine sys_ID |
[Tabelle : 9. Parameter]

{#PDAuto-duplicateProcess_S_S_S_S_S__table_zkb_lbs_1cc} {#PDAuto-duplicateProcess_S_S_S_S_S__table_alb_lbs_1cc__entry__2}

| Eigenschaft | Beschreibung |
|-|-|
| Objekt | Objekt mit Details zur Prozessdefinition-Duplizierung. { "errors": [Array] "processDefinitionSysId": "String", "state": "String" } |
| Fehler | Liste der Fehler. Leer, wenn erfolgreich. Datentyp: Array von Zeichenfolgen Mögliche Fehlermeldungen: * Bereich nicht gefunden für scope-ID: xyz * Prozessdefinition nicht gefunden für ID: xyz * Auslösertyp nicht gefunden für triggerTypeId: xyz {#PDAuto-duplicateProcess_S_S_S_S_S__ul_df4_hkt_bcc} |
| ProcessDefinitionSysId | Die sys_ID des neuen Playbooks in der Tabelle „Prozessdefinitionen \[sys_pd_process_definition\]". Datentyp: Zeichenfolge |
| Staat | Gibt an, ob die Playbook-Duplizierung erfolgreich war. Mögliche Werte: * ERFOLG: Das Playbook wurde erfolgreich dupliziert. * FEHLER: Die ID für das Playbook, den Anwendungsbereich oder den Auslöser wurde nicht gefunden. {#PDAuto-duplicateProcess_S_S_S_S_S__ul_zq2_434_2cc} Datentyp: Objekt |
[Tabelle : 10. Rückgaben]

{#PDAuto-duplicateProcess_S_S_S_S_S__table_alb_lbs_1cc}  
Dieses Beispiel zeigt, wie ein Playbook mit der sys_ID dupliziert wird `F8ca6192ec210210f8772cbd595eab20 `. Das neue Playbook ist benannt Playbook 2,0 , Hat einen Anwendungsbereich von Global , Und wird ausgelöst, wenn ein Datensatz erstellt wird. Die Datensatzerstellung Auslösertyp hat eine sys_ID von `Ab6951170f1200108c87f4f0ff767e4f `.

    sn_pad.PDAutomationProvider.duplicateProcess('f8ca6192ec210210f8772cbd595eab20', 'Playbook 2.0', '', 'global', 'ab6951170f1200108c87f4f0ff767e4f');

Ausgabe:

    {"processDefinitionSysId":"6e4f0b8fece9c210f8772cbd595eabda","state":"SUCCESS"}


