Progress - Monitor-Objekt verwalten

Port: Biz

Beschreibung

Mit diesem Service können Monitor Objekte überwacht oder bearbeitet werden. Für ein aktives Monitor-Objekt (M-O) kann eine der folgenden Funktionen ausgelöst werden: Nicht abbrechen, Schritt abbrechen, Job abbrechen, Verarbeitung abbrechen, Quittieren. Der Service kann Informationen zum M-O zurückgeben, es aktualisieren, es löschen oder ein neues M-O erstellen. Beim Ausführen des Service kann eine Log-Meldung beim M-O gespeichert werden.

Argumente

Nr.
Key
Name
Beschreibung
1
ProgressId
Monitor-Id
Monitor-Objekt-Id
2
ToDoCode
Was ist zu tun?
Siehe Code-Tabelle 'ProgressToDo'
3
ProcName
Verarbeitungs-Name
Eine Verarbeitung besteht aus keinem, einem oder mehreren Jobs. Z.B.: beim Applikations-Pool sind es Pool-Items; ein Job besteht aus einem oder mehreren Schritten z.B.: ein Dokument wird gebucht; und der Applikations-Pool selbst ist die Verarbeitung.
4
RetainObject
Behalten in Std.
Wie lange in Stunden sollte das Monitor-Objekt mit dem Status 'abgeschlossen' oder 'keine Rückmeldung' aufbewahrt werden. Für den Status 'nicht gestartet' ist fix 24 Stunden.
5
AutoUpdateByBusService
Aktualisierung durch Bus-Service
Ein Monitor-Objekt wird meistens von dedizierten Bus-Services verwendet und auch automatisch aktualisiert. Aber ist es auch möglich ein Monitor für Zwecke von Dritt-Komponenten nutzen. In einem solchen Fall, die Aktualisierung vom Monitor-Objekt liegt in der Obhut und der Verantwortung dieser Komponente.
6
ComputerName
Rechner-Name
Rechner-Name, wo die Verarbeitung läuft.
7
ComputerPID
Rechner-PID
Prozess-ID auf dem Rechner, wo die Verarbeitung läuft.
8
ProcCancelSupported
Verarbeitungs-Abbruch unterstützt
Ob die Verarbeitung vom Anwender abgebrochen werden kann.
9
ProcPercent
Verarbeitungs-Fortschritt in %
Fortschritt des Ablaufs in %(0-100). Leer bedeutet 'nicht unterstüzt'.
10
IsNewJob
Ist neuer Job ?
Wenn 'nein', dann wird nur Argument 'Job-Fortschritt in %' akzeptiert.
11
JobName
Job-Name
Die mittlere Stufe der Verarbeitung.
12
JobPercent
Job-Fortschritt in %
Fortschritt des Ablaufs in %(0-100). Leer bedeutet 'nicht unterstüzt'.
13
JobCancelSupported
Job-Abbruch unterstützt
Ob der laufenden Job vom Anwender abgebrochen werden kann.
14
IsNewStep
Ist neuer Step ?
Wenn 'nein', dann wird nur Argument 'Step-Fortschritt in %' akzeptiert.
15
StepName
Schritt-Name
Die unterste Stufe der Verarbeitung.
16
StepPercent
Schritt-Fortschritt in %
Fortschritt des Ablaufs in %(0-100). Leer bedeutet 'nicht unterstüzt'.
17
StateCode
Status der Verarbeitung
Siehe Code-Tabelle 'ProgressState'
18
Info
Info
Info über den Ablauf der Verarbeitung.
19
StepCancelSupported
Schritt-Abbruch unterstützt
Ob der laufenden Schritt vom Anwender abgebrochen werden kann.
20
NotRespondingSwitchOn
Rückmeldung in Min.
Das Monitor-Objekt mit dem Status „Wird ausgeführt“ wird auf Status „Keine Rückmeldung“ umgestellt, wenn das Monitor-Objekt innnerhalb von letzten n-Minuten nicht mehr aktualisiert wurde.
21
ProcPath
Verarbeitungs-Gruppe
Gruppierung von Monitor-Objekten. Z.B.: „Opacc.Search.Agent.Indexing.1-Art“ oder „Opacc.Bus.Biz.AppPool_Process“.
22
WinServiceName
Win-Service-Name
Name des dazugehörigen Windows-Services.
23
Version
Version der Komponente
Version der dazugehörigen Komponenten (damit sollen einfach alte Komponenten erkannt werden können).
24
WinUser
Windows-User
Windows-User
25
InteractiveSession
Dialoge erlaubt ?
Die serverseitigen Interaktionen mit Anwender sind zugelassen.
26
LogStateCode
Log-Status
Setzen eines tieferen Log-Status nur möglich, wenn eine Bestätigung/Quittierung vorhanden. Log-Status kann auch leer sein.
27
LogMessage
Log-Meldung
Log-Meldung
28
LogSource
Log-Herkunft
Log-Herkunft
29
LogSourceDetail
Log-Herkunft-Detail
Log-Herkunft-Detail
30
LogThread
Log-Thread
Log-Thread
31
LogComputerName
Log-Rechner-Name
Log-Rechner-Name
32
LogComputerPID
Log-Rechner-PID
Log-Rechner-PID
33
LogWinUser
Log-Win-User
Log-Win-User
34
ViewStateCode
Monitor-Status-Filter
Monitor-Status-Filter (nur für ToDo-Codes 50 und 55 relevant).
35
ProcStartDateMin
Verarbeitungs-Start-Datum von
Verarbeitungs-Start-Datum von: Nur für ToDo-Codes 50, 55 und 99 relevant.
36
ProcStartDateMax
Verarbeitungs-Start-Datum bis
Verarbeitungs-Start-Datum bis: Nur für ToDo-Codes 50, 55 und 99 relevant. Das hier eingegebene Datum liefert Verarbeitungen welche bis und mit dem eingegebenen Datum gestartet wurden.
37
ResultObject
Rückgabe-Spalten
Definiert welche Spalten zurückgegeben werden sollen. Standardmässig werden alle Spalten zurückgegeben. Aus Performance-Gründen sollen jedoch wenn immer möglich nur die wirklich benötigten Spalten angegeben werden.

