Information Required to Define a Channel Group

ADDRESS VOX Commands › Voice Commands › SETGROUP Command › Information Required to Define a Channel Group

Information Required to Define a Channel Group

The stem variable varname that you specify on the VAR operand contains your group definition information.

The value in the varname.0 variable contains the number of groups that you want to define. Variables varname.1 through varname.n each contain a line of formatted information necessary to define one channel group.

The line of information containing a group definition is divided into several fields, as shown:

Field	Description
1	The group name (of up to eight characters) that you want to assign. Note: The group name ALL is a reserved name that includes all channels on a given notification server. You cannot change this name.
2	If the ANSWER command is waiting for incoming calls on the group, the value in this field specifies whether another REXX program can interrupt the ANSWER operation and retrieve one of the group's channels. Valid values are: YES--Releases a channel in the group if another REXX program requests it. Note: When the other REXX program releases the channel, CA Automation Point adds the channel back into the group automatically. NO--Does not release a channel in the group if another REXX program requests it.
3	The type of SETGROUP operation that you want to perform. Valid values are: ADD - Adds the following channels to the specified group. SET - Creates the specified group to contain only the following channels. REMOVE - Removes the following channels from the specified group. PURGE - Purges (deletes) the specified group and its associated channels.
4	The number of channels that you want this group to contain. Valid values range from 1 through the number of lines installed.
5	The first physical voice channel number to associate with the group.
6	The second physical voice channel number to associate with the group.
n	The nth physical voice channel number to associate with the group (specified in field 4).

Return Information:

After the SETGROUP command executes, it sets the special REXX return code variable RC.

If the command executes successfully, the RC variable contains a value of zero.
If the command does not execute successfully, the RC variable contains one of the following values: 5108, 5110, 5114, 5117, 5155, 5199, 5203, 5206. (See the Message Reference Guide for further information.) Additionally, the VOX.ERROR variable contains the complete VOX error message, which includes the four-digit return code and complete error message text.

Example:

Suppose that you want to define one new channel group-for use by your technical support department-with these characteristics:

The group name is SUPPORT.
An ANSWER operation on the group is not interruptible by other REXX programs.
The group contains four channels.
Channels 03, 04, 05, and 06 are available at your site.

Assume that you have specified the variable MYVARGRP to contain the group definition information. The variable MYVARGRP.0 contains a value of 1 and the group definition in variable MYVARGRP.1 looks like this:

SUPPORT  NO  ADD  4  03  04  05  06

The following REXX code illustrates how to use the SETGROUP command to create a new channel group:

/* Get a list of the available voice channels */
/* on the New York office's notification server.       */

address vox 'getgroup group(all) system(nyengine)'

if RC == 0 then
do
   parse var vox.getgroup.1 name interrupt numchannels channelsingroup

   /* Define a new channel group to contain */
   /* all available channels.               */ 

   newgroup.0 = 1
   newgroup.1 = "NEWGROUP" || " " || interrupt || " " || "set " || numchannels || " " || channelsingroup

   /* Create the new group on the New York office's notification server.*/

   address vox 'setgroup var(newgroup.) system(nyengine)'
   ...
end