Custom server parameters

For Blueworx Voice Response to communicate correctly with the ICM, you must set some command line parameters for the Cisco ICM custom server. The default is for the custom server to start in state table mode. Use the parameters listed in this section to customize the behavior of the custom sever:

-A <application launch file>
Defines the name of an application launch file, which is used when state tables are tested. See Application launch file.
-B <index number>
Defines the range of dialogue IDs for use by each VRU so that the dialogue IDs that are used are unique across all VRUs in a VRU/VRU PG pair. index number is an Integer in the range 1 through 200 that must be unique across all VRUs in a VRU/VRU PG pair. This Integer is used to calculate the range of dialogue IDs that each VRU uses; this range is ((<index number> * 500000) +1) through ((<index number> + 1) * 500000).
-c
Specifies that Blueworx Voice Response channel groups and logical channel numbers are to be used for reporting data that relates to telephony traffic to the ICM. If this parameter is not specified, Blueworx Voice Response physical card numbers and physical channel numbers are used when reporting telephony traffic to the ICM.
Note: If the -J parameter is used, -c does not need to be specified as channel groups and logical channel numbers will be used for reporting data to the ICM by default.
-d <debug level>
Defines whether to run the custom server in debug mode.

The following values for debug level can be specified:

1 or blank
Prints the contents of messages that flow between the custom server and the ICM.
2
Prints the following:
  • The data that is printed when -d1 is specified
  • The contents of messages that flow between the processes
  • The names of the procedures that are run
3
Prints the following:
  • The data that is printed when -d2 is specified
  • The contents of many of the variables

Debug information is written to the GeoTel.Log file.

-e <seconds>
Indicates that trunk group status messages should be sent every <seconds> seconds. The time interval must be in the range 1–600 seconds; the default value is 60 seconds. Applying this parameter modifies the behavior of the trunk group status message, such that trunks are considered out of service if they are busy, in addition to when they are actually out of service (blocked or unavailable). It also allows the use of the parameter to modify the frequency at which this check is made. This parameter should be used in environments where trunk availability data is critical to the performance of the platform, and where it is not possible to achieve the same results using data on the Cisco ICM platform.
-f <service definition file name>
Defines the name of the service definition file that is described in Service definition file.
-g <parameter definition file>
The fully qualified name of the parameter definition that you are using as the configuration parameters for the custom server. SeeRunning multiple instances of the Cisco ICM custom server for more information.
-h <host machine name>
Defines the host (TCP/IP) name of the machine to which the Cisco ICM simulator is to connect. It is stated as a name that is listed in the /etc/hosts file, or as an IP address in dotted-quad notation. For example, if the Cisco ICM custom server is on a machine called “leo”, specify the parameter as -hleo.
-I
Controls the debug informational messages that print to the GeoTel.Log file. If this flag is provided on the command line or in the properties window, these messages are printed. If the flag is not provided, the messages are not printed. This parameter is useful because it provides a level of debug that does not need such large file sizes or use as much disk space as the -d flag does. This flag performs this function only on Service Control Interface messages (that is, with the -U parameter selected).
-J <port number>
Instructs the custom server to start in Java mode. If you need to change the port number of the socket connection to Java, specify a number after the -J parameter. This number must match the InitServiceString in the Java configuration file. If no port number is specified, a default port number (7253) is used (and InitServiceString will not need to be defined.) For further information see Configuring for Java.
Note: If the custom server is started in Java mode, it cannot be used with state table applications, and vice versa.
-K
Indicates that the VRU supports the event data feed interface.
-L
Indicates that the VRU supports the Call Routing Interface.
-l <log file name>
Defines the name of the log file into which status and trace data is written. The default name is $OAM_LOG_PATH/GeoTel.Log. When the simulator is running in stand-alone mode, the default name is $OAM_LOG_PATH/GeoTel.Simulator.Log. The format of the status and trace data is described in Format of status and trace data.

Each time the custom server is started, data is appended to the log file. When the size of the log file reaches 500 000 bytes, it is renamed by appending a date stamp to its name.

-n <number of instances>
The number of instances of the Cisco ICM custom server that you want to run. Possible values are 1 to 5 inclusive. See Running multiple instances of the Cisco ICM custom server for more information.
-p <port number>
Defines the TCP/IP port number that is to be used to communicate with the ICM. The port number parameter is not required if the -s parameter is specified. If the -s and -p parameters are both specified, -p is used.
-s <service name>
Defines the name of the service that is held in the /etc/services file. It is used to determine the port number that is to be used to communicate with the ICM.
-T <test setup>
Defines how a test system is set up. To test the Cisco ICM custom server when it is not connected to an ICM, you can use this parameter to set up a test system. The test system can be set up either to run the Cisco ICM simulator as an additional process of the custom server, or to run the Cisco ICM simulator as a stand-alone process on a different machine. See Cisco ICM simulator. The values for test setup can be:
1 or blank
To run the simulator as an additional process in the custom server.
2
To run the simulator in stand-alone mode. If it is run on a second machine, the Cisco executable must be installed on the second machine.
-t <connection timeout>
Defines how long, in seconds, the custom server can try to connect to the ICM before the custom server is stopped. If this parameter is omitted, the custom server tries to connect until it succeeds, or is stopped.
-U
Indicates the VRU supports the Service Control Interface. This parameter is ignored if the ICM is at a version that is lower than 4.
-V
Indicates that the VRU supports the run script feature. This feature is available only if the -U parameter is selected.
-W
Indicates that the VRU supports the connect instruction to retarget calls. This is available only if the -U parameter is selected.
-X
Indicates that the VRU supports the release call operation. This is available only if the -U parameter is selected.
-Y
Indicates that the VRU supports the cancel request operation. This is available only if the -U parameter is selected.
-Z
Indicates that the VRU supports the blind transfer feature.
-z <time zone delta>
Defines the existing local time difference, in seconds, from UTC time (coordinated universal time). If this parameter is not specified, the system time zone delta is used.

Examples

In the following examples, where you are asked to enter a character string, you can type it on the command line while in the $CUR_DIR/GeoTel_dir directory for the GeoTel custom server (the GeoTel custom server is opened from the Custom Server Manager window.)

  1. To run the Cisco ICM custom server so that it communicates with an ICM on host 192.9.200.2, use:
    • port 44444
    • A service definition called service.def
    • The EDFI and CRI interfaces (enabled)
    and enter the following:
    GeoTel -K -h192.9.200.2 -p44444 -fservice.def
  2. To run the Cisco ICM custom server so that it communicates with an ICM on host leo, and writes status data into my.log, use:
    • Service dt6000
    • A service definition called service.def
    • The EDFI and CRI interfaces (enabled)
    and enter the following:
    GeoTel -K -sdt6000 -fservice.def -lmy.log -hleo
  3. To run the Cisco ICM custom server so that it communicates with an ICM on port 7001, and writes status data into the default log file, use:
    • A service definition called service.def
    • Channel groups and logical channel numbers for reporting telephony traffic
    • The EDFI and CRI interfaces (enabled)
    and enter the following :
    GeoTel -K -p7001 -fservice.def -c
  4. To test a state table using the Cisco ICM simulator running on port 9000, use:
    • A service definition file called service.def
    • The EDFI and CRI interfaces (enabled)
    and enter the following:
    GeoTel -K -p9000 -fservice.def -T
    Note: You must enter this example from the command line because you need to be able to enter input to the Cisco ICM simulator.
  5. To run the Cisco ICM custom server so that it communicates with host 192.9.200.2, and has the Run_Script, Connect, Release and Cancel operations enabled, use:
    • Port 7001
    • A service definition file called service.def
    • The SCI interface (but not the EDFI or CRI interfaces enabled)
    and enter the following:
    GeoTel -p7001 -h192.9.200.2 -fservice.def -U -V -W -X -Y
  6. To run the Cisco ICM custom server so that it communicates with host 192.9.200.3 and has the Run_Script operation supported, use:
    • Port 7001
    • A service definition file called service.def
    • The SCI and EDFI interfaces enabled
    and enter the following:
    GeoTel -p7001 -h192.9.200.3 -fservice.def -K -U -V
  7. To test a state table using the Cisco ICM simulator running on port 8000, that supports the Connect and Cancel operations, use:
    • A service definition file called service.def
    • The SCI and EDFI interfaces enabled
    and enter the following:
    GeoTel -p8000 -fservice.def -T -K -U -W -Y
    Note: You must enter this example from the command line because you need to be able to enter input to the Cisco ICM simulator.
  8. To run the Cisco ICM custom server in Java mode so that it communicates with host 192.9.200.3 and has the Run_Script operation supported, use:
    • Port 7001
    • A service definition file called service.def
    • The SCI interface enabled
    and enter the following:
    GeoTel -p7001 -h192.9.200.3 -fservice.def -U -V -J