WebSphere Message Broker, Version 8.0.0.7 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

Samples

The WebSphere® Message Broker Toolkit provides samples that show the features that are available in WebSphere Message Broker, and how to use them. This topic provides links to the information about the individual samples.

Use the samples to learn how to use WebSphere Message Broker.

  • You can view information about samples only when you use the information center that is integrated with the WebSphere Message Broker Toolkit or the online information center. You can run samples only when you use the information center that is integrated with the WebSphere Message Broker Toolkit.
  • Not all samples work in all modes. If you try to use a sample in a mode that is restricted, you receive a message indicating the reason; see Restrictions that apply in each operation mode. You can run all samples in a development and unit test broker; see Development and unit test.
  • You might receive the following error:
    SEVERE: Could not find the connection files.
    If you receive this error, copy the .broker file for your default broker from the runtime workspace in which you created your default configuration to your current runtime workspace.
  • To ensure that all available samples are displayed in the Samples and Tutorials tab in the WebSphere Message Broker Toolkit, in the "More samples" panel in the Samples and Tutorials tab click Retrieve and select the sample categories that you want to display.
  • Note: A message set is the original container for message models used by WebSphere Message Broker. In WebSphere Message Broker Version 8.0 and later, message model schema files contained in applications and libraries are the preferred way to model messages for most data formats. Message sets continue to be supported, and are required if you use the MRM or IDOC domains. If you need to model data formats for use in the MRM or IDOC domains, you must first enable message set development in the WebSphere Message Broker Toolkit. For more information, see Enabling message set development .

The samples are categorized as either Application or Technology samples.

Application samples
The Application samples are small end-to-end WebSphere Message Broker message flow applications that show how to transform and route messages through message flows.
Technology samples
The Technology samples are small WebSphere Message Broker message flow applications that each show a specific feature of WebSphere Message Broker.

Before you can use the samples, you must create the Default Configuration, see Creating the Default Configuration.

The following table lists the Application samples that are available in WebSphere Message Broker.

Sample name Description
Airline Reservations This sample shows how to use a range of nodes, including nodes for aggregation, routing, tracing, filtering, and updating database tables.
Coordinated Request Reply This sample contains two applications and one library. The library references a message set and broker project that are shared by both the applications. This sample demonstrates:
  • How two WebSphere MQ applications that have different message formats communicate with each other by using WebSphere MQ messages in a request-reply processing pattern, which is coordinated by using an MQGet node
  • How two JMS applications that have different message formats communicate with each other by using JMS messages in a request-reply processing pattern, which is coordinated by using a JMSReceive node
DatabaseInput Node This sample demonstrates how to take data from a database, as it is being updated, and process the data within WebSphere Message Broker.
Data Warehouse This sample contains a message flow that archives data, such as sales data, to a database.
Error Handler This sample contains a message flow and a subflow to show error handling in message flows.
Large Messaging This sample shows how to process messages that contain repeating structures, and how to minimize the virtual storage requirements for the message flow.
Message Routing This sample shows how to use a message flow to route messages to different WebSphere MQ queues based on data that is stored in a database table or a file.
Pager This sample shows simple point-to-point messaging and publish/subscribe messaging. Use graphical interfaces to send text messages to a pager application, or to subscribe to publications about the surf on selected beaches.
Scribble This sample is a small, graphical whiteboard application on which you draw by using your mouse pointer. Depending on the options you choose, you can see the effects of message transformation by using WebSphere MQ transport or RealTime transport.
Solar Pattern Authoring This sample shows how to build a WebSphere Message Broker pattern. The sample provides an example Message Broker project that calculates the sunrise and sunset times in a PHPCompute node. The sample also provides a pattern authoring project that configures a pattern.
User-defined Extension These two samples show the use of user-defined nodes that are written in the C and Java™ programming languages.
Video Rental This sample shows message transformation between three different formats: XML, Custom Wire Format (CWF), and Tagged/Delimited String (TDS) Format.
WBI JDBC Adapter Migration This sample re-creates a scenario of migrating a JDBC adapter to invoke a message flow, by using an MQInput node with the built-in DatabaseInput node.
Web Service Aggregation This sample demonstrates how to invoke a number of web services and amalgamate the results by using WebSphere Message Broker aggregation nodes. The sample illustrates how aggregation can be used for transports other than WebSphere MQ, and highlights issues to be aware of. The sample also shows how you can use message flow monitoring to audit data across the aggregation fan-out and fan-in by using Collector node techniques.

