From b2a5b80a05fb213d30cd0bcadc855b509f67479e Mon Sep 17 00:00:00 2001 From: schulz2 Date: Mon, 11 Jun 2018 14:29:40 +0200 Subject: [PATCH] Minor documentation clean-up - Removing 'InfoSphere' name in documentation - Version bump v5.3.7 -> v5.3.8 --- com.ibm.streamsx.messaging/info.xml | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/com.ibm.streamsx.messaging/info.xml b/com.ibm.streamsx.messaging/info.xml index e7bebe2..d2f4e92 100644 --- a/com.ibm.streamsx.messaging/info.xml +++ b/com.ibm.streamsx.messaging/info.xml @@ -5,11 +5,11 @@ com.ibm.streamsx.messaging -The Messaging toolkit project is an open source IBM InfoSphere Streams toolkit project. -It is focused on the development of operators and functions that help you use InfoSphere Streams +The Messaging toolkit project is an open source IBM Streams toolkit project. +It is focused on the development of operators and functions that help you use IBM Streams to interact with messaging systems such as Kafka, JMS, XMS, and MQTT. -The operators provide the ability for InfoSphere Streams applications to send and receive data +The operators provide the ability for IBM Streams applications to send and receive data from a queue or topic that is posted on Kafka, WebSphere MQ, Apache ActiveMQ or MQ Telemetry Transport (MQTT) server. In particular, the `XMSSource` and `XMSSink` operators in the Messaging Toolkit use the standard XMS architecture @@ -29,7 +29,7 @@ The `KafkaProducer` and `KafkaConsumer` operators support Kafka v0.10.0.0 broker **Restriction**: The `XMSSource` and `XMSSink` operators in the Messaging Toolkit are not supported on RHEL 7 platforms. The following figure shows how the `XMSSink` and `XMSSource` operators in the Messaging Toolkit use standard XMS architecture and APIs. -{doc/images/8751_dgm1.gif|This diagram illustrates the XMS APIs that are used to communicate between InfoSphere Streams, an XMS client, and a WebSphere MQ server.} +{doc/images/8751_dgm1.gif|This diagram illustrates the XMS APIs that are used to communicate between IBM Streams, an XMS client, and a WebSphere MQ server.} For example: * The `CreateProducer` API creates a message producer to send messages to the specified destination. @@ -50,9 +50,9 @@ or the SPL compiler to be aware of the location of the toolkit. # Before you begin -* Install IBM InfoSphere Streams. Configure the product environment variables by entering the following command: +* Install IBM Streams. Configure the product environment variables by entering the following command: source product-installation-root-directory/4.0.0.0/bin/streamsprofile.sh -* Install a supported version of WebSphere MQ Client, Apache ActiveMQ and XMS client on the same machine as InfoSphere Streams. +* Install a supported version of WebSphere MQ Client, Apache ActiveMQ and XMS client on the same machine as IBM Streams. WebSphere MQ Server might or might not be on the same machine. For Kafka and MQTT, the toolkit ships with a set of required clients, and therefore this configuration @@ -60,8 +60,8 @@ or the SPL compiler to be aware of the location of the toolkit. * Apache ActiveMQ * The `JMSSource` and `JMSSink` operators support Apache ActiveMQ 5.7 and up. - * The Apache ActiveMQ libraries must be installed on same machine as IBM InfoSphere Streams - because the `JMSSink` and `JMSSource` operators require the libraries that are installed with IBM InfoSphere Streams. + * The Apache ActiveMQ libraries must be installed on same machine as IBM Streams + because the `JMSSink` and `JMSSource` operators require the libraries that are installed with IBM Streams. However, the ActiveMQ instance to which a message is sent can be a different machine. You must set the **STREAMS_MESSAGING_AMQ_HOME** environment variable to the location where Apache ActiveMQ is installed. For example: export STREAMS_MESSAGING_AMQ_HOME="/home/streamsuser/ApacheActiveMQ" @@ -86,7 +86,7 @@ Alternatively, you can fully qualify the operators that are provided by toolkit # Procedure -1. Review the list of restrictions for the InfoSphere Streams specialized toolkits in the product documentation. +1. Review the list of restrictions for the IBM Streams specialized toolkits in the product documentation. For example, the `XMSSource` and `XMSSink` operators are supported on x86_64 systems. 2. Verify that the appropriate environment variables are set for the messaging systems that you use. * If you use `JMSSink` or `JMSSource` operators to connect to WebSphere MQ or Apache ActiveMQ systems, @@ -101,7 +101,7 @@ Alternatively, you can fully qualify the operators that are provided by toolkit sc -t $STREAMS_INSTALL/toolkits/com.ibm.streamsx.messaging -M MyMain where MyMain is the name of the SPL main composite. **Note**: These command parameters override the **STREAMS_SPLPATH** environment variable. - * Add the toolkit location in InfoSphere Streams Studio. + * Add the toolkit location in IBM Streams Studio. 4. Develop your application. To avoid the need to fully qualify the operators, add a use directive in your application. * For example, you can add the following clause in your SPL source file: use com.ibm.streamsx.messaging.jms::*; @@ -114,7 +114,7 @@ Alternatively, you can fully qualify the operators that are provided by toolkit use com.ibm.streamsx.messaging.xms::XMSSource; use com.ibm.streamsx.messaging.kafka::KafkaConsumer; 5. Build your application. You can use the **sc** command or Streams Studio. -6. Start the InfoSphere Streams instance. +6. Start the IBM Streams instance. 7. Run the application. You can submit the application as a job by using the **streamtool submitjob** command or by using Streams Studio. + Connection specifications document @@ -441,7 +441,7 @@ When the message_class attribute value is `bytes`: When the message_class attribute value is `empty`: * The `XMSSink` operator construct an empty XMS message. The `JMSSink` operator construct an empty JMS message. - For example, you can use an empty XMS message to verify that your InfoSphere Streams application can connect + For example, you can use an empty XMS message to verify that your IBM Streams application can connect to the WebSphere MQ server and that the message reaches its destination. **Note**: This message_class value cannot be used with a <native_schema> element. * The `XMSSource` operator expects an empty XMS message. It emits a tuple with attribute values that are assigned by the SPL program. @@ -678,7 +678,7 @@ The <attribute> element has three possible attributes: * composite types * xml - 5.3.7 + 5.3.8 4.2.0.0