PDAutomationProvider – Scoped, Global

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 5 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 des Playbooks -Plugins (com.glide.pad.core) und wird im sn_pad- Namespace ausgeführt.

    Das Aufrufen von Skripts mit dieser API erfordert mindestens eine der folgenden Voraussetzungen:
    • Der Aufrufer 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. Eine optionale Aktivität wird während des Prozessdesigns vordefiniert. Die Aktivitäten sind nicht so geplant, dass sie zu einem bestimmten Zeitpunkt ausgeführt werden. Eine Aktivität kann einer Spur zugewiesen und während der Ausführung der Spalte ausgeführt werden. Eine Aktivität kann einem Prozess zugewiesen und zur Ausführung während der Spaltenausführung zur Verfügung gestellt werden.

    Um eine optionale Aktivität zu erstellen, muss die Startregel in der Aktivitätentabelle [sys_pd_activity] auf „ Manuell “ festgelegt sein. Playbooks unterstützt derzeit nicht die 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.

    PDAutomationProvider – addOptionalActivityRelativeToActivityContext(String contextID, String activityId, String where, String relativeToId)

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

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

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    contextID 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 Bearbeitungbefinden.
    activityId Zeichenfolge Sys_id der optionalen Aktivität, die in der Aktivitätentabelle [sys_pd_aktivität] aufgeführt ist.
    Hinweis:
    Um eine optionale Aktivität zu erstellen, muss die Startregel in der Aktivitätentabelle [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 die optionale Aktivität ausgeführt wird. Wird in der Tabelle „Aktivitätskontext“ [sys_pd_activity_context] aufgelistet.
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Boolean Kennzeichnung, die angibt, ob die Ausführung der Aktivität erfolgreich geplant wurde.
    Gültige Werte:
    • true: Die Ausführung der Aktivität ist erfolgreich geplant. Die Ausgabe ist eine Zeichenfolge, die „ Success“ angibt.
    • false: Die Ausführung der Aktivität ist nicht erfolgreich geplant. Die Ausgabe ist ein Array mit einer oder mehreren Fehlermeldungen.

    Bei Fehlern: Liste mit einer oder mehreren Fehlermeldungen. Nachricht, die besagt, dass das Array ansonsten 0 oder mehr Elemente enthält.

    Array Bei Fehlern: Liste mit einer oder mehreren Fehlermeldungen. Nachricht, die besagt, 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 Prozessdesigners (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 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 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(String contextID, String activityId, String where, String relativeToId)

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

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

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    contextID 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 Bearbeitungbefinden.
    activityId Zeichenfolge Sys_id der optionalen Aktivität, die in der Aktivitätentabelle [sys_pd_aktivität] aufgeführt ist.
    Hinweis:
    Um eine optionale Aktivität zu erstellen, muss die Startregel in der Aktivitätentabelle [sys_pd_activity] auf „ Manuell “ festgelegt sein.
    wo Zeichenfolge Gibt an, wo die Aktivität im Prozess platziert werden soll.
    Gültige Werte:
    • LETZTER: Wird als letzte Aktivität in einer Spur ausgeführt Kontext.
    • WEITER: Wird in der nächsten Aktivität in einer Spur ausgeführt Kontext.
    relativeZuId Zeichenfolge ID des relativen Spaltenkontexts, in dem die optionale Aktivität ausgeführt werden soll. Wird in der Tabelle „Spaltenkontext“ [sys_pd_lane_context] aufgelistet.
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Boolean Kennzeichnung, die angibt, ob die Ausführung der Aktivität erfolgreich geplant wurde.
    Gültige Werte:
    • true: Die Ausführung der Aktivität ist erfolgreich geplant. Die Ausgabe ist eine Zeichenfolge, die „ Success“ angibt.
    • false: Die Ausführung der Aktivität ist nicht erfolgreich geplant. Die Ausgabe ist ein Array mit einer oder mehreren Fehlermeldungen.
    Array Bei Fehlern: Liste mit einer oder mehreren Fehlermeldungen. Nachricht, die besagt, 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 Prozessdesigners (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 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 nicht relativ zur im Parameter relativeToId angegebenen Spalte hinzugefügt werden. Vergewissern Sie sich, 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.
    • Relativer Spaltenkontext nicht gefunden  – Die für den Parameter relativeToId angegebene sys_id 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