Rückgabewerte

Nr.
Key
Name
Beschreibung
1
ProgressId
Monitor-Id
Monitor-Objekt-Id
2
QueryTime
Zeitpunkt der Abfrage
Zeitpunkt der Abfrage des Monitor-Objekts
3
ProcPath
Verarbeitungs-Gruppe
Gruppierung von Monitor-Objekten. Z.B.: „Opacc.Search.Agent.Indexing.1-Art“ oder „Opacc.Bus.Biz.AppPool_Process“.
4
ProcName
Verarbeitungs-Name
Eine Verarbeitung besteht aus keinem, einem oder mehreren Jobs. Z.B.: beim Applikations-Pool sind es Pool-Items; ein Job besteht aus einem oder mehreren Schritten z.B.: ein Dokument wird gebucht; und der Applikations-Pool selbst ist die Verarbeitung.
5
ProcStart
Start-Zeit der Verarbeitung
Start-Zeit der Verarbeitung
6
ProcSpan
Dauer der Verarbeitung
Dauer der Verarbeitung im Vergleich zum Start
7
ProcPercent
Verarbeitungs-Fortschritt in %
Fortschritt des Ablaufs in %(0-100). Leer bedeutet 'nicht unterstüzt'.
8
ProcCancelSupported
Verarbeitungs-Abbruch unterstützt
Ob die Verarbeitung vom Anwender abgebrochen werden kann.
9
JobName
Job-Name
Die mittlere Stufe der Verarbeitung.
10
JobStart
Start-Zeit des Jobs
Start-Zeit des Jobs
11
JobSpan
Dauer des Jobs
Dauer des Jobs im Vergleich zum Start
12
JobPercent
Job-Fortschritt in %
Fortschritt des Ablaufs in %(0-100). Leer bedeutet 'nicht unterstüzt'.
13
JobCancelSupported
Job-Abbruch unterstützt
Ob der laufenden Job vom Anwender abgebrochen werden kann.
14
StepName
Schritt-Name
Die unterste Stufe der Verarbeitung.
15
StepStart
Start-Zeit des Schrittes
Start-Zeit des Schrittes
16
StepSpan
Dauer des Schrittes
Dauer des Schrittes im Vergleich zum Start
17
StepPercent
Schritt-Fortschritt in %
Fortschritt des Ablaufs in %(0-100). Leer bedeutet 'nicht unterstüzt'.
18
StepCancelSupported
Schritt-Abbruch unterstützt
Ob der laufenden Schritt vom Anwender abgebrochen werden kann.
19
StateCode
Verarbeitungs-Status
Siehe Code-Tabelle 'ProgressState'
20
StateChange
Seit wann der Status
Zeitpunkt der Status-Änderung. Im Falle von Status 'nicht gestartet' bedeutet es der Zeitpunkt des Erstellens von Monitor-Objekt.
21
StateSpan
Dauer des Status
Die Zeitspanne zwischen der letzten Status-Änderung und dem Zeitpunkt der Abfrage des Monitor-Objekts.
22
Info
Info
Info über den Ablauf der Verarbeitung.
23
LogStateCode
Log-Status
Mögliche Stati: 'Info', 'Warnung' und 'Fehler'. Setzen eines tieferen Log-Status nur möglich, wenn eine Quittierung vorhanden. Log-Status kann auch leer sein.
24
LogStateChange
Letzte Log-Meldung
Wann wurde die letzte Log-Meldung bei Monitor-Objekt gespeichert.
25
LogStateSpan
Log-Zeitspanne
Die Zeitspanne zwischen der letzten Log-Meldung und dem Zeitpunkt der Abfrage des Monitor-Objekts.
26
LogMessage
Log-Meldung
Log-Meldung
27
LogSource
Log-Herkunft
Log-Herkunft
28
LogSourceDetail
Log-Herkunft-Detail
Log-Herkunft-Detail
29
LogThread
Log-Thread
Log-Thread
30
LogClientNo
Log-Mandant
OpaccERP-Mandant mit dem geloggt wurde
31
LogUserNo
Log-Benutzer
OpaccERP-Benutzer mit dem geloggt wurde
32
LogComputerName
Log-Computer
Computer von dem aus geloggt wurde
33
LogComputerPID
Log-Prozess
Windows-Prozess von dem aus geloggt wurde
34
LogWinUser
Log-Win-User
Log-Win-User
35
ViewStateCode
Monitor-Status
Ausgewerteter logischer Zustand des Monitor-Objektes (daraus soll 'rot', 'grün' oder 'gelb' gebildet werden können). Es ist eine Kombination aus 'Verarbeitungs-Status', 'Log-Status' und 'Quittieren'. Siehe Code-Tabelle 'Monitor-Status' ('ProgressViewState')
36
ViewAck
Gültige Quittierung vorhanden
Der letzte(!) Zustand des Monitor-Objektes (insbesondere Status der Verarbeitung und/oder Log-Status) durch interaktiven Anwender eingesehen/quittiert.
37
ViewAckChange
Zeit der Quittierung
Die Zeit wann letztes Mal wurde durch Anwender eingesehen/quittiert.
38
ViewAckSpan
Quittierungs-Zeitspanne
Zeitspanne zwischen der letzten Quittierung und dem Zeitpunkt der Abfrage des Monitor-Objekts.
39
ViewAckClientNo
Quittierungs-Mandant
Wer hat das Monitor-Objekt eingesehen/quittiert? Login-Mandanten-Nr
40
ViewAckUserNo
Quittierungs-Anwender
Wer hat das Monitor-Objekt eingesehen/quittiert? Login-Anwender-Nr
41
CancelRequested
Abbruch verlangt
Anwender-Wunsch nach Abbruch des Ablaufs
42
RetainObject
Behalten in Std.
Wie lange in Stunden sollte das Monitor-Objekt mit dem Status 'abgeschlossen' oder 'keine Rückmeldung' aufbewahrt werden. Für den Status 'nicht gestartet' ist fix 24 Stunden.
43
NotRespondingSwitchOn
Rückmeldung in Min.
Das Monitor-Objekt mit dem Status „Wird ausgeführt“ wird auf Status „Keine Rückmeldung“ umgestellt, wenn das Monitor-Objekt innnerhalb von letzten n-Minuten nicht mehr aktualisiert wurde.
44
ClientNo
Mandanten-Nr
Mandanten-Nr
45
UserNo
Anwender-Nr
Anwender-Nr
46
ComputerName
Rechner-Name
Rechner-Name, wo die Verarbeitung läuft.
47
ComputerPID
Rechner-PID
Prozess-ID auf dem Rechner, wo die Verarbeitung läuft.
48
WinUser
Windows-Benutzer
Name des Windows-Benutzers zu dem die Verarbeitung gehört
49
WinServiceName
Win-Service-Name
Name des dazugehörigen Windows-Services.
50
Version
Version der Komponente
Version der dazugehörigen Komponenten (damit sollen einfach alte Komponenten erkannt werden können).
51
InteractiveSession
Dialoge erlaubt
Ist das Rückgabe-Attribut aktiv, sind serverseitige Interaktionen mit dem Anwender zugelassen.
52
AutoUpdateByBusService
Aktualisierung durch Bus-Service
Ein Monitor-Objekt wird meistens von dedizierten Bus-Services verwendet und auch automatisch aktualisiert. Aber ist es auch möglich ein Monitor für Zwecke von Dritt-Komponenten nutzen. In einem solchen Fall, die Aktualisierung vom Monitor-Objekt liegt in der Obhut und der Verantwortung dieser Komponente.

Message Keys

keine