Services

Queue_DequeueItem - Eintrag aus Queue abholen und entfernen

Port: Biz

Beschreibung

Eintrag aus Queue liefern (und entfernen). Mindestens Queue-Typ, Eintrags-Nummer oder Monitor-Objekt-ID muss angegeben werden (übrige Argumente sind optional). Optional kann auch das dazugehörige Monitor-Objekt entfernt werden. Schliesslich ist es möglich, das Entfernen nur zu simulieren (Peek-Modus).

Argumente

Nr.
Key
Name
Beschreibung
1
QueueTypeCd
Queue-Typ
Queue-Typ (zwingendes Argument ausser wenn Eintrags-Nummer oder Monitor-Objekt-ID übergeben)
2
QueueSubTypeCd
Queue-Subtyp
Queue-Subtyp (optionales Argument; mögliche Werte abhängig vom Queue-Typ; wenn leer/0 erfolgt keine Einschränkung auf Subtyp - andernfalls werden nur Einträge mit passendem Subtyp gesucht)
3
ClientNo
Mandant
Mandant (kann leer/0 sein = Einträge für alle Mandanten werden geliefert; ansonsten Einschränkung auf einen bestimmten Mandanten)
4
QueueItemNo
Eintrag-Nummer
Nummer des Eintrags der abgeholt und entfernt werden soll (kann/muss leer sein, wenn Eintrag via Queue-Typ oder Monitor-Objekt adressiert wird)
5
PeekOnly
Simulation (nur 'Peek')?
Soll Abholen des adressierten Eintrags nur simuliert werden?
6
DeleteProgress
Monitor-Objekt löschen?
Soll allenfalls dazugehöriges Monitor-Objekt gelöscht werden? Normalerweise ist dies nicht erwünscht, weil Objekt bei der eigentlichen Verarbeitung des Queue-Eintrags (nach dem Abholen) als Behälter für Rückmeldungen dient. Also nur Löschen, wenn wirklich erwünscht!
7
ProgressId
Monitor-Objekt-ID
Monitor-Objekt-ID dessen dazugehöriger Eintrag abgeholt und entfernt werden soll (kann/muss leer sein, wenn Eintrag via Queue-Typ oder Eintrag-Nummer adressiert wird)

Rückgabewerte

Nr.
Key
Name
Beschreibung
1
Number
Queue-Eintrag-Nummer
Eindeutige Nummer des Queue-Eintrags
2
QueueTypeCd
Queue-Typ
Queue-Typ
3
QueueSubTypeCd
Queue-Subtyp
Queue-Subtyp (mögliche Werte abhängig vom Queue-Typ)
4
ClientNo
Mandant
Mandant (kann leer/0 sein)
5
Data
Daten
Daten welche beim Einfügen dem Eintrag zugeordnet wurden
6
ProgressId
Monitor-Objekt-ID
Monitor-Objekt-ID des dazugehörigen Monitor-Objekts
7
ExternalSystemNo
Externes System
Externes System (kann leer/undefiniert sein)

Message Keys

Nr.
Key
Name
Beschreibung
1
NotFound
Queue_DequeueItem.Ek.NotFound
Queue_DequeueItem.Ek.NotFound