IBMStreams com.ibm.streamsx.messaging Toolkit > com.ibm.streamsx.messaging 5.4.3 > com.ibm.streamsx.messaging.xms > XMSSink
DEPRECATED: The com.ibm.streamsx.messaging.xms.XMSSink operator is deprecated. There is no toolkit providing a replacement operator. The deprecated operator might be removed in a future release.
The XMSSink operator takes messages from IBM InfoSphere Streams and can send them to a WebSphere MQ queue or topic.
The incoming tuple from InfoSphere Streams can be one or many of the following data types: int8, uint8, int16, uint16, int32, uint32, int64, float32, float64, boolean, blob, or rstring. The input tuple is serialized into a WebSphere MQ message either as a map, stream, bytes, xml, wbe, or wbe22 message, according to the value of the message_class attribute in the connection specifications document. An additional empty value can be specified in the message_class attribute, in which case the operator constructs an empty JMS or XMS message. This message class cannot be used with a native schema.
The XMSSink operator supports consistent regions. This operator can be part of a consistent region but it cannot be at the start of a consistent region.
In all of these cases, the operator logs the exception in the console logs. The information about the exception is also sent to the optional error output port, unless it is a run time error that halts the operator or a compile time error.
Required: access, connection
Optional: connectionDocument, period, reconnectionBound, reconnectionPolicy
The XMSSink operator is configurable with a single input data port, which is required. The input port is non-mutating and its punctuation mode is Oblivious.
The XMSSink operator is configurable with an optional port that submits a tuple when an error occurs. The optional port is mutating and its punctuation mode is Free.
The error output port contains an optional first attribute which contains the input tuple that caused the error and a second attribute of type rstring that details the error message. Only one error message is sent per failed tuple.
Required: access, connection
Optional: connectionDocument, period, reconnectionBound, reconnectionPolicy
This mandatory parameter identifies the access specification name.
This mandatory parameter identifies the name of the connection specification that contains an XMS element.
This optional parameter specifies the path name of the file that contains the connection and access specifications, which are identified by the connection and access parameters. If the parameter is specified, it must have exactly one value that is a string constant. If the parameter is not specified, the operator uses the file that is in the default location ../etc/connections.xml. If a relative path is specified, the path is relative to the root of the application directory.
This optional parameter specifies the time period in seconds the operator waits before it tries to reconnect. You can use this parameter only when the reconnectionPolicy parameter is specified, otherwise a compile time error occurs. The default value for the period parameter is 60.
This optional parameter specifies the number of successive connections that are attempted for an operator. You can use this parameter only when the reconnectionPolicy parameter is specified and set to BoundedRetry, otherwise a compile time error occurs. If the reconnectionBound parameter is specified and the reconnectionPolicy parameter is not set, a compile time error occurs. The default value for the reconnectionBound parameter is 5.
This is an optional parameter that specifies the reconnection policy. The valid values are NoRetry, InfiniteRetry, and BoundedRetry. If the parameter is not specified, the reconnection policy is set to BoundedRetry with a reconnectionBound of 5 and a period of 60 seconds.
() as ${sinkPrefix}Sink = XMSSink(${inputStream}) {
param
connection : "${ConnectionSpecificationName}";
access : "${AccessSpecificationName}";
}
The number of connection attempts that are made before a successful connection.
The number of failed inserts to the WebSphere MQ. Failed insertions can occur when a message is dropped because of a run time error.
The number of tuples that have truncated attributes when they are converted to a message.