Document new options and add an example.

This commit is contained in:
agibert 2009-01-05 17:40:17 +00:00
parent 5904264927
commit 2d3d359d79

View File

@ -1,7 +1,7 @@
# $RCSfile: ReadMe.txt,v $ # $RCSfile: ReadMe.txt,v $
# $Revision: 1.5 $ # $Revision: 1.6 $
# $Name: $ # $Name: $
# $Date: 2007/12/11 16:50:50 $ # $Date: 2009/01/05 17:40:17 $
# $Author: agibert $ # $Author: agibert $
@ -10,6 +10,7 @@
Compilation: Compilation:
------------ ------------
- Just type: "javac MQSSave.java" ! - Just type: "javac MQSSave.java" !
@ -21,10 +22,42 @@ Installation:
Usage:
------
MQSSave [-qm "Input_QueueMng_Name"] [-cc] [-cs "character_set"] [-st "sleep_time"] [-mb "message_break"] [-cm] [-tm] [-mbtm] [-bem] [-ms "message_skip"] [-mc "message_count"] [-rc "repeat_count"] <Output_File_Name> <Input_MsgQueue_Name>
Default: Input QueueMng Name: () Character Convert: (false) Character Set: (1208) Sleep Time: (0) Message Break: (\r\n) Copy Mode: (false) Trim Mode: (false) MsgBreak Trailer Mode: (false) Best Effort Mode: (false) Message Skip: (0) Message Count: (0) Repeat Count: (1)
Arguments:
----------
- Optional arguments:
-qm "Input_QueueMng_Name": Name of the queue manager to use,
-cc "character_convert": Switch on the caracter conversion (Set the MQGetMessageOptions to MQC.MQGMO_CONVERT),
-cs "character_set": MQMessage character set,
-st "sleep_time": Delay between message sending,
-mb "message_break": String used as message separator,
-cm "copy_mode": Don't remove messages from queue,
-tm "trim_mode": Remove trailing spaces at the message end,
-mbtm "msg_break_trailer_mode": Add a message break at the end of the last message,
-bem "best effort mode": Skip errors and continue to save the next message,
-ms "message_skip": Number of message to skip before to start the saving,
-mc "message_count": Number of message to save,
-rc "repeat_count": Number of time the whole process (start of file + skip + save) should be repeated.
- Mandatory arguments:
<Output_File_Name>: Name of the output file to save to,
<Input_MsgQueue_Name>: Name of the input message queue to save from.
Notes: Notes:
------ ------
- MQSSave has been tested with MQ/Series 5.2, 5.2, 5.3 and WMQ 6.0. - MQSSave has been tested with WMQ 6.0.
- "-mb" argument accept a string with formated escape character: - "-mb" argument accept a string with formated escape character:
+ "\n" for newline, + "\n" for newline,
@ -37,12 +70,9 @@ Notes:
- Windows text files: newline is specified as "\r\n", - Windows text files: newline is specified as "\r\n",
- Unix text files: newline is specified as "\n". - Unix text files: newline is specified as "\n".
- The Flush File is only used when TI Swift Batch Mode is enabled (by setting "-tisbm" command line switch).
- When trim mode is enabled (by setting "-tm" command line switch), all the trailing spaces are removed. - When trim mode is enabled (by setting "-tm" command line switch), all the trailing spaces are removed.
- By default Message break is "\r\n", - By default Message break is "\r\n",
- By default Flush File Name is "flush.txt".
- This software is under the GNU General Public License. See GNU-GPL.txt. - This software is under the GNU General Public License. See GNU-GPL.txt.
@ -54,5 +84,5 @@ Usage Example:
- To save the messages of the MQ/Series "SWIFT-QUEUE" queue into a swift batch file "swift-batch.txt" with "---MESSAGE-BREAK---" message separator use: - To save the messages of the MQ/Series "SWIFT-QUEUE" queue into a swift batch file "swift-batch.txt" with "---MESSAGE-BREAK---" message separator use:
java MQSSave -mb "---MESSAGE-BREAK---\r\n" swift-batch.txt SWIFT-QUEUE java MQSSave -mb "---MESSAGE-BREAK---\r\n" swift-batch.txt SWIFT-QUEUE
- To save the messages of the MQ/Series "SWIFT-QUEUE" queue into a swift batch file "swift-batch.txt" with no message break message and by using the TI Swift Batch Mode, use: - To save 10 times the third message of the MQ/Series "SWIFT-QUEUE" queue into a swift batch file "swift-batch.txt" with "---MESSAGE-BREAK---" message separator without removing it from the queue use:
java MQSSave -mb "" -tisbm swift-batch.txt SWIFT-QUEUE java MQSSave -mb "---MESSAGE-BREAK---\r\n" -cm -ms 2 -mc 1 -rc 10 swift-batch.txt SWIFT-QUEUE