Prozessstatuswechsel

Um den Status eines oder auch mehrerer Prozesse manuell zu ändern, steht im Menü der Prozessaktion eine zentrale Funktion zum Statuswechsel zur Verfügung.

Der Benutzer soll zuerst den Prozess/die Prozesse auswählen, dessen Status er ändern möchte (mit einfachem Mausklick). Mit einem Rechtsklick öffnet sich das Kontextmenü, das den Button "Aktionen" enthält. Im Untermenü ist der Button "Status ändern" zu sehen (siehe Screenshot).

Nach dem Klicken auf diesen Menüeintrag öffnet sich ein neues Fenster zur Statusbearbeitung, der vorher markierten Prozesse. Die Prozesse, für welche eine Statusänderung manuell durchgeführt werden soll, werden mit Ihrer Prozess-ID aufgelistet.

Der Anwender kann nun den neuen Status für die ausgewählten Prozesse via Pulldown-Menüs festlegen.
Weiterhin besteht die Möglichkeit, notwendige Informationen zur Statusänderung im Feld für Bemerkungen, Hinweise Notizen o.ä. als Kommentar einzugeben.
Die Statusänderung muss mit der verwendeten Process-Engine (bspw. IGUASU oder INUBIT) umgesetzt werden.

Zugriffsrechte

Damit ein Benutzer Prozessstatuswechsel nutzen kann, benötigt er das Recht bpcmonitor_changeprocessstate.

Um einem Benutzer das Recht für ausgewählte Komponenten zu geben, benötigt er spezifizierte Rechte mit der ID der Komponente: bpcmonitor_changeprocessstate_{MONITORID}.

Sollte das System, das den Statuswechsel verarbeitet, über eine Backend Connection angesprochen werden, so wird für alle Nutzer der Funktion das Recht loadModule_backendconnection benötigt.

Allgemeine Einstellung

Folgende Einstellungen werden je Monitor vorgenommen:

Aktiv: (function_changeState)
(boolean; default: true)
Ermöglicht die Verwendung der manuellen Statuswechselfunktion.
Endpunkt oder Prozessor: (changeStateEndpointProcessor)
(string; default: "")
Auswahl des REST-Endpunktes (Backend Connection) oder Prozessors (Flow) zur Ausführung eines Prozessstatuswechsels.
Einstellungen (function_changeStateConfig)
(json)
Einstellungen der Funktionsparameter für den Statuswechsel Siehe Konfiguration.

Default:

[
    {
        "dataIndex": "STATUS",
        "useDistinctValues": true
    }
]

Konfiguration

Dieser Abschnitt beschreibt die Möglichkeiten, wie die Prozessstatuswechsel konfiguriert werden können.

Syntax

dataIndex
(string)
Der dataIndex der Spalte, in der der Status geändert werden soll.
useDistinctValues
(boolean, default: true)
Wenn true, werden automatisch alle unterschiedlichen Werte aus der Spalte als Auswahlmöglichkeiten angeboten. Wenn false, können die Auswahlmöglichkeiten über das Attribut states definiert werden.
states
(array)
Definiert die Auswahlmöglichkeiten für den neuen Status (Wird nur verwendet, wenn useDistinctValues false ist). Jedes Element im Array ist ein Objekt mit folgenden Attributen:
- settable
  (boolean, default: true)
  Gibt an, ob der Status als Auswahlmöglichkeit angeboten wird.
- state
  (string)
  Der Wert, der als neuer Status gesetzt wird.
useRendererValue
(boolean)
Wenn true, werden die gerenderten Werte der Spalte verwendet (anstatt der Rohwerte).
preselectState
(string)
Ermöglicht die Vorauswahl eines bestimmten Status im Auswahlmenü.
"preselectState": "<Suchwert>": Wählt den ersten Eintrag aus, der den angegebenen Text enthält (Groß-/Kleinschreibung beachten). Es können sowohl Rohwerte als auch Anzeigenamen (aus Custom Renderer) verwendet werden.
"preselectState": "_first": Wählt immer den ersten verfügbaren Wert aus dem Dropdown aus.
metadata
(object)
Zusätzliche Metadaten, die an den Endpunkt oder Prozessor übergeben werden, um zusätzliche Konfigurationswerte oder Kontextinformationen zu ergänzen.

Erwartetes Rückgabe-Format

Der Client erwartet vom Server eine JSON-Antwort.

Es sollte sichergestellt werden, dass der Content-Type-Header entsprechend gesetzt wird, um dem Client das Datenformat korrekt zu übermitteln:

JSON-Antworten benötigen Content-Type: application/json.

Antwort auf Absenden des Prozesses

Beispiel Fehler

{
    "success": "false",
    "msg": "Fehlermeldung"
}

Beispiel OK

{
    "success": "true",
    "msg": "Status wurde erfolgreich geändert"
}

OpenAPI Spezifikation

Eine detaillierte Beschreibung aller Endpunkte finden Sie in unserer OpenAPI Spezifikation.

Keywords: