Universal Messaging 10.7 | Administration Guide | Command Line Administration Tools | Syntax reference for command line tools | Syntax: Publish Tools
 
Syntax: Publish Tools
PublishChannel

Tool name:
PublishChannel

Description:
Publishes events to a Universal Messaging channel.

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

Examples:
PublishChannel -rname=nsp://localhost:9000 -channelname=mychannel
-message="hello world"

Required arguments:

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

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

Optional Parameters:

message :
Message to send. Put the message in quotes if it contains spaces.
You can't use -size along with -message.

count :
How many times to send the event. Default 1.

size :
Size in bytes of the message to send. Message will be generated.
You can't use -message along with -size.

properties :
Properties, if any, of the event. Expected syntax is
"propertyName1:value1;propertyName2:value2",
e.g. "shirt:green;price:80;sleeve:long".

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.
PublishChannelXML

Tool name:
PublishChannelXML

Description:
Publishes an XML document to a Universal Messaging channel.

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

Examples:
PublishChannelXML -rname=nsp://localhost:9000 -channelname=mychannel
-file=C:\myDoc.xml

Required arguments:

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

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

file :
File path of the XML document to send.

Optional Parameters:

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.
PublishCompressed

Tool name:
PublishCompressed

Description:
Publishes events to a store, using compression.

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

Examples:
PublishCompressed -rname=nsp://localhost:9000 -storename=mychannel
-message="hello world"

Required arguments:

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

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

Optional Parameters:

message :
Message to send. Put the message in quotes if it contains spaces.
You can't use -size along with -message.

count :
How many times to send the event. Default 1.

size :
Size in bytes of the message to send. Message will be generated.
You can't use -message along with -size.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.
PublishQueue

Tool name:
PublishQueue

Description:
Publishes events to a queue.

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

Examples:
PublishQueue -rname=nsp://localhost:9000 -queuename=myqueue
-message="hello world"

Required arguments:

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

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

Optional Parameters:

message :
Message to send. Put the message in quotes if it contains spaces.
You can't use -size along with -message.

count :
How many times to send the event. Default 1.

size :
Size in bytes of the message to send. Message will be generated.
You can't use -message along with -size.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.
PublishTX

Tool name:
PublishTX

Description:
Publishes events, as a part of a transaction, to a Universal Messaging
channel or queue.

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

Examples:

PublishTX -rname=nsp://localhost:9000 -storename=myStore
-message="hello world" -count=20 -txsize=5

PublishTX -rname=nsp://localhost:9000 -storename=myStore -size=2048

Required arguments:

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

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

Optional Parameters:

message :
Message to send. Put the message in quotes if it contains spaces.
You can't use -size along with -message.

count :
How many times to send the event. Default 1.

size :
Size in bytes of the message to send. Message will be generated.
You can't use -message along with -size.

txsize :
How many events to batch in a single transaction. Default 1.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.