Administering the Siebel Gateway System Service

The Siebel Gateway authenticates any client attempting to access configuration information. You set up the method of authentication during initial configuration.

Occasionally, you must stop and restart the Siebel Gateway system service for maintenance purposes. Restart the system service only when it is necessary. Running the Siebel Gateway system service represents the Siebel Gateway registry.

Administering the Siebel Gateway system service also sometimes requires you to start or stop the application container manually, as noted in "Starting and Shutting Down a Siebel CRM Deployment". See also the Siebel Installation Guide for the operating system you are using.

Note:

For compatibility with prior releases, the actual name of the system service is Siebel Gateway Name Server. However, this guide refers instead to Siebel Gateway, for consistency with current usage.

This topic includes the following information:

"About Siebel Gateway Authentication"
"Administering the Siebel Gateway System Service on Windows"
"Administering the Siebel Gateway System Service on UNIX"

About Siebel Gateway Authentication

This topic provides an overview of Siebel Gateway authentication. All of the server and client executable programs that connect to the Siebel Gateway, including the Siebel Server, pass a user name and password to the Siebel Gateway for authentication.

Configuration of Siebel Gateway authentication is part of initial configuration using Siebel Management Server. No additional configuration is required, unless, for instance, you change a data source, or choose to use a different means of authentication than that specified during initial configuration. For more information, see the Siebel Installation Guide for the operating system you are using and Siebel Security Guide. This topic is part of "Administering the Siebel Gateway System Service".

Administering the Siebel Gateway System Service on Windows

This topic describes how to start, stop, and check the status of the Siebel Gateway system service on Windows. This topic is part of "Administering the Siebel Gateway System Service".

Starting the Siebel Gateway System Service on Windows

This procedure describes how to start the Siebel Gateway system service on Windows.

To start the Siebel Gateway system service on Windows

Right-click My Computer.
Click Manage.

The Computer Management panel appears.
In the Computer Management tree, expand Services and Applications.
Click Services.
In the details panel, scroll through the list of services and select Siebel Gateway Name Server.
Right-click Siebel Gateway Name Server and select Start.

Windows starts the Siebel Gateway Name Server system service. This operation might take a few seconds. After the service has started, the Status field changes to Started.
If the application container is not running, then start it manually.

For more information, see Siebel Installation Guide for the operating system you are using.

Stopping the Siebel Gateway System Service on Windows

This procedure describes how to stop the Siebel Gateway system service on Windows.

To stop the Siebel Gateway system service on Windows

Right-click My Computer.
Click Manage.

The Computer Management panel appears.
In the Computer Management tree, expand Services and Applications.
Click Services.
In the details panel, scroll through the list of services and select Siebel Gateway Name Server.
Right-click Siebel Gateway Name Server and select Stop.

The Stop Other Services dialog box now appears and asks whether you want to stop the Siebel Server system service.
Click Yes.

Windows stops the Siebel Gateway Name Server system service. This operation might take a few seconds. After the service has stopped, the Status field is blank.
If the application container is not running, then stop it manually.

For more information, see Siebel Installation Guide for the operating system you are using.

Checking the Status of the Siebel Gateway System Service on Windows

This procedure describes how to check the status of the Siebel Gateway system service on Windows.

To check the status of the Siebel Gateway system service on Windows

Right-click My Computer.
Click Manage.

The Computer Management panel appears.
In the Computer Management tree, expand Services and Applications.
Click Services.
In the details panel, scroll through the list of services and select Siebel Gateway Name Server.

A value of Started in the Status field for the specified service indicates that the Siebel Gateway Name Server system service is running. If the Status field is blank, then the system service is not currently running.
Check whether the application container is running.

If you need to start or stop the application container manually, do so as described in Siebel Installation Guide for the operating system you are using.

Administering the Siebel Gateway System Service on UNIX

This topic describes how to start, stop, and check the status of the Siebel Gateway system service on UNIX. This topic is part of "Administering the Siebel Gateway System Service".

Starting the Siebel Gateway System Service on UNIX

This procedure describes how to start the Siebel Gateway system service on UNIX.

To start the Siebel Gateway system service on UNIX

On the Siebel Gateway computer, log in as the Siebel Service owner user.
Run the siebenv.sh or siebenv.csh script to set Siebel environment variables. For more information about these scripts, see Siebel Installation Guide for UNIX.
Enter the following command:
```
start_ns
```
With some of the available command-line flags, you can do the following:
- To specify the Siebel root directory, use the -r flag, as follows:
```
start_ns -r siebel_root
```
  Typically, you do not have to use this flag, because the SIEBEL_ROOT environment variable is set by the siebenv.csh (or siebenv.sh) script. If the variable is not set, then you must specify the Siebel root directory to indicate the Siebel installation under which the Siebel Gateway runs.
- To start the Siebel Gateway only if currently marked with the autostart attribute, use the -a flag, as follows:
```
start_ns -a
```
  Typically, use this flag only when invoking the start_ns script from an autostart script. For more information about the autostart script, see Siebel Installation Guide for UNIX.
- To force the startup, use the -f flag, as follows:
```
start_ns -f
```
  This command can be used to make sure that the Siebel Gateway starts even if it was not previously shut down completely. This flag is typically not needed.
Run the ps command and check whether the application container for the Siebel Gateway (javaw daemon process) is running.

If you need to start the application container manually, do so as described in Siebel Installation Guide for the operating system you are using.

Stopping the Siebel Gateway System Service on UNIX

This procedure describes how to stop the Siebel Gateway system service on UNIX.

To stop the Siebel Gateway system service on UNIX

On the Siebel Gateway computer, log in as the Siebel Service owner user.
Run the siebenv.sh script in the current shell process, as follows:
```
. ./siebenv.sh
```
Run the ps command and check whether the application container for the Siebel Gateway (javaw daemon process) is running.

If you need to stop the application container manually, do so as described in Siebel Installation Guide for the operating system you are using.
Enter the following command:
```
stop_ns -r siebel_root -f
```
With some of the available command-line flags, you can do the following:
- To specify the Siebel root directory, use the -r flag, as follows:
```
stop_ns -r siebel_root
```
  Typically, you do not have to use this flag, because the SIEBEL_ROOT environment variable is set by the siebenv.csh (or siebenv.sh) script. If the variable is not set, then you must specify the Siebel root directory to indicate the Siebel installation under which the Siebel Gateway is running.
- To force the shutdown, use the -f flag, as follows:
```
stop_ns -f
```
  This flag causes the Siebel Gateway to shut down sooner, but it might not shut down completely. In general, use the -f flag only if the Siebel Gateway did not respond to the unforced shutdown in a timely manner.

Checking the Status of the Siebel Gateway System Service on UNIX

This procedure describes how to check the status of the Siebel Gateway system service on UNIX.

To check the status of the Siebel Gateway system service on UNIX

Enter the following command:
```
list_ns
```
To specify the Siebel root directory, use the -r flag, as follows:
```
list_ns -r siebel_root
```
Typically, you do not have to use this flag, because the SIEBEL_ROOT environment variable is set by the siebenv.csh (or siebenv.sh) script. If the variable is not set, then you must specify the Siebel root directory to indicate the Siebel installation under which the Siebel Gateway is configured.
Run the ps command and check whether the application container for the Siebel Gateway (javaw daemon process) is running.

If you need to start or stop the application container manually, do so as described in Siebel Installation Guide for the operating system you are using.