SHOW-MAIL-ORDER-STATUS - Informationen zum E-Mail-Sende-Auftrag abfragen

Domäne:

UTILITIES

Erforderliche Berechtigung:

STD-PROCESSING
TSOS

Mit dem Kommando SHOW-MAIL-ORDER-STATUS können Sie den Status der abgeschickten E-Mail-Sende-Aufträge abfragen.

Für alle aktuellen Aufträge zeigt SHOW-MAIL-ORDER-STATUS an, ob diese

• auf die Ausführung warten,

• aktuell ausgeführt werden oder

• bereits ausgeführt wurden.

Das Kommando SHOW-MAIL-ORDER-STATUS unterstützt die strukturierte Ausgabe in S-Variablen (siehe Handbuch „Kommandos, Band 6, S-Variable“).

SHOW-MAIL-ORDER-STATUS

ORDER-ID = *ALL / list-poss(30): <x-text 1..16>

,SENDER-USERID = *OWN / *ANY / <name 1..8>

,INFORMATION = *SUMMARY / *ALL

Beschreibung der Operanden

ORDER-ID = *ALL / list-poss(30): <x-text 1..16>
legt fest, welche Aufträge ausgewählt werden.

ORDER-ID = *ALL
Alle Aufträge der mit dem Operanden SENDER-USERID spezifizierten Benutzer werden ausgewählt.

ORDER-ID = list-poss(30): <x-text 1..16>
Hier können Sie bis zu 30 Aufträge angeben, die ausgewählt werden sollen. Nur Benutzer mit TSOS-Berechtigung dürfen Aufträge mit einer fremden Benutzerkennung angeben.

SENDER-USERID = *OWN / *ANY / <name 1..8>
spezifiziert die Benutzer, deren Aufträge ausgewählt werden sollen.

SENDER-USERID = *OWN
Nur die Aufträge des Kommando-Aufrufers werden ausgewählt.

SENDER-USERID = *ANY
Für Benutzer ohne TSOS-Berechtigung entspricht diese Angabe der Angabe von *OWN. Für Benutzer mit TSOS-Berechtigung bedeutet diese Angabe, dass die Aufträge aller Benutzer ausgewählt werden.

SENDER-USERID = <name 1..8>
Benutzerkennung, deren Aufträge ausgewählt werden sollen. Nur Benutzer mit TSOS-Berechtigung dürfen Aufträge einer fremden Benutzerkennung angeben.

INFORMATION = *SUMMARY / *ALL
legt fest, welche Informationen zu den Aufträgen ausgegeben werden.

INFORMATION = *SUMMARY
Es werden nur die jeweiligen Summen der Auftragskategorien ausgegeben.

INFORMATION = *ALL
Es werden alle verfügbaren Informationen zu den ausgewählten Aufträgen ausgegeben.

Return codes

(SC2)	SC1	Maincode	Bedeutung / garantierte Meldungen
	0	CMD0001	Kein Fehler.
	64	CMD0216	Der Benutzer hat nicht die notwendige Berechtigung für das Kommando.
	32	CMD0220	Interner Fehler.
	32	CMD2009	Fehler während der Erstellung der Ausgabe-Variable.
	64	YML0120	Subsystem ASTI ist nicht verfügbar.
	32	YML0176	Unerwarteter ASTI-Fehler.
	64	YML0210	Auftrag nicht gefunden.
	128	YML0214	Ressourcen-Auslastung.
	64	YML0216	Auftrag durch fremde Anwendung ausgeführt.
	64	YML0218	Auftrag ist kein Mail-Sende-Auftrag.

Ausgabe-Daten

• Beim Operanden INFORMATION=*SUMMARY werden die Mail-Sende-Aufträge anhand der Operanden ORDER-ID und SENDER-USERID ausgewählt und in Kategorien zusammengefasst. Die Summe der Aufträge wird ausgegeben. Es werden fünf Kategorien unterschieden:

  WAITING	Auftrag wartet auf die Durchführung durch die Backend-Task.
  DEFERRED	Bei der Ausführung durch die Backend-Task ist ein zeitlich begrenzter Fehler aufgetreten (z.B. wenn der Mail-Server heruntergefahren ist). Nach einiger Zeit wird erneut versucht den Auftrag auszuführen.
  ACTIVE	Auftrag wird derzeit durch die Backend-Task ausgeführt. Die Anwendung unterstützt keine parallele Verarbeitung. Daher kann die Zahl der Aufträge in dieser Kategorie nur 0 oder 1 sein, außer wenn ein Fehler auftritt.
  SENT	Der Auftrag wurde erfolgreich ausgeführt.
  FAILED	Bei der Verarbeitung des Auftrags ist ein Fehler aufgetreten.

  Die Daten können in einer S-Variablen abgelegt werden, die die Namen der Kategorien als Komponenten enthält.

