PlaybookExperience : Bereichsbezogen
Die PlaybookExperience- API bietet Methoden für die Verarbeitung von Playbook-Ausführungen.
Diese API erfordert das Plugin „Playbook Experience Core“ (com.glide.playbook_experience.config) und wird im Namespace sn_playbook bereitgestellt.
Diese API erfordert mindestens ein Playbook in der Tabelle „Prozessdefinition“ [sys_pd_process_definition]. Zur Verwendung dieser API müssen Sie über die erforderlichen Rollen verfügen, um einen laufenden Prozess im Prozessautomatisierungs-Designer anzuzeigen und abzubrechen. Weitere Informationen finden Sie unter Prozessautomatisierungs-Designer.
PlaybookExperience – cancelPlaybooksByParentRecord(GlideRecord parentRecord, Zeichenfolge „cancelionReason“, Zeichenfolge „scopedName“, Zeichenfolge „playbookExperienceId“)
Bricht Playbook-Ausführungen für einen bestimmten übergeordneten Datensatz ab.
| Name | Typ | Beschreibung |
|---|---|---|
| parentRecord | GlideRecord | Der übergeordnete Datensatz, für den Playbook-Ausführungen abgebrochen werden sollen. Der übergeordnete Datensatz kann ein beliebiger Datensatz mit Playbook-Ausführungen sein, z. B. ein Interaktionsdatensatz oder ein Onboarding-Falldatensatz. |
| Stornierungsgrund | Zeichenfolge | Der Grund für den Abbruch der Playbook-Ausführungen. |
| scopedName | Zeichenfolge | Optional. Der bereichsbezogene Name des abzubrechenden Playbooks. Der bereichsbezogene Name stammt aus der Tabelle „Prozessdefinition“ [sys_pd_process_definition] im Format scope.name. Wenn angegeben, werden nur Ausführungen dieses Playbooks für den angegebenen übergeordneten Datensatz abgebrochen. Wenn nicht angegeben, werden alle Ausführungen aller Playbooks für den angegebenen übergeordneten Datensatz abgebrochen. |
| playbookExperienceId | Zeichenfolge | Optional. Sys_id des Playbook-Experience-Datensatzes in der Playbook-Experience-Tabelle [sys_playbook_experience], der für den Abbruch verwendet werden soll. Verwenden Sie diesen Parameter, wenn Sie anwenderdefinierte Aktivitätsstatuszuordnungen definiert haben. Weitere Informationen finden Sie unter Zuordnung des Playbook-Aktivitätsstatus. Standard: Sys_id des Datensatzes „Globale Playbook-Experience“. |
| Typ | Beschreibung |
|---|---|
| Objekt | Objekt, das die abgebrochenen Playbook-Ausführungen und alle übersprungenen Playbook-Ausführungen enthält, die nicht abgebrochen werden konnten. |
| <Object>.canceldPlaybookContext | Liste der abgebrochenen Playbook-Ausführungen. Jede Playbook-Ausführung ist ein Objekt im Array. Datentyp: Array |
| <Object>.canceldPlaybookContext.can_read | Kennzeichnung, die angibt, ob der aktuelle Anwender den Playbook-Ausführungsdatensatz lesen kann. Der aktuelle Anwender muss Lesezugriff auf den übergeordneten Datensatz haben, um den Playbook-Ausführungsdatensatz lesen zu können. Gültige Werte:
Datentyp: Boolesch |
| <Object>.canceledPlaybookContext.canceled_by | Die Anwender-ID des Anwenders, der die Ausführung des Playbooks abgebrochen hat. Datentyp: Zeichenfolge |
| <Object>.canceledPlaybookContext.cancelation_reason | Der vom Anwender eingegebene Abbruchgrund, der die Ausführung des Playbooks abgebrochen hat. Datentyp: Zeichenfolge |
| <Object>.abgebrochenPlaybookKontext.Fehler | Liste der Abbruchfehler. Jeder Fehler ist ein Objekt im Array. Datentyp: Array |
| <Object>.canceledPlaybookContext.errors.message | Die Fehlermeldung. Datentyp: Zeichenfolge |
| <Object>.canceledPlaybookContext.errors.type | Der Typ des Fehlers. Datentyp: Zeichenfolge |
| <Object>.canceldPlaybookContext.parent_record | Sys_id des übergeordneten Datensatzes, für den Playbook-Ausführungen abgebrochen wurden. Datentyp: Zeichenfolge |
| <Object>.canceldPlaybookContext.parent_table | Der Name der Tabelle, aus der der übergeordnete Datensatz stammt. Datentyp: Zeichenfolge |
| <Object>.canceldPlaybookContext.playbook_id | Sys_id des Playbooks aus der Tabelle „Prozessdefinitionen“ [sys_pd_process_definition]. Datentyp: Zeichenfolge |
| <Object>.canceldPlaybookContext.playbook_table | Der Name der Tabelle, aus der das Playbook stammt, im Allgemeinen die Tabelle „Prozessdefinitionen“ [sys_pd_process_definition]. Datentyp: Zeichenfolge |
| <Object>.canceldPlaybookContext.scoped_name | Der bereichsbezogene Name des Playbooks aus der Tabelle „Prozessdefinitionen“ [sys_pd_process_definition] im Format scope.name.Datentyp: Zeichenfolge |
| <Object>.abgebrochenPlaybookKontext.Status | Der Status der Playbook-Ausführung aus der Tabelle „Prozessausführungen“ [sys_pd_context]. Datentyp: Objekt |
| <Object>.canceledPlaybookContext.state.displayValue | Der Anzeigewert des Playbook-Ausführungsstatus. Datentyp: Zeichenfolge |
| <Object>.cancelledPlaybookContext.state.value | Der Wert des Playbook-Ausführungsstatus. Datentyp: Zeichenfolge |
| <Object>.canceldPlaybookContext.sys_id | Sys_id der Playbook-Ausführung aus der Tabelle „Prozessausführungen“ [sys_pd_context]. Datentyp: Zeichenfolge |
| <Object>.abgebrochenPlaybookKontext.Titel | Die Bezeichnung der Playbook-Ausführung aus der Tabelle „Prozessausführungen“ [sys_pd_context]. Datentyp: Zeichenfolge |
| <Object>.übersprungenPlaybookContext | Liste der übersprungenen Playbook-Ausführungen. Jede Playbook-Ausführung ist ein Objekt im Array. Beschreibungen der Objekteigenschaften finden Sie unter Array canceledPlaybookContext. Datentyp: Array |
In diesem Beispiel wird gezeigt, wie alle Ausführungen eines bestimmten Playbooks (in diesem Fall der Playbook-Experience-Demo) für einen bestimmten Interaktionsdatensatz abgebrochen werden. Um diese Methode in einer UI-Aktion oder Geschäftsregel zu verwenden, übergeben Sie stattdessen das aktuelle Objekt als parentRecord.
var parentRecord = new GlideRecordUtil().getGR("interaction", "d91742531b343010a26c98a1b24bcbe0");
var cancellationReason = "Cancelling this playbook";
// demo playbook from Process Automation Experience Demo store app
var scopedName = "sn_pad_demo.playbook_experience_demo";
// demo playbook experience from Process Automation Experience Demo store app
var playbookExperienceId = "a56d8d93ff311010cc0853ea793bf1a6";
var cancelPlaybookReturn = sn_playbook.PlaybookExperience.cancelPlaybooksByParentRecord(parentRecord, cancellationReason, scopedName, playbookExperienceId);
gs.info(JSON.stringify(cancelPlaybookReturn, null, 2));
Ausgabe:
{
"canceledPlaybookContext": [
{
"can_read": true,
"sys_id": "d02782533d343010ac50ee17e75d3466",
"scoped_name": "sn_pad_demo.playbook_experience_demo",
"canceled_by": "admin",
"playbook_table": "sys_pd_process_definition",
"state": {
"displayValue": "Pending Cancel",
"value": "PENDING_CANCEL"
},
"title": "Playbook Experience Demo",
"parent_record": "d91742531b343010a26c98a1b24bcbe0",
"playbook_id": "0d35ee1807301010cc08d9630ad3002a",
"cancellation_reason": "Cancelling this playbook",
"parent_table": "interaction",
"errors": []
}
],
"skippedPlaybookContext": []
}
PlaybookExperience – getPlaybooksForParentRecord(GlideRecord parentRecord)
Ruft eine Liste von Playbook-Ausführungen für einen bestimmten übergeordneten Datensatz ab.
| Name | Typ | Beschreibung |
|---|---|---|
| parentRecord | GlideRecord | Der übergeordnete Datensatz, für den Playbook-Ausführungen abgerufen werden sollen. Der übergeordnete Datensatz kann ein beliebiger Datensatz mit Playbook-Ausführungen sein, z. B. ein Interaktionsdatensatz oder ein Onboarding-Falldatensatz. |
| Typ | Beschreibung |
|---|---|
| Array | Liste der Playbook-Ausführungen für den übergeordneten Datensatz. Jede Playbook-Ausführung ist ein Objekt im Array. |
| <Array>.can_read | Kennzeichnung, die angibt, ob der aktuelle Anwender den Playbook-Ausführungsdatensatz lesen kann. Der aktuelle Anwender muss Lesezugriff auf den übergeordneten Datensatz haben, um den Playbook-Ausführungsdatensatz lesen zu können. Gültige Werte:
Datentyp: Boolesch |
| <Array>.cancel_by | Die Anwender-ID des Anwenders, der die Ausführung des Playbooks abgebrochen hat. Leer, wenn das Playbook nicht abgebrochen wird. Datentyp: Zeichenfolge |
| <Array>.cancelation_reason | Der vom Anwender eingegebene Abbruchgrund, der die Ausführung des Playbooks abgebrochen hat. Leer, wenn das Playbook nicht abgebrochen wird. Datentyp: Zeichenfolge |
| <Array>.Fehler | Liste der Fehler. Jeder Fehler ist ein Objekt im Array. Datentyp: Array |
| <Array>.Fehler.Meldung | Die Fehlermeldung. Datentyp: Zeichenfolge |
| <Array>.Fehler.Typ | Der Typ des Fehlers. Datentyp: Zeichenfolge |
| <Array>.parent_record | Sys_id des übergeordneten Datensatzes. Datentyp: Zeichenfolge |
| <Array>.parent_table | Der Name der Tabelle, aus der der übergeordnete Datensatz stammt. Datentyp: Zeichenfolge |
| <Array>.playbook_id | Sys_id des Playbooks aus der Tabelle „Prozessdefinitionen“ [sys_pd_process_definition]. Datentyp: Zeichenfolge |
| <Array>.playbook_table | Der Name der Tabelle, aus der das Playbook stammt, im Allgemeinen die Tabelle „Prozessdefinitionen“ [sys_pd_process_definition]. Datentyp: Zeichenfolge |
| <Array>.scoped_name | Der bereichsbezogene Name des Playbooks aus der Tabelle „Prozessdefinitionen“ [sys_pd_process_definition] im Format scope.name.Datentyp: Zeichenfolge |
| <Array>.state | Der Status der Playbook-Ausführung aus der Tabelle „Prozessausführungen“ [sys_pd_context]. Datentyp: Objekt |
| <Array>.state.displayValue | Der Anzeigewert des Playbook-Ausführungsstatus. Datentyp: Zeichenfolge |
| <Array>.Status.Wert | Der Wert des Playbook-Ausführungsstatus. Datentyp: Zeichenfolge |
| <Array>.sys_id | Sys_id der Playbook-Ausführung aus der Tabelle „Prozessausführungen“ [sys_pd_context]. Datentyp: Zeichenfolge |
| <Array>.title | Die Bezeichnung der Playbook-Ausführung aus der Tabelle „Prozessausführungen“ [sys_pd_context]. Datentyp: Zeichenfolge |
In diesem Beispiel wird gezeigt, wie Playbook-Ausführungen für einen bestimmten Interaktionsdatensatz abgerufen werden. Um diese Methode in einer UI-Aktion oder Geschäftsregel zu verwenden, übergeben Sie stattdessen das aktuelle Objekt als parentRecord.
var parentRecord = new GlideRecordUtil().getGR("interaction", "148776e5818d7410f87701eb89fdc824");
var playbook = sn_playbook.PlaybookExperience.getPlaybooksForParentRecord(parentRecord);
gs.info(JSON.stringify(playbook, null, 2));
Ausgabe:
[
{
"can_read": true,
"sys_id": "bd87bae50b8d7410807a8ffed6d0909e",
"scoped_name": "sn_pad_demo.playbook_experience_demo",
"canceled_by": "",
"playbook_table": "sys_pd_process_definition",
"state": {
"displayValue": "In Progress",
"value": "IN_PROGRESS"
},
"title": "Playbook Experience Demo",
"parent_record": "148776e5818d7410f87701eb89fdc824",
"playbook_id": "0d35ee1807301010cc08d9630ad3002a",
"cancellation_reason": "",
"parent_table": "interaction",
"errors": []
}
]
PlaybookExperience – parentRecordContainsPlaybook(GlideRecord parentRecord, String scopedName)
Überprüft, ob für einen übergeordneten Datensatz Playbook-Ausführungen vorhanden sind.
| Name | Typ | Beschreibung |
|---|---|---|
| parentRecord | GlideRecord | Der übergeordnete Datensatz zur Überprüfung auf Playbook-Ausführungen. Der übergeordnete Datensatz kann ein beliebiger Datensatz mit Playbook-Ausführungen sein, z. B. ein Interaktionsdatensatz oder ein Onboarding-Falldatensatz. |
| scopedName | Zeichenfolge | Optional. Der bereichsbezogene Name des Playbooks, nach dem gesucht werden soll. Der bereichsbezogene Name stammt aus der Tabelle „Prozessdefinition“ [sys_pd_process_definition] im Format scope.name. Wenn angegeben, wird nur nach Ausführungen dieses Playbooks geprüft. Wenn nicht angegeben, wird nach Ausführungen aller Playbooks gesucht. |
| Typ | Beschreibung |
|---|---|
| Boolean | Kennzeichnung, die angibt, ob für den übergeordneten Datensatz Playbook-Ausführungen vorhanden sind. Gültige Werte:
|
In diesem Beispiel wird gezeigt, wie überprüft wird, ob für einen bestimmten Interaktionsdatensatz ein bestimmtes Playbook (in diesem Fall die Playbook-Experience-Demo) ausgeführt wird. Um diese Methode in einer UI-Aktion oder Geschäftsregel zu verwenden, übergeben Sie stattdessen das aktuelle Objekt als parentRecord.
var parentRecord = new GlideRecordUtil().getGR("interaction", "148776e5818d7410f87701eb89fdc824");
// demo playbook from Process Automation Experience Demo store app
var scopedName = "sn_pad_demo.playbook_experience_demo";
var hasPlaybooks = sn_playbook.PlaybookExperience.parentRecordContainsPlaybook(parentRecord, scopedName);
gs.info(hasPlaybooks);
Ausgabe:
true
PlaybookExperience – neustartPlaybook (Zeichenfolge „playbookContextId“, Zeichenfolge „laneContextId“, Zeichenfolge „activityContextId“, Zeichenfolge „playbookExperienceId“)
Sie können eine Ausführung von Beginn an (das gesamte Playbook) oder von einer bestimmten Phase oder Aktivität eines Playbooks aus neu starten.
| Name | Typ | Beschreibung |
|---|---|---|
| playbookContextId | Zeichenfolge | Die sys_id des Playbook-Kontextdatensatzes für die Playbook-Ausführung, die Sie neu starten möchten. Befindet sich in der Tabelle „Prozessausführung“ [sys_pd_context]. |
| laneContextId | Zeichenfolge | Optional. Die sys_id des Phasenkontextdatensatzes für die Phasenausführung oder Ausführung, aus der Sie neu starten möchten. Befindet sich in der Tabelle „Spaltenausführungen“ [sys_pd_lane_context]. Hinweis: Nur abgeschlossene Phasen können neu gestartet werden. |
| activityContextId | Zeichenfolge | Optional. Die sys_id des Aktivitätskontextdatensatzes für die Aktivitätsausführung, von der Sie neu starten möchten. Befindet sich in der Tabelle „Aktivitätsausführungen“ [sys_pd_activity_context]. Hinweis: Nur abgeschlossene Aktivitäten können neu gestartet werden. |
| playbookExperienceId | Zeichenfolge | Optional. Die sys_id der Playbook-Experience, die Sie für die neu gestartete Ausführung verwenden möchten. Befindet sich in der Tabelle „Playbook-Experience“ [sys_playbook_experience]. Verwenden Sie diesen Parameter, wenn Sie anwenderdefinierte Aktivitätsstatuszuordnungen definiert haben. Weitere Informationen finden Sie unter Zuordnung des Playbook-Aktivitätsstatus. Standard: Globale Playbook-Experience |
| Eigenschaft | Beschreibung |
|---|---|
| Objekt | Objekt mit den Ausführungsdetails des neu gestarteten Playbooks. |
| can_add_activity | Kennzeichnung, die angibt, ob ein Anwender dem Playbook eine optionale Aktivität hinzufügen kann. Gültige Werte:
Datentyp: Boolesch |
| can_cancel | Kennzeichnung, die angibt, ob ein Anwender ein Playbook stornieren kann.
Datentyp: Boolesch |
| can_read | Kennzeichnung, die angibt, ob der aktuelle Anwender den Playbook-Ausführungsdatensatz lesen kann. Der aktuelle Anwender muss Lesezugriff auf den übergeordneten Datensatz haben, um den Playbook-Ausführungsdatensatz lesen zu können.
Datentyp: Boolesch |
| can_restart | Kennzeichnung, die angibt, ob ein Anwender ein Playbook, eine Phase oder eine Aktivität neu starten kann
Datentyp: Boolesch |
| cancelled_by | Die Anwender-ID des Anwenders, der die Ausführung des Playbooks abgebrochen hat. Datentyp: Zeichenfolge |
| Stornierungsgrund | Der vom Anwender eingegebene Abbruchgrund, der die Ausführung des Playbooks abgebrochen hat. Datentyp: Zeichenfolge |
| Fehler | Liste der Neustartfehler. Jeder Fehler ist ein Objekt im Array. Datentyp: Array |
| is_archived | Kennzeichnung, die angibt, ob Playbook-Kontextdatensätze archiviert sind. Auf true festlegen. Dieser Wert kann nicht geändert werden. Mögliche Werte:
Datentyp: Boolesch |
| parent_record | Die sys_id des übergeordneten Datensatzes, für den Playbook-Ausführungen neu gestartet wurden. Datentyp: Zeichenfolge |
| parent_table | Der Name der Tabelle, aus der der übergeordnete Datensatz stammt. Datentyp: Zeichenfolge |
| playbook_id | Die sys_id des Playbooks aus der Tabelle „Prozessdefinitionen“ [sys_pd_process_definition]. Datentyp: Zeichenfolge |
| playbook_table | Der Name der Tabelle, aus der das Playbook stammt, im Allgemeinen die Tabelle „Prozessdefinitionen“ [sys_pd_process_definition]. Datentyp: Zeichenfolge |
| scoped_name | Optional. Der bereichsbezogene Name des neu zu startenden Playbooks. Der bereichsbezogene Name stammt aus der Tabelle „Prozessdefinition“ [sys_pd_process_definition] im Format scope.name. Wenn angegeben, werden nur Ausführungen dieses Playbooks für den angegebenen übergeordneten Datensatz neu gestartet. Wenn nicht angegeben, werden alle Ausführungen aller Playbooks für den angegebenen übergeordneten Datensatz neu gestartet.Datentyp: Zeichenfolge |
| Status | Gibt an, ob Ihre Aktivierungsanforderung erfolgreich war. Datentyp: Objekt Mögliche Werte:
|
| state.displayValue | Der Anzeigewert des Playbook-Ausführungsstatus. Datentyp: Zeichenfolge |
| Status.Wert | Der Wert des Playbook-Ausführungsstatus. Datentyp: Zeichenfolge |
| sys_id | Die sys_id der Playbook-Ausführung aus der Tabelle „Prozessausführungen“ [sys_pd_context]. Datentyp: Zeichenfolge |
| Titel | Die Bezeichnung der Playbook-Ausführung aus der Tabelle „Prozessausführungen“ [sys_pd_context]. Datentyp: Zeichenfolge |
Dieses Beispiel zeigt, wie Sie eine gesamte Playbook-Ausführung mit der Datensatz-ID „Prozessausführungen“ [sys_pd_context] 98e4fe04591b4caca59583f7b8e30b0a neu starten.
var gr = new GlideRecord('sys_pd_context');
var found = gr.get('98e4fe04591b4caca59583f7b8e30b0a');
if (found) {
var result = sn_playbook.PlaybookExperience.restartPlaybook(gr);
gs.info(JSON.stringify(result));
}
else
gs.info('invalid pd context');
Ausgabe:
{
"scoped_name": "global.restart_scriptable_demo",
"canceled_by": "",
"can_add_activity": true,
"playbook_table": "sys_pd_process_definition",
"can_restart": true,
"can_cancel": true,
"title": "Restart scriptable demo",
"cancellation_reason": "",
"parent_table": "interaction",
"can_read": true,
"sys_id": "98e4fe04591b4caca59583f7b8e30b0a",
"is_archived": false,
"state": {
"displayValue": "In Progress",
"value": "IN_PROGRESS"
},
"parent_record": "b88623beb5e10210f877d783f6f83a46",
"playbook_id": "12d5a7fab5e10210f877d783f6f83aff",
"errors": []
}
PlaybookExperience – triggerPlaybook(String scopedName, GlideRecord parentRecord)
Initiiert ein Playbook für einen übergeordneten Datensatz.
| Name | Typ | Beschreibung |
|---|---|---|
| scopedName | Zeichenfolge | Der bereichsbezogene Name des zu initiierenden Playbooks. Der bereichsbezogene Name stammt aus der Tabelle „Prozessdefinition“ [sys_pd_process_definition] im Format scope.name. |
| parentRecord | GlideRecord | Der übergeordnete Datensatz, für den ein Playbook initiiert werden soll. Der übergeordnete Datensatz kann ein beliebiger Datensatz mit Playbook-Ausführungen sein, z. B. ein Interaktionsdatensatz oder ein Onboarding-Falldatensatz. |
| Typ | Beschreibung |
|---|---|
| Zeichenfolge | Sys_id der Playbook-Ausführung aus der Tabelle „Prozessausführungen“ [sys_pd_context], die für den übergeordneten Datensatz erstellt wurde. NULL, wenn eine Playbook-Ausführung nicht erfolgreich erstellt wurde. |
In diesem Beispiel wird gezeigt, wie ein Playbook für einen bestimmten Interaktionsdatensatz initiiert wird. Um diese Methode in einer UI-Aktion oder Geschäftsregel zu verwenden, übergeben Sie stattdessen das aktuelle Objekt als parentRecord.
var parentRecord = new GlideRecordUtil().getGR("interaction", "148776e5818d7410f87701eb89fdc824");
// demo playbook from Process Automation Experience Demo store app
var scopedName = "sn_pad_demo.playbook_experience_demo";
var playbookExecution = sn_playbook.PlaybookExperience.triggerPlaybook(scopedName, parentRecord);
gs.info(playbookExecution);
Ausgabe:
f059958267cdb410952864f0fed358cc