Defining properties for protocol file servers using the ProtocolBridgeProperties.xml file

Define the properties of one or more protocol file servers that you want to transfer files to and from using the ProtocolBridgeProperties.xml file, which is provided by IBM® MQ Managed File Transfer in the agent configuration directory.

About this task

The fteCreateBridgeAgent command creates the ProtocolBridgeProperties.xml file in the agent configuration directory MQ_DATA_PATH/mqft/config/coordination_queue_manager/agents/bridge_agent_name. The command also creates an entry in the file for the default protocol file server, if a default was specified when the command was run.

If you want to add further non-default protocol servers, edit this file to define their properties. This example adds an additional FTP server.

Procedure

Define a protocol file server by inserting the following lines into the file as a child element of <tns:serverProperties>:

<tns:ftpServer name="myserver" host="myhost.hursley.ibm.com" port="1234" 
   platform="windows"
		         		   timeZone="Europe/London" locale="en-GB" fileEncoding="UTF-8"
		        		   listFormat="unix" limitedWrite="false" >
<tns:limits maxListFileNames="10" maxListDirectoryLevels="500"/>

Then change the value of the attributes:
- name is the name of your protocol file server
- host is the host name or IP address of the protocol file server
- port is the port number of the protocol file server
- platform is the platform that the protocol file server runs on
- timeZone is the time zone that the protocol file server runs in
- locale is the language used on the protocol file server
- fileEncoding is the character encoding of the protocol file server
- listFormat is the file listing format returned from the protocol file server
- limitedWrite determines whether to follow the default mode when writing to a file server, which is to create a temporary file and then rename that file when the transfer has completed. For a file server that is configured as write only, the file is created directly with its final name. The value of this property can be true or false. The limitedWrite attribute and the doNotUseTempOutputFile agent property are used together in the case of protocol bridge agents. If you want to use temporary files, then you must not set the value of doNotUseTempOutputFile, and you must set the value of limitedWrite to false. Another other combination of settings means that temporary files will not be used.
- maxListFileNames is the maximum number of names collected when scanning a directory on the protocol file server for file names.
- maxListDirectoryLevels is the maximum number of directory levels to recurse when scanning a directory on the protocol file server for file names.
For more details about these attributes, including whether they are required or optional and their default values, see Protocol bridge properties file format.