Skip to content

Commit

Permalink
Minor documentation clean-up
Browse files Browse the repository at this point in the history
- Removing 'InfoSphere' name in documentation
- Version bump v5.3.7 -> v5.3.8
  • Loading branch information
schulz2 committed Jun 11, 2018
1 parent e5ce7fd commit b2a5b80
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions com.ibm.streamsx.messaging/info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
<info:identity>
<info:name>com.ibm.streamsx.messaging</info:name>
<info:description>
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
Expand All @@ -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.
Expand All @@ -50,18 +50,18 @@ 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
is not needed.

* 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=&quot;/home/streamsuser/ApacheActiveMQ&quot;
Expand All @@ -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,
Expand All @@ -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::*;
Expand All @@ -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
Expand Down Expand Up @@ -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 &lt;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.
Expand Down Expand Up @@ -678,7 +678,7 @@ The &lt;attribute> element has three possible attributes:
* composite types
* xml
</info:description>
<info:version>5.3.7</info:version>
<info:version>5.3.8</info:version>
<info:requiredProductVersion>4.2.0.0</info:requiredProductVersion>
</info:identity>
<info:dependencies/>
Expand Down

0 comments on commit b2a5b80

Please sign in to comment.