Diagnose-Kommandos

Aufruf

  • Interaktiver Modus

    startcli [-u <Benutzerkennung>] [-p <Passwort>]
    ...
    `<Option> [<arg>]`
  • Skriptmodus

    startcli [-u <Benutzerkennung>] [-p <Passwort>] --execCommand "<Option> [<arg>]"

Kommandooptionen

Option Bedeutung

-h,--help

Anzeigen der Hilfe

-v

Liefert die aktuelle Version des Clients zurück (nur im Skriptmodus)

-a

Liefert alle lokalen IPv4-Netzwerkinterfaces zurück (nur im Skriptmodus)

--debug

Startet den interaktiven CLI-Modus im Trace-Modus

Nach Beendigung des CLIs wird der Trace-Modus automatisch deaktiviert.

debug {on|off}

Schaltet im interaktiven CLI-Modus den Trace-Modus des interaktiven Modus ein/aus

Beispiel

  • Interaktiver Modus

    debug on
  • Skriptmodus

    startcli -v
    CLI 7.1.0.4
    Copyright (C) Virtimo AG
    https://www.virtimo.de
    Supported INUBIT Process Engine versions from 4.0.1 to 7.1.0.4.
    startcli -a
    <IP-Adresse> (<Hostname>)
    startcli --debug

Laufende Prozesse über das CLI anzeigen

Mit dem Kommando ps können Sie Details aller Prozesse oder nur bestimmter Workflows anzeigen.

Aufruf

  • Interaktiver Modus

    startcli [-u <Benutzerkennung>] [-p <Passwort>]
    ...
    CLI|<Benutzerkennung@Hostname> ps [Option(en)]
  • Skriptmodus

    startcli --execCommand "ps [Option(en)]"

Kommandooptionen

Option Bedeutung

-a,--all

Zeigt alle Einträge

-c,--count

Zeigt nur die Anzahl der Einträge

-csv

Gibt eine kommaseparierte Liste anstatt einer Tabelle aus

-e,--error

Zeigt nur fehlerhafte Workflows an (Status Error)

-f,--filter '<filterExpression>' [<options>]

Filtert laufende Prozesse mithilfe der Argumente workflow und/oder tag

-f 'workflow=<workflowName>' [-a|-e|-q|-w]

Filtert Prozesse mit dem angegebenen Workflow-Namen

Die Option -f muss zusammen mit einer der Optionen -a, -e, -q, oder -w verwendet werden.

Um nach dem Workflow-Namen und dem Tag zu filtern, nutzen Sie die folgende Syntax:

-f 'workflow=<workflowName> AND tag=<tagName>' [-a|-e|-q|-w]

Der Filterausdruck muss in einfache Anführungszeichen eingeschlossen sein.

  • AND (muss in Großbuchstaben angegeben werden)
    Zum Verknüpfen von zwei Filterbedingungen

  • OR
    Nicht direkt unterstützt, indirekt unter Verwendung von inFile und in.

    • inFile (muss in Camel-Case-Schreibweise angegeben werden)
      zum Angeben einer Variablen, die einen Pfad zu einer CSV-Datei mit Filterwerten enthält, z.B. Werte in benutzerdefinierten Spalten

    • in (muss in Kleinbuchstaben angegeben werden)
      zum Angeben mehrerer Werte

-f 'tag=<tagName>' [-a|-e|-q|-w]

Filtert Prozesse mit dem angegebenen Tag-Namen

Die Option -f muss zusammen mit einer der Optionen -a, -e, -q, oder -w verwendet werden.

Der Filterausdruck muss in einfache Anführungszeichen eingeschlossen sein.

  • AND (muss in Großbuchstaben angegeben werden)
    Zum Verknüpfen von zwei Filterbedingungen

  • OR
    Nicht direkt unterstützt, indirekt unter Verwendung von inFile und in.

    • inFile (muss in Camel-Case-Schreibweise angegeben werden)
      zum Angeben einer Variablen, die einen Pfad zu einer CSV-Datei mit Filterwerten enthält, z.B. Werte in benutzerdefinierten Spalten

    • in (muss in Kleinbuchstaben angegeben werden)
      zum Angeben mehrerer Werte

