Tool name:
PeekQueue

Description:
Peeks all events on a Universal Messaging queue and prints statistics for
the bandwidth rates.

Usage:
runUMTool PeekQueue -rname=<rname> -queuename=<queuename> [optional_args]

Examples:

PeekQueue -rname=nsp://localhost:9000 -queuename=myqueue

Required arguments:

rname :
Connection URL to the realm where the channel exists.

queuename :
Name of a queue on the Universal Messaging Realm.

Optional Parameters:

selector :
Optional filter for the messages.

statevents :
How many events to peek before printing event statistics.
Default 1000.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.

Tool name:
SubscribeChannel

Description:
Reads all the messages from a Universal Messaging channel.

Usage:
runUMTool SubscribeChannel -rname=<rname> -channelname=<channelname>
[optional_args]

Examples:

SubscribeChannel -rname=nsp://localhost:9000 -channelname=channel

Required arguments:

rname :
Connection URL to the realm where the channel exists.

channelname :
Name of a channel on the Universal Messaging Realm.

Optional Parameters:

selector :
Optional filter for the messages.

starteid :
Starting EID of the messages to consume.

statevents :
How many events to peek before printing event statistics.
Default 1000.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.

Tool name:
SubscribeChannelAsync

Description:
Listens for messages on a Universal Messaging channel.

Usage:
runUMTool SubscribeChannelAsync -rname=<rname> -channelname=<channelname>
[optional_args]

Examples:

SubscribeChannelAsync -rname=nsp://localhost:9000 -channelname=channel

Required arguments:

rname :
Connection URL to the realm where the channel exists.

channelname :
Name of a channel on the Universal Messaging Realm.

Optional Parameters:

selector :
Optional filter for the messages.

starteid :
Start event ID of the messages to consume.

statevents :
How many events to peek before printing event statistics.
Default 1000.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.

Tool name:
SubscribeChannelAsyncDurable

Description:
Listens for messages on a Universal Messaging channel.
Running the tool with the same "-name" argument will continue reading
from the last unconsumed event.

Usage:
runUMTool SubscribeChannelAsyncDurable -rname=<rname>
-channelname=<channelname> [optional_args]

Examples:

SubscribeChannelAsyncDurable -rname=nsp://localhost:9000 -channelname=channel

Required arguments:

rname :
Connection URL to the realm where the channel exists.

channelname :
Name of a channel on the Universal Messaging Realm.

Optional Parameters:

selector :
Optional filter for the messages.

name :
Unique name of the durable subscriber. The name will be created
if it doesn't exist. Default is "STGE".

starteid :
Start EID of the messages to consume.

persistent :
Whether the durable name will exist after Universal Messaging
server reset. Default is false.

clusterwide :
Whether the durable name should be registered in the entire
cluster. Default is false.

autoack :
Whether each event will be automatically acknowledged by the API.
Default is true.

statevents :
How many events to peek before printing event statistics.
Default 1000.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.

Tool name:
SubscribeChannelDurable

Description:
Listens for messages on a Universal Messaging channel.
Running the tool with the same "-name" argument will continue reading
from the last unconsumed event.

Usage:
runUMTool SubscribeChannelDurable -rname=<rname> -channelname=<channelname>
[optional_args]

Examples:

SubscribeChannelDurable -rname=nsp://localhost:9000 -channelname=channel

Required arguments:

rname :
Connection URL to the realm where the channel exists.

channelname :
Name of a channel on the Universal Messaging Realm.

Optional Parameters:

selector :
Optional filter for the messages.

name :
Unique name of the durable subscriber. The name will be created if
it doesn't exist. Default is "STGE".

starteid :
Start event ID of the messages to consume.

persistent :
Whether the durable name will exist after Universal Messaging
server reset. Default is false.

clusterwide :
Whether the durable name should be registered in the entire
cluster. Default is false.

autoack :
Whether each event will be automatically acknowledged by the API.
Default is true.

statevents :
How many events to peek before printing event statistics.
Default 1000.

timeout :
Maximum wait time (milliseconds) when attempting to synchronously
retrieve message from the server. Default is 1000ms.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.

Tool name:
SubscribeCompressed

Description:
Listens for compressed messages on a Universal Messaging channel.

Usage:
runUMTool SubscribeCompressed -rname=<rname> -storename=<storename>
[optional_args]

Examples:

SubscribeCompressed -rname=nsp://localhost:9000 -storename=channel

Required arguments:

rname :
Connection URL to the realm where the channel exists.

storename :
Name of a channel or queue on the Universal Messaging Realm.

Optional Parameters:

selector :
Optional filter for the messages.

starteid :
If the chosen store is a channel, only messages with ID greater
than this will be consumed.

statevents :
How many events to peek before printing event statistics.
Default 1000.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.

Tool name:
SubscribeQueue

Description:
Reads all the messages from a Universal Messaging queue.

Usage:
runUMTool SubscribeQueue -rname=<rname> -queuename=<queuename> [optional_args]

Examples:

SubscribeQueue -rname=nsp://localhost:9000 -queuename=myqueue

Required arguments:

rname :
Connection URL to the realm where the channel exists.

queuename :
Name of a queue on the Universal Messaging Realm.

Optional Parameters:

selector :
Optional filter for the messages.

transacted :
Set to true to use transacted subscriber. Default is false.

statevents :
How many events to peek before printing event statistics.
Default 1000.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.

Tool name:
SubscribeQueueAsync

Description:
Listens for messages on a Universal Messaging queue.

Usage:
runUMTool SubscribeQueueAsync -rname=<rname> -queuename=<queuename>
[optional_args]

Examples:

SubscribeQueueAsync -rname=nsp://localhost:9000 -queuename=myqueue

Required arguments:

rname :
Connection URL to the realm where the channel exists.

queuename :
Name of a queue on the Universal Messaging Realm.

Optional Parameters:

selector :
Optional filter for the messages.

transacted :
Set to true to use transacted subscriber. Default is false.

statevents :
How many events to peek before printing event statistics.
Default 1000.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.