PDAutomationProvider: Bereichsbezogen, global

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 8 Minuten Lesedauer

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

    Diese API ist Teil des Plugins Playbooks (com.glide.pad.core) und wird im Namespace sn_pad ausgeführt.

    Das Aufrufen von Skripts mit dieser API erfordert mindestens eine der folgenden Voraussetzungen:
    • Der Anrufer muss sich im selben Bereich befinden, in dem der optionale Aktivitätsauslöser erstellt wurde.
    • Administratorrechte.

    Ein Prozess ist eine Reihe von Aktivitäten, die nach Spuren geordnet sind. Während des Prozessdesigns wird eine optionale Aktivität vordefiniert. Die Aktivitäten sind nicht für einen bestimmten Zeitpunkt geplant. Eine Aktivität kann einer Spalte zugewiesen und während der Ausführung der Spalte zur Ausführung freigegeben werden. Eine Aktivität kann einem Prozess zugewiesen und während der Ausführung der Spalte zur Ausführung bereitgestellt werden.

    Um eine optionale Aktivität zu erstellen, muss die Startregel in der Tabelle Aktivitäten [sys_pd_activity] auf Manuell festgelegt sein. Playbooks unterstützt derzeit keine Erstellung manueller Aktivitäten.

    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:

    PDAutomationProvider – aktivierenProzess(Zeichenfolge processDefinitionSysId)

    Aktiviert ein Playbook.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    processDefinitionSysId Zeichenfolge Sys_id eines Playbooks.

    Tabelle: Prozessdefinitionen [sys_pd_process_definition]
    Tabelle : 2. Rückgaben
    Eigenschaft Beschreibung
    Objekt Objekt mit Details zur Aktivierung der Prozessdefinition.
    {
  "errors": [Array]
  "process_definition": {Object},
  "state": "String"
}
    Fehler Liste der Fehler. Leer, wenn erfolgreich.

    Datentyp: Array aus Zeichenfolge(n)
    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 nach 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.

    Datentyp: Boolesch
    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“.

    Datentyp: Zeichenfolge
    state Gibt an, ob Ihre Aktivierungsanforderung 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

    Das folgende Beispiel zeigt, wie Sie ein Playbook aktivieren.

    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(String contextID, Zeichenfolge activityId, Zeichenfolge wo, Zeichenfolge relativeToId)

    Fügt einem Prozess eine angegebene optionale Aktivität hinzu, die relativ zu einer anderen Aktivität während der Prozessausführung ausgeführt werden soll.

    Wenn ein Prozess ausgeführt wird, wird für jede Aktivität ein Aktivitätskontext erstellt. Der Kontext verarbeitet auch, wie die Aktivität die Ausführung behandelt. Weitere Informationen finden Sie unter Prozessautomatisierungs-Designer – Spuren und Aktivitäten.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Kontext-ID Zeichenfolge Sys_id der Aktivitätsausführung, in der die optionale Aktivität hinzugefügt werden soll. Um auf zuzugreifen, klicken Sie auf den Prozess in der Tabelle „Prozessausführungen“ [sys_pd_context]. Die ausgewählte Ausführung muss sich im Status „ In Bearbeitung“befinden.
    activityId Zeichenfolge Sys_id der optionalen Aktivität, die in der Tabelle „Aktivitäten“ [sys_pd_activity] aufgeführt ist.
    Hinweis:
    Um eine optionale Aktivität zu erstellen, muss die Startregel in der Tabelle Aktivitäten [sys_pd_activity] auf Manuell festgelegt sein.
    wo Zeichenfolge Gibt an, wo die Aktivität im Prozess platziert werden soll.
    Gültige Werte:
    • NACH: Führt diese Aktivität nach der relativen Aktivität aus Kontext.
    • MIT – Die Aktivität wird gleichzeitig mit einer anderen relativen Aktivität ausgeführt Kontext.
    relativeZuId Zeichenfolge ID des relativen Aktivitätskontexts, nach dem oder mit dem die optionale Aktivität ausgeführt wird. In der Tabelle „Aktivitätskontext“ [sys_pd_activity_context] aufgeführt.
    Tabelle : 4. Rückgaben
    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 Erfolgangibt.
    • „falsch“: Die Ausführung der Aktivität wurde nicht erfolgreich geplant. Die Ausgabe ist ein Array mit einer oder mehreren Fehlermeldungen.

    Bei Fehlern Liste mit einer oder mehreren Fehlermeldungen. Meldung, die angibt, dass das Array ansonsten 0 oder mehr Elemente enthält.
    Array Bei Fehlern Liste mit einer oder mehreren Fehlermeldungen. Meldung, die angibt, dass das Array ansonsten 0 oder mehr Elemente enthält.
    Mögliche Fehlermeldungen:
    • Ungültige optionale Aktivitäts-ID: Die für den Parameter activityId angegebene sys_id ist ungültig.
    • Ungültige PD-Kontext-ID: Die im Parameter contextID angegebene sys_id des Process Designer (PD) ist ungültig.
    • Ungültiger Positionstyp: Der angegebene Positionstyp ist ungültig. Gültige Typen finden Sie in der Beschreibung des Parameters where.
    • Ungültige Relative-zu-ID: Die für den Parameter relativeToId angegebene sys_id ist ungültig.
    • Optionale Aktivität nicht gefunden: Die für den Parameter activityId angegebene sys_id wurde nicht gefunden.
    • 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 für den Parameter relativeToId angegebene sys_id wurde nicht gefunden.

    Das folgende Beispiel zeigt, wie eine optionale Aktivität gleichzeitig mit dem zugehörigen 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(String contextID, Zeichenfolge activityId, Zeichenfolge wo, Zeichenfolge relativeToId)

    Weist einer Spur eine optionale Aktivität zu, die während des Ausführungskontexts dieser Spalte ausgeführt werden soll.

    Wenn ein Prozess ausgeführt wird, wird für jede Spalte ein Spaltenkontext erstellt. Der Kontext verarbeitet auch, wie die Spalte die Ausführung behandelt. Weitere Informationen finden Sie unter Prozessautomatisierungs-Designer – Spuren und Aktivitäten.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Kontext-ID Zeichenfolge Sys_id der Aktivitätsausführung, in der die optionale Aktivität hinzugefügt werden soll. Um auf zuzugreifen, klicken Sie auf den Prozess in der Tabelle „Prozessausführungen“ [sys_pd_context]. Die ausgewählte Ausführung muss sich im Status „ In Bearbeitung“befinden.
    activityId Zeichenfolge Sys_id der optionalen Aktivität, die in der Tabelle „Aktivitäten“ [sys_pd_activity] aufgeführt ist.
    Hinweis:
    Um eine optionale Aktivität zu erstellen, muss die Startregel in der Tabelle Aktivitäten [sys_pd_activity] auf Manuell festgelegt sein.
    wo Zeichenfolge Gibt an, wo die Aktivität im Prozess platziert werden soll.
    Gültige Werte:
    • LAST: Als letzte Aktivität in einer Spalte ausführen Kontext.
    • NEXT – Ausführung in der nächsten Aktivität in einer Spalte Kontext.
    relativeZuId 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 : 6. Rückgaben
    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 Erfolgangibt.
    • „falsch“: Die Ausführung der Aktivität wurde nicht erfolgreich geplant. Die Ausgabe ist ein Array mit einer oder mehreren Fehlermeldungen.
    Array Bei Fehlern Liste mit einer oder mehreren Fehlermeldungen. Meldung, die angibt, dass das Array ansonsten 0 oder mehr Elemente enthält.
    Mögliche Fehlermeldungen:
    • Ungültige optionale Aktivitäts-ID: Die für den Parameter activityId angegebene sys_id ist ungültig.
    • Ungültige PD-Kontext-ID: Die im Parameter contextID angegebene sys_id des Process Designer (PD) ist ungültig.
    • Ungültiger Positionstyp: Der angegebene Positionstyp ist ungültig. Gültige Typen finden Sie in der Beschreibung des Parameters where.
    • Ungültige Relative-zu-ID: Die für den Parameter relativeToId angegebene sys_id ist ungültig.
    • Optionale Aktivität kann der Spalte nicht hinzugefügt werden: Die im Parameter activityId angegebene optionale Aktivität kann relativ zu der im Parameter relativeToId angegebenen Spalte nicht hinzugefügt werden. Stellen Sie sicher, dass sich die ausgewählte Aktivitätsausführung im Status In Bearbeitung befindet.
    • Optionale Aktivität nicht gefunden: Die für den Parameter activityId angegebene sys_id wurde nicht gefunden.
    • Prozess muss noch aktiv sein: Der Prozess, der diese Aktivität enthält, muss aktiv sein, um die optionale Aktivität auszuführen.
    • Kontext für relative Spalte nicht gefunden : Die für den Parameter relativeToId angegebene sys_id wurde nicht gefunden.

    Das folgende Beispiel zeigt, wie eine optionale Aktivität als abschließende 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 – disableProcess(String processDefinitionSysId)

    Deaktiviert ein Playbook.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    processDefinitionSysId Zeichenfolge Sys_id eines Playbooks.

    Tabelle: Prozessdefinitionen [sys_pd_process_definition]
    Tabelle : 8. Rückgaben
    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 aus Zeichenfolge(n)
    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 nach 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.

    Datentyp: Boolesch
    process_definition.description Details zu Ihrem deaktivierten Playbook.

    Datentyp: Zeichenfolge
    process_definition.label Der Name des deaktivierten Playbooks, den Anwender auf der Schnittstelle 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 wieder in einen Entwurf geändert.

    Datentyp: Zeichenfolge
    state 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.

    Datentyp: Zeichenfolge

    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(Zeichenfolge processDefinitionSysId, Zeichenfolgenbezeichnung, Zeichenfolgenbeschreibung, Zeichenfolge scopeId, Zeichenfolge triggerTypeId)

    Dupliziert ein Playbook.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    processDefinitionSysId Zeichenfolge Sys_id eines Playbooks.

    Tabelle: Prozessdefinitionen [sys_pd_process_definition]
    label Zeichenfolge Der Name des duplizierten Playbooks.
    description 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, ab dem 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 : 10. Rückgaben
    Eigenschaft Beschreibung
    Objekt Objekt mit Details zur Duplizierung von Prozessdefinitionen.
    {
  "errors": [Array]
  "processDefinitionSysId": "String",
  "state": "String"
}
    Fehler Liste der Fehler. Leer, wenn erfolgreich.

    Datentyp: Array aus Zeichenfolge(n)

    Mögliche Fehlermeldungen:
    • Bereich nicht gefunden für scopeId: xyz
    • Prozessdefinition für ID nicht gefunden: xyz
    • Auslösertyp nicht gefunden für triggerTypeId: xyz
    processDefinitionSysId Die sys_id des neuen Playbooks in der Tabelle „Prozessdefinitionen“ [sys_pd_process_definition].

    Datentyp: Zeichenfolge
    state 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.

    Datentyp: Objekt

    In diesem Beispiel wird gezeigt, wie Sie ein Playbook mit der sys_id f8ca6192ec210210f8772cbd595eab20duplizieren. Das neue Playbook heißt Playbook 2.0, hat einen Anwendungsbereich von Globalund wird ausgelöst, wenn ein Datensatz erstellt wird. Der Auslösertyp „Datensatzerstellung“ hat die sys_id ab6951170f1200108c87f4f0ff767e4f.

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

    Ausgabe:

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