-h,--help

Zeigt diese Hilfe an

-l <arg>

Begrenzt die Ausgabe auf X Zeilen

-q,--queued

Zeigt nur Workflows im Status Queued an

-u <index>

Anzeigen der angegebenen benutzerdefinierten Spalten. Mögliche Indizes sind 1 bis 5. Ist kein Index angegeben, werden alle Spalten angezeigt.

-u '<filterExpression>'

Anzeigen der benutzerdefinierten Spalte(n) anhand der benutzerdefinierten Daten

Der Filterausdruck muss in einfache Anführungszeichen eingeschlossen sein.

  • AND (muss in Großbuchstaben angegeben werden)
    Zum Verknüpfen von zwei Filterbedingungen

  • OR
    Nicht direkt unterstützt, indirekt unter Verwendung von inFile und in.

    • inFile (muss in Camel-Case-Schreibweise angegeben werden)
      zum Angeben einer Variablen, die einen Pfad zu einer CSV-Datei mit Filterwerten enthält, z.B. Werte in benutzerdefinierten Spalten

    • in (muss in Kleinbuchstaben angegeben werden)
      zum Angeben mehrerer Werte

-w,--waiting

Zeigt nur Workflows im Status Waiting an

Beispiel

  • Interaktiver Modus

    startcli -u root
    Password:
    ps -a
    CLI|root@be6vw0149> ps -a
    NODE UID PID PRIO STATE DATE WORKFLOW MODULE TAG
    __NotAssigned__ jh 7 normal Waiting 2016-05-31T15:42:30 ErrorExit FTP(2120723586) alpha
    <hostname>.......... miller 8 normal Error 2016-05-31T17:13:15 InvoiceSupplierA Invoice openTRANS ..
    <hostname>.......... jh 19 normal Error 2016-05-31T17:42:57 ValidationWorkflow Create_Query(21223..
    <hostname>.......... jh 20 normal Error 2016-05-31T17:54:08 Location_Hamburg Wait10m(4)
    Total: 4
  • Skriptmodus

    startcli --execCommand "ps -a -csv"
    Password:
    NODE,UID,PID,PRIO,STATE,DATE,WORKFLOW,MODULE,TAG
    __NotAssigned__,jh,7,normal,Waiting,2016-05-31T15:42:30,ErrorExit,FTP(2120723586),alpha
    <hostname>,miller,8,normal,Error,2016-05-31T17:13:15,InvoiceSupplierA,Invoice openTRANS output(16066),
    <hostname>,jh,19,normal,Error,2016-05-31T17:42:57,ValidationWorkflow,Create_Query(2122359735),
    <hostname>,jh,20,normal,Error,2016-05-31T17:54:08,Location_Hamburg,Wait10m(4),
    Total: 4
    startcli --execCommand "ps -a -f 'workflow=Location_Hamburg AND tag=1.4Beta'"
    NODE UID PID PRIO STATE DATE WORKFLOW MODULE TAG
    __NotAssigned__ jh 26 normal Waiting 2016-05-31T22:27:42 Location_Hamburg Wait10m(4)
    1.4Beta
    Total: 1

Toleranz gegenüber Datenbankverbindungsunterbrechungen anzeigen und konfigurieren

Mit dem Kommando dbconnectiontolerance können Sie die Parameter zum Konfigurieren der Toleranz gegenüber kurzzeitigen Unterbrechungen der Verbindung zu den internen Datenbanken anzeigen und ändern.

Aufruf

  • Interaktiver Modus

    startcli [-u <Benutzerkennung>] [-p <Passwort>]
    ...
    dbconnectiontolerance [Option(en)]
  • Skriptmodus

    startcli --execCommand "dbconnectiontolerance [Option(en)]"

Kommandooptionen

Option Bedeutung

-h,--help

Hilfe anzeigen

show

Aktuelle Einstellungen anzeigen

  • Error level
    Derzeitiger prozentualer Anteil der Anzahl kurzzeitiger Datenbankverbindungsunterbrechungen am konfigurierten Schwellwert (Parameter Fault threshold)

  • Fault threshold
    Anzahl der kurzzeitigen Datenbankverbindungsunterbrechungen, die innerhalb der im Parameter drop interval konfigurierten Zeitspanne nicht überschritten werden darf

  • Drop rate
    Prozentualer Anteil der kurzzeitigen Datenbankverbindungsunterbrechungen, die nach Ablauf des im Parameter Drop interval konfigurierten Zeitraums entfernt werden

  • Drop interval
    Zeitintervall in Sekunden innerhalb dessen die Anzahl der kurzzeitigen Datenbankverbindungsunterbrechungen den im Parameter Fault threshold konfigurierten Wert nicht überschreiten darf. Überschreitet die Anzahl der kurzzeitigen Datenbankverbindungsunterbrechungen den im Parameter Fault threshold konfigurierten Wert, wird das Verbindungsproblem als dauerhaft eingestuft und der Knoten heruntergefahren.

set

Setzt die Werte für die folgenden Parameter.

  • threshold <positive ganze Zahl>
    Anzahl der kurzzeitigen Datenbankverbindungsunterbrechungen, die innerhalb der im Parameter interval konfigurierten Zeitspanne nicht überschritten werden darf, Standardwert: 25

  • droprate <positive ganze Zahl>
    Prozentualer Anteil der kurzzeitigen Datenbankverbindungsunterbrechungen, die nach Ablauf des im Parameter interval konfigurierten Zeitraums entfernt werden, Standardwert: 4%

  • interval <positive ganze Zahl>
    Zeitintervall in Sekunden innerhalb dessen die Anzahl der kurzzeitigen Datenbankverbindungsunterbrechungen den im Parameter threshold konfigurierten Wert nicht überschreiten darf, Standardwert: 3600 Sekunden

Beispiel

  • Interaktiver Modus

    startcli
    CLI|root@be6vw0149> dbconnectiontolerance set interval 180
    Error level: 0%
    Fault threshold: 25
    Drop rate: 4%
    Drop interval (s): 180 seconds
  • Skriptmodus

    startcli --execCommand "dbconnectiontolerance show"
    Password:
    Error level: 0%
    Fault threshold: 25
    Drop rate: 1%
    Drop interval (s): 180 seconds

Systemüberwachung über das CLI

Die Kommandos zur Systemüberwachung starten Sie direkt als Option des CLI, im Unterschied zum Skriptmodus ohne das Kommando execCommand.

Aufruf

startcli [-u <Benutzerkennung>] [-p <Passwort>] \{Option} [Process-Engine-URL]

Wenn Sie keinen Benutzer angegeben, wird root verwendet.

Wenn Sie kein Passwort angeben, werden Sie nach dem Start des Programms zur Eingabe des Passworts aufgefordert.

Wenn Sie keine URL angeben, wird https://<server>:<port>/ibis/servlet/IBISSoapServlet verwendet.

Folgende Kommandos/Optionen stehen u.a. zur Verfügung:

Kommando/Option Beschreibung

-who

Zeigt alle Benutzer an, die über Workbenches an der Process Engine angemeldet sind.

Es werden keine Benutzer angezeigt, die über StartCLI im interaktiven Modus an der Process Engine angemeldet sind.

-nwho

Anzahl der User, die über eine Workbench eingeloggt sind

-ne

Anzahl der Prozesse im Zustand Error

-nx

Anzahl der Prozesse im Zustand Processing, d.h., Prozesse, die gerade ausgeführt werden

-nw

Anzahl der Prozesse im Zustand Waiting

-nq

Anzahl der Prozesse im Zustand Queued

-q

Ausgabe der Queue

-sv

Ausgabe der Produktversion der Process Engine

-pctmem

Ausgabe von Informationen über die JVM-Speicherauslastung

-maintenanceState

Ausgabe des Wartungmodusstatus der Process Engine

uname

Liefert die Version der Process Engine zurück

uptime

Liefert für die Process Engine die aktuelle Uhrzeit und die Zeit im Betrieb seit dem letzten Hochfahren

date

Liefert aktuelles Datum und aktuelle Uhrzeit der Process Engine

free <option>

Liefert den verfügbaren und den benutzten Speicher der Virtual Machine

  • -i <arg> Intervall für die erneute Anzeige in Sekunden.

    Zum Beenden der Anzeige drücken Sie die Enter-Taste.

  • -k Ausgabe in KByte anzeigen

  • -m Ausgabe in MByte anzeigen

  • -p prozentuale Speicherauslastung

lls

Anzeigen des Inhalts des lokalen Verzeichnisses

msgsend

Sendet eine Instant-Nachricht an den/die angegebene(n) Benutzer/ Benutzergruppe

  • -f Liest den Inhalt der Instant-Nachricht aus einer Textdatei

  • -s <arg> Betreffzeile der Instant-Nachricht

    Nur das erste Argument nach der Option -s wird als Betreff verwendet.

    Enthält der Betreff Leerzeichen, muss er in Hochkommas ` `eingeschlossen sein.

msglist

Listet ID, Betreff, Absender sowie Datum und Uhrzeit der eingegangenen Instant-Meldungen auf

msgread <ID>

Anzeigen der durch die angegebene ID ausgewählte Instant-Nachricht Sie können die ID mit dem Kommando msglist ermitteln.

msgdel

Löscht Instant-Nachrichten

  • <ID> ID der Instant-Nachricht

    Sie können die ID mit dem Kommando msglist ermitteln.

  • -a Löscht alle Instant-Nachrichten

license

Lizenzablauf

  • -td Lizenzablauf in Tagen

  • -ts Lizenzablauf in Sekunden

Beispiel

startcli -who
Password:
SYSTEM-ID SYSTEM TYPE STATE VERSION IDLE
<Hostname> (<Benutzer>) Toolset OK Head 0:00:07s
msgsend inubit_group -s 'Bitte abmelden ...' Ihre Process Engine wechselt um 18:00 Uhr in den Wartungsmodus.

Server-Trace über das CLI setzen

Sie starten das Kommando trace im interaktiven Modus nach dem Anmelden beim CLI.

Aufruf

startcli [-u <Benutzername>] [-p <Passwort>] [Process-Engine-URL]

Die folgenden Kommandos/Optionen sind verfügbar:

Kommando/Option Beschreibung

trace -l [fatal|error|warn|info|debug]

Trace-Level setzen

trace [on|off]

Server-Trace an-/ausschalten

trace

Anzeigen des derzeitigen Trace-Status (an/aus)

Beispiel

Führen Sie die folgenden Kommandos aus, um das Trace-Level auf error zu setzen, das Server-Trace anzuschalten und den derzeitigen Trace-Status anzuzeigen.

startcli -u root
Password:
trace -l error
Successfully changed level to ERROR
trace on
trace
Trace is currently on.

Größe der Blocking Queue über das CLI abrufen

Die Größe der Blocking-Queue wird in der Datei logsDbConfig.xml konfiguriert. Der Wert hängt davon ab, wie die Workflows entworfen und ausgeführt werden. Die Größe der Blocking-Queue zu einem bestimmten Zeitpunkt sollte bekannt sein, um die tatsächliche Größe der Warteschlange zu bestimmen. Dieser CLI-Befehl ist erforderlich, um den aktuellen Wert der Blocking-Queue abzurufen.

Aufruf

  • Interaktiver Modus

    startcli [-u <Benutzerkennung>] [-p <Passwort>]
    ...
    getBlockingQueueSize [Option(en)]
  • Skriptmodus

    startcli --execCommand "getBlockingQueueSize [Option(en)]"

Kommandooptionen

-h, --help Anzeigen der Hilfe.

Rückgabewert

Die aktuelle Größe der Blocking-Queue als ganzzahligen Wert.

Beispiel

  • Interaktiver Modus

    startcli
    CLI|root@localhost> getBlockingQueueSize
    100
  • Skriptmodus

    startcli --execCommand "getBlockingQueueSize"
    100