The following tables list the Technology samples that are available in WebSphere Message Broker.

Control and Routing samples

Sample name Description
Aggregation This sample shows how to use the Aggregation nodes to perform a basic four-way aggregation operation, with simple fan-out and fan-in message flows.
Collector Node This sample shows how to configure the Collector node to gather input from different input sources. It also shows some alternative methods for completing collections.
Simplified Database Routing This sample shows how to use the following range of simplified (non-programming) message flow nodes: Route, DatabaseRoute, and DatabaseRetrieve. The sample illustrates how to access databases by using JDBC, and how to use values that are held in an acquired result set, gathered from a database query, to either dynamically route messages or update the content of the messages.
Timeout Processing This sample shows how to use the timeout nodes to add timeouts to message flows.

File Processing samples

Sample name Description
Batch Processing This sample shows how to use the FileInput and FileOutput nodes to read different input files and append them to one output file. It also shows you how to read a file "as is" from one local input directory and write the file to a different local output directory.
File Output This sample shows how a FileOutput node can write a message to a file during a message flow. The sample shows a flow updating a SOAP message, the FileOutput node writing this updated message to a file, and the message being sent back to the sender by using HTTP as the transport mechanism.
Managed File Transfer This sample shows how the FTEOutput node writes a message to a file by using WebSphere MQ File Transfer Edition to manage the transfer of the file. The sample shows a Retail HQ to Branch product provisioning scenario. The flow receives a stream of WebSphere MQ messages with product data, and a file is created with an FTEOutput node. The built-in FTEAgent operates with the FTEOutput node to manage the transfer of the file to a remote location.
Connect:Direct® File Transfer This sample demonstrates how to use the CDInput and CDOutput nodes to work with IBM® Sterling Connect:Direct in conjunction with WebSphere Message Broker. The sample shows how to configure the IBM Sterling Connect:Direct nodes to send and receive files using IBM Sterling Connect:Direct.
WildcardMatch This sample shows how to access the LocalEnvironment.Wildcard.WildcardMatch variable that is set in the FileInput node. The sample then gives an example of how, by using this variable, you can dynamically override the output file name and directory properties that are set in the FileOutput node.

Industry samples

Sample name Description
Healthcare This sample is a development accelerator, decreasing the time an integration developer within the healthcare industry requires to deliver integration solutions. This sample provides a number of Healthcare assets that solve key healthcare-specific integration problems.
TLOG Processor This sample is a set of customized message sets, subflows, message flows, and style sheets that process transaction log (TLOG) data from retail stores. These samples provide sample TLOG input messages that are generated by various IBM Retail applications to test the TLOG message flows. Customers and service teams can customize or extend the TLOG Processor samples by modifying the message sets and flows, or by recombining these components in alternative ways.

Message Formats samples

Sample name Description
COBOL This sample shows how to model binary messages that are based on COBOL copybooks, by using DFDL.
Comma Separated Value (CSV) This sample shows how to model common CSV message variants, and how to transform the sample CSV messages to and from XML.
EDIFACT This sample shows an industry-standard message set for Edifact messages.
FIX This sample shows an industry-standard message set for Fix messages.
ISO8583 This sample shows an industry-standard message model for ISO8583 messages using DFDL, and demonstrates how to transform ISO8583 messages received over TCP/IP.
SWIFT This sample shows an industry-standard message set for Swift messages.
X12 This sample shows an industry-standard message set for X12 messages.
XMLNSC Namespaces This sample shows how to change the existing namespace of a message, remove a namespace from a message, and add a namespace to a message.
XMLNSC Validation This sample shows the capability of the XMLNSC parser to validate messages against an XML schema.

Message Transformation samples

