X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

MQ Series Transfer

Der Adapter sendet und empfängt Nachrichten über eine IBM-WebSphere-MQ-Nachrichtenwarteschlange und unterstützt MQ-spezifische Funktionen wie z. B. Dynamic Queues.

Eigenschaften (Properties)

Delete

(keine Funktion)

File name

(keine Funktion)

I/O Mode

(keine Funktion)

Operation

Bestimmt, welche Operation mit der Nachrichtenwarteschlange durchgeführt wird.

Mögliche Werte:

  • Send: Daten aus dem vorangegangen Prozessschritt an die MQ-Warteschlange senden

  • Receive: Nachricht in den Prozess einlesen

  • Commit: Transaktion abschließen

  • Rollback: Transaktion abbrechen und sämtliche Änderungen rückgängig machen

  • Create Queue: Warteschlange erstellen

  • Destroy Queue: Warteschlange entfernen

  • Clear: Verbindung zu MQ Series zurücksetzen

Parameter

Tipp:

Viele der in der folgenden Tabelle aufgelisteten Parameter können über ein Kontrollkästchen auf true oder false gesetzt werden. Diese Kontrollkästchen weisen folgendes Verhalten auf:

  • image-20251216-090550.png : Der Parameter ist true.

  • image-20251216-090609.png : Der Parameter ist nicht gesetzt.

  • image-20251216-090620.png : Der Parameter ist false.

alias

Name der Parametergruppe zum externen Konfigurieren des Adapters über die Datei QueueConfig.xml (in x4.ear im Unterordner conf). Dort angegebene Werte besitzen eine höhere Priorität als die Parameter des Transfer-Adapter-Prozessbausteins.

toXML

Wenn die Operation auf Receive gesetzt wurde: Ergebnis des Prozessschritts als XML-Dokument ausgeben. Wenn zudem der Parameter MQMessage.format auf NONE gesetzt wurde, dann wird die Nachricht Base64-kodiert.

Mögliche Werte:

  • true: XML-Dokument generieren, das Header und Body der Nachricht mit sämtlichen Eigenschaften enthält (siehe Beispiel)

  • false: Als Ergebnis des Prozessschritts eine MQ-Nachricht generieren (Standard)

ccdtUrl

URL zu einer Client Channel Definition Table (CCDT)

 Es gibt vier Möglichkeiten, die ccdtUrl zu definieren:

  1. Über die Java-Argumente -DMQCHLLIB und -DMQCHLTAB beim Start des X4 Servers
    Mögliche Werte:

    • -DMQCHLLIB: Pfad zur Table-Datei

    • -DMQCHLTAB: AMQCLCHL.TAB (IBM Default-Name)

  2. Durch das Java-Argument -Dx4.mqseries.ccdtUrl
    Beispiel:  -Dx4.mqseries.ccdtUrl=file:/// Pfad_zur_Tabelle/AMQCLCHL.TAB

  3. Über die Eigenschaft ccdtUrl in der QueueConfig.xml

  4. Über den Parameter ccdtUrl im Adapter selbst

Dabei wird die oben genannte Priorität angewendet.

RemoteQueueManager.
name

Name des Queue-Managers

Mögliche Werte:

  • Beliebige gültige Zeichenkette

  • {EMPTY}: Explizit kein Wert (leere Zeichenkette)

MQEnviroment.hostname

Hostname des angesprochenen MQ-Servers. Gilt systemweit innerhalb der gesamten Java-VM für alle folgenden Operationen (der Parameter wird nur für lokale Tests auf Entwicklungsystemen benötigt, sonst leer lassen!).

Mögliche Werte:

  • Beliebige Zeichenkette (z. B. MQSR2402)

  • {EMPTY}: Explizit kein Wert (leere Zeichenkette)

MQEnviroment.channel

Name des Channels. Gilt systemweit innerhalb der gesamten Java-VM für alle folgenden Operationen (nur für lokale Tests auf Entwicklungsystemen benötigt, sonst leer lassen!).

Mögliche Werte:

  • Beliebige Zeichenkette (z. B. MQSR2402.CLS25740.DT)

  • {EMPTY}: Explizit kein Wert (leere Zeichenkette)

