Administering Server System Services

This chapter describes the sequence in which to start up and shut down your Siebel deployment, and provides the procedures required to start, stop, and administer the Siebel Gateway system service and the Siebel Server system service.

This chapter includes the following topics:

Starting and Shutting Down a Siebel CRM Deployment

It is important to follow the correct sequence when starting or shutting down a Siebel CRM deployment, because several dependencies require that certain servers are running before others. Perform the following procedures to start or shut down your Siebel CRM deployment.

This topic contains the following information:

Related Books

Siebel Deployment Planning Guide

Siebel Installation Guide for the operating system you are using

Siebel Security Guide

Starting a Siebel CRM Deployment

This procedure describes how to start a Siebel CRM deployment. This topic is part of Starting and Shutting Down a Siebel CRM Deployment.

To start a Siebel CRM deployment

If necessary, start the Siebel database.
For more information about this task, see your database documentation.
Start the Siebel Gateway system service.
For more information, see Administering the Siebel Gateway System Service.
Start the application container for each applicable installed module.
For more information about stopping and starting the application container, see the Siebel Installation Guide for the operating system you are using. For information about configuring autostart for the application container on UNIX operating systems, see the Siebel Installation Guide for UNIX.
Start any third-party software, if applicable.
Start the Siebel Server system service.
The Siebel Server must connect to the Siebel Gateway and Siebel database on startup.
For more information, see Administering the Siebel Server System Service.

Shutting Down a Siebel CRM Deployment

This procedure describes how to shut down a Siebel CRM deployment. This topic is part of Starting and Shutting Down a Siebel CRM Deployment.

To shut down a Siebel CRM deployment

Shut down the Siebel Server system service.
When the Siebel Server system service is shut down, it shuts down server components and tasks before shutting down itself.
For more information, see Administering the Siebel Server System Service.

Note: To make sure that server components shut down properly, shut down Siebel Servers before shutting down the Siebel Server system service.
Shut down the application container for each applicable installed module.
For more information about stopping and starting the application container, see the Siebel Installation Guide for the operating system you are using. For information about configuring autostart for the application container on UNIX operating systems, see the Siebel Installation Guide for UNIX.
Shut down the Siebel Gateway system service.
For more information, see Administering the Siebel Gateway System Service.

Note: Make sure that all of the Siebel Servers are shut down before shutting down the Siebel Gateway service.
Shut down the Siebel database.
For more information about this task, see your database documentation. This step is not necessary if you are restarting your Siebel CRM deployment.

Administering the Siebel Gateway System Service

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 starts the Siebel Gateway registry.

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

The Siebel Gateway authenticates any client attempting to access configuration information. You set up the method of authentication during initial configuration. For more information, see About Siebel Gateway Authentication.

Administering the Siebel Gateway 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.

This topic contains the following information:

Related Books

Siebel Installation Guide for the operating system you are using

Siebel Security Guide

About Siebel Gateway Authentication

This topic provides an overview of Siebel Gateway authentication. All of the server and client side 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 Console. 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.

This topic contains the following information:

Starting the Siebel Gateway System Service on Windows

This topic 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 Starting and Shutting Down a Siebel CRM Deployment.

Stopping the Siebel Gateway System Service on Windows

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

To stop the Siebel Gateway system service on Windows

If the application container is running, then stop it manually.
For more information, see Starting and Shutting Down a Siebel CRM Deployment.
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 and the Siebel Server system service. This operation might take a few seconds. After the services have stopped, the Status field is blank.

Checking the Status of the Siebel Gateway System Service on Windows

This topic 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.
For more information, see Starting and Shutting Down a Siebel CRM Deployment.

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.

This topic contains the following information:

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.
To start the Siebel Gateway, enter a command like the following:
```
start_ns
```
The following are explanations of some of the available command-line flags:
- To specify the Siebel root directory, use the -r flag, as follows:
```
start_ns -r siebel_root
```
  Typically, you do not have to use the -r flag, because the script in the previous step sets the SIEBEL_ROOT environment variable. If the variable is not set, then you must specify the Siebel root directory, using this flag, 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 the -a 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 process daemon) is running. Start it if necessary.
For more information, see Starting and Shutting Down a Siebel CRM Deployment.

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 or siebenv.csh script in the current shell process.
For more information about these scripts, see Siebel Installation Guide for UNIX.
Run the ps command and check whether the application container for the Siebel Gateway (javaw process daemon) is running. Stop it as necessary.
For more information, see Starting and Shutting Down a Siebel CRM Deployment.
To stop the Siebel Gateway system service, enter a command like the following:
```
stop_ns -r siebel_root -f
```
The following are explanations of some of the available command-line flags:
- To specify the Siebel root directory, use the -r flag, as follows:
```
stop_ns -r siebel_root -f
```
  Typically, you do not have to use the -r flag, because the script in the previous step sets the SIEBEL_ROOT environment variable. If the variable is not set, then you must specify the Siebel root directory, using this flag, 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

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.
To check the status of the Siebel Gateway, enter a command like the following:
```
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 the -r flag, because the script in the previous step sets the SIEBEL_ROOT environment variable. If the variable is not set, then you must specify the Siebel root directory, using this flag, 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 process daemon) is running.
For more information, see Starting and Shutting Down a Siebel CRM Deployment.

Administering the Siebel Server System Service

Occasionally, you must stop and restart the Siebel Server system service for certain administrative changes to take effect. Restart the system service only when it is necessary.

Note: The Siebel Server system service must be running before any Siebel Server can be started.

Administering the Siebel Server 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.

This topic contains the following information:

Related Books

Siebel Installation Guide for the operating system you are using

Siebel Security Guide

Administering the Siebel Server System Service on Windows

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

This topic contains the following information:

Starting the Siebel Server System Service on Windows

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

To start the Siebel Server system service on Windows

If the application container is not running, then start it manually.
For more information, see Starting and Shutting Down a Siebel CRM Deployment.
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 the Siebel Server system service that you need (the enterprise name and Siebel Server name are indicated within square brackets).
Right-click Siebel Server and select Start.
Windows starts the Siebel Server system service. This operation might take a few seconds. After the service has started, the Status field changes to Started.

Stopping the Siebel Server System Service on Windows

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

To stop the Siebel Server 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 the Siebel Server system service that you need (the enterprise name and Siebel Server name are indicated within square brackets).
Right-click Siebel Server and select Stop.
Windows stops the Siebel Server system service. This operation might take a few seconds. After the service has stopped, the Status field is blank.

Note: A Microsoft Windows 1053 error might occur during this process. This error does not prevent the Siebel Server system service from stopping.
If the application container is running, then stop it manually.
For more information, see Starting and Shutting Down a Siebel CRM Deployment.

Checking the Status of the Siebel Server System Service on Windows

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

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

Check whether the application container is running.
For more information, see Starting and Shutting Down a Siebel CRM Deployment.
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 the Siebel Server system service that you need (the enterprise name and Siebel Server name are indicated within square brackets).
A value of Started in the Status field for the specified service indicates that the system service is running for the Siebel Server. If the Status field is blank, then the system service is not currently running.

Administering the Siebel Server System Service on UNIX

This topic describes how to start, stop, check, and reset the Siebel Server system service daemon process on UNIX. This topic is part of Administering the Siebel Server System Service.

This topic contains the following information:

Starting the Siebel Server System Service on UNIX

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

To start the Siebel Server system service on UNIX

On the Siebel Server 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.
Run the ps command and check whether the application container for the Siebel Server (javaw process daemon) is running. Start it if necessary.
For more information, see Starting and Shutting Down a Siebel CRM Deployment.
Enter the following command:
```
start_server siebel_server_name
```
In this command, siebel_server_name is the name of the Siebel Server.
You can run this script to start the system service for a specified Siebel Server (or servers), either within a specified Siebel Enterprise Server or across Siebel Enterprise Servers defined for the current installation. With some of the available command-line flags, you can do the following:
- To start multiple servers, enter the names of the Siebel Servers (separated by spaces), or enter all to start all of the Siebel Servers configured under the specified SIEBEL_ROOT on the particular server computer (or all of the Siebel Servers for a particular Siebel Enterprise Server, if the Siebel Enterprise Server name is specified, as described for the use of the -e flag). Use one of the following commands:
```
start_server server1 server2...
start_server all
```
- To specify the Siebel root directory, use the -r flag, as follows:
```
start_server -r siebel_root
```
  Typically, you do not have to use the -r flag, because the script in the previous step sets the SIEBEL_ROOT environment variable. If the variable is not set, then you must specify the Siebel root directory, using this flag, to indicate the Siebel installation under which the Siebel Server (or servers) run.
- To limit the operation to Siebel Servers in a specific Siebel Enterprise Server, use the -e flag, as follows:
```
start_server -e enterprise server1 server2...
```
  You do not have to use the -e flag if the SIEBEL_ENTERPRISE environment variable is set in the siebenv.sh or siebenv.csh script during initial configuration. If the variable is not set, then you must specify the Siebel Enterprise Server name. To start all of the servers for all of the Siebel Enterprise Servers configured for the SIEBEL_ROOT, do not use the -e flag (you might also have to unset the SIEBEL_ENTERPRISE environment variable).
  For example, to start the Siebel Server system services for the prod01 server in the Siebel Enterprise Server, use the -e flag, as follows:
```
start_server -e siebel prod01
```
- To start the Siebel Server system services for the prod01 and prod02 servers in the Siebel Enterprise Server, use the -e flag, as follows:
```
start_server -e siebel prod01 prod02
```
- To start only Siebel Servers that are marked with the autostart attribute, use the -a flag, as follows:
```
start_server -a
```
  Typically, use the -a flag only when invoking the start_server 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_server -f
```
  This flag can be used to make sure that the Siebel Server (or servers) start even if it was not previously shut down cleanly. This flag is typically not needed.
Note: Do not manually copy or rename the svc.siebsrvr.* filenames or any files in the SIEBSRVR_ROOT /sys directory. Additionally, do not delete the MW* (mainwin) files stored in the /tmp directory while the Siebel Server is running. These files are reused by components in the event of a component restart.

Stopping the Siebel Server System Service on UNIX

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

To stop the Siebel Server system service on UNIX

On the Siebel Server computer, log in as the Siebel Service owner user.
Run the siebenv.sh or siebenv.csh script in the current shell process.
For more information about these scripts, see Siebel Installation Guide for UNIX.
Run the ps command and check whether the application container for the Siebel Server (javaw process daemon) is running. Stop it if necessary.
For more information, see Starting and Shutting Down a Siebel CRM Deployment.
Enter the following command:
```
stop_server siebel_server_name
```
You can run this script to stop the system service for a specified Siebel Server (or servers), either within a specified Siebel Enterprise Server or across all of the Siebel Enterprise Servers defined for the current installation. With some of the available command-line flags, you can do the following:
- To stop multiple Siebel Servers, enter the names of the Siebel Servers (separated by spaces), or enter all to stop all of the Siebel Servers configured under the specified SIEBEL_ROOT (or all of the Siebel Servers for a particular Siebel Enterprise Server, if the Siebel Enterprise Server name is specified, as described for the use of the -e flag). Use one of the following commands:
```
stop_server server1 server2...
stop_server all
```
- To specify the Siebel root directory, use the -r flag, as follows:
```
stop_server -r siebel_root 
```
  Typically, you do not have to use the -r flag, because the script in the previous step sets the SIEBEL_ROOT environment variable. If the variable is not set, then you must specify the Siebel root directory, using this flag, to indicate the Siebel installation under which the Siebel Server (or servers) is running.
- To limit the operation to Siebel Servers in a specific Siebel Enterprise Server, use the -e flag, as follows:
```
stop_server -e enterprise server1 server2...
```
  You do not have to use the -e flag if the SIEBEL_ENTERPRISE environment variable is set in the siebenv.sh or siebenv.csh script during initial configuration. If the variable is not set, then you must specify the Siebel Enterprise Server name. To stop all of the Siebel Servers for all of the Siebel Enterprise Servers configured for the SIEBEL_ROOT, do not use the -e flag (you might have to unset the SIEBEL_ENTERPRISE environment variable).
- To stop the Siebel Server system service for the prod01 server in the Siebel Enterprise Server, use the -e flag, as follows:
```
stop_server -e siebel prod01
```
- To force the shutdown, use the -f flag, as follows:
```
stop_server -f
```
  This flag causes the Siebel Server to shut down sooner, but it might not give all of the components a chance to shut down cleanly. In general, use the -f flag only if the Siebel Servers did not respond to the unforced shutdown in a timely manner.
Note: A normal shutdown of the Siebel Server system service on UNIX deletes MainWin page files of the format MW* stored in the /tmp directory. You can safely delete these files if they remain after the Siebel Server shuts down. However, do not delete these files while the Siebel Server is running.

Resetting the Siebel Server System Service on UNIX

This procedure describes how to reset the Siebel Server system service on UNIX.

To reset the Siebel Server system service on UNIX

On the Siebel Server 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.
Run the ps command and check whether the application container for the Siebel Server (javaw process daemon) is running. You can shut it down and, if necessary, restart it later.
For more information, see Starting and Shutting Down a Siebel CRM Deployment.
To reset the Siebel Server system service, enter a command like the following:
```
reset_server siebel_server_name
```
Note: Use this script only if the Siebel Server system service is unable to start after an abnormal shutdown or crash of the Siebel Server computer. Do not use it as part of the normal operation of the Siebel Server.
You can run this script to reset the system service for a specified Siebel Server (or servers), either within a specified Siebel Enterprise Server or across all of the Siebel Enterprise Servers defined for the current installation. The names of one or more Siebel Servers (separated by spaces) must be specified on the command line.
The following are explanations of some of the available command-line flags:
- To reset multiple Siebel Servers, enter the names of the Siebel Servers (separated by spaces), or enter all to reset all of the Siebel Servers configured under the specified SIEBEL_ROOT (or all of the Siebel Servers for a particular Siebel Enterprise Server, if the Siebel Enterprise Server name is specified, as described in the use of the -e flag). Use one of the following commands:
```
reset_server server1 server2...
reset_server all
```
- To specify the Siebel root directory, use the -r flag, as follows:
```
reset_server -r siebel_root
```
  Typically, you do not have to use the -r flag, because the script in the previous step sets the SIEBEL_ROOT environment variable. If the variable is not set, then you must specify the Siebel root directory, using this flag, to indicate the Siebel installation under which the Siebel Server (or servers) is running.
- To specify the Siebel Enterprise Server under which the specified Siebel Server (or servers) is configured, use the -e flag, as follows:
```
reset_server -e enterprise server1 server2...
```
  You do not have to use the -e flag if the SIEBEL_ENTERPRISE environment variable is set in the siebenv.sh or siebenv.csh script during initial configuration. If the variable is not set, then you must specify the Siebel Enterprise Server name to indicate the Siebel Enterprise Server under which the Siebel Servers are configured. To reset all of the Siebel Servers for all of the Siebel Enterprise Servers configured for the SIEBEL_ROOT, do not use the -e flag (you might have to unset the SIEBEL_ENTERPRISE environment variable). Instead, use all for the enterprise variable.
- To reset the Siebel Server system service for the prod01 server in the Siebel Enterprise Server, use the -e flag in a command like the following:
```
reset_server -e siebel prod01
```