Sample name Description
Data Analysis This sample demonstrates how to use the Data Analysis Toolkit to analyze XML data and create Data Analysis Tools.
JavaCompute Node This sample shows how to use the JavaCompute node to perform tasks such as calling an external service and propagating a new message that is based on the results of the call.
Graphical Data Mapping Retail This sample shows how to use a graphical data map on a Mapping node to transform messages and enrich them with data from a database, within a simple retail scenario.
.NETCompute Node This sample shows how to filter, modify, and create messages by using the .NETCompute node in a message flow.
PHPCompute Node This sample shows how to use the PHPCompute node in a message flow to transform an XML message.
XSL Transform This sample shows how to use a message flow to transform an XML message to another form of XML message according to the rules provided by an XSL stylesheet.
JavaCompute Node JAXB Transformation This sample shows how to use the JavaCompute node to transform a message by using Java Architecture for XML Binding (JAXB).

Monitoring samples

Sample name Description
WebSphere Business Monitor This sample provides resources to help you use the monitoring events that are produced by your message flows for business process modeling by using WebSphere Business Monitor.

Security samples

Sample name Description
Security Identity Propagation This sample shows how to use Identity Security features to extract the security credentials from the messages on the MQInput and HTTPInput nodes. So that the sample can run stand-alone, the sample does not include security validation with an external security provider system, such as LDAP or TFIM. The sample also shows how to manipulate the security credentials by using ESQL, then how to propagate the identity to the MQOutput and HTTPRequest nodes.
Security Policy Enforcement Point (PEP) This sample demonstrates how to use the SecurityPEP node as the Policy Enforcement Point in a message flow.

Transports and Connectivity samples

Sample name Description
Browsing WebSphere MQ Queues This sample shows how a message flow can browse WebSphere MQ messages that are in a queue, therefore retrieving the messages non-destructively. This sample also shows how to examine the contents of the browsed message to determine whether to get the message. Getting the message is a destructive process that removes the message from the queue.
CICS® Transaction Server for z/OS® Connectivity This sample is based on a scenario in which a business wants to retrieve a record from a file resource on CICS Transaction Server for z/OS. The sample demonstrates how to use the CICSRequest node. With this node, you can run CICS applications, and retrieve data from CICS regions.
CICS Transaction Server for z/OS Channel Connectivity This sample demonstrates how to call a channel-based CICS program. A CICS channel structure can be represented in WebSphere Message Broker by a message collection. This sample demonstrates how to create and populate a message collection for the CICSRequest node and how to process the collection after the call.
CORBA nodes This sample is based on a product warehouse scenario where a stock administrator wants to manage a stock control management system hosted on a CORBA server. The sample demonstrates how to use the CORBARequest node to invoke CORBA server applications.
Email This sample consists of three message flows that show the use of sending and receiving emails. The emailform message flow provides an HTML input form to construct and submit an email message. The sendemail message flow receives the message and processes all the details that are associated with the email message. The recipients that are specified on the form receive the message as an email in the appropriate format, with any attachments. The getemail message flow processes the email that is sent and filters the email either to a WebSphere MQ queue, or saves the attachment to a file by using the FileOutput node.
HTTPHeader node This sample consists of three message flows that show the different ways in which you can use an HTTPHeader node. The three message flows are:
  • Single WebService in MQ flow sample. This sample message flow shows how to create an interface between a WebSphere MQ application and web-based applications by using the HTTPHeader and MQHeader nodes.
  • Multiple WebService requests sample. This sample shows how to create and reset HTTP headers by using the HTTPHeader node.
  • Set Cookie HTTP reply sample. This sample shows how to add an HTTPReply header by using the HTTPHeader node in a request-reply session.