MQEnviroment.CCSID

CCSID (Charset) aller Nachrichten für die gesamte Java-VM. Gilt systemweit innerhalb der gesamten Java-VM für alle folgenden Operationen, deshalb Vorsicht bei der Benutzung (sollte nicht benutzt werden!).

Mögliche Werte:

  • Beliebige CCSID (z. B. 1208)

  • {EMPTY}: Explizit kein Wert (leere Zeichenkette)

MQEnviroment.userID

Benutzer-ID zur Authentifizierung des WebSphere MQ Clients. Gilt systemweit innerhalb der gesamten Java-VM für alle folgenden Operationen (nur für lokale Tests auf Entwicklungsystemen benötigt, sonst leer lassen!).

MQEnviroment.
localAddressSetting

MQ-spezifischer Parameter. Gilt systemweit innerhalb der gesamten Java-VM für alle folgenden Operationen (nur für lokale Tests auf Entwicklungsystemen benötigt, sonst leer lassen!).

Mögliche Werte:

  • Beliebige gültige Zeichenkette

  • {EMPTY}: Explizit kein Wert (leere Zeichenkette)

MQEnviroment.password

Passwort zur Authentifizierung des WebSphere MQ Clients. Gilt systemweit innerhalb der gesamten Java-VM für alle folgenden Operationen (nur für lokale Tests auf Entwicklungsystemen benötigt, sonst leer lassen!).

Mögliche Werte:

  • Beliebige gültige Zeichenkette

  • {EMPTY}: Explizit kein Wert (leere Zeichenkette)

MQEnviroment.port

Port des MQServers. Gilt systemweit innerhalb der gesamten Java-VM für alle folgenden Operationen (nur für lokale Tests auf Entwicklungsystemen benötigt, sonst leer).

Mögliche Werte:

  • Beliebige ganze Zahl (z. B. 1414)

  • {EMPTY}: Explizit kein Wert (leere Zeichenkette)

MQEnviroment.
properties.MQC.SSL_
CIPHER_SUITE_PROPERTY

CipherSuite-Konfiguration für die aktuelle Verbindung. Die eingetragene CipherSuite muss dabei der verwendeten CipherSpec entsprechen:

CipherSpec und die entsprechende CipherSuite

  • NULL_MD5: SSL_RSA_WITH_NULL_MD5

  • NULL_SHA: SSL_RSA_WITH_NULL_SHA

  • RC4_MD5_EXPORT: SSL_RSA_EXPORT_WITH_RC4_40_MD5

  • RC4_MD5_US: SSL_RSA_WITH_RC4_128_MD5

  • RC4_SHA_US: SSL_RSA_WITH_RC4_128_SHA

  • RC2_MD5_EXPORT: SSL_RSA_EXPORT_
    WITH_RC2_CBC_40_MD5

  • DES_SHA_EXPORT: SSL_RSA_WITH_DES_CBC_SHA

  • RC4_56_SHA_EXPORT1024: SSL_RSA_EXPORT1024_
    WITH_RC4_56_SHA

  • DES_SHA_EXPORT1024: SSL_RSA_EXPORT1024_
    WITH_DES_CBC_SHA

  • TRIPLE_DES_SHA_US: SSL_RSA_WITH_3DES_EDE_CBC_SHA

  • TLS_RSA_WITH_AES_128_CBC_SHA: SSL_RSA_WITH_AES_128_CBC_SHA

  • TLS_RSA_WITH_AES_256_CBC_SHA: SSL_RSA_WITH_AES_256_CBC_SHA

  • AES_SHA_US

  • TLS_RSA_WITH_DES_CBC_SHA: SSL_RSA_WITH_DES_CBC_SHA

  • TLS_RSA_WITH_3DES_EDE_CBC_SHA: SSL_RSA_WITH_3DES_EDE_CBC_SHA

  • FIPS_WITH_DES_CBC_SHA: SSL_RSA_FIPS_WITH_DES_CBC_SHA

  • FIPS_WITH_3DES_EDE_CBC_SHA: SSL_RSA_FIPS_
    WITH_3DES_EDE_CBC_SHA

