Channel and Queue Configuration Commands
Ensure that the Universal Messaging server instance is running before executing the following commands:
View all the configuration instances for a
Universal Messaging server instance using the
sagcc get configuration instances node_alias Universal-Messaging-umserver command.
Create a channel on a
Universal Messaging server instance using the
sagcc create configuration data node_alias Universal-Messaging-umserver UM-CHANNELS -i absolute path to the XML file containing channel properties command .
Update a channel on a
Universal Messaging server instance using the
sagcc update configuration data node_alias Universal-Messaging-umserver UM-CHANNELS-channel_name -f xml -i absolute path to the XML file containing channel properties command.
Create a queue on a
Universal Messaging server instance using the
sagcc create configuration data node_alias Universal-Messaging-umserver UM-QUEUES -i absolute path to the XML file containing queue properties command.
Update a queue on a
Universal Messaging server instance using the
sagcc update configuration data node_alias Universal-Messaging-umserver UM-QUEUES-queue_name -f xml -i absolute path to the XML file containing channel properties command.
Retrieve the configuration information of a specific channel using the
sagcc get configuration data node_alias Universal-Messaging-umserver UM-CHANNELS-channel_name command.
Retrieve the configuration information of a specific queue using the
sagcc get configuration data node_alias Universal-Messaging-umserver UM-QUEUES-queue_name command.
Examples
To view all the configuration instances for a
Universal Messaging server instance:
sagcc get configuration instances sag01 Universal-Messaging-umserver
sag01 is the alias name of the installation where the Universal-Messaging-umserver server instance is running.
To create a channel on a
Universal Messaging server instance:
sagcc create configuration data sag01 Universal-Messaging-umserver
UM-CHANNELS -i C:\Channels\channel_create.xml
sag01 is the alias name of the installation where the Universal-Messaging-umserver server instance is running. UM-CHANNELS is the configuration type and channel_create.xml is an XML file containing the channel attributes of the new channel that is created.
Format of the channel_create.xml file:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Channel>
<name>channel1</name>
<type>Persistent</type>
<ttl>0</ttl>
<capacity>0</capacity>
.......
</Channel>
To update a channel on a
Universal Messaging server instance:
sagcc update configuration data sag01 Universal-Messaging-umserver
UM-CHANNELS-channel1 -f xml -i C:\Channels\channel_edited.xml
sag01 is the alias name of the installation where the Universal-Messaging-umserver server instance is running. UM-CHANNELS-channel1 is the configuration type, in which channel1 is the name of the channel. channel_edited.xml is an XML file containing the channel attributes to be updated.
Format of the channel_edited.xml file:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Channel>
<name>channel1</name>
<type>Persistent</type>
<ttl>50000</ttl>
<capacity>50000</capacity>
<deadEventStore/>
<engine>JMS Engine</engine>
......
</Channel>
To create a queue on a
Universal Messaging server instance:
sagcc create configuration data sag01 Universal-Messaging-umserver
UM-QUEUES -i C:\queues\queue_create.xml
sag01 is the alias name of the installation where the Universal-Messaging-umserver server instance is running. UM-QUEUES is the configuration type and queue_create.xml is an XML file containing the attributes of the new queue.
Format of the queue_create.xml file:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Queue>
<name>queue1</name>
<type>Persistent</type>
<ttl>78</ttl>
<capacity>99</capacity>
<parent>umserver</parent>
......
</Queue>
To update a specific queue on a
Universal Messaging server instance:
sagcc update configuration data sag01 Universal-Messaging-umserver
UM-QUEUES-queue1 -f xml -i C:\queues\queue_edited.xml
sag01 is the alias name of the installation where the Universal-Messaging-umserver server instance is running. UM-QUEUES-queue1 is the configuration type, in which queue1 is the name of the queue to update. queue_edited.xml is an XML file containing the queue attributes to be updated.
Format of the queue_edited.xml file:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Queue>
<name>queue1</name>
<type>Persistent</type>
<ttl>50000</ttl>
<capacity>50000</capacity>
<parent>umserver</parent>
<deadEventStore/>
......
</Queue>
To retrieve configuration information about a specific channel:
sagcc get configuration data sag01 Universal-Messaging-umserver
UM-CHANNELS-channel1
sag01 is the alias name of the installation where the Universal-Messaging-umserver server instance is running. UM-CHANNELS-channel1 is the configuration type, in which channel1 is the name of the channel.
To retrieve configuration information about a specific queue:
sagcc get configuration data sag01 Universal-Messaging-umserver
UM-QUEUES-queue1
sag01 is the alias name of the installation where the Universal-Messaging-umserver server instance is running. UM-QUEUES-queue1 is the configuration type, in which queue1 is the name of the queue.