• Bei INFORMATION=*ALL werden für jeden ausgewählten Auftrag mehrere Zeilen ausgegeben.

Die folgende Tabelle stellt den Labeln der SYSOUT-Zeilen die entsprechenden Komponenten-Namen der S-Variablen gegenüber. Falls ein bestimmter Wert nicht vorhanden ist, wird die zugehörige Zeile bzw. Variablen-Komponente unterdrückt.

SYSOUT	S-Variable	Bedeutung
ORDER-ID	ORDER-ID	Auftrags-ID
STATE	STA	Auftragsstatus (Waiting, Deferred, Active, Sent, Failed)
SEND TIME	SEND-TIME	Sendezeitpunkt der Mail
SENDER	SENDER	Benutzerkennung des Absenders der Mail
RETURN CODE	RETURN-CODE	Return Code der Backend-Task bei STATUS=Sent oder Failed
RETURN MESSAGE	RETURN-MSG	Auftragsende-Meldung des Mail-Servers oder Fehlermeldung in Textform bei STATUS=Sent oder Failed
FROM	FROM	Wert des SEND-MAIL-Operanden FROM
TO	TO	Wert des SEND-MAIL-Operanden TO
CC	CC	Wert des SEND-MAIL-Operanden CC
BCC	BCC	Wert des SEND-MAIL-Operanden BCC

Beispiele

/EXECUTE-CMD CMD=(SHOW-MAIL-ORDER-STATUS INFORMATION=*SUMMARY),-
/             STRUCTURE-OUTPUT=OUT
%  # ORDERS
%    WAITING:     1
%    DEFERRED:    0
%    ACTIVE:      0
%    SENT:        1
%    FAILED:      0
%    TOTAL:       2


/SHOW-VARIABLE OUT
OUT(*LIST).WAITING = 1
OUT(*LIST).DEFERRED = 0
OUT(*LIST).ACTIVE = 0
OUT(*LIST).SENT = 1
OUT(*LIST).FAILED = 0


/EXECUTE-CMD CMD=(SHOW-MAIL-ORDER-STATUS ORDER=*ALL,INFORMATION=*ALL),-
/              STRUCTURE-OUTPUT=OUT
%  ORDER_ID:            01E7E48600000025
%  STATUS:              Waiting
%  SUBMISSION TIME:     2010-02-10 17:23:18
%  SUBMITTER:           CLAUDIO
%  FROM:                [e-mail]
%  TO:                  [e-mail]
%  CC:                  [e-mail]
%  BCC:                 [e-mail]
%  ---
%  ORDER_ID:            01E7E48600000013
%  STATUS:              Sent
%  SUBMISSION TIME: 2010-02-10 11:05:54
%  SUBMITTER:           HEINRICH
%  RETURN CODE:         Ok
%  RETURN MESSAGE:      250 Ok: queued as BDB6F6EA2F
%  FROM:                [e-mail]
%  TO:                  [e-mail]


/SHOW-VARIABLE OUT
OUT(*LIST).ORDER-ID = 01E7E48600000025
OUT(*LIST).STA = Waiting
OUT(*LIST).SEND-TIME = 2010-02-10 17:23:18
OUT(*LIST).SENDER = CLAUDIO
OUT(*LIST).FROM = [e-mail]
OUT(*LIST).TO = [e-mail]
OUT(*LIST).CC = [e-mail]
OUT(*LIST).BCC = [e-mail]
OUT(*LIST).ORDER-ID = 01E7E48600000013
OUT(*LIST).STA = Sent
OUT(*LIST).SEND-TIME = 2010-02-10 11:05:54
OUT(*LIST).SENDER = HEINRICH OUT(*LIST).RETURN-CODE = Ok
OUT(*LIST).RETURN-MSG = 250 Ok: queued as BDB6F6EA2F
OUT(*LIST).FROM = [e-mail]
OUT(*LIST).TO = [e-mail]