X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Websphere MQ Connector

Der Adapter Sendet, empfängt und zählt Nachrichten einer IBM Websphere MQ-Nachrichten-Warteschlange und unterstützt dabei die MQ-Version 7.

Hinweis:

Beachten Sie, dass dieser Adapter unabhängig von der Warteschlangen-Konfiguration des MQ Series Transfer Adapters (innerhalb von x4.ear erfolgt dies in der Datei conf/QueueConfig.xml) arbeitet.

Eigenschaften (Properties)

Operation

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

Mögliche Werte:

  • Send: Daten aus dem vorangegangen Prozess-Schritt an die MQ Series-Warteschlange senden

  • Receive: Nachricht in den Technical Process einlesen

  • Commit: Transaktion abschließen

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

  • Count: Anzahl der Nachrichten in der Warteschlange in einem XML-Dokument ausgeben

Parameter

toXML

Wenn Eigenschaft Operation auf Receive gesetzt wurde: Ergebnis des Prozess-Schritts als XML-Dokument ausgeben; Wenn zudem 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 Prozess-Schritts eine MQ-Nachricht generieren (Standard)

ccdtUrl

URL zu einer Client Channel Definition Table (CCDT)

Es gibt drei verschiedene 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 den Parameter ccdtUrl im Adapter selbst

Dabei wird die oben genannte Priorität angewendet.

RemoteQueueManager_name

Name des Queue-Managers

MQEnvironment_
hostname

Hostname des angesprochenen MQ-Servers; gilt Java-VM-weit (der Parameter wird nur für lokale Tests auf Entwicklungsystemen benötigt, sonst bleibt er leer)

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

MQEnvironment_
channel

Name des Channels; gilt Java-VM-weit (nur für lokale Tests auf Entwicklungsystemen benötigt, sonst leer)

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

MQEnvironment_CCSID

CCSID (Charset) aller Nachichten für die gesamte Java-VM; deshalb Vorsicht bei der Benutzung (sollte nicht benutzt werden!)

Mögliche Werte: Beliebige CCSID (z.B. 1208)

MQEnvironment_userID

Benutzer-ID zur Authentifizierung des WebSphere MQ Clients

MQEnvironment_
localAddress Setting

MQ-spezifischer Parameter

MQEnvironment_
password

Passwort zur Authentifizierung des WebSphere MQ Clients

MQEnvironment_port

Port des MQ-Servers; gilt Java-VM-weit (nur für lokale Tests auf Entwicklungsystemen benötigt, sonst leer)

Mögliche Werte: Beliebige ganze Zahl (z.B. 1414)

MQEnvironment_
properties_MQC_
TRANSPORT_PROPERTY

Einstellung für die Verbindung

Mögliche Werte: MQC.TRANSPORT_MQSERIES: Einziger zulässiger Wert

MQEnvironment_
properties_MQC_
CCSID_PROPERTY

CCSID (Charset) für die Verbindung

Mögliche Werte: Beliebige ganze Zahl (z.B. 1208)

MQEnvironment_
properties_MQC_
USER_ID_PROPERTY

Benutzer-ID für die Verbindung

Mögliche Werte: Beliebige Zeichenkette

MQEnvironment_
properties_MQC_
CHANNEL_PROPERTY

Name des Kanals für die Verbindung

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

MQEnvironment_
properties_MQC_
CONNECT_OPTIONS_PROPERTY

Verbindungsoptionen

Mögliche Werte: Beliebige Zeichenkette

MQEnvironment_
properties_MQC_
HOST_NAME_PROPERTY

Hostname des angesprochenen MQ-Servers für die Verbindung

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

MQEnvironment_
properties_MQC_
LOCAL__ADDRESS_PROPERTY

Lokale Adresse für die Verbindung

Mögliche Werte: Beliebige Zeichenkette

MQEnvironment_
properties_MQC_
ORB_PROPERTY

ORB-Eigenschaft für die Verbindung

