PDAutomationProvider: Bereichsbezogen, Global

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

Diese API ist Teil von Playbooks Plugin (com.Glide.Pad.Core) und wird in ausgeführt sn_Pad Namespace.

Das Aufrufen von Skripts mit dieser API erfordert mindestens eines der folgenden:

• 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 sortiert sind. Während des Prozessdesigns ist eine optionale Aktivität vordefiniert. Die Ausführung der Aktivitäten ist nicht zu einem bestimmten 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
• Prozessautomatisierungs-Designer – Spuren und Aktivitäten

PDAutomationProvider – activateProcess(String 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 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 in der Liste Prozessdefinitionen [sys_pd_Process_Definition] nach Prozessdefinitionen. 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
Status	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

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, wobei, Zeichenfolge relativeToId)

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 .

Tabelle : 3. Parameter

Name	Typ	Beschreibung
contextID	Zeichenfolge	SYS_ID der Aktivitätsausführung, der die optionale Aktivität hinzugefügt werden soll. Um auf zuzugreifen, klicken Sie auf den Prozess, der in der Tabelle „Prozessausführungen“ [sys_pd_context] aufgeführt ist. Die ausgewählte Ausführung muss einen Status von aufweisen 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.
Relativezu Id	Zeichenfolge	ID des relativen Aktivitätskontexts, nach dem die optionale Aktivität oder mit ausgeführt wird. Aufgeführt in der Tabelle „Aktivitätskontext“ [sys_pd_activity_context].

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 angibt Erfolg . Falsch: Die Ausführung der Aktivität wurde nicht erfolgreich geplant. Die Ausgabe ist ein Array aus einer oder mehreren Fehlermeldungen. 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 ID der optionalen Aktivität : Die für bereitgestellte sys_ID 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. Weitere Informationen finden Sie in der Beschreibung von whereParameter für gültige Typen. Ungültige relative-to-ID : Die für bereitgestellte sys_ID relativeToIdParameter ist ungültig. Optionale Aktivität nicht gefunden : Die für bereitgestellte sys_ID activityIdParameter 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 bereitgestellte sys_ID relativeToIdParameter wurde nicht gefunden.

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(ZeichenfolgenkontextID, ZeichenfolgenaktivitätenId, Zeichenfolge, ZeichenfolgenrelativeToId)

Weist einer Spalte eine optionale Aktivität zu, die im Ausführungskontext 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 .

Tabelle : 5. Parameter

Name	Typ	Beschreibung
contextID	Zeichenfolge	SYS_ID der Aktivitätsausführung, der die optionale Aktivität hinzugefügt werden soll. Um auf zuzugreifen, klicken Sie auf den Prozess, der in der Tabelle „Prozessausführungen“ [sys_pd_context] aufgeführt ist. Die ausgewählte Ausführung muss einen Status von aufweisen 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: ZULETZT: Als letzte Aktivität in einer Spalte ausführen Kontext. NEXT: In der nächsten Aktivität in einer Spalte ausführen Kontext.
Relativezu Id	Zeichenfolge	ID des relativen Spaltenkontexts, in dem die optionale Aktivität ausgeführt werden soll. Aufgeführt in der Tabelle „Spaltenkontext“ [sys_pd_lane_context].

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 angibt Erfolg . Falsch: Die Ausführung der Aktivität wurde nicht erfolgreich geplant. Die Ausgabe ist ein Array aus einer oder mehreren Fehlermeldungen.
Array	Bei Fehlern: Liste einer oder mehrerer Fehlermeldungen. Nachricht mit der Angabe Array von 0 oder mehr Elementen Andernfalls. Mögliche Fehlermeldungen: Ungültige ID der optionalen Aktivität : Die für bereitgestellte sys_ID 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. Weitere Informationen finden Sie in der Beschreibung von whereParameter für gültige Typen. Ungültige relative-to-ID : Die für bereitgestellte sys_ID 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 für bereitgestellte sys_ID activityIdParameter 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 Spaltenkontext nicht gefunden : Die für bereitgestellte sys_ID relativeToIdParameter wurde nicht gefunden.

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(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 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 in der Liste Prozessdefinitionen [sys_pd_Process_Definition] nach Prozessdefinitionen. 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, das Anwender in 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 wieder in einen Entwurf geändert. Datentyp: Zeichenfolge
Status	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(String processDefinitionSysId, Zeichenfolgenbezeichnung, Zeichenfolgenbeschreibung, String scopeId, String 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.
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 : 10. Rückgaben

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 für ID xyz nicht gefunden 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
Status	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

Dieses Beispiel zeigt, wie ein Playbook mit der sys_ID dupliziert wird F8ca6192ec210210f8772cbd595eab20 . Das neue Playbook wird 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"}