SMM Manual

Gerco Dries

Tako Grijpma

You may use Sonic Message Manager only with a valid license for Sonic MQ (it won’t do you any good without anyway). Sonic™ Message Manager is not supported, endorsed by or affiliated with Progress Software in any way. Do not contact Progress Software with questions or remarks. Instead, e-mail one of the developers mentioned in the chapter "developer contact information".

Sonic is a trademark of Sonic Software.

Sonic Message Manager is free software, released under the GNU GPL version 2. The source code for Sonic Message Manager is included in the application jar file.

Table of Contents

1. Introduction
1.1. Changelog version 1.6.2
1.2. Changelog version 1.6.1
1.3. Changelog version 1.6
1.4. Changelog version 1.5
1.5. Changelog version 1.4
1.6. Changelog version 1.3
1.7. Changelog version 1.2
1.8. Changelog version 1.1
1.9. Changelog version 1.0
2. Installation
3. Running SMM
3.1. Connection
3.2. Connection overview
3.3. Required permissions for using SMM
4. Short overview
4.1. General
4.2. Tab message viewer
4.3. Tab message sender
5. View a message
6. Sending messages
6.1. Drag & drop to send a message
6.2. Select a file as message
6.3. Type your own message
6.4. Move message between queue's
6.5. Move between applications
7. Download messages
7.1. Save a single message
7.2. Save multiple messages
7.3. Save multipart message(s)
8. Developer contact information
A. GNU General Public License
A.1. Preamble
A.3. How to Apply These Terms to Your New Programs

Chapter 1. Introduction

The SMM is an application aimed at replacing the JMS Test Client provided with Sonic MQ for general use. It will not support the most advanced features of the JMS Test Client, but will provide other features that the Test Client lacks.

Sonic Message Manager is available for Sonic 6.1, 7.0.x, 7.5.x and Sonic 7.6.x

1.1. Changelog version 1.6.2

Resolved / New features:

  • SMM now only allows a user to "Clear messages" when they can also read from the specified queue. Send permissions are not required because someone who can read from the queue could also just consume all messages if they wanted to remove them.

1.2. Changelog version 1.6.1

Resolved / New features:

  • A ClassCastException could occur on brokers with HTTP_DIRECT acceptor as primary.

1.3. Changelog version 1.6

Resolved / New features:

  • JMS Correlation ID is now displayed in bytes as well (uses the JVM default encoding to convert from String to bytes. Sonic MQ does not natively store a Correlation ID in bytes, only as a String so this is the only way to do it for now. Configurable encoding is being worked on.

  • SonicMQ.deadMessage queue is now visible. SonicMQ.routingQueue is not accessible through the SonicMQ management API and thus is invisible.

  • This manual was included with the program as on-line help. No context sensitivity is currently implemented, nor is it planned.

1.4. Changelog version 1.5

Resolved / New features:

  • Configurable message sending delay;

  • Sonic 7.6 support;

  • Resolved an issue that prevented the display of inproperly formatted Xml messages;

1.5. Changelog version 1.4

Resolved / New features:

  • Allow the user to filter the queue list;

  • Allow XmlMessages to be sent;

  • Improve drag and drop operations;

  • Add saving and loading of .esbmsg files;

  • Progress dialog sometimes gets stuck;

  • Manual also available in Windows help format as in HTML format;

  • Handling of messages in messages (in messages).

1.6. Changelog version 1.3

New features:

  • Text messages are now formatted as Xml if possible;

  • The broker selection combo box only displays brokers that are started and on-line;

  • Improved message sending speed, particularly on high-latency networks.

1.7. Changelog version 1.2

New features:

  • Multi select for queues. You can now select multiple queues at the same time to clear messages;

  • Auto refresh for message counts. The message count will now refresh automatically every few seconds;

  • The last used directory for saving or opening a message file will now be remembered;

  • The connection tab now allows you to delete saved connections.

1.8.  Changelog version 1.1

New features:

  • select a directory to send the files in that directory to Sonic;

  • improved error handling;

  • a-synchronous queue browsing;

  • save message with extension based an message type (xml = xml file);

  • format xml messages / parts before viewing in browser;

  • SMM Manual updated.

1.9.  Changelog version 1.0

For now it features:

  • Automatically discovers all active brokers in the connected Sonic Domain;

  • Lists queues on the selected broker to prevent needless typing;

  • Deleting a single message anywhere on a queue;

  • Delete all message from a queue;

  • Re-uses connection information from the Sonic Management Console;

  • Displays every part of a multi-part message separately;

  • Includes hex-v ewer for BytesMessages;

  • Drag (multiple) messages from one queue to another;

  • Send messages by dragging files on to a queue;

  • Send one message multiple times to a queue;

  • Set JMSCorrelationID property on test message;

  • Set JMSReplyTo property on test message;

  • Set custom Header Properties on test message;

  • Copy content of a message part from a (multipart) message to another queue or application.

Chapter 2.  Installation

No installation is required, you can webstart the application by open an Internet browser and surf to for more information and another short introduction.

For an overview of all downloads, just surf to


You need certain permissions on the Sonic Domain you are connecting to to allow SMM to work. See Section 3.3, “Required permissions for using SMM” for details.

After installing the SMM using webstart you should get also a shortcut on your desktop.

If this is not happened do the following:

  • Open a dos box (menu -> start -> cmd)

  • Type now: javaws.

Now the Java Webstart Application Viewer is opened and you see the Sonic Queue Manager entry.

Select this and go to Application "Sonic message manager". right mouse -> Install shortcuts to install the shortcut on your desktop.

Chapter 3. Running SMM

To work with SMM you first need to make a connection to a Sonic Domain. After you connected to the Domain, automatically all active brokers are discovered including all queue's for each broker.

3.1. Connection

When you start SMM you get a connection dialog to setup a connection to the Sonic domain. Make sure you fill in all entries.

  • Connection name = Required

  • Domain Name = Required

  • Connection URL(s) = Required

  • User Name = Required (if security is enabled)

  • Password = Required (if security is enabled)

3.2.  Connection overview

SMM can also store you earlier connections, just like the Sonic Management Console.

One of all your connections can be set as default connection.

After you successfully connected to a Sonic Domain you automatically switch to the next tab, Message viewer.

3.3. Required permissions for using SMM

Since SMM uses management requests to determine the available brokers and queues, you need to have certain permissons on the Sonic domain you are trying to connect to. Any member of the Administrators group already has these permissions but any other user (by default) does not. The required ACLs (for the management broker) are:

Resource typeResource namePrincipalPrincipal typePermissionAction

This will allow any user in the group SMMUsers to connect to the domain. If you do not use management security (available from Sonic MQ 7.0), this will also allow these users to perform most management operations using the Sonic Management Console!. If you are using management security, be sure to allow the following operations:

Configure permissions/BrokersSMMUsersRead
Configure permissions/ContainersSMMUsersRead
Manage permissions/ContainersSMMUsersGet information
Manage permissions/ContainersSMMUsersOther actions [1]
Manage permissions/Containers/DomainManager/AGENT MANAGERSMMUsersSubscribe to notifications

[1] Only required to allow the "Clear messages" button to work. This will allow the user to clear any queue they have read access to!

Chapter 4. Short overview

In this chapter you find a short overview / description about the different tabs in this application and what you see on those tabs.

4.1. General

After the application is started you see in the Title bar the name of the chosen connection together with the Sonic Domain name as the connection URL to the Domain Manager.

4.2. Tab message viewer

Here we explain what you see on this tab.

Number 1: List of active brokers within your Sonic Domain

Number 2: List of queue's that is available on selected broker

Number 3: List of messages that is saved on the selected broker

Number 4: Message information from the selected message (JMS properties / part / body)

4.3.  Tab message sender

Here we explain what you see on this tab.

This tab contains two ways of sending messages to a Sonic queue. You can select a message or you can type a message of yourself.

4.3.1.  Select a file as message

Number 1: List of queue's that is available on selected broker

Number 2: Set the number that the message will be send to Sonic and set some message properties

Number 3: Choose to select a message from file or to type your own message

Number 4: Opens a dialog to search & select a file to be uploaded to Sonic

Number 5: Send the message to Sonic

4.3.2.  Type your own message

Number 1: List of queue's that is available on selected broker

Number 2: Set the number that the message will be send to Sonic and set some message properties

Number 3: Choose to select a message from file or to type your own message

Number 4: Type here your own message

Number 5: Send the message to Sonic

Chapter 5. View a message

Once you are connected to a Sonic Domain you select the tab “Message viewer” (if not automatically done).

On this tab you can select a broker that is available in your Domain. Automatically you direct see all the queue's that are available on the selected broker.

Only the active brokers are shown in SMM (in case of FT brokers, the backup brokers are not shown because there STAND-BY)

If there are messages on a queue, the field number of messages turns into red.

Once you selected the queue you see on the right the list of messages that are on the queue (in this example three messages).

When you select the message you can view all message details in the bottom viewer.

You can view the properties of the message and also the content of the message.

Chapter 6. Sending messages

With SMM you can easily send messages to a queue. You can do this in different ways, for now the following is supported:

  • Drag & drop a file onto a queue

  • Select a file or directory and send to a queue

  • Type your a message and sent to a queue

  • Move message between queues by drag & drop

When you drag & drop a message to a queue, you cannot use the extra functionality like sending the same message multiple times or setting JMS properties. To use these extra functionality you must use the "message sender" tab and select a file or type your own message.

When you drag or select an xml file, the file will be sent as an XMLMessage. When dragging or selecting any other type of file, it will be send as a TextMessage. BytesMessages are not supported. If you select or drag multiple files, each file will be examined and sent as the appropriate message type for that file.

6.1. Drag & drop to send a message

To send a message to a queue it doesn't matter witch tab (message viewer / message sender) is selected. Just select the necessary file and drag it to the desired queue and drop the message. You can also drop directories on a queue and all files in that directory will be sent. Sending directories is not recursive so only the files in the top level directory will be sent.

This also works if you select more than one file from disk and drag these files to the queue. All selected files will be sent to the queue.

6.2. Select a file as message

Select the queue to which you would send your message.

Use ‘browse' to select your file and press the ‘send' button to send the content as a Sonic message to the queue.



Number of messages

Minimum value is 1. Changing this number allows you to send the same message multiple times with the same conditions

Delay (ms)

The number of milliseconds to wait between sending messages. This allows for simple performance tests to be done.

JMS Correlation ID

Type here your value that will be set as JMScorrelationID

JMS Reply to

Type here the address for ReplyTo. You can also drag & drop a queue from the queue table into this field

Custom JMS properties

If you want to set your own JMS Header properties you can define them here.

The format is PropertyName=PropertyValue separated with a comma (,)

6.2.1.  Select a directory

Using the browse button to select a single file, you also can select a directory. Doing this you can select a directory that contains multiple files to send them all to a queue.

6.3.  Type your own message

Select the queue to which you would send your message.

Just type your message and press the ‘send' button to send the content as a Sonic message to the queue.



Number of messages

Minimum value is 1. Changing this dumber allows you to send the same message multiple times with the same conditions

JMS Correlation ID

Type here your value that will be set as JMScorrelationID

JMS Reply to

Type here the address for ReplyTo. You can also drag & drop a queue from the queue table into this field

Custom JMS properties

If you want to set your own JMS Header properties you can define them here.

The format is PropertyName=PropertyValue separated with a comma (,)

6.4.  Move message between queue's

With SMM it is possible to move a message from the queue to another queue. Just select your message and drag it to the destination queue and drop it there. This also works when you select multiple messages on a queue.

It is also possible to select a message part of the message and drag this part to another queue. This works for text, xml messages and also for multipart messages.

Also you can select a message part and drag that part into an application like Stylus Studio.

Only messages can be moved between queues on the same broker!!

6.5.  Move between applications

You can drag & drop messages between different instances of SMM as you see fit. They don't have to be connected to the same Sonic environment. When you drag a message to another instance of SMM, the message is copied, not moved.

You can also drag messages from SMM to any other application that accepts text drags (most editors do). When you drag a multi part message, all parts of the message will be copied into the application with blank lines in between the parts. You may also drag a single message part to another application or another instance of SMM (in which case the part will be considered a message by itself).

You can drag any file onto the "Type my own message" field and the contents will be loaded into that field. This works best for text- or xml files, but SMM will attempt to insert any content you drop there, be careful not to drop a multi-megabyte binary file, the results will not be pretty.

Chapter 7.  Download messages

You can download messages to a file on your machine.Just select your message or select multiple messages and click on the save button. Now just select a directory to save the files.


You can save messages to disk in XML, TXT or in .esbmsg format.

7.1.  Save a single message

When you selected one message and you click the ‘save' button, you will be asked to enter a filename for the message to be saved.

7.2.  Save multiple messages

When you selected multiple messages and you click the ‘save' button, you will be asked to select a destination directory. SMM will save the messages to disk with a filename same as the JMS MessageId of the message.

7.3.  Save multipart message(s)

When you select one or more multipart messages SMM will save each part of that multipart message as a separate file. Using the file name you provided (or the JMS MessageId when you selected multiple files) SMM will ad a suffix to the message filename with the partnumber.

SMM can also save multipart message to .esbmsg format.

Chapter 8. Developer contact information




Gerco Dries

Progaia Resource Solutions

gdr at progaia-rs dot nl

Tako Grijpma

Progress Software

tgrijpma at progress dot com

Maurice Klein Breteler

Progress Software

mkleinbr at progress dot com

Yuan Yong Zhong

Progaia Resource Solutions

Humphrey Lopez


hlopez at triennium dot com

GNU General Public License

Version 2, June 1991

Free Software Foundation, Inc. 
  51 Franklin Street, Fifth Floor
  BostonMA 02110-1301

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Version 2, June 1991

A.1. Preamble

The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software - to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.

To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.

For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

We protect your rights with two steps:

  1. copyright the software, and

  2. offer you this license which gives you legal permission to copy, distribute and/or modify the software.

Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.

Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.

The precise terms and conditions for copying, distribution and modification follow.


A.2.1. Section 0

This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The “Program”, below, refers to any such program or work, and a “work based on the Program” means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term “modification”.) Each licensee is addressed as “you”.

Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.

A.2.2. Section 1

You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.

You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.

A.2.3. Section 2

You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:

  1. You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.

  2. You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.

  3. If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: If the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)

These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.

Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.

In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.

A.2.4. Section 3

You may copy and distribute the Program (or a work based on it, under Section 2 in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:

  1. Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

  2. Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,

  3. Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)

The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.

If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.

A.2.5. Section 4

You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.

A.2.6. Section 5

You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.

A.2.7. Section 6

Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.

A.2.8. Section 7

If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.

If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.

It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.

This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.

A.2.9. Section 8

If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.

A.2.10. Section 9

The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and “any later version”, you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.

A.2.11. Section 10

If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.

A.2.12. NO WARRANTY Section 11


A.2.13. Section 12



A.3. How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.

<one line to give the program's name and a brief idea of what it does.> Copyright (C) <year> <name of author>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Also add information on how to contact you by electronic and paper mail.

If the program is interactive, make it output a short notice like this when it starts in an interactive mode:

Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type “show w”. This is free software, and you are welcome to redistribute it under certain conditions; type “show c” for details.

The hypothetical commands “show w” and “show c” should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than “show w” and “show c”; they could even be mouse-clicks or menu items--whatever suits your program.

You should also get your employer (if you work as a programmer) or your school, if any, to sign a “copyright disclaimer” for the program, if necessary. Here is a sample; alter the names:

Yoyodyne, Inc., hereby disclaims all copyright interest in the program “Gnomovision” (which makes passes at compilers) written by James Hacker.

<signature of Ty Coon>, 1 April 1989 Ty Coon, President of Vice

This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.