Datapower and MQFTE Integration

MQFTE Integration
WebSphere DataPower Release 4.0.1

B2B MQFTE
2011 IBM Corporation
This presentation describes WebSphere DataPower Release 4.0.1 Business to Business

B2B MQFTE.
401DataPowerB2BMQFTEl.ppt
Page 1 of 23
MQFTE Integration
New MQFTE features
MQFTE URL Opener

MQFTE Front Side Protocol Handler
Correlated transactions with Integration ID
Display MQFTE transfer metadata
Here are the new features for DataPower MQFTE integration.

First, we will introduce the new MQFTE URL opener and front-side protocol handler that
are available for both XI and XB. Then we will introduce the concept of integration-id and
how it can be used to correlate a B2B transaction with a MQFTE transfer. Finally, we will
introduce how to use this ID to retrieve transfer metadata on B2B transaction viewer.
Page 2 of 23
MQFTE Integration
MQFTE URL Opener user scenario

Logical flow of data
DataPower portion
of transfer
Partner
Appliance
MQ File Transfer Edition portion of transfer
Agent
Network
Agent
MQ queue
1. The trading partner sends a message to the DataPower appliance

2. The DataPower appliance writes the message payload to an MQ queue that is shared
between the DataPower appliance and MQFTE
3. MQFTE source agent consumes the message and uses the information present in the
message headers to route the data to a destination agent, where the message payload is
written to a file
This slide shows the flow of using an MQFTE URL opener to send messages to the
MQFTE network. The DataPower service puts the message on a shared queue that the
MQFTE destination agent monitors. After all pieces of the message are sent to the shared
queue, the MQFTE source agent will transfer the data to a destination agent and the
message payload is written to a file.
Page 3 of 23
MQFTE Integration
Message segmentation for large files

...
...
...
...
...
...
...
If the payload of the received message is too large, the message payload is segmented into
smaller pieces before forwarded to the shared queue.
The maximum message size used is decided by these factors:
- The configuration of the maximum message size for the QM object in DP
- The message size configured for the queue
- The message size configured for the channel
When transferring a large file, the message payload is segmented into smaller pieces
during the transfer. From the perspective of MQFTE, these segments belong to the same
message group and is reassembled into one file after the transfer.
The maximum size of each segment is decided by three factors.

