Creating a WebSphere MQ File Transfer Edition (FTE) bridge agent to a mainframe

This article shows you how to create a WebSphere MQ FTE bridge agent to communicate from a WebSphere MQ FTE server to a mainframe. It also provides a sample Create Transfer command to test the agent.


David V. DeAngelo (, Advisory Software Engineer, IBM

Photo of David DeAngeloDavid DeAngelo is an Advisory Software Engineer in IBM Software Services for WebSphere for IBM (ISSW for IBM). He has worked with WebSphere MQ for a number of years, and he is an IBM Certified System Administrator for WebSphere MQ V6 and V7.

11 September 2013


This article shows you how to create an IBM® WebSphere® MQ FTE bridge agent, a special FTE agent that can be used to communicate with a mainframe, and explains the special parameters used by the bridge agent.


  • Basic knowledge of WebSphere MQ FTE
  • WebSphere MQ FTE V7.0.4.1 or later installed on each end. (Bridge agent functionality is not available in earlier versions of WebSphere MQ FTE).

Step 1. Creating the bridge agent

The command to create a bridge agent is fairly standard, but adds certain parameters that are not commonly used on distributed systems. Pay particular attention to the parameters shown in bold:

fteCreateBridgeAgent -agentName <agent name> 
    -agentQMgr <agent queue manger>
    -agentQMgrHost <agent queue manger host name>
    -agentQMgrPort <agent queue manager port number>
    -agentQMgrChannel <agent queue manager channel - by default, SYSTEM.DEF.SVRCONN>
    -bt <protocol file server type>
    -bh <mainframe host name>
    -bm <machine platform type>
    -bsl <protocol file server locale>
    -bfe <file encoding format>
    -btz <protocol file server time zone>


This command creates a bridge agent on to talk to

fteCreateBridgeAgent -agentName FTPAGENT -agentQMgr AGTFTE -agentQMgrHost
-agentQMgrPort 1426 -agentQMgrChannel SYSTEM.DEF.SVRCONN -bt FTP -bh 
-bm UNIX -bsl en_US -bfe IBM1047 -btz US\Eastern

The bfe parameter is what you will need to confirm with the mainframe team. This example transfers to z/OS using a format of IBM1047. Here is the definition that you get for bfe when using -h on fteCreateBridgeAgent:

Defines the file-encoding format of the file stored on the protocol file server.  For example: UTF-8.

You can get all of the possible values by typing fteCreateBridgeAgent -hcs.

Step 2. Import MQSC file

The next step, as for any agent you create, is to import the definitions in the mqsc file after the create bridge command is successful. Using the example above:

runmqsc AGTFTE < FTPAGENT_create.mqsc

Step 3. Edit the ProtocolBridgeCredentials.xml file

Edit the resultant ProtocolBridgeCredentials.xml file. Open the file in your editor and find the following string:

<!-- Insert user elements here -->
<tns:user name="mqm" serverUserId="USERID" serverPassword="PWD" />
user name
userid that will run the createtransfer command
logon id for the mainframe
password for this userid

Step 4. Start the bridge agent

You can now start the bridge agent in the same way as on distributed FTE servers. Using the example above:

fteStartAgent FTPAGENT

Step 5. Test a file transfer

Test the bridge agent by transferring a text file. The source agent in this example is AGTAGENT (which has already been created). The target is the bridge agent you just created: FTPAGENT. A most important parameter is dce.

fteCreateTransfer -sa AGTAGENT -da FTPAGENT -t text -dce ibm1047 -df <dest file> <source file>

You will need to confirm the parameter ibm1047 with the z/OS team, and then verify that the source file was transferred to the mainframe.



developerWorks: Sign in

Required fields are indicated with an asterisk (*).

Need an IBM ID?
Forgot your IBM ID?

Forgot your password?
Change your password

By clicking Submit, you agree to the developerWorks terms of use.


The first time you sign into developerWorks, a profile is created for you. Information in your profile (your name, country/region, and company name) is displayed to the public and will accompany any content you post, unless you opt to hide your company name. You may update your IBM account at any time.

All information submitted is secure.

Choose your display name

The first time you sign in to developerWorks, a profile is created for you, so you need to choose a display name. Your display name accompanies the content you post on developerWorks.

Please choose a display name between 3-31 characters. Your display name must be unique in the developerWorks community and should not be your email address for privacy reasons.

Required fields are indicated with an asterisk (*).

(Must be between 3 – 31 characters.)

By clicking Submit, you agree to the developerWorks terms of use.


All information submitted is secure.

Dig deeper into WebSphere on developerWorks

ArticleTitle=Creating a WebSphere MQ File Transfer Edition (FTE) bridge agent to a mainframe