IMS™ Synchronous Request This sample shows how to call an IBM Information Management System (IMS) transaction synchronously from within a message flow. The sample uses the IMSRequest node to make the synchronous calls by using IMS Connect. This sample uses the IMS sample transaction DSPALLI (Display All Invoices), which is typically available on all IMS systems. The DSPALLI transaction can call a REXX or COBOL program, although REXX is the default that is typically installed on IMS.
JD Edwards Connectivity This sample consists of a message flow that demonstrates the use of the JDEdwardsRequest node. This sample message flow uses the JD Edwards business function call "retrieve" to fetch a record from a JD Edwards EnterpriseOne server. The record is then put on a WebSphere MQ queue.
JMS Nodes This sample shows how to use the JMS nodes as a JMS Consumer and Producer to an external JMS provider.
JMSHeader node This sample shows how to use the JMSHeader node in a JMS coordinated request-reply scenario.
MQHeader node This message flow sample shows how to use the MQHeader node to add and remove an MQMD header.
SAP callout to a synchronous system This sample consists of a single message flow that demonstrates the use of the SAPInput node with the SAPReply node to enable a message flow to act as a synchronous BAPI. The message flow is used to service requests for four different BAPIs that create, update, retrieve, and delete customer details.
SAP callout to an asynchronous system This sample consists of three message flows that demonstrate the use of the SAPInput node with the SAPReply node to enable a message flow to act as a synchronous BAPI that wraps an asynchronous application. The message flows are used to service requests for four different BAPIs that create, update, retrieve, and delete customer details.
SAP Connectivity This sample consists of two message flows that show the use of the SAPInput node and the SAPRequest node. The SAPInput node scenario shows how to use a message flow to receive IDocs from the SAP Material Master, then send the data to a WebSphere MQ output queue for processing by another message flow or application. The SAPRequest node scenario shows how to use a message flow to create a customer in SAP, then update and retrieve the customer details.
SCA nodes This sample shows how to use the SCAInput, SCAReply, SCAAsyncRequest, and SCAAsyncResponse nodes to exchange message requests and responses with a business process in WebSphere Process Server.

The sample re-creates a scenario in which a savings account is linked to a current account, and money can be transferred between the two accounts. In the outbound scenario, WebSphere Message Broker passes money transfer requests to WebSphere Process Server, which hosts the savings account.

This sample can be extended to include an inbound scenario where WebSphere Process Server passes requests onto WebSphere Message Broker, which hosts the current account.

TCPIP Client Nodes This sample consists of three message flows that show both synchronous and asynchronous communication from the WebSphere Message Broker to a TCP/IP server. It also includes a simple message flow to simulate the TCP/IP server.
TCPIP Handshake This sample shows how to implement an application-level handshake protocol for a synchronous request reply model of communication between a client and a server. The sample also includes two other message flows to emulate the client and server applications. You can replace these applications by external applications that use the same interfaces.
Twineball Example EIS Adapter This sample shows how to use the WebSphere Adapter nodes by using the Twineball adapter, a self contained EIS, to synchronize a C system with an EIS.

Web Service samples

Sample name Description
Address Book This sample shows how to use the SOAPInput, SOAPReply, and SOAPRequest nodes to provide and consume a web service. Two sets of example input messages are provided: one set to call the consumer flow, which in turn calls the provider flow, and one set to call the provider flow directly. This sample can also be extended to show how to set up WS-Security for existing message flows for both a provider and a consumer.
Asynchronous Consumer This sample shows how to use the asynchronous SOAP nodes when you call a web service. The web service simulates an order service, and the client shows how existing WebSphere MQ interfaces can be extended to make web service requests.
RESTful Web Service Using JSON This sample shows how to front an existing service as a RESTful web service providing a JSON message format interface. The sample also shows how to consume the RESTful web service from a message flow.
SOAP Nodes This sample shows the use of SOAP nodes to both provide and consume a web service.
Web services using HTTP nodes This sample shows how to use WebSphere Message Broker to front an existing application as a web service.
Web Services Gateway This sample demonstrates how to use the SOAP nodes in a Web Services Gateway mode, which allows WebSphere Message Broker to handle generic SOAP request/response and one-way messages when used as a web services provider or consumer.
WebSphere Service Registry and Repository Connectivity This sample shows how to retrieve documents by using the WebSphere Service Registry and Repository nodes. You can use these nodes to query Service Registry information, and to use this information at run time. You can also use these nodes to acquire WSDL or other generic descriptions of available services.
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2016Copyright IBM Corporation 1999, 2016.

        
        Last updated:
        
        Last updated: 2016-05-23 14:47:41


Concept topicConcept topic | Version 8.0.0.7 | ax20230_