The first one is the configured maximum message size for the QM object in DataPower.
The second one is the message size configured for the shared queue.
The third one is the message size configured for the MQ communication channel.
Page 4 of 23
MQFTE Integration
Configure MQFTE Destination
This slide shows how to configure an MQFTE URL as a destination of B2B partner profile.
Page 5 of 23
MQFTE Integration
Using MQFTE URL Opener
Like MQ URL opener, MQFTE URL opener has dynamic and static URLs.
The URL location part stands for Queue Manager name or its IP-port combination.
For example:
- dpmqfte://QM_Demo/?RequestQueue=Q_in&DestAgent=Kai&DestQM=dummyQM&DestFile=dummyPath
- mqfte://172.16.130.75:4444/?RequestQueue=Q_in&DestAgent=Kai&DestQM=dummyQM&DestFile=dummyPath
Available URL Parameters:
Required
DestAgent - The destination agent in MQFTE network that receives a message.
DestQM - The destination queue manager to which the source agent sends a message.
DestFile - The name of the file where the destination agent stores a received message.
Optional
SenderID - The business ID of the sender, for example, the external partner.
ReceiverID - The business ID of the receiver, for example, the internal partner.
ContentType - The content type of the message payload.
Unique filename is supported for MQFTE destination. (XB60 only)
Configuring an MQFTE URL is similar to configuring an MQ URL. You need to provide the
queue manager information where the shared queue is located and the URL parameters
as well. Alternatively, you can provide the IP address and port to setup the connection
dynamically.
Here we list the required MQFTE URL parameters. The DestAgent (destination agent) is
the agent that will ultimately receive the file, the DestQM (destination queue manager) is
the queue manager to which the source agent should send the message, and the DestFile
(destination file) is the name of the file where the destination agent stores a received
message.
The MQFTE URL opener has some optional parameters. The SenderID is the business ID
of the sender, and the RecevierID is the business ID of the receiver. The ContentType
identifies the type of the message payload.
You can enable the unique file name feature for an MQFTE destination so that old files are
not overwritten by new files with the same name. This feature is only available on B2B
appliances.
Page 6 of 23
[MQFTE Integration
Transactionality Support
1. The trading partner sends data to the DataPower appliance.

2. The DataPower appliance writes data to an MQ queue as one or more messages
in a group.
3. An error occurs in the transaction process and the MQFTE URL opener rolls the
transfer back. As a result, the message is removed from the MQ queue
Like MQ, transactionality is supported for MQFTE URLs. Enable this feature to prevent
the transfer of partial message segments when an error occurs.
Here is the flow: The trading partner sends data to the DataPower appliance, which writes
data to an MQ queue as one or more messages in a group.
When an error is detected during transaction processing, the residual messages in the
shared queue is removed.
Page 7 of 23
MQFTE Integration
New MQFTE features
MQFTE URL Opener

Now let us move on to the next topic the MQFTE front-side protocol handler.
Page 8 of 23
MQFTE Integration
MQFTE Front-Side Protocol Handler for XI and XB

DataPower portion
of transfer
File Transfer
Sender
Source
Agent
MQFTE
Network
Appliance
Message
Partner
Destination
Agent
MQ queue
Message
1. The MQFTE source agent receives the transfer and sends the file to the destination
agent which shares queues with the DataPower appliance.
2. The destination agent places file data as one or more messages in a group.
3. The MQFTE front-side handler consumes messages from the queue, reassembles
the message if there are more than one segments, and sends the data to the
external partner
This slide shows the flow of receiving a transaction request from the trading partner using
an MQFTE front-side handler.
The trading partner creates a transfer and the document is transferred to the shared
queue.
MQFTE front-side handlers on the DataPower appliance poll the message pieces from the
shared queue, reassembled them, and then starts processing the transaction.
Page 9 of 23
MQFTE Integration
Configure an MQFTE Front Side Handler
The Queue manager that host the shared queue where you retrieve
the message segments.
10
This screen capture shows how to configure an MQFTE front-side handler.

Like configuring an MQ front-side protocol handler, you basically need to specify the name
of the shared queue and the queue manager where the shared queue is located.
Page 10 of 23
MQFTE Integration
MQFTE and DP Integration Headers
The MQFTE Source Agent can optionally configure these metadata to integrate with XB60
When set, B2B Gateway uses this information to match the right partner profile setting :
DPMQFTESenderID: The business ID of the internal partner
DPMQFTEReceiverID: The business ID of the external partner
DPMQFTEContentType: The content type of the message payload
Example:
/opt/IBM/WMQFTE/bin/fteCreateTransfer
-sa QM1.AGENT -da QM1.AGENT -dq Q_receive -qmp true
-md DPMQFTESenderId=companyA,
DPMQFTEReceiverId=companyB,
DPMQFTEContentType=application/edi
-qs 1M /home/kai/doc/doc.edi
11
MQFTE administrators can explicitly specify B2B information like the name of the trading
partner and the document content type in the transfer by using the -md option when
issuing the fteCreateTransfer command.
In this example, the administrator explicitly sets the sender ID to be company A, the
receiver ID to be company B, and the content type to be edi.
Page 11 of 23
MQFTE Integration
Transactionality Support
DataPower portion
of transfer
File Transfer
Sender
4 (error)
Source
Agent
MQFTE
Network
Partner
Destination
Agent
1
Appliance
Get Queue
3
Backout Queue
1. The MQFTE source agent receives the transfer and sends the file to the destination agent which
shares queues with the DataPower appliance.
2. The destination agent places file data as one or more messages in a group.
3. The MQFTE front-side handler consumes messages from the queue
4. An error occurs in the transaction process and MQFTE front-side handler rolls the transfer back.
Go back to step 1 to retry the transfer.
5. If the number of retries reaches the backout threshold, the MQFTE front-side handler sends the
transfer to the backout queue.
When an error occurs during transaction processing on XB60 and transactionality is disabled, the B2B
Gateway cleans up the remaining message segments on the shared queue to avoid orphan messages
12
As in an MQFTE URL opener, transactionality is supported in an MQFTE front-side

handler as well.
The MQFTE source agent receives the transfer and sends the file to the destination agent
which shares queues with the DataPower appliance.
The destination agent places file data as one or more messages in a group, and the
MQFTE front-side handler consumes messages from the queue.
If an error occurs during transaction processing, the transfer is rolled back, for example,
the message segments are put back to the queue.
When the backout threshold is reached, all the message segments will be put into the
backout queue if specified.
Page 12 of 23
MQFTE Integration
New MQFTE features
MQFTE URL Opener

13
Now let us move on to the next topic the MQFTE integration ID.
Page 13 of 23
MQFTE Integration
New Integration ID Column in B2B Viewer (XB60 only)
The new column Integration ID stores the integration ID that correlates a B2B Transaction
with a back-end transaction.
For MQFTE integration, the integration ID maps to the transfer ID of MQFTE network.
For inbound transactions, the integration-ID is the Message ID of the first message that
is sent to the shared queue
For outbound transactions, the integration-ID is the Message ID of the first message that
is received from the shared queue.
14
The integration ID is created to correlate a transaction on a B2B appliance and a transfer

in the MQFTE network.
In the B2B transaction viewer, a new column is added to display the integration. The ID is
displayed in hex format.
Here is how the ID is generated:
For an MQFTE URL opener, when sending a message from the appliance to the MQFTE
network, the integration ID is generated automatically by the MQ server that host the
shared queue. When retrieving a message from the MQFTE network, the integration ID is
the MQFTE transfer ID.
Page 14 of 23
MQFTE Integration
Customize the integration ID
A new service variable var://service/mqfte-integ-id is used in the request rule of multistep to

set the integration ID.
The value of this service variable must be presented in hex format; otherwise, the value is
discarded.
If the value of this service variable is set, it becomes the Message ID of the first message
that is sent to queue. If the value of this service variable is not set, the Message ID is
automatically generated by the Queue Manager
15
In some case the administrator might want to customize the integration ID. An integration
ID can be specified by setting the mqfte-integ-id service variable. When setting an
integration ID, make sure the value is presented in hex format. If not specified or not in
hex format, the integration ID is generated by the MQ queue manager where the shared
queue is located.
Page 15 of 23
MQFTE Integration
New MQFTE features
MQFTE URL Opener

16
Now let us go to the last topic the display MQFTE metadata. This feature is only
available on only B2B appliances
Page 16 of 23
MQFTE Integration
Display MQFTE Transfer Metadata (XB60 only)
For each MQFTE-related transaction, the transfer-related metadata is stored in the MQFTE
logger database (if installed). The installation of MQFTE logger database is optional.
When you click the integration-id link, the DataPower appliance retrieves the transaction
metadata from the logger database and displays the result on a pop-up window
17
When a B2B appliance sends a message to the MQFTE network, a new transfer is
initiated and the transfer results are recorded in the MQFTE database. In some cases, it is
helpful to take a quick look of the transfer results in the DataPower B2B transaction
viewer. This can be done by clicking the integration-id link in the transaction viewer. When
clicked, the appliance retrieves the the transaction metadata from the MQFTE logger
database and display the results.
Page 17 of 23
MQFTE Integration
Retrieve MQFTE Transfer Metadata

DataPower portion
of transfer
Outbound GW
Inbound GW
Agent
Appliance
Network
Back-end
System
Agent
MQ queue
4
1. An outbound gateway sends an AS2 message to

an inbound gateway.
2. The DataPower appliance writes data to an MQ
queue as one or more messages in a group. The
message ID assigned to the first message in the
group becomes the Integration ID. Other
information can be passed in the RFH 2 header of
the first message.
18
MQFTE Logger
3. FTE consumes the group of messages and uses the

information present in the first message in the group to
route the data to a back-end system, where it is written
as a file.
4. B2B Viewer of the outbound gateway retrieves the
transaction metadata from the MQFTE Logger
Database.
This chart shows the flow of how DataPower retrieves transfer metadata from the MQFTE
logger database.
1.An outbound gateway sends an AS2 message to an inbound gateway.

2.The DataPower appliance writes data to an MQ queue as one or more messages in a
group. The message ID assigned to the first message in the group becomes the
Integration ID. Other information can be passed in the RFH 2 header of the first message.
3.FTE consumes the group of messages and uses the information present in the first
message in the group to route the data to a remote system, where it is written as a file.
4.The B2B Viewer of the outbound gateway retrieves the transaction metadata from the
MQFTE logger database.
Page 18 of 23
MQFTE Integration
Configure SQL Data Source in B2B Gateway

An SQL Data Source object is required for B2B Gateway to retrieve MQFTE
transfer metadata for display
On the Advanced tab in the B2B Gateway configuration screen, a new SQL
Database Property is added to configure ODBC settings
You cannot configure one B2B Gateway to access multiple MQFTE Network
19
Because the metadata is retrieved through ODBC, an SQL data source configuration is
required for the B2B gateway. This slide shows how to configure this SQL data source.
Note that only one SQL data source is allowed with one B2B gateway.
Page 19 of 23
MQFTE Integration
Display MQFTE Transfer Metadata

A pop-up window displays the MQFTE metadata when you click the integration-id
(for MQFTE-related transaction only)
Depending on whether the transaction is inbound or outbound, the pop-up window
shows different metadata
20
For B2B appliances, if the MQFTE logger is enabled and the SQL data source for the B2B
gateway is configured, the transfer metadata of MQFTE related transactions can be
displayed by clicking on the MQFTE integration ID in the B2B transaction viewer as shown
in the previous chart.
Page 20 of 23
MQFTE Integration
Summary
MQFTE URL Opener

21
To summarize, this presentation introduces how to use an MQFTE URL opener and
MQFTE front-side protocol handler, which are available for both Integration (XI) and B2B
(XB) appliances.
In addition, the usage of the integration ID and how to display MQFTE transfer metadata is
also illustrated. Each MQFTE-related transaction is associated with a specific MQFTE
integration ID, which can be used to retrieve and display transfer metadata on XB
appliances.
Page 21 of 23
Feedback
Your feedback is valuable

You can help improve the quality of IBM Education Assistant content to better meet your
needs by providing feedback.
Did you find this module useful?
Did it help you solve a problem or answer a question?
Do you have suggestions for improvements?
Click to send email feedback:

mailto:iea@us.ibm.com?subject=Feedback_about_401DataPowerB2BMQFTEl.ppt
This module is also available in PDF format at: ../401DataPowerB2BMQFTEl.pdf
22
You can help improve the quality of IBM Education Assistant content by providing
feedback.
Page 22 of 23
Trademarks, disclaimer, and copyright information
IBM, the IBM logo, ibm.com, DataPower, and WebSphere are trademarks or registered trademarks of International Business Machines Corp.,
registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of other
IBM trademarks is available on the web at "Copyright and trademark information" at http://www.ibm.com/legal/copytrade.shtml
THE INFORMATION CONTAINED IN THIS PRESENTATION IS PROVIDED FOR INFORMATIONAL PURPOSES ONLY.
THE INFORMATION CONTAINED IN THIS PRESENTATION IS PROVIDED FOR INFORMATIONAL PURPOSES ONLY. WHILE EFFORTS WERE
MADE TO VERIFY THE COMPLETENESS AND ACCURACY OF THE INFORMATION CONTAINED IN THIS PRESENTATION, IT IS PROVIDED
"AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. IN ADDITION, THIS INFORMATION IS BASED ON IBMS CURRENT
PRODUCT PLANS AND STRATEGY, WHICH ARE SUBJECT TO CHANGE BY IBM WITHOUT NOTICE. IBM SHALL NOT BE RESPONSIBLE FOR
ANY DAMAGES ARISING OUT OF THE USE OF, OR OTHERWISE RELATED TO, THIS PRESENTATION OR ANY OTHER DOCUMENTATION.
NOTHING CONTAINED IN THIS PRESENTATION IS INTENDED TO, NOR SHALL HAVE THE EFFECT OF, CREATING ANY WARRANTIES OR
REPRESENTATIONS FROM IBM (OR ITS SUPPLIERS OR LICENSORS), OR ALTERING THE TERMS AND CONDITIONS OF ANY AGREEMENT
OR LICENSE GOVERNING THE USE OF IBM PRODUCTS OR SOFTWARE.
Copyright International Business Machines Corporation 2011. All rights reserved.
23
Page 23 of 23

Datapower and MQFTE Integration

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Datapower and MQFTE Integration

Uploaded by

Copyright:

Available Formats

MQFTE Integration

WebSphere DataPower Release 4.0.1

2011 IBM Corporation

This presentation describes WebSphere DataPower Release 4.0.1 Business to Business

New MQFTE features

MQFTE URL Opener

WebSphere DataPower Release 4.0.1

2011 IBM Corporation

Here are the new features for DataPower MQFTE integration.

MQFTE URL Opener user scenario

MQ File Transfer Edition portion of transfer

1. The trading partner sends a message to the DataPower appliance

2011 IBM Corporation

Message segmentation for large files

2011 IBM Corporation

The maximum size of each segment is decided by three factors.

Configure MQFTE Destination

2011 IBM Corporation

Using MQFTE URL Opener

DestAgent - The destination agent in MQFTE network that receives a message.

ContentType - The content type of the message payload.

Unique filename is supported for MQFTE destination. (XB60 only)

2011 IBM Corporation

1. The trading partner sends data to the DataPower appliance.

2011 IBM Corporation

New MQFTE features

MQFTE URL Opener

2011 IBM Corporation

MQFTE Front-Side Protocol Handler for XI and XB

MQ File Transfer Edition portion of transfer

2011 IBM Corporation

Configure an MQFTE Front Side Handler

2011 IBM Corporation

This screen capture shows how to configure an MQFTE front-side handler.

MQFTE and DP Integration Headers

DPMQFTEReceiverID: The business ID of the external partner

DPMQFTEContentType: The content type of the message payload

-sa QM1.AGENT -da QM1.AGENT -dq Q_receive -qmp true

2011 IBM Corporation

MQ File Transfer Edition portion of transfer

2011 IBM Corporation

As in an MQFTE URL opener, transactionality is supported in an MQFTE front-side

New MQFTE features

MQFTE URL Opener

2011 IBM Corporation

New Integration ID Column in B2B Viewer (XB60 only)

2011 IBM Corporation

The integration ID is created to correlate a transaction on a B2B appliance and a transfer

Customize the integration ID

A new service variable var://service/mqfte-integ-id is used in the request rule of multistep to

automatically generated by the Queue Manager

2011 IBM Corporation

New MQFTE features

MQFTE URL Opener

2011 IBM Corporation

Display MQFTE Transfer Metadata (XB60 only)

2011 IBM Corporation

Retrieve MQFTE Transfer Metadata

MQ File Transfer Edition portion of transfer

1. An outbound gateway sends an AS2 message to

3. FTE consumes the group of messages and uses the

2011 IBM Corporation

1.An outbound gateway sends an AS2 message to an inbound gateway.