Debugger Service

The Debugger Service handles communications between Web Tools and an Application Object Manager (AOM), such as Siebel Call Center, when debugging scripts or Workflow Processes. It can be run on any or all Siebel Servers in the Design Repository (DR) development environment. The service is defined as a Java process (DBGService.jar).

In general, when you start a debugging session, a Siebel Server will attempt to connect to a Debugger Service running on the same machine as the AOM. If there is no Debugger Service available on that machine, it will attempt to connect to a designated primary host.

Configuring the Primary Host

To configure the primary Debugger Service, you must perform a one-time setup task to create a subsystem named DBGSVC using the subsystem type "DbgProcCfg" and then set the following parameters:

Host. The hostname or server where the debugger service is hosted in an enterprise. It is the default host/server that the Debugger Service is going to connect to if there is no debugger service running on the same host/server that the Web Tools component is running on.
Port. The port at which the debugger service is run as a socket server. The value of this parameter must be between 0 and 65535 and should not be a well-known port or a port in use by any other process on that host. The configured value is passed as a parameter to the AOM from the Web Tools session, allowing the AOM to communicate back to the debugger service on that port. For information on common well-known ports, see https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml.

Note: If the Application Interface is running outside the firewall, then this port must be open to the Siebel Server machine where the debugger service runs.
TxnTimeout. This is an internal parameter used by the debugger service for reading the data at any given time interval. The value of this parameter should not exceed 10 digits, and the recommended value is 50 or 100 milliseconds. The configured value is passed as a parameter to the AOM.
MaxTasks. The maximum number of debugger sessions that the debugger service can run at a time. The value of this parameter should not exceed 10 digits, and the recommended value is 100. The configured value is passed as a parameter to the debugger service.

The Web Tools Script Debugger will not connect to the Debugger Service (DBGService.jar) if:

The named DBGSVC subsystem is not created
Any of the subsystem parameters are not set

Creating a Subsystem and Configuring Parameters from the Server Manager Utility

The following commands show how to create a named subsystem, list its parameters, and then configure its parameters from the Server Manager command-line utility (srvrmgr):

To create a named subsystem, go to server manager and type the following command:
```
create named subsystem DBGSVC for subsystem DbgProcCfg 
```
To list the parameters, type the following command:
```
list parameters for named subsystem DBGSVC 
```

To configure or change the values of parameters, type the following commands:

change parameter Host=<machine_name> for named subsystem DBGSVC
change parameter Port=<port> for named subsystem DBGSVC
change parameter MaxTasks=<tasks> for named subsystem DBGSVC
change parameter TxnTimeout=<txn_timeout> for named subsystem DBGSVC

For example:

change parameter Host=MySiebelServer.domain.com for named subsystem DBGSVC
change parameter Port=10000 for named subsystem DBGSVC
change parameter MaxTasks=100 for named subsystem DBGSVC
change parameter TxnTimeout=50 for named subsystem DBGSVC

Configuring the Debugger Service Properties

In addition to specifying the parameters in the Server Manager, the Script Debugger Java service must be configured in the dbgsrvr.properties file, located in the .../ses/siebsrvr/CLASSES folder. Where they have the same property names, values must match the subsystem parameter values defined previously:

Port. This parameter is described in Configuring the Primary Host.
TxnTimeout. This parameter is described in Configuring the Primary Host.
MaxTasks. This parameter is described in Configuring the Primary Host.
ShutDownPort. The port at which the debugger service is waiting for a stop command to exit gracefully. The value of this parameter must be between 0 and 65535 and should not be a well-known port or a port in use by any other process on that host.

Configuring Additional Instances of the Debugger Service

If using multiple instances of the Debugger Service, then note the following:

You can start the Debugger Service on any (or all) Siebel Servers where you want to host the additional Debugger Service.
You must configure the dbgsrvr.properties file on all Siebel Servers where the Debugger Service will be hosted. It is recommended that all values be the same on all hosts. Port is required to be the same.
The Web Tools Object Manager component will check whether the Debugger Service is running or not on its respective server:
- If the Debugger Service is running, then that instance will be used.
- If the Debugger Service is not running, then the primary Debugger Service defined by the DBGSVC named subsystem Host parameter will be used.

Enabling the Debugger Service

A Windows Service to launch the Debugger Service is created during installation of the Siebel Server. If it has been removed or the installer failed to create it, the service can be recreated by step 1 in the following procedure.

On UNIX platforms, the Debugger Service must be launched as a daemon process.

To enable the Debugger Service on Microsoft Windows:

If necessary, run the InstallDbgservice.bat batch file (located under .../ses/siebsrvr/bin) to create the DbgService entry in the standard Windows Services Control Panel. This is a one-time task.
On all hosts where the Debugger Service should run, configure the DbgService entry to start with the "Automatically (Delayed)" setting in the Services Control Panel. Using the "Delayed" option allows the Siebel Server to start before the Debugger Service.
Note: You can also manually control the DbgService (the debugger service) as required in the Windows Services Control Panel using the standard Start, Pause, Stop, and Restart buttons.

To enable the Debugger Service on UNIX:

Edit the existing Siebel Server startup and shutdown scripts as follows:
- Run ./startdbgsvc.sh (located under .../ses/siebsrvr/bin) to start the debugger service
- Run ./stopdbgsvc.sh (located under .../ses/siebsrvr/bin) to stop the debugger service