Adapter type: wsmq_out. The default WebSphere MQ Output adapter publishes a string in CSV format.
The WebSphere MQ adapter does not produce a header line because the schema of the stream publishing to the adapter determines the order and datatypes of the fields. Columns are published in the default display format for the appropriate datatype. The adapter prepends stream names and opcode instructions (insert, delete, update, upsert) to CSV data added to a queue. See the prependStreamNameOpcode property.
To run the adapter successfully in Linux and UNIX installations, set the LD_LIBRARY_PATH to point to the MQ client libraries to run the adapter successfully.
If you use the CCL ATTACH ADAPTER statement to attach an adapter, you must supply the adapter type.
| Property Label | Property ID | Type | Description |
|---|---|---|---|
| Queue Name | QueueName | string | (Required) Name of the queue on the server to send messages. This queue must be managed by the indicated Queue Manager Name. No default value. |
| Queue Manager Name | QueueManagerName | string | (Required) Name of the queue manager on the server to send messages. No default value. |
| MQ System Name | SystemName | string | (Required) Name of the MQ server system. This may be a symbolic name or an IP address. No default value. |
| Port | Port | string | (Required) Port number on the MQ server system to which the MQ server queue listener is attached. No default value. |
| MQ Channel | Channel | string | (Required) Name of the MQ server channel associated with the queue. No default value. |
| CSV Field Separator | CsvSeparatorChar | string | (Optional) The CSV field separator, specify a single character. Default value is a comma ( , ). |
| CSV Escape Character | CsvEscapeChar | string | (Optional) The character to escape the meaning of special characters, including the field separator, escape character, and quote character. Default value is a backslash ( \ ). |
| CSV Quote Character | CsvQuoteChar | string | (Optional) The character to delineate the beginning and end of a field, which can include anything. Any embedded quote characters are escaped. Default value is a double quote ( " ). |
| Prepend Stream Name, Opcode | prependStreamNameOpcode | boolean | (Advanced) If true, every CSV record is prepended with stream name and an opcode. Default value is false. |
| Timestamp Column Format | TimestampColumnFormat | string | (Advanced) The format for timestamp values. Default value is YYYY-MM-DDTHH:MM:SS.SSS. |
| Date Column Format | DateColumnFormat | string | (Advanced) The format in which date values are stored in the file. Default value is YYYY-MM-DDTHH:MM:SS.SSS. |
Runs Adapter in GD Mode |
enableGDMode | boolean | (Advanced) If set to true, the adapter runs in guaranteed delivery (GD) mode and all GD-related parameters become required. Default value is false. |
Name of Column Holding GD Key |
gdKeyColumn | string | (Advanced) Specifies column name in the Flex operator holding the GD key. The GD key is a constantly increasing value that uniquely identifies every event regardless of the opcode in the stream of interest. No default value. |
Name of Column Holding opcode |
gdOpcodeColumn | string | (Advanced) Specifies name of column in Flex operator holding opcode. The opcode is the operation code (for example, inserts, update, or delete) of the event occurring in the stream of interest. No default value. |
Name of Truncate Stream |
gdControlStream | string | (Advanced) Specifies name of the control window in the GD setup. The control window is a source stream that informs the Flex operator of which data has been processed by the adapter and can be safely deleted. No default value. |
Purge After Number of Records |
gdPurgeInternal | int | (Advanced) Specifies number of records after which to purge the Flex operator. Default value is 1000. |
Batch Size to Update Truncate Stream |
gdBatchSize | int | (Advanced) Specifies number of records after which the control window must be updated with the latest GD key. Default value is 1000. |
PropertySet |
propertyset | string | (Advanced) Specifies the name of the property set from the project configuration file. If you specify the same properties in the project configuration file and the ATTACH ADAPTER statement, the values in the property set override the values defined in the ATTACH ADAPTER statement. No default value. |