Mögliche Werte: Beliebige Zeichenkette

MQEnvironment_
properties_MQC_
PASSWORD_PROPERTY

Passwort-Eigenschaft für den Verbindungsaufbau, um den WebSphere MQ Client zu authentifizieren (entspricht Parameter MQEnvironment_password)

Mögliche Werte: Beliebige Zeichenkette

MQEnvironment_
properties_MQC_
PORT_PROPERTY

Port für die Verbindung

Mögliche Werte: Beliebige Zeichenkette

MQEnvironment_
properties_MQC_
RECEIVE_EXIT_PROPERTY

Receive Exit -Eigenschaft für die Verbindung

Mögliche Werte: Beliebige Zeichenkette

MQEnvironment_
properties_MQC_
SECURITY_EXIT_PROPERTY

Security Exit -Eigenschaft für die Verbindung

Mögliche Werte: Beliebige Zeichenkette

MQEnvironment_
properties_MQC_
SEND_EXIT_PROPERTY

Send Exit -Eigenschaft für die 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

Mögliche Werte: Beliebige gültige Zeichenkette

MQQueue_dynamicQueue
Name

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

Mögliche Werte: Beliebige gültige Zeichenkette

MQQueue_alternateUserId

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:

  • true: Queue-Einstellungen übernehmen

  • false: 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:

  • true: Queue-Einstellungen übernehmen

  • false: 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 von Nachrichten verwenden (erforderlich für die Operationen Commit und Rollback)

Mögliche Werte:

  • true: Syncpoint beim Schreiben verwenden

  • false: 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_application
IdData

MQ-spezifischer Parameter

MQMessage_application
OriginData

MQ-spezifischer Parameter

MQMessage_backoutCount

MQ-spezifischer Parameter

MQMessage_messageFlags
_
MQC_MQMT_REQUEST

MQ-spezifischer Parameter

MQMessage_replyTo
QueueName

Name der ReplyToQueue für diese Nachricht

MQMessage_replyToQueue
ManagerName

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_message Id

MQ-spezifischer Parameter

MQMessage_message
SequenceNumber

MQ-spezifischer Parameter

MQMessage_messageType

MQ-spezifischer Parameter

MQMessage_offset

MQ-spezifischer Parameter

MQMessage_originalLength

MQ-spezifischer Parameter

MQMessage_persistence

MQ-spezifischer Parameter

MQMessage_priority

MQ-spezifischer Parameter

MQMessage_put
ApplicationType

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:

  • true: Syncpoint beim Empfangen verwenden

  • false: 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:

  • true: Nicht warten und sofort abbrechen

  • false: 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:

  • true: Konvertierung aktivieren

  • false: 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:

  • true: Alle anderen GetOptions ignorieren

  • false: 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:

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

  • false: Syncpoint nicht deaktivieren (Standard)

MQGetMessageOptions_
options_MQC_MQGMO_
SYNCPOINT_IF_PERSISTENT

Syncpoint nutzen, wenn die Nachricht als persistent gekennzeichnet ist

Mögliche Werte:

  • true: Syncpoint bei persistenten Nachrichten nutzen

  • false: 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_MATCH_GROUP_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

Hinweis:

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.

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.

Operation: Receive

Mit Operation Receive lassen sich Nachrichten aus der Warteschlange in den Technical Process einlesen.

Input

Für Operation Receive erwartet der Adapter kein Input-Dokument.

Output

Für Operation Receive und wenn Eigenschaft Operation auf Receive gesetzt wurde, gibt der Adapter beispielsweise folgendes XML-Dokument aus:

<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>

Operation: Count

Input

Für Operation Count erwartet der Adapter kein Input-Dokument.

Output

Für Operation Count gibt der Adapter ein XML-Dokument aus, das im Wurzel-Element <Count> die Anzahl der Nachrichten in der Warteschlange enthält.

<Count><!--Nachrichtenanzahl--><Count>