Mögliche Werte:

CipherSuite als gültige Zeichenkette

MQEnviroment.
properties.MQC.
TRANSPORT_PROPERTY

Einstellung für die aktuelle Verbindung

Mögliche Werte:

MQC.TRANSPORT_MQSERIES: einziger zulässiger Wert

MQEnviroment.
properties.MQC.
CCSID_PROPERTY

CCSID (Charset) für die aktuelle Verbindung

Mögliche Werte:

Beliebige ganze Zahl (z. B. 1208)

MQEnviroment.
properties.MQC.
USER_ID_PROPERTY

Benutzer-ID für die aktuelle Verbindung

Mögliche Werte:

Beliebige Zeichenkette

MQEnviroment.
properties.MQC.
CHANNEL_PROPERTY

Name des Channels für die aktuelle Verbindung

Mögliche Werte:

Beliebige Zeichenkette (z. B. MQSR2402.CLS25740.DT)

MQEnviroment.
properties.MQC.
CONNECT_ OPTIONS_
PROPERTY

Verbindungsoptionen für die aktuelle Verbindung

Mögliche Werte:

Beliebige Zeichenkette

MQEnviroment.
properties.MQC.
HOST_NAME_PROPERTY

Hostname des angesprochenen MQ-Servers für die aktuelle Verbindung

Mögliche Werte: Beliebige Zeichenkette (z. B. MQSR2402)

MQEnviroment.
properties.MQC.
LOCAL_ADDRESS_
PROPERTY

Lokale Adresse für die aktuelle Verbindung

Mögliche Werte:

Beliebige Zeichenkette

MQEnviroment.
properties.MQC.
ORB_PROPERTY

ORB-Eigenschaft für die aktuelle Verbindung

Mögliche Werte:

Beliebige Zeichenkette

MQEnviroment.
properties.MQC.
PASSWORD_PROPERTY

Passwort-Eigenschaft für den aktuellen Verbindungsaufbau, um den WebSphere MQ Client zu authentifizieren (entspricht Parameter MQEnviroment.password)

Mögliche Werte:

Beliebige Zeichenkette

MQEnviroment.
properties.MQC.
PORT_PROPERTY

Port für die aktuelle Verbindung

Mögliche Werte:

Beliebige Zeichenkette

MQEnviroment.
properties.MQC.
RECEIVE_EXIT_
PROPERTY

Receive Exit -Eigenschaft für die aktuelle Verbindung

Mögliche Werte:

Beliebige Zeichenkette

MQEnviroment.
properties.MQC.
SECURITY_EXIT_
PROPERTY

Security Exit -Eigenschaft für die aktuelle Verbindung

Mögliche Werte:

Beliebige Zeichenkette

MQEnviroment.
properties.MQC.
SEND_EXIT_PROPERTY

Send Exit -Eigenschaft für die aktuelle Verbindung

Mögliche Werte:

Beliebige Zeichenkette

MQQueueManager.name

Name des QueueManagers. Nur für lokale Tests auf Entwicklungsystemen notwendig, sonst leer.

MQQueue.name

Name der Queue

MQQueue.dynamic
QueueName

Name der Session Queue für diese Nachricht (Sollte zukünftig nicht mehr verwendet werden)

MQQueue.alternate
UserId

Alternative User-ID um den Zugriff auf die Warteschlange zu prüfen, wenn diese geöffnet ist. Dieser Parameter kann nicht gesetzt werden, während das Objekt geöffnet ist.

MQQueue.openOptions.
MQC.MQOO_OUTPUT

(Muss bei schreibendem Zugriff gesetzt werden)

MQQueue.openOptions.
MQC.MQOO_FAIL_
IF_QUIESCING

Erlaubt dem MQ-Manager, den Listener zu trennen (z. B. beim Herunterfahren)

MQQueue.openOptions.
MQC.MQDL_SUPPORTED

MQ-spezifischer Parameter

MQQueue.openOptions.
MQC.MQOO_ALTERNATE_
USER_AUTHORITY

MQ-spezifischer Parameter

MQQueue.openOptions.
MQC.MQOO_ BIND_AS_
QDEF

Queue-Einstellungen zur Persistenz etc. übernehmen (sollte immer gesetzt werden)

Mögliche Werte:

  • ja: Queue-Einstellungen übernehmen

  • nein: Keine Queue-Einstellungen übernehmen (Standard)

MQQueue_openOptions.
MQC.MQOO_BIND_
NOT_FIXED

MQ-spezifischer Parameter

MQQueue_openOptions.
MQC.MQOO_BIND_ON_
OPEN

MQ-spezifischer Parameter

MQQueue.openOptions.
MQC.MQOO_INPUT_AS_
Q_DEF

Einstellungen der Queue zur Persistenz etc. übernehmen (muss beim Lesen immer gesetzt werden)

Mögliche Werte:

  • ja: Queue-Einstellungen übernehmen

  • nein: Keine Queue-Einstellungen übernehmen (Standard)

MQQueue.openOptions.
MQC.MQOO_INPUT_SHARED

MQ-spezifischer Parameter

MQQueue.openOptions.
MQC.MQOO_INPUT_
EXCLUSIVE

MQ-spezifischer Parameter

MQQueue.openOptions.
MQC.MQOO_INQUIRE

MQ-spezifischer Parameter

MQQueue.openOptions.
MQC.MQOO_PASS_ALL_
CONTEXT

MQ-spezifischer Parameter

MQQueue.openOptions.
MQC.MQOO_PASS_
IDENTITY_CONTEXT

MQ-spezifischer Parameter

MQQueue.openOptions.
MQC.MQOO_SAVE_ALL_
CONTEXT

MQ-spezifischer Parameter

MQQueue.openOptions.
MQC.MQOO_SET

MQ-spezifischer Parameter

MQQueue.openOptions.
MQC.MQOO_SET_ALL_
CONTEXT

MQ-spezifischer Parameter

MQQueue.openOptions.
MQC.MQOO_SET_
IDENTITY_CONTEXT

MQ-spezifischer Parameter

MQPutMessageOptions.
options.MQC.MQPMO_
NEW_MSG_ID

MQ-spezifischer Parameter

MQPutMessageOptions.
options.MQC.
MQPMO_SYNCPOINT

Syncpoint beim Schreiben verwenden

Mögliche Werte:

  • ja: Syncpoint beim Schreiben verwenden

  • nein: Keinen Syncpoint beim Schreiben verwenden (Standard)

MQQueue.
closeOptions.MQC.
MQCOO_DELETE

MQ-spezifischer Parameter

MQQueue.
closeOptions.MQC.
MQCOO_DELETE_
PURGE

MQ-spezifischer Parameter

MQMessage.format

Nachrichtenformat

Mögliche Werte:

  • MQC.MQFMT_STRING: Nachricht besteht komplett aus Zeichen

  • MQC.MQFMT_ADMIN: Befehl-Server-Anfrage/Antwort

  • MQC.MQFMT_COMMAND1: 1 Befehl-Server-Antwortnachricht vom Typ 1

  • MQC.MQFMT_COMMAND2: 2 Befehl-Server-Antwortnachricht vom Typ2

  • MQC.MQFMT_DEAD_LETTER_HEADER: Dead-letter Header

  • MQC.MQFMT_EVENT: Event

  • MQC.MQFMT_NONE: Kein Formatname, es findet keine Konvertierung statt (d. h. die Bytes werden original geliefert); wenn zudem Parameter toXML aktiviert ist, dann wird die Nachricht Base64-kodiert

  • MQC.MQFMT_PCF: Benutzerdefinierte Nachricht im Programmable Command Format

  • MQC.MQFMT_TRIGGER: Trigger-Nachricht

  • MQC.MQFMT_XMIT_Q_HEADER: Transmission Queue Header

  • (kein Wert): Nicht konvertieren (entspricht MQC.MQFMT_NONE) (Standard)

MQMessage.
applicationIdData

MQ-spezifischer Parameter

MQMessage.
application
OriginData

MQ-spezifischer Parameter

MQMessage.
backoutCount

MQ-spezifischer Parameter

MQMessage.
messageFlags.MQC.
MQMT_REQUEST

MQ-spezifischer Parameter

MQMessage.
replyToQueueName

Name der ReplyToQueue für diese Nachricht

MQMessage.
replyToQueueManager
Name

Name des ReplyToQueueManagers für diese Nachricht

Mögliche Werte:

Beliebige Zeichenkette

MQMessage.
characterSet

Charset (CCSID) für die Nachricht. Beim Auslesen: das erwartete Charset. Beim Schreiben: das Charset, das die Nachricht bekommt.

Mögliche Werte:

Beliebige CCSID (z. B. 1208)

MQMessage.
correlationId

CorrelationID mit 24 Byte Länge (diese ist ebenso wie die zurückgegebene MessageID Base64-kodiert)

Mögliche Werte:

Beliebige Zeichenkette mit 32 Zeichen, die eine Base64-kodierte CorrelationID mit 24 Byte Länge enthält

MQMessage.encoding

Zeichenkodierung der Nachricht

MQMessage.expiry

Zeit in Zehntelsekunden, nach der die Nachricht ungültig wird und aus der Queue gelöscht wird.

Mögliche Werte:

Beliebige ganze Zahl

MQMessage.feedback

MQ-spezifischer Parameter

MQMessage.groupId

MQ-spezifischer Parameter

MQMessage.messageId

MQ-spezifischer Parameter

MQMessage.
messageSequence
Number

MQ-spezifischer Parameter

MQMessage.message
Type

MQ-spezifischer Parameter

MQMessage.offset

MQ-spezifischer Parameter

MQMessage.
originalLength

MQ-spezifischer Parameter

MQMessage
.persistence

MQ-spezifischer Parameter

MQMessage.priority

MQ-spezifischer Parameter

MQMessage.
putApplicationType

MQ-spezifischer Parameter

MQMessage.report

MQ-spezifischer Parameter

MQMessage.userId

MQ-spezifischer Parameter

MQGetMessageOptions.
options.MQC.
MQGMO_SYNCPOINT

Syncpoint beim Empfangen von Nachrichten verwenden (erforderlich für die Operationen Commit und Rollback)

Mögliche Werte:

  • ja: Syncpoint beim Empfangen verwenden

  • nein: Keinen Syncpoint beim Empfangen verwenden (Standard)

MQGetMessageOptions.
options.MQC.
MQGMO_WAIT

Beim Auslesen warten, wenn sich keine Nachricht in der Queue befindet

MQGetMessageOptions.
options.MQC.
MQGMO_NO_WAIT

Beim Auslesen nicht warten, wenn sich keine Nachricht in der Queue befindet, und sofort abbrechen

Mögliche Werte:

  • ja: Nicht warten und sofort abbrechen

  • nein: Warten (Standard)

MQGetMessageOptions.
options.MQC.
MQGMO_ACCEPT_
TRUNCATED_MSG

MQ-spezifischer Parameter

MQGetMessageOptions.
options.MQC.
MQGMO_BROWSE_FIRST

MQ-spezifischer Parameter

MQGetMessageOptions.
options.MQC.
MQGMO_BROWSE_MSG
_UNDER_CURSOR

MQ-spezifischer Parameter

MQGetMessageOptions.
options.MQC.
MQGMO_BROWSE_NEXT

MQ-spezifischer Parameter

MQGetMessageOptions.
options.MQC.
MQGMO_CONVERT

Automatische Konvertierung in MQ aktivieren

Mögliche Werte:

  • ja: Konvertierung aktivieren

  • nein: Keine Konvertierung (Standard)

MQGetMessageOptions.
options.MQC.MQGMO_
FAIL_IF_QUIESCING

MQ-spezifischer Parameter

MQGetMessageOptions.
options.MQC.
MQGMO_LOCK

MQ-spezifischer Parameter

MQGetMessageOptions.
options.MQC.
MQGMO_MSG_UNDER_
CURSOR

MQ-spezifischer Parameter

MQGetMessageOptions.
options.MQC.
MQGMO_NONE

Alle anderen GetOptions ignorieren

Mögliche Werte:

  • ja: Alle anderen GetOptions ignorieren

  • nein: Andere GetOptions nicht ignorieren (Standard)

MQGetMessageOptions.
options.MQC.MQGMO_
MARK_SKIP_BACKOUT

MQ-spezifischer Parameter

MQGetMessageOptions.
options.MQC.
MQGMO_NO_SYNCPOINT

Syncpoint deaktivieren

Mögliche Werte:

  • ja: Syncpoint deaktivieren (damit ist keine Transaktion möglich)

  • nein: Syncpoint nicht deaktivieren (Standard)

MQGetMessageOptions.
options.MQC.MQGMO_
SYNCPOINT_IF_
PERSISTENT

Syncpoint nutzen, wenn die Nachricht als persistent gekennzeichnet ist

Mögliche Werte:

  • ja: Syncpoint bei persistenten Nachrichten nutzen

  • nein: Keinen Syncpoint bei persistenten Nachrichten nutzen (Standard)

MQGetMessageOptions.
options.MQC.MQGMO_
UNLOCK

MQ-spezifischer Parameter

MQGetMessageOptions.
options.MQC.
MQGMO_ALL_MSGS_
AVAILABLE

MQ-spezifischer Parameter

MQGetMessageOptions.
options.MQC.
MQGMO_ALL_SEGMENTS_
AVAILABLE

MQ-spezifischer Parameter

MQGetMessageOptions.
options.MQC.
MQGMO_COMPLETE_MSG

MQ-spezifischer Parameter

MQGetMessageOptions.
options.MQC.
MQGMO_LOGICAL_ORDER

MQ-spezifischer Parameter

MQGetMessageOptions.
matchOptions.MQC.
MQGMO_MATCH_
CORREL_ID

MQ-spezifischer Parameter

MQGetMessageOptions.
matchOptions.MQC.
MQGMO_MATCHGROUP_ID

MQ-spezifischer Parameter

MQGetMessageOptions.
matchOptions.MQC.
MQGMO_MATCH_MSG_ID

MQ-spezifischer Parameter

MQGetMessageOptions.
matchOptions.MQC.
MQGMO_MATCH_MSG_
SEQ_NUMBER

MQ-spezifischer Parameter

MQGetMessageOptions.
matchOptions.
MQC_MQGMO_NONE

MQ-spezifischer Parameter

MQGetMessageOptions.
waitInterval

Zeit in Millisekunden, die beim Auslesen gewartet wird, wenn sich keine Nachrichten in der Queue befinden (siehe Parameter MQGetMessageOptions.options.MQC.MQGMO_WAIT). Der Nachrichtenempfang wird nicht abgebrochen, wenn er während des Warte-Intervalls begonnen wurde.

Mögliche Werte:

Beliebige positive ganze Zahl

MQGetMessageOptions.
resolvedQueueName

MQ-spezifischer Parameter

Weitere Informationen zu den MQ-spezifischen Parametern finden Sie unter https://www.ibm.com/docs/en/ibm-mq/8.0?topic=java-mqenvironment.


Statuswerte

1

Die Operation wurde erfolgreich ausgeführt.

0

Die Operation wurde erfolgreich ausgeführt, jedoch ohne Ergebnis.

-1

Die Operation ist aufgrund eines technischen Fehlers fehlgeschlagen.


Beispiel

Das erzeugte XML-Dokument, wenn Eigenschaft Operation auf Receive gesetzt wurde, besitzt folgende Struktur:

<document>
<header>
   <CorrelationID>AAAAAAAAAAAAAAAAAAAAA</CorrelationID>
   <MessageID>QU1RIFFNX3NwX2Nvbm5lYxvAdUQgC9sH</MessageID>
   <MessageSequenceNr>1</MessageSequenceNr>
   <MessageFormat>MQSTR</MessageFormat>
   <ReplyToQueue/>
   <ReplyToQueueMngr>QM_sp_connect</ReplyToQueueMngr>
   <backoutCount>0</backoutCount>
</header>
<body>Message</body>
</document>


 

Weitere Informationen zu den MQ-Series-spezifischen Parametern erhalten Sie von dessen Hersteller IBM in der englischsprachigen Dokumentation WebSphere MQ – Using Java in Kapitel 9 The WebSphere MQ base Java classes and interfaces.