Sending Extremely Large Files with MQ File Mover (How To #4)

In this blog posting, I will show you how to send an extremely large file (i.e. 1GB) when connecting to the queue manager in “client mode”. From a user’s perspective, sending a 1GB file is done exactly the same way as sending a 1KB file.

For files greater than 4MB, MQFM’s Send and Watch Actions use MQ’s segmentation feature. The large file is broken up into segments and send via MQ. The Receive Action will get and write each message segment to the target file.

If the message data does not need to be converted between platforms, then I strongly suggest that MQFM’s compression feature be used on the Send and/or Watch Actions. Using compression will cause the messages to move through your MQ environment faster and use less resources. Depending on the original file contents, the compression may achieve 5 to 1 compression or as high as 40 to 1 compression ratio.

Note: You can combine both encryption and compression when sending files using MQFM.

In this example, the following servers are used but they only have WebSphere MQ (WMQ) Client installed (no queue managers):
– aix002 is an AIX server with WMQ Client and MQFM software installed
– linux002 is a Linux server with WMQ Client and MQFM software installed

In this example, the following queue managers are used:
– MQA1 is a queue manager residing on a AIX (aix001) server (sender)
– MQL1 is a queue manager residing on a Linux (linux001) server (receiver)

– TEST.LINUX.QL and TEST.LINUX.QL.BK are local queues defined in queue manager MQL1 (receiver)
– TEST.LINUX.QR is a remote queue defined in queue manager MQA1 (sender)

If you do not know how to define/setup communication between 2 queue managers then follow the instructions in this blog posting:
http://www.capitalware.biz/rl_blog/?p=509

Step #1: On the linux002 server, create a file in the mq directory called mql1.xml and copy the following into the file:

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE MQFM_MQ SYSTEM "MQFM_MQ.dtd">
<MQFM_MQ>
    <QMgrName>MQL1</QMgrName>
    <QueueName>TEST.LINUX.QL</QueueName>
    <Hostname>linux001</Hostname>
    <ChannelName>SYSTEM.DEF.SVRCONN</ChannelName>
    <Port>1414</Port>
    <UserID>tester</UserID>
</MQFM_MQ>

The mql1.xml (MQFM_MQ XML) file describes how to connect to the remote MQL1 queue manager on server linux001. The connection will use UserID of tester. If you do not have that UserID defined on the linux001 server then use a UserID that is defined.

Step #2: On the linux002 server, in the MQFM install directory, create a file called mqfm_receive_test_4.xml and copy the following into the file:

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE MQFM_Workflow SYSTEM "MQFM_Workflow.dtd">
<MQFM_Workflow>

  <Actions>
    <Receive run="D" >
      <MQ>
        <MQFile>mql1.xml</MQFile>
        <BackOutQName>TEST.LINUX.QL.BK</BackOutQName>
      </MQ>
      <Default>
         <Directory override="Y">/home/roger/MQFM/</Directory>
      </Default>
    </Receive>
  </Actions>

</MQFM_Workflow>

When MQFM is started, it will run as a daemon (run=”D”) and use a backout queue called TEST.LINUX.QL.BK just in case there is an issue with a message. MQFM will override the message’s specified directory and use the one provided. Either create /home/roger/MQFM/ directory on your Linux server or use a directory that already exist on your Linux server.

Note: There were no options specified for MQFM’s Receive Action to use the decompression feature. The Receive Action will automatically detect if the incoming message has been compressed or not and take the appropriate action.

Step #3: On the linux002 server, start MQFM to receive the file transfers:

./mqfm.sh mqfm_receive_test_4.xml &

Step #4: On the aix002 server, in the mq directory, create a file called mqa1.xml and copy the following into the file:

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE MQFM_MQ SYSTEM "MQFM_MQ.dtd">
<MQFM_MQ>
    <QMgrName>MQA1</QMgrName>
    <QueueName>TEST.LINUX.QR</QueueName>
    <Hostname>aix001</Hostname>
    <ChannelName>SYSTEM.DEF.SVRCONN</ChannelName>
    <Port>1414</Port>
    <UserID>tester</UserID>
</MQFM_MQ>

The mqa1.xml (MQFM_MQ XML) file describes how to connect to the remote MQA1 queue manager on server aix001. The connection will use UserID of tester. If you do not have that UserID defined on the aix001 server then use a UserID that is defined.

Step #5: On the aix002 server, I have a file called giant_test.txt that is 1GB (1024MB) in size. Use your own extremely large file or create an extremely large file called giant_test.txt.

Step #6: On the AIX server, in the MQFM install directory, create a file called mqfm_send_test_4.xml and copy the following into the file:

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE MQFM_Workflow SYSTEM "MQFM_Workflow.dtd">
<MQFM_Workflow>

  <Actions>
    <Send delete="N" format="Z" >
      <File>data/giant_test.txt</File>
      <MQ>
        <MQFile>mqa1.xml</MQFile>
      </MQ>
      <Remote>
        <Directory>/var/mqm/</Directory>
      </Remote>
    </Send>
  </Actions>

</MQFM_Workflow>

When MQFM is started, it will determine that it needs to use MQ’s segmentation feature. In the Send Action above, I have used the compress feature (format=”Z”), hence, before a message segment is sent, MQFM will compress the message segment.

Step #7: On the aix002 server, start MQFM to send the file:

./mqfm.sh mqfm_send_test_4.xml

MQFM will start, put the message segments to the specified queue then terminate.

Step #8: On the linux002 server, verify that the test file (i.e. giant_test.txt or whatever you called it) was put into the /home/roger/MQFM/ directory or whatever directory you specified in the mqfm_receive_test_4.xml file.

Step #9: Finally, we need to stop MQFM daemon that is running on the linux002 server. In the MQFM install directory, create a file called mqfm_putquit_test_4.xml and copy the following into the file:

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE MQFM_Workflow SYSTEM "MQFM_Workflow.dtd">
<MQFM_Workflow>
  <Actions>
    <PutQuit>
      <MQ>
        <MQFile>mql1.xml</MQFile>
      </MQ>
    </PutQuit>
  </Actions>
</MQFM_Workflow>

Step #10: On the linux002 server, run MQFM with the PutQuit action:

./mqfm.sh mqfm_putquit_test_4.xml

This blog demonstrates how easy it is to send an extremely large file using MQFM. Remember, when possible, use the compression option for the Send and/or Watch Actions and you can combine both encryption and compression when sending files (any size) using MQFM.

Regards,
Roger Lacroix
Capitalware Inc.