4Configuring Siebel Servers
Configuring Siebel Servers
This chapter describes Siebel Server configuration tasks and processes that you perform by using the Siebel Server Manager GUI and gives background information about Siebel system parameters. It includes the following topics:
About the Server Manager GUI
The Siebel Server Manager graphical user interface (GUI) consists of the views in the following server administration screens, which are available from the application Site Map:
Administration - Server Configuration
Administration - Server Management
Server Jobs
In general, use the Siebel Server Manager GUI to perform most administrative tasks, because it provides a more intuitive view into the operation of Siebel Servers than does the command-line interface.
As of Siebel CRM 18.7 Update, Siebel system administrators can configure server elements in the Siebel CRM deployment by using the Configuration screen in the Siebel Management Console. Administrators can perform tasks here that are equivalent to some of the tasks that you traditionally perform in the Administration - Server Configuration screen in the Siebel application or using the Server Manager command-line utility. The new functionality is provided as an alternative to the traditional methods. For more information, see the Siebel Installation Guide for the operating system you are using.
This topic contains the following information:
About the Enterprise Explorer View
The Administration - Server Configuration screen contains a view for reviewing enterprise data in an Explorer or hierarchical format. The Enterprise Explorer view provides an alternate means of navigation and a comprehensive layout of the enterprise data. You access this view by selecting Enterprise Explorer from the link bar.
About the Process Failure Diagnostics View
The Administration - Server Management screen contains the Process Failure Diagnostics view, which you can use for investigating process failures for Siebel Server components. You access this view by selecting Diagnostics from the link bar.
Related Topics
Related Books
Siebel Installation Guide for the operating system you are using
Siebel Applications Administration Guide
Siebel Security Guide
Siebel System Monitoring and Diagnostics Guide
About Siebel System Parameters
The Siebel application uses parameter values based on the level at which they are set. Parameter values at the highest levels are inherited by the same parameter at lower levels. For example, a parameter set at the enterprise level contains the same value for the same parameter at the server and component level, unless the value is overridden at a lower level. If a change is made to that parameter at the enterprise level, then this value is inherited down to the lower levels. The table in this topic lists the parameter-setting levels in order from highest to lowest.
If a parameter value is set at a lower level, and a new change is made to the same parameter at a higher level, then the new change does not inherit down to the lower level unless the override is deleted at that lower level.
delete parameter override command.
Once you set a parameter at a lower level, this value creates an entry in the Siebel Gateway registry and, from that time on, you must maintain it at this level. That is, any further changes that are to affect this level must be made at this level unless you delete the override.
This topic contains the following information:
Related Topics
Hierarchy of System Parameters
The following table lists the parameter-setting levels in order, from highest to lowest. Named subsystem parameters can apply to entities at different levels.
Table Hierarchy of System Parameters
Level |
System Parameter |
Comment |
|---|---|---|
1 |
Default from library |
Default, hard-coded values from the library. Does not apply for passwords and other parameters that require user-supplied values. |
2 |
Siebel Enterprise parameter |
For more information, see About Siebel Enterprise Server Parameters and Configuring Siebel Enterprise Parameters. |
3 |
Siebel Server parameter |
For more information, see About Siebel Server Parameters and Configuring Siebel Server Parameters. |
4 |
Siebel Server component parameter, enterprise level |
Enterprise-level Siebel Server component parameters are set by configuring component definition parameters. For more information, see Configuring Siebel Enterprise Component Definition Parameters and About Siebel Server Component Definitions. |
5 |
Siebel Server component parameter, server level |
For more information, see About Siebel Component Parameters and Configuring Siebel Server Component Parameters. |
6 |
Siebel Server component task parameter |
Configure these parameters mainly for batch tasks or when invoking tasks from a script or a workflow process. For more information, see About Task Parameters, Starting a Component Job, and Configuring Siebel Server Task Dynamic Parameters. |
About Advanced and Hidden Parameters
Parameters that affect or modify advanced product functionality are, by default, hidden from the Server Manager GUI.
To make advanced or hidden parameters visible, click Advanced or Hidden on the parameter views for the enterprise, Siebel Server, or components. To restore the default view, click Reset.
Related Topics
About Parameter Availability Status
The Server Manager GUI provides parameter availability status for system parameters at the following levels: enterprise, Siebel Server, component definition, component, task, and session. Certain parameters become available or effective only after specific Siebel Server operations are performed. Review the parameter availability status options to determine the type of action necessary to make your parameter change effective.
Table Parameter Availability Status Options
Availability Status |
Description |
|---|---|
Immediately |
These parameters are effective immediately and require no further Siebel Server operations. These parameter are also known as dynamic parameters. All other parameters are static parameters. |
At Next Task |
These parameters are effective at the start of the next task. |
At Component Restart |
These parameters require a restart of the server component before they become effective. |
At Server Restart |
These parameters require a restart of the Siebel Server before they become effective. |
Require Reconfiguration |
These parameters require the component definition to be reconfigured before they become effective. |
Related Topics
Reconfiguring Siebel Server Component Definitions
About Siebel Enterprise Server Parameters
Enterprise parameters set the attributes of the entire Siebel Enterprise Server. These parameters are initially set when the Siebel Enterprise Server is configured by using the Siebel Management Console. Each Siebel Server installed and configured in the Siebel Enterprise Server inherits these enterprise parameters. Many of the parameters that can be set at the enterprise level are server or named subsystem parameters, which can then be modified or overridden on each Siebel Server, as needed.
For example, if a Siebel environment contains multiple Siebel Servers, and the component parameters Maximum MT Servers (alias MaxMTServers) and Maximum Tasks (alias MaxTasks) are set at the enterprise level for a specific component with the values 5 and 100, respectively, then, unless override values are in effect, each Siebel Server in the environment runs this specific component with a maximum of 5 server processes (MaxMTServers) and a maximum 100 tasks (MaxTasks). The values 100 and 5 do not apply to the enterprise as a whole, but provide values for each instance of the component on an individual Siebel Server.
Related Topics
About Siebel Server Parameters
Siebel Server parameters set the attributes of each Siebel Server. These parameters are either used by the Siebel Server for its own operation, such as Shutdown Wait Time, or inherited by the components assigned to that Siebel Server.
The entire set of parameters for a given Siebel Server is a combination of the enterprise parameters inherited from the enterprise, and those specified when the Siebel Server is initially configured. Either type can be modified for any given Siebel Server.
If Siebel Server-level parameters are changed, then any future configurations to Siebel Enterprise Server-level parameters do not cascade down to the Siebel Server parameter level for that particular parameter. To restore this functionality, see the description of the appropriate delete parameter override command.
New values for Siebel Server-level dynamic parameters, which are parameters marked as Effective Immediately, apply to subsequently started tasks, unless these values are overridden at a lower level.
New values for static parameters, which are parameters not marked Effective Immediately, do not apply to subsequently started tasks until you stop and restart the Siebel Server system service. For both fixed and static parameters, the Server Manager views continue to show both the current value and the value upon Siebel Server restart.
Related Topics
About Siebel Component Parameters
Siebel component parameters set the attributes specific to a particular component type. These parameters are set initially when the defined component is created. For each component assigned to a Siebel Server, the component inherits the Siebel Enterprise and Siebel Server parameters applicable to that Siebel Server. The three types of parameters (except those marked Fixed when the defined component was created) can be overridden for the particular component on that Siebel Server.
If component-level parameters are changed, then any future configurations to Siebel Enterprise Server or Siebel Server-level parameters do not cascade down to the component parameter level for that particular parameter. To restore this functionality, see the description of the appropriate delete parameter override command.
New values for component-level dynamic parameters, which are parameters marked as Effective Immediately, apply to subsequently started tasks, unless these values are overridden at a lower level.
New values for static parameters (that is, parameters that are not marked Effective Immediately) do not apply to subsequently started tasks until you stop and restart the Siebel Server system service. For both fixed and static parameters, the Siebel Server Manager views continue to show both the current value and the value upon Siebel Server restart.
Related Topics
About Task Parameters
Task parameters control the execution of a specific task. These parameters consist of Siebel Enterprise, Siebel Server, and component-level parameters for the Siebel Server and the component for which the task is being executed, as well as task-specific parameters specified when you start a task. Task parameters are set or overridden when you first start the task. After a task is running, only dynamic parameters can be changed.
Related Topics
About Named Subsystem Parameters
Named subsystems are groupings of defined enterprise parameters, which allow the Siebel Server to manage multiple sets of parameter values. Like other server constructs, such as component definitions, server parameters, enterprise parameters, and component parameters, they are stored in the Siebel Gateway registry. When a Siebel Server starts, it retrieves this information and creates a copy of the named subsystems in shared memory. You can create named subsystems by using the Server Manager GUI or command-line interface.
The Server Manager GUI also refers to named subsytems as enterprise profiles. You create new named subsystems in the Profile Configuration subview of the Enterprises view in the Administration - Server Configuration screen.
By using named subsystems, the Application Object Manager can maintain several different values for a particular parameter. The value used by the Application Object Manager depends on the context. In other words, an Application Object Manager has several groups of parameters with context-dependent values: in context 1, parameters PA and PB have values V1A and V1B, respectively, whereas in context 2, the same parameters have values V2A and V2B.
For example, the Application Object Manager uses different configuration information that depends on the data source on which the business components are based. Which data source, and data source configuration, is used for a particular business component is context information that can come from several different sources. A business component can specify a data source in the compiled repository file, or a client can select a data source from several available data sources. Configuration information like database case sensitivity can have different values depending on the data source.
The parameters that have a context dependency are defined as named subsystem parameters. The component code that uses these named subsystems can request the subsystem parameter values by using a context name and will receive the value belonging to the named subsystem.
Named subsystem parameters are set at the enterprise level only. Parameter names associated with a data source usually start with DS so they do not conflict with the other parameters from the levels 2 to 6 in the table in About Siebel System Parameters. Named subsystem parameters have a higher priority than the default parameter settings that are hard-coded in their library.
Where they apply, named subsystem parameters override parameters set at the Siebel Enterprise, Siebel Server, and server component levels.
Related Topics
About Siebel System Parameters
Creating Siebel Enterprise Server Named Subsystems
Configuring Siebel Enterprise Server Named Subsystem Parameters
Configuring the Siebel Enterprise Server
This topic lists the configuration tasks applicable to the Siebel Enterprise Server. For more information about the Siebel Enterprise Server and the overall system architecture, see Siebel Enterprise Server Architecture. You initially configure the Siebel Enterprise Server modules using Siebel Management Console, as described in the Siebel Installation Guide for the operating system you are using.
This topic contains the following information:
About Assigned and Unassigned Component Group
Component groups are assigned to Siebel Servers within a Siebel Enterprise Server. Both predefined and defined components groups are automatically assigned to each Siebel Server installed and configured within an existing Siebel Enterprise Server. Component groups must be assigned to Siebel Servers before tasks can be started for the components belonging to the component group. Only make changes to the component group assignment if you want to unassign or reassign component groups to different Siebel Servers.
Unassigning a component group on a Siebel Enterprise Server results in:
No allocation of space in the shared memory segment for component groups after startup.
The removal of the component group entries from the Siebel Gateway data.
A loss of any component group customization (for example, parameter overrides at the component level).
Changes to the component group assignment state take effect only when the Siebel Server system service and Siebel Gateway system service are restarted.
Generally, only unassign a component group if the component group is not planned for future deployment on a particular server. Alternatively, you can disable a component group temporarily.
Related Topics
Unassigning Component Groups on a Siebel Server
Assigning Component Groups on a Siebel Server
Unassigning Component Groups on a Siebel Server
This topic describes how to unassign component groups on a Siebel Server.
To unassign a component group on a Siebel Server
Shut down the Siebel Server that contains the component group that you want to unassign.
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
In the Component Groups list, select the component group of interest.
In the Component Group Assignments list, select the Siebel Server of interest.
Click Unassign.
The Assigned? field for the specified component group on the specified Siebel Server no longer contains a check mark.
Restart the Siebel Server that previously contained the unassigned component group.
For the change to take effect, stop and restart the Siebel Server system service and Siebel Gateway system service.
Related Topics
Configuring the Siebel Enterprise Server
About Assigned and Unassigned Component Group
Administering the Siebel Gateway System Service
Assigning Component Groups on a Siebel Server
This topic describes how to assign component groups on a Siebel Server. You can assign component groups that are currently unassigned.
To assign a component group on a Siebel Server
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
In the Component Groups list, select the component group of interest.
In the Component Group Assignments list, select the Siebel Server of interest.
Click Assign.
The Assigned? field for the specified component group on the specified Siebel Server now contains a check mark.
For the change to take effect, stop and restart the Siebel Server system service and the Siebel Gateway system service.
Related Topics
Configuring the Siebel Enterprise Server
About Assigned and Unassigned Component Group
About Enabled and Disabled Component Groups
An enabled component group, at the enterprise level and server level, is one of the necessary conditions for execution of server component tasks belonging to that component group. Component groups are enabled and disabled independently at the enterprise and server level.
To enable or disable a component group at the enterprise level, the component group must be assigned on one or more Siebel Servers. To enable or disable a component group at the Siebel Server level, the component group must be assigned on this Siebel Server.
When creating a new component group, first assign the component group to the appropriate Siebel Servers before enabling the component group at the enterprise and server levels.
Enabled. The component group is enabled at the enterprise level. You can then configure the component group run state so tasks can be started for components within the component group.
Disabled. The component group is disabled at the enterprise level. You cannot configure the component group run state, and tasks cannot be started for components within the component group.
Disabling a component group results in:
Components that are unavailable on Siebel Servers, therefore, tasks cannot be started (existing tasks run to completion).
No allocation of space in the shared memory segment for those components when the Siebel Server is restarted.
For procedures for enabling and disabling component groups, see the following:
Related Topics
About Assigned and Unassigned Component Group
Checking Your Siebel Enterprise and Siebel Server Configurations
Enabling Component Groups on a Siebel Enterprise Server
This topic describes how to enable component groups on a Siebel Enterprise Server.
To enable a component group on a Siebel Enterprise Server
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
In the Component Groups list, select the disabled component group of interest.
Click Enable.
The Enable State field of the component group record changes to Enabled.
If the component group contains batch mode components, then synchronize Siebel Server components.
For the change to take effect, stop and restart the Siebel Server system service.
Related Topics
Configuring the Siebel Enterprise Server
About Enabled and Disabled Component Groups
Synchronizing Components on a Siebel Enterprise Server
Disabling Component Groups on a Siebel Enterprise Server
This topic describes how to disable component groups on a Siebel Enterprise Server.
To disable a component group on a Siebel Enterprise Server
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
In the Component Groups list, select the enabled component group of interest.
Click Disable.
The Enable State field of the component group record changes to Disabled.
If the component group contains batch mode components, then synchronize Siebel Server components.
For the change to take effect, stop and restart the Siebel Server system service.
Related Topics
Configuring the Siebel Enterprise Server
About Enabled and Disabled Component Groups
Synchronizing Components on a Siebel Enterprise Server
Configuring Siebel Enterprise Server Named Subsystem Parameters
This topic describes how to configure Siebel Enterprise Server named subsystem parameters.
To configure named subsystem parameters on a Siebel Enterprise Server
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Profile Configuration view tab.
In the Profile Configuration list, select the named subsystem (profile) of interest.
In the Profile Parameters list, select the parameter of interest and configure its value.
Related Topics
About Named Subsystem Parameters
Creating Siebel Enterprise Server Named Subsystems
This topic describes how to create Siebel Enterprise Server named subsystems.
The named subsystem parameters override the parameters that are set at the Enterprise Server, Siebel Server, and server component levels.
You can create and configure the named subsystems by using either the Siebel Server Manager GUI or the command-line interface.
To create named subsystems
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Profile Configuration view tab.
In the Profile Configuration list, click New.
In the Profile field, type the name of the named subsystem (profile). Do not exceed 30 characters when defining the name of the named subsystem.
In the Alias field, type the alias of the named subsystem.
In the Subsystem Type field, click the select button and then select the Subsystem Type from the dialog box and click OK.
The subsystem type that you select must have a check mark in the Is Named Enabled field.
In the Description field, type a description of the named subsystem.
Click Menu, and then Save Record.
In the Profile Parameters list, modify the parameters as appropriate.
Parameters are added to the named subsystem, based on the specified subsystem type.
Related Topics
About Siebel System Parameters
About Named Subsystem Parameters
Configuring the Siebel Enterprise Server
Configuring Siebel Enterprise Server Named Subsystem Parameters
Configuring Siebel Enterprise Parameters
This topic describes how to configure Siebel Enterprise parameters.
To configure Siebel Enterprise parameters
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Parameters view tab.
In the Enterprise Parameters list, select the parameter of interest and configure its value.
Related Topics
Configuring Siebel Enterprise Component Definition Parameters
This topic describes how to configure Siebel Enterprise Server component definition parameters.
To configure Siebel Enterprise Server component definition parameters
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Component Definitions view tab.
In the Component Definitions list, select the Siebel Server component definition of interest.
In the Component Parameters list, make any changes to the component parameters.
If the component definition is based on a batch mode component, then synchronize the component.
If a parameter value is effective at server restart, then restart the Siebel Server for changes to take effect.
The values of fixed parameters can be changed during component reconfiguration. Fixed parameters cannot be changed after the component has been activated or enabled.
Related Topics
About Siebel System Parameters
Configuring the Siebel Enterprise Server
Synchronizing Components on a Siebel Enterprise Server
About System Alert Notification
System alert notification is a feature that allows a running server component to alert the administrator, using preconfigured communication channels, to any problems that cannot be handled by the server component.
The system alert notification process starts when a server component that has been configured for component notification encounters a problem. This component sends a request to the Siebel Administrator Notification component (alias AdminNotify) with details on the encountered problem and with an appropriate message to send to the administrator. The AdminNotify component then alerts the administrator by using the preconfigured communication channels, for example, email.
AdminNotify is a batch mode, multithreaded server component and is part of the Auxiliary System Management (alias SystemAux) component group. This server component is enabled by default.
Some tasks involve configuring Siebel Server components for notification by using the Server Manager command-line interface.
Note the following points about system alert notification:
A server component event or task event triggers a system alert notification.
Losing database connectivity does not trigger a system alert notification.
If a Siebel Server that hosts an AdminNotify server component is forced to shut down, then the AdminNotify server component also shuts down, resulting in the loss of the system alert notifications for server components or tasks on that Siebel Server.
A server component or task on a Siebel Server cannot trigger an alert on an AdminNotify server component that is hosted by another Siebel Server in the Siebel Enterprise Server.
A change in the state of a component (for example, from running to online) does not trigger a system alert notification.
An administrator shutting down a server component does not trigger an alert.
The server components required for the communications channel that delivers the system alert notification must be enabled.
This topic contains the following information:
Related Topics
Configuring System Alert Notification
Configuring System Alert Notification
This topic describes how to configure system alert notification. It contains the following information:
Related Topics
About Siebel System Parameters
About Advanced and Hidden Parameters
Configuring Siebel Enterprise Parameters
About System Alert Notification
Configuring System Alert Notification
Creating a System Alert Profile
Use the following procedure for creating a system alert profile.
To create a system alert profile
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the System Alerts view tab.
In the System Alerts view, click New to create a system alert profile record.
Enter values for system alert profile Name, Alias, and Description.
Click the Media column drop-down list and select the system alert notification medium.
Click Menu, and then Save Record.
In the Alert Parameters list, enter values to define the communication parameters. For example, define the email addresses and email server if the notification medium is by email notification.
Related Topics
Configuring Server Components to Use System Alerts
Use the following procedure for configuring server components to use system alerts by setting applicable server component parameters.
To configure components to use system alerts
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Component Groups view tab.
In the Component Groups list, select the Siebel Server component group of interest.
In the Components list, select the server component of interest.
In the Component Parameters list, query for and set the parameters described in the following table.
Table Configuring System Alert Notification
Parameter Name |
Parameter Alias |
Description |
|---|---|---|
Notification Handler |
NotifyHandler |
The name of the system alert profile, which specifies the notification medium and settings for the component alerts. Set this value to the alias name of the system alert profile that you defined previously. |
Disable Notification |
DisableNotification |
A Boolean value that enables or disables server component notification. The default value is False. |
Time to Wait for doing Notification |
NotifyTimeOut |
Specifies the amount of time to wait in milliseconds for connecting to the named pipe, which is a system element used in notification communications. If the named pipe does not reply within the specified time, then the notification is terminated. The default value is 100 milliseconds. |
Notification Action on Task Exit |
NotifyOnTaskExit |
An integer value that determines if notifications are sent in case of error. A value of 0 disables error notifications. A value of 1 enables error notifications. The default value is 0. Set this parameter to 1 to configure system alerts. Note: This parameter is an advanced parameter, which might not be set for display in the GUI. |
Troubleshooting System Alert Notification
This topic provides guidelines for resolving problems with system alert notification. To resolve a problem, look for it in the list of symptoms or error messages in the following table.
Table Resolving System Alert Notification Problems
Problem |
Cause |
Solution |
|---|---|---|
Not receiving system alerts |
Incorrect enterprise, Siebel Server, or server component configurations |
Review information in Checking Your Siebel Enterprise and Siebel Server Configurations. |
SMTP server defined in the system alert profile is not configured to accept requests from the Siebel Server |
Review your SMTP server documentation to configure these requests. |
|
Review log files |
Review log files of server component AdminNotify for other error messages or conditions. For information about configuring and reading server component log files, see Siebel System Monitoring and Diagnostics Guide. |
Related Topics
About System Alert Notification
Configuring System Alert Notification
Checking Your Siebel Enterprise and Siebel Server Configurations
Configuring Component Job Templates
This topic describes how to configure a component job template, which you can use on Siebel Servers across an enterprise. A component job template is a predefined component job that uses parameter values that you have defined. Use component job templates instead of individual component jobs if you are planning to regularly run component jobs with the same parameter values.
To define a component job template
Navigate to the Administration - Server Configuration screen, then the Job Templates view.
In the Job Templates list, click New.
In the Name field, type in a descriptive name for the component job, such as Monthly EIM.
In the Short Name field, type in an alias for the component job, such as MonthEIM.
In the Component field, select the component for this component job, such as Enterprise Integration Manager.
Note: After a component job is created, do not change the value of the Component field. To change the component for an existing component job, create a new component job instead of modifying the existing one.In the Description field, type in a description of the component job.
Click Menu, and then Save Record.
In the Job Parameters list, click New.
In the Name field, select the parameter that you want to define for this component job.
In the Name field, click the select button.
The Component Parameters dialog box appears. The parameters that appear in the Component Parameters dialog box vary depending on the component that you specified in an earlier step.
In the Component Parameters dialog box, click Query.
In the Name field, type in the name of the parameter and click Go.
If the query matches the parameter of interest, then click OK.
In the Value field of the Job Parameters list, type in the value for the parameter.
The default value is automatically displayed in this field.
Check the appropriate flags for this parameter. To set the parameter type, use the following flags:
For a fixed parameter, check the Fixed field.
For a required parameter, check the Required field.
Click Menu, and then Save Record.
Continue to add parameters until you have defined the parameters for the component job.
Related Topics
Synchronizing Components on a Siebel Enterprise Server
This topic describes how to synchronize components on a Siebel Enterprise Server. You must synchronize batch mode Siebel Server components between the Siebel Gateway and the database whenever you:
Create new component definitions
Modify existing batch mode component definitions
Delete Siebel Server components
To synchronize components on a Siebel Enterprise Server
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Synchronize view tab.
A list of batch mode server components appears.
Click Synchronize.
This operation might take up to a minute to execute.
For the changes to take effect, stop and restart the Siebel Server system service.
Related Topics
Configuring the Siebel Server
This topic lists the configuration tasks and processes applicable to the Siebel Server. For more information about the Siebel Server and the overall system architecture, see Siebel Enterprise Server Architecture.
This topic contains the following information:
Enabling Component Groups on a Siebel Server
This topic describes how to enable Siebel Server component groups on an individual Siebel Server.
When you initially configure a Siebel Server, you specify which component groups to enable. When you have to change which groups are enabled or disabled, use the procedures described in this topic and the topic that follows. For more information about the initial configuration tasks for the Siebel Server, see the Siebel Installation Guide for the operating system you are using.
To enable a component group on a Siebel Server
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Component Groups view tab.
In the Component Groups list, select the Siebel Server component group of interest.
In the Component Groups Assignments list, select the Siebel Server of interest.
Click Enable.
The Enabled on Server? field of the Siebel Server record becomes checked.
For the change to take effect, stop and restart the Siebel Server system service.
Related Topics
About Enabled and Disabled Component Groups
Disabling Component Groups on a Siebel Server
This topic describes how to disable Siebel Server component groups on an individual Siebel Server.
To disable a component group on a Siebel Server
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Component Groups view tab.
In the Component Groups list, select the Siebel Server component group of interest.
In the Component Groups Assignments list, select the Siebel Server of interest.
Click Disable.
The Enabled on Server? field of the Siebel Server record becomes clear.
For the change to take effect, stop and restart the Siebel Server system service.
Related Topics
About Enabled and Disabled Component Groups
About Starting Siebel Server Components
When a component group is enabled, all of the server components within the component group are started and assigned to the Siebel Servers. The Siebel Servers are configured to use the component group provided that the server components are configured to start automatically. If the server components are not configured to start automatically, then you must start them manually.
You determine the state of a server component by viewing the value that appears in the State field for a component. This field is available, for example, when you choose Administration - Server Management, then Enterprises. The State field for a component can have one of the following possible values:
Running. The server component is online and accepting requests, and at least one task is running.
Online. The server component is online and awaiting a request.
For a multithreaded component, if the number of active running processes are greater than the value of the parameter MinMTServers, and no tasks are running for the component, then the state is Online.
For a background mode component, if the number of active running processes is less than the value of the parameter DfltTasks, and no tasks are running for the component, then the state is Online.
Not Online. The server component is not online. After the Siebel Server is restarted, this component state might occur temporarily before the component's state becomes Online. If the status Not Online persists, then an error is preventing the component from becoming online. Check the component log and fix the error to let the component state become Online again.
Partially Offline. The server component is partially offline and cannot start until the Siebel Server is restarted.
For a multithreaded component, if the number of active running processes is less than the value of the parameter MinMTServers, then the state is Partially Offline.
For a background mode component, if the number of active running processes is less than the value of the parameter DfltTasks, then the state is Partially Offline.
Unavailable. The server component is unavailable.
Paused. The server component is online but is not accepting new requests.
Shutting down. The server component is shutting down and cannot accept new requests. At least one task is still running.
Shutdown. The server component is shut down.
Related Topics
Automatically Starting a Component on a Siebel Server
Manually Starting or Disabling a Component on a Siebel Server
Automatically Starting a Component on a Siebel Server
This topic describes how to configure a Siebel Server component to start automatically when the Siebel Server starts.
To automatically start a component on a Siebel Server
Navigate to the Administration - Server Configuration screen, then the Servers view.
In the Siebel Servers list, select the Siebel Server of interest.
In the Components list, select the server component that you want to configure.
Click Auto Start.
The server component starts automatically when the Siebel Server starts.
Related Topics
About Starting Siebel Server Components
Manually Starting or Disabling a Component on a Siebel Server
Manually Starting or Disabling a Component on a Siebel Server
This topic describes how to configure a Siebel Server component so that you must manually start it after the Siebel Server starts.
To manually start a component on a Siebel Server
Navigate to the Administration - Server Configuration screen, then the Servers view.
In the Siebel Servers list, select the Siebel Server of interest.
In the Components list, select the server component that you want to configure.
Click Manual Start.
The server component requires that you start it after the Siebel Server starts.
Related Topics
Configuring Siebel Server Parameters
This topic describes how to configure Siebel Server parameters.
To configure Siebel Server parameters
Navigate to the Administration - Server Configuration screen, then the Servers view.
In the Siebel Servers list, select the Siebel Server of interest.
Select the Parameters view tab.
In the Parameters list, select the parameter of interest and configure its value.
Related Topics
About Siebel System Parameters
Configuring Siebel Server Component Parameters
This topic describes how to configure Siebel Server component parameters.
To configure Siebel Server component parameters
Navigate to the Administration - Server Configuration screen, then the Servers view.
In the Siebel Servers list, select the Siebel Server of interest.
Click the Components view tab.
In the Components list, select the Siebel Server component of interest.
Select the Parameters view tab below the Components list.
In the Component Parameters list, select the parameter of interest and configure its value.
Related Topics
About Siebel System Parameters
Checking Your Siebel Enterprise and Siebel Server Configurations
One of the main objectives of your Siebel Enterprise and Siebel Server configurations is to make sure that server components are properly configured and ready to execute tasks. Check the following items to make sure that you meet the necessary configuration conditions for this objective:
The component group that contains the server component member is enabled at the enterprise level.
The component group that contains the server component is enabled at the Siebel Server level.
The component definition is enabled. The component definition defines the configured component for the Siebel Enterprise and for all of its Siebel Servers.
If the previously listed conditions are true, then the Siebel Server allocates resources (some space in the shared memory and a public port) for the server component to use when the Siebel Server starts. The Siebel Server also marks the server component as ready (available) to start new tasks and performs any additional steps necessary, for example, starting shells if the server component is multithreaded. The number of multithreaded shells started is governed by the parameter Minimum MT Servers (alias MinMTServers). If the server component is a background mode component, then it starts the background number of tasks governed by the parameter Default Tasks (alias DfltTasks).
Related Topics
Enabling Component Groups on a Siebel Enterprise Server
About Siebel Server Component Definitions
If you want to use customized components, then you can create defined components or customize existing components. After it is defined, a component can have one of three definition states: Creating, Active, or Inactive.
Creating. Indicates that the defined component is being configured. After the definition is configured, activating the component definition fixes its configuration, changes the component's state to Active, and allows the component to be assigned to Siebel Servers. The fixed parameters for the defined component cannot be overridden when the component is assigned, or when tasks are started for the component.
Active. Indicates that the defined component definition state is available for registration on Siebel Servers.
Inactive. Indicates that the defined component will be inactivated when you restart the Siebel Server (or servers) to which the component is assigned. The component remains assigned to the Siebel Servers, but tasks cannot be started for the component until you revert the component definition state to Active and restart the Siebel Servers.
Parameter values in a component definition are used to initialize the component on a specific Siebel Server.
Related Topics
Configuring Siebel Enterprise Component Definition Parameters
Synchronizing Components on a Siebel Enterprise Server
Process of Creating a Custom Siebel Server Component
Process of Creating a Custom Siebel Server Component
This topic describes the process of creating a custom Siebel Server component.
To create a custom Siebel Server component
(Optional) Create a new component group.
Do not perform this task if you plan to add the new custom Siebel Server component to an existing component group. For information about this task, see Creating a Custom Siebel Server Component Group.
Create a new component definition.
For information about this task, see Creating a Custom Siebel Server Component Definition.
Activate the new component definition.
For information about this task, see Activating a Custom Siebel Server Component Definition.
Synchronize components if the new custom Siebel Server component is a batch mode component.
For information about this task, see Synchronizing Components on a Siebel Enterprise Server.
Stop and restart the Siebel Server system service.
For information about this task, see Administering the Siebel Server System Service.
Related Topics
About Siebel Server Component Definitions
Creating a Custom Siebel Server Component Group
If you want to create your own defined components and assign them to component groups other than the predefined ones, then you first must create component groups before creating the defined components. Component groups allow you to run related tasks and administer related components in logical groupings. Do not perform this task if you plan to add a new custom Siebel Server component to an existing component group.
This task is an optional step in Process of Creating a Custom Siebel Server Component.
To create a custom component group
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Component Groups view tab.
In the Component Groups list, click New.
In the Name field, type in a name for the component group.
The name must be unique across the Siebel Enterprise Server. Specify a name that expressively identifies the component group.
In the Alias field, type in an alias for the component group.
The component group alias must:
Be unique across the Siebel Enterprise Server
Not contain any spaces
The maximum alias length is dependent on the operating system.
In the Description field, enter a description of the component group.
Click Menu, and then Save Record.
Creating a Custom Siebel Server Component Definition
This topic describes how to create a custom Siebel Server component definition. Each custom server component definition is based on a Siebel Server component type.
This task is a step in Process of Creating a Custom Siebel Server Component.
To create a custom Siebel Server component definition
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Component Definitions view tab.
In the Component Definitions list, click Menu, and then New Record.
In the Component field, type in a name for the component.
The component name must:
Be unique across Siebel Enterprise Servers
Expressively identify the defined component
Not contain any numbers
In the Alias field, type in an alias for the component.
The component alias must:
Be unique across Siebel Enterprise Servers
Not contain any spaces
The maximum alias length is dependent on the operating system.
In the Component Type field, click the select button and choose the component type that you want to use as the template for this component.
- In the Description field, type in a description of this component.
In the Component Group field, click the select button and choose the component group to which this component will belong.
The group must exist before you can select it.
Note: You cannot modify the specified component group after you modify the component record.Click Menu, and then Save Record.
The State field changes to Creating.
In the Component Parameters list, make any changes to the component parameters that were created.
The values of fixed parameters can be changed during component reconfiguration. Fixed parameters cannot be changed after you activate the component.
Related Topics
Activating a Custom Siebel Server Component Definition
This topic describes how to activate a custom Siebel Server component definition.
This task is a step in Process of Creating a Custom Siebel Server Component.
To activate a custom Siebel Server component definition
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Component Definitions view tab.
In the Component Definitions list, select the component definition of interest (that is not currently activated).
Click Activate.
The component definition state field changes to Active.
If the component definition is based on a batch mode component, then synchronize the component.
For the change to take effect, stop and restart the Siebel Server system service.
Related Topics
Synchronizing Components on a Siebel Enterprise Server
Deleting a Siebel Server Component Definition
This topic describes how to delete a Siebel Server component definition.
To delete a Siebel Server component definition
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Component Definitions view tab.
In the Component Definitions list, select the component definition of interest.
Click Delete.
Related Topics
About Siebel Server Component Definitions
Deactivating a Siebel Server Component Definition
This topic describes how to deactivate a custom Siebel Server component definition.
To deactivate a Siebel Server component definition
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Component Definitions view tab.
In the Component Definitions list, select the component definition of interest (that is currently activated).
Click Deactivate.
The State field for the component definition changes to Inactive.
For the change to take effect, stop and restart the Siebel Server system service.
Related Topics
About Siebel Server Component Definitions
Process of Creating a Custom Siebel Server Component
Advanced Configuration Tasks
This topic lists advanced configuration tasks and processes applicable to the Siebel Enterprise Server and Siebel Server. For more information about the Siebel Server and the overall system architecture, see Siebel Enterprise Server Architecture .
For common configuration tasks for the Siebel Enterprise Server and Siebel Server, see:
This topic contains the following information:
Reconfiguring Siebel Server Component Definitions
Component reconfiguration is a process that allows existing component tasks to continue running until they finish, while starting new processes with reconfigured component parameter values. Each component can be reconfigured, but this task is primarily done for multithreaded components. This topic is part of Advanced Configuration Tasks.
Component reconfiguration is particularly useful for scenarios such as site migration. In this scenario, component reconfiguration allows you to maintain the existing component configuration, which remains available until the migration is complete and a new component configuration becomes available.
When a component reconfiguration is committed, this action signifies to every Siebel Server in the Siebel Enterprise Server that a new component definition is available and that new tasks should not start for that component. Existing tasks, however, continue to run until completion. The connected Siebel Servers then start new multithreaded processes for the component, using the new parameter values that were read from the Siebel Gateway registry. On each Siebel Server, the number of new multithreaded processes is governed by the parameter Minimum MT Servers (alias MinMTServers).
Previous component tasks that are not affected by the component reconfiguration can continue to run for some time. Therefore, the multithreaded processes hosting the tasks continue to run and the tasks occupy slots in shared memory. Because old and new multithreaded processes for the component are both running, there might be an increase in the number of multithreaded processes running on the Siebel Server computers.
Therefore, it is recommended that you run component definition reconfiguration at times when the server component workload is low, that is, when the component's existing tasks or sessions are few in number. Doing so allows the existing tasks or sessions on the old multithreaded processes to end, so that the total numbers of multithreaded processes and tasks do not exceed configured limits or exhaust system resources. When all of its tasks have ended, a multithreaded process eventually ends.
For each Siebel Server, initial sizing would have been performed, as described in Siebel Performance Tuning Guide. The total number of multithreaded processes for the component cannot exceed what is specified using the parameter Maximum MT Servers (alias MaxMTServers) and the total number of tasks cannot exceed what is specified using the parameter Maximum Tasks (alias MaxTasks).
Before reconfiguring Siebel Server components, make sure that:
All of the Siebel Servers running the server component designated for reconfiguration are running. This check makes sure that the server component instances receive the reconfigured parameter values.
Any external resources that are accessed by current tasks running on the existing component configuration remain available.
Examples of external resources include the configuration files that are defined in the component configuration.
The Siebel runtime repository in effect reflects the application configuration you require.
Any external resources that are defined in the new component configuration are available.
Any previous component reconfiguration process has already completed. If it has not, then you might have to wait before you can reconfigure again.
If existing multithreaded processes are still running along with reconfigured multithreaded processes, then the following error message might appear:
Unable to complete reconfiguration due to insufficient process resources.Starting another reconfiguration process at this time would require more reconfigured multithreaded processes on all applicable Siebel Servers, which might exceed the limits that you configured during sizing and tuning.
To reconfigure Siebel Server components
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Component Definitions view tab.
In the Component Definitions list, select the component definition that you want to reconfigure.
Click Menu, and then Start Reconfiguration.
The Definition State field changes to Reconfiguring.
In the lower Component Definitions list, change the Value field of parameters that you want to reconfigure for the component.
You can also change the values of fixed parameters, but you cannot change whether parameters are fixed.
After parameter values have been reconfigured, commit the new configuration by clicking Menu, and then Commit Reconfiguration.
The new parameter values are merged at the enterprise level. To cancel the reconfiguration before it has been committed, click Menu, and then Cancel Reconfiguration.
Related Topics
Related Books
Siebel Performance Tuning Guide
Configuring Automatic Restart for Server Components
Automatic restart is a feature that allows a Siebel Server component to automatically attempt a restart if the component exits with an error. For a user-defined number of times after the error, the Siebel Server tries to restart the component. This feature greatly reduces the administration of Siebel Server components. By default, this feature is disabled for all components. This topic is part of Advanced Configuration Tasks.
You can configure automatic restart by using the following parameters:
Auto Restart (alias AutoRestart)
Minimum Up Time (alias MinUpTime)
Number of Restarts (alias NumRestart)
The Minimum Up Time and Number of Restarts parameters combine to determine the number of restart attempts in a time interval allowed for a component (NumRestart multiplied by MinUpTime). If a component instance cannot be restarted after this time interval, then no new restart is attempted (therefore, the component instance will not run).
Typically, you set these parameters at the component level, but, depending on your system configuration, you might want to set these parameters at the Siebel Enterprise Server or Siebel Server levels.
Related Topics
Configuring Database Reconnect for Server Components
Database reconnect is an optional feature that enables Siebel Server components to automatically attempt a database connection following a database or network failure. At regular intervals after the failure, Siebel Server components try to reconnect to the database and resume any tasks that were rolled back due to the failure. This feature greatly reduces the administration of Siebel Server components. This topic is part of Advanced Configuration Tasks.
Without database reconnect, a database or network failure causes the Siebel Server component to shut down and all of the running tasks to crash. You must then manually restart all of the components that were shut down and rerun all of the tasks that crashed.
Database reconnect is enabled for all of the background mode and batch mode Siebel Server components, except for the Enterprise Integration Manager and Database Extract components. This feature is disabled for all of the interactive mode Siebel Server components (such as Synchronization Manager and all of the Application Object Manager components).
You can configure database reconnect by using the following parameters:
Number of Retries (alias NumRetries)
Retry Interval (alias RetryInterval)
Retry Up Time (alias RetryUpTime)
Set these parameters at the same level as the automatic restart parameters (typically, at the component level).
Related Topics
About Siebel System Parameters
Configuring Memory-Based Server Component Recycling
If certain multithreaded server components within your Siebel application are experiencing excessive memory consumption, then you can configure certain parameters to configure a component process to restart automatically. This feature, called component recycling, allows continued operation of server components without affecting end users. This topic is part of Advanced Configuration Tasks.
The memory-based component recycling feature operates as follows:
Identifies a process for recycling by monitoring virtual memory usage
Flags the process not to accept any new requests
Starts another process to take the place of the original process
Waits for all of the current tasks to complete
Shuts down the process, which releases memory resources back to the operating system
To configure memory-based recycling of server components, set the parameters Memory Usage Based Multithread Shell Recycling (alias MemoryBasedRecycle) and Process VM Usage Lower Limit (alias MemoryLimit) at the component level for the affected multithreaded server component. The parameter MemoryBasedRecycle allows the recycling feature to monitor the virtual memory of a process and begins the recycling procedure when a certain memory limit is reached. For example, on Windows, this virtual memory is the working set of a process. The parameter MemoryLimit sets the memory limit at which recycling occurs.
You can also set a value in percent for the parameter Process VM Usage Upper Limit (alias MemoryLimitPercent). The default value is 20. When memory usage exceeds the value of MemoryLimitPercent above MemoryLimit, a fast shutdown of the memory consuming process is triggered rather than a normal shutdown.
Set the parameters for memory-based server component recycling at the component level.
For a listing of preconfigured server components, see the table in Siebel Server Components, which indicates whether the server component is multithreaded and, therefore, eligible to use the memory-based recycling feature.
Related Topics
Deleting System Parameter Overrides
As previously described, lower-level system parameters inherit values from the same higher-level system parameters. However, modifying a lower-level parameter value sets an override at this level. That is, the lower-level parameter loses the ability to inherit values from higher-level parameters. To reinstate the default functionality, perform a delete parameter override operation on affected parameters. This topic is part of Advanced Configuration Tasks.
The following procedures describe how to delete parameter overrides for Siebel Enterprise Server parameters, Siebel Server parameters, component definition parameters, and Siebel Server component parameters.
This topic contains the following information:
Deleting a Parameter Override for a Siebel Enterprise Parameter
Deleting a Parameter Override for a Siebel Server Parameter
Deleting a Parameter Override for a Component Definition Parameter
Deleting a Parameter Override for a Siebel Server Component Parameter
Related Topics
Deleting a Parameter Override for a Siebel Enterprise Parameter
This procedure describes how to delete a parameter override for a Siebel Enterprise parameter.
To delete a parameter override for a Siebel Enterprise parameter
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Parameters view tab.
In the Enterprise Parameters list, select the parameter of interest.
Click Menu, and then Delete Parameter Override.
Deleting a Parameter Override for a Siebel Server Parameter
This procedure describes how to delete a parameter override for a Siebel Server parameter.
To delete a parameter override for a Siebel Server parameter
Navigate to the Administration - Server Configuration screen, then the Servers view.
Select the Parameters view tab.
In the Server Parameters list, select the parameter of interest.
Click Menu, and then Delete Parameter Override.
Deleting a Parameter Override for a Component Definition Parameter
This procedure describes how to delete a parameter override for a component definition parameter.
To delete a parameter override for a component definition parameter
Navigate to the Administration - Server Configuration screen, then the Enterprises view.
Select the Component Definitions view tab.
In the Component Definitions list, select the component definition that you want to reconfigure.
Select the Parameters view tab.
In the Component Parameters list, select the parameter of interest.
Click Menu, and then Delete Parameter Override.
Deleting a Parameter Override for a Siebel Server Component Parameter
This procedure describes how to delete a parameter override for a Siebel Server component parameter.
To delete a parameter override for a Siebel Server component parameter
Navigate to the Administration - Server Configuration screen, then the Servers view.
Select the Components view tab.
Select the component of interest.
Click the Parameters view tab below the Components view tab.
In the Component Parameters list, select the parameter of interest.
Click Menu, and then Delete Parameter Override.