Skip Headers
Siebel CRM System Administration Guide
Siebel Innovation Pack 2015, Rev. A
E24823-01
  Go to Documentation Home
Home
Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
 
Next
Next
  View PDF

Siebel Enterprise, Server, and Component Parameters

Table A-3 lists some of the Siebel Enterprise Server, Siebel Server, and generic parameters and their related attributes. More complete descriptions of each listed parameter follow this table. In most cases, the parameters with *** shown as the default value are initially set during the initial configuration tasks (based on the input specified by the administrator). For the parameters with +++ shown as the default value, the actual default values differ from component to component. Review the documentation pertinent to the individual component for more information.

Table A-3 Parameters and Attributes

Parameter Name Alias Level Req Override Effective Immed Dynamic Default Value

Enterprise Server Description

EnterpriseDesc

Enterprise

No

No

No

No

***

Indexspace Name

IdxSpace

Enterprise

No

Yes

Yes

Yes

***

ODBC Data Source

Connect

Enterprise

Yes

Yes

Yes

No

***

Siebel File System

FileSystem

Enterprise

Yes

Yes

Yes

No

***

Siebel Repository

Repository

Enterprise

No

Yes

No

No

Siebel Repository

Table Owner

TableOwner

Enterprise

No

No

No

No

***

Table Owner Password

TableOwnPass

Enterprise

No

No

No

Yes

***

Tablespace Name

TblSpace

Enterprise

No

No

No

No

***

Upgrade Component

UpgradeComponent

Enterprise

No

No

Yes

No

Siebel HQ Server

Auto Startup Mode

AutoStart

Server

No

No

Yes

No

True

Communication Transport

Comm

Server

Yes

No

Yes

No

TCPIP

Compression Type

Compress

Server

No

No

Yes

No

NONE

Component Priority Level Timeout

CompPriorityTime

Server

No

No

No

No

Not applicable

Encryption Type

Crypt

Server

No

No

Yes

No

NONE

Host Name

Host

Server

Yes

No

No

No

***

Log Archive Keep

LogArchive

Server

No

No

Yes

No

10

Log Segment Size

LogSegmentSize

Server

No

No

No

No

Not applicable

Log Maximum Segments

LogMaxSegments

Server

No

No

No

No

Not applicable

Server Description

ServerDesc

Server

No

No

No

No

***

Server Shutdown Wait Time

ShutdownTime

Server

No

No

Yes

Yes

60

Siebel Root Directory

RootDir

Server

Yes

No

No

No

***

Siebel Server Name

Server

Server

Yes

No

Yes

No

***

Size of Error Buffer

ErrorBufferSize

Server

No

No

No

No

1000

Synchronization Port

SyncPort

Server

Yes

No

Yes

No

40400

Alert Level

AlertLevel

Generic

No

Yes

Yes

Yes

1

Application Datasource

CFGDatasource

Generic

No

Not applicable

Yes

No

ServerDataSrc

Application Scripting Enabled

CFGEnableScripting

Generic

No

Not applicable

Yes

No

True

Application Shared Mode users directory

CFGSharedModeUsersDir

Generic

No

Not applicable

Yes

No

Not applicable

Auto Restart

AutoRestart

Generic

No

No

No

No

False

Compressed File Download

CompressedFileDownload

Generic

No

No

No

No

True

DB Multiplex - Max Number of Shared DB Connections

MaxSharedDbConns

Generic

No

Not applicable

No

No

-1

DB Multiplex - Min Number of Dedicated DB Connections

MinTrxDbConns

Generic

No

Not applicable

No

No

-1

DB Multiplex - Min Number of Shared DB Connections

MinSharedDbConns

Generic

No

Not applicable

No

No

-1

Default Processes

DfltProcs

Generic

Yes

Yes

Yes

Yes

0

Default Tasks

DfltTasks

Generic

Yes

No

No

No

0

EnableOpenUI

EnableOpenUI

Generic

No

No

No

Yes

Depends on Object Manager

EnableResponsive

EnableResponsive

Generic

No

No

No

Yes

False

Error Flags

ErrorFlags

Generic

No

Yes

Yes

Yes

0

HighInteractivity

HighInteractivity

Generic

No

No

No

Yes

Depends on Object Manager

Honor MaxTasks

HonorMaxTasks

Generic

No

No

No

No

False

Language Code

Lang

Generic

Yes

Yes

Yes

No

ENU

Locale Code

LocaleCode

Generic

Yes

Yes

Yes

No

***

Local load balancing upper threshold

UpperThreshold

Generic

No

Yes

No

No

100

Log Print Timestamp

LogTimestamp

Generic

No

Yes

Yes

Yes

False

Maximum depth of the query

MaxDepthOfTheQuery

Generic

No

No

No

No

500

Maximum MT Servers

MaxMTServers

Generic

Yes

No

No

No

1

Maximum Processes

MaxProcs

Generic

Yes

Yes

No

No

20

Maximum Tasks

MaxTasks

Generic

Yes

No

No

No

+++

Memory Usage Based Multithread Shell Recycling

MemoryBasedRecycle

Generic

No

Yes

No

No

False

Minimum MT Servers

MinMTServers

Generic

Yes

No

No

No

1

Minimum Up Time

MinUpTime

Generic

No

No

No

No

60

Multithreaded

Threaded

Generic

Yes

No

No

No

False

Number of lines after which to flush the log file

LogFlushFreq

Generic

No

No

Yes

No

0

Number of Restarts

NumRestart

Generic

No

No

No

No

10

Number of Retries

NumRetries

Generic

No

No

No

No

10000

Number of Sessions per SISNAPI Connection

SessPerSisnConn

Generic

No

Not applicable

No

No

20

OM - Data Source

DataSource

Generic

No

Not applicable

Yes

No

ServerDataSrc

OM - Named Data Source name

NamedDataSource

Generic

No

Not applicable

Yes

No

ServerDataSrc, GatewayDataSrc

OM - Model Cache Maximum

ModelCacheMax

Generic

No

Not applicable

Yes

No

10

OM - Preload SRF Data

PreloadSRF

Generic

No

Not applicable

No

No

False

OM - Resource Language Code

ResourceLanguage

Generic

No

Not applicable

Yes

No

Not applicable

OM - Save Preferences

SavePreferences

Generic

No

Yes

No

No

True

Password

Password

Generic

Yes

Yes

Yes

Yes

***

Process VM Usage Lower Limit

MemoryLimit

Generic

No

Yes

No

No

1500

Process VM Usage Upper Limit

MemoryLimitPercent

Generic

No

Yes

No

No

20

Retry Interval

RetryInterval

Generic

No

No

No

No

5

Retry Up Time

RetryUpTime

Generic

No

No

No

No

600

Session Keepalive Timeout

SessKeepAlive

Generic

No

Yes

No

No

7200

SISNAPI Connection Maximum Idle Time

ConnIdleTime

Generic

No

Yes

Yes

No

-1

SISNAPI - Log Traffic

LogTraffic

Generic

No

Not applicable

Yes

Yes

False

Sleep Time

SleepTime

Generic

No

Yes

Yes

Yes

60

SQL Trace Flags

SQLFlags

Generic

No

Yes

Yes

Yes

0

Static Port Number

PortNumber

Generic

Yes

No

Yes

No

0

Trace Flags

TraceFlags

Generic

No

Yes

Yes

Yes

0

Use IP Address

UseIPAddress

Generic

No

No

No

No

True

Use Shared Log File

LogUseSharedFile

Generic

No

Not applicable

No

No

False

User Name

Username

Generic

Yes

Yes

Yes

Yes

***


Siebel Enterprise Server Parameters

This topic describes in detail the Siebel Enterprise Server parameters listed in Table A-3.

Enterprise Server Description (alias EnterpriseDesc). A description of the Siebel Enterprise Server, used for identification in Server Manager views. The system prompts you for the value of this parameter during the configuration of the Siebel Enterprise Server after installation.

Indexspace Name (alias IdxSpace). The indexspace name for the Siebel database schema tables. This parameter specifies the name of the storage space in which to create the indexes for the Siebel database schema. The exact physical meaning of this parameter is database platform-specific. To determine whether this parameter applies to your database platform, see the Siebel Installation Guide for the operating system you are using.

ODBC Data Source (alias Connect). The ODBC data source name for the Siebel database schema connectivity. The default data source is created during the initial configuration of the Siebel Server, but can be overridden for a component or task. This data source must be created as a system DSN. Note that this parameter is case-sensitive.

Siebel File System (alias FileSystem). The Siebel File System path names. The specification of the File System paths must be valid relative to the computer on which the Siebel Server is installed. The value of the parameter cannot exceed 253 characters. Multiple File System directories can be specified for this parameter by using commas to delimit each directory. For example, the following value specifies two directories hosted on different server computers:

\\server_name1\fs\,\\server_name2\fs\

Siebel Repository (alias Repository). The name of the Siebel Repository for application configuration information. The default value is Siebel Repository. There can only be one active repository for each database.

Table Owner (alias TableOwner). The table owner for the Siebel database schema:

  • For Oracle Database, you are prompted for the default value for Table Owner during the Siebel Server initial configuration.

  • For Microsoft SQL Server, the value defaults to dbo.

Table Owner Password (alias TableOwnPass). The database password for the table owner account. This value must be set in order to run Siebel Server components that manipulate objects in the Siebel database schema.

Tablespace Name (alias TblSpace). The tablespace name for the Siebel database schema tables. This parameter specifies the name of the storage space in which to create the tables for the Siebel database schema. The exact physical meaning of this parameter is database platform-specific. To determine whether this parameter applies to your database platform, see the Siebel Installation Guide for the operating system you are using.

Upgrade Component (alias UpgradeComponent). Used by Siebel Anywhere to determine which Siebel Anywhere configuration is version-checked. By default, the value is Siebel HQ Server. On a regional Siebel Server, change this value to Siebel Regional Server.

Siebel Server Parameters

This topic describes in detail the Siebel Server parameters listed in Table A-3.

Auto Startup Mode (alias AutoStart). Indicates whether the Siebel Server components start automatically on Siebel Server startup. This parameter defaults to True, which indicates that the Siebel Server components are fully enabled and the default number of Siebel Server processes start when the Siebel Server system service starts (or the computer restarts). If Auto Startup Mode is set to False, then the Siebel Server components enter a shutdown state after the Siebel Server system service starts.

Communication Transport (alias Comm). The name of the transport type for network communications, for example, TCPIP.

Component Priority Level Timeout (alias CompPriorityTime). The amount of time to wait before starting lower-priority components. Components are prioritized as follows:

  • Components in the System Management component group have the highest priority. These components start first.

  • Components in the Auxiliary System Management component group start next.

  • Components in the remaining component groups have the lowest priority.

The Siebel Server starts components in the System Management component group and waits for the maximum number of seconds, specified by the Component Priority Level Timeout parameter, for these components to initialize. If, at the expiry of Component Priority Level Timeout, the components fail to initialize, then the Siebel Server attempts to start the components in the Auxiliary System Management component group. If the components in this component group fail to initialize before the expiry of Component Priority Level Timeout, then the Siebel Server attempts to start the lowest priority components.


Note:

The Siebel Server attempts to start lower-level components irrespective of the dependencies of these components in the Auxiliary System Management component group, such as File System Manager or Server Request Processor.

Compression Type (alias Compress). The type of compression for SISNAPI network communications (NONE or ZLIB) sent internally between the Siebel Web Server Extension (SWSE) and the Application Object Manager. This parameter is independent of the eapps.cfg configuration file parameter DoCompression, which configures compression between the SWSE and the browser client. Make sure that the compression type portion of the eapps.cfg configuration file parameter ConnectString is the same as the Compression Type parameter. For more information about the ConnectString parameter, see Appendix B, "Structure of the eapps.cfg File."

Encryption Type (alias Crypt). The type of encryption for network communications between Siebel Web Server Extension and the Application Object Manager (NONE, MSCrypto, or RSA). If you are running the Siebel Web Server Extension and the Siebel Server on the same computer, then you must set this parameter to either NONE or RSA. Make sure that the encryption type portion of the eapps.cfg configuration file parameter ConnectString is the same as the setting of the Encryption Type parameter. For more information about the ConnectString parameter, see Appendix B, "Structure of the eapps.cfg File." For more information about encryption, see Siebel Security Guide.

Host Name (alias Host). The name of the host computer on which the Siebel Server is installed. The value is set automatically during the initial configuration of the Siebel Server, but can be changed if you want to route connection requests through a network card bound to a different host name.

Log Archive Keep (alias LogArchive). The number of log archive directories to keep in the logarchive directory. Each time the Siebel Server system service starts, the current log subdirectory moves to the logarchive subdirectory, tagged with the incarnation number of the Siebel Server. This parameter indicates the number of previous logarchive directories to retain. If this parameter is set to 0, then the current log subdirectory is not archived upon startup of the Siebel Server system service. If this parameter is set to -1, then the Siebel Server keeps logarchive subdirectories. After moving the log directory, a new log directory is created, inheriting the permissions from the parent siebsrvr directory.

Log Segment Size (alias LogSegmentSize). Determines how large a segment of the log file is, in kilobytes. If you set this parameter to 5, then the log segment is 5 KB in size.

Log Maximum Segments (alias LogMaxSegments). Determines the number of log segments that are kept. If you set this parameter to 1, then only one segment is kept. When this segment reaches the size specified by the Log Segment Size parameter, the segment is overwritten. In general, set this parameter to a high value, such as 20. In this case, the twenty-first segment overwrites the first segment, and so forth.

Server Description (alias ServerDesc). A description of the Siebel Server, used for identification in Siebel Server Manager views. The value of this parameter is prompted for during the initial configuration of the Siebel Server.

Server Shutdown Wait Time (alias ShutdownTime). The time to wait (in seconds) during a Siebel Server shutdown before killing component processes. When a Siebel Server is shut down (either from the Siebel Server Manager, when the Siebel Server system service is stopped, or when the computer is shut down or restarted), the currently running component tasks are notified. If the tasks do not shut down within the time specified by the Server Shutdown Wait Time parameter, then the Siebel Server kills the component processes directly and then finishes shutting down. The default value of this parameter is 60 seconds.

Siebel Root Directory (alias RootDir). The root installation directory for the Siebel Server. Every Siebel Server subdirectory is directly under this directory (such as admin, dbtempl, docking, log, logarchive, upgrade, and so on). Do not change the value for this parameter.

Siebel Server Name (alias Server). The name of the Siebel Server. This parameter is specified during the initial configuration of the Siebel Server. The name of the Siebel Server cannot be changed after it is initially configured. The Siebel Server Name parameter can contain only alpha characters, numerals, underscores, or a combination thereof. Parameter names must also lead with an alpha character and can be no longer than 12 characters. For more information about the name of the Siebel Server, see the Siebel Installation Guide for the operating system you are using.

Size of Error Buffer (alias ErrorBufferSize). The number of entries in the shared memory circular error buffer used by the Siebel Server. This buffer receives all level 0 and level 1 error messages.

Synchronization Port (alias SyncPort). The TCP/IP port number for the Synchronization Server component. The Mobile Web Clients that synchronize with this Siebel Server must be configured to connect to this port when initiating a synchronization session (in the DockConnString parameter of the client configuration file).

Generic Parameters

This topic describes in detail some of the generic parameters listed in Table A-3. Many of these parameters can be set at the Siebel Enterprise Server, Siebel Server, or component levels.

Alert Level (alias AlertLevel). The level of logging to the Server Alert File. The value is set to 1 by default, but more detailed information can be specified by setting the parameter to a higher value. Currently, only levels 1 and 2 are supported. Level 1 sends only information about abnormal process and task terminations to the Alert File. Level 2 sends information about every process or task when it exits, whether normally or unexpectedly.

Application Datasource (alias CFGDatasource). The Application Object Manager default configuration data source. The value for this parameter is one of the values listed for the OM - Named Data Source name parameter.

Application Scripting Enabled (alias CFGEnableScripting). Determines whether the Application Object Manager server component can execute a server script. If you set this to True, then scripting DLL files are loaded and the application can then execute scripts. The default value for this parameter is True. Setting this parameter to False also disables browser scripts in addition to server scripts.

Application Shared Mode users directory (alias CFGSharedModeUsersDir). Specifies the users directory used in shared mode. Update the value of this parameter if you change the location of the Siebel File System.

Application * Font. Several parameters with names starting with Application and ending in Font specify fonts to use for Siebel application user interface elements unless these settings are overridden by font specifications in style sheets (CSS).

Auto Restart (alias AutoRestart). Indicates whether this component can be restarted automatically. This parameter works in conjunction with the Number of Restarts parameter to determine the number of attempts that are made to restart the target component.


Note:

For multithreaded server components, auto-restart does not occur if a process initially fails to start and is terminated by the Siebel application. Only processes that reach the running state are restarted.

Compressed File Download (alias CompressedFileDownload). By default, files are downloaded to a client's browser in a compressed form when using Siebel File System Manager. On certain versions of Microsoft Internet Explorer, this operation might result in the renaming of the file. If you want to disable compressed file download, then set this parameter to False for the Application Object Manager for which you want this feature to be disabled. The default value is True.

DB Multiplex - Max Number of Shared DB Connections (alias MaxSharedDbConns). One of two parameters that configure shared database connections. (The other parameter is DB Multiplex - Min Number of Shared DB Connections.) Shared connections are used by most Application Object Manager operations. DB Multiplex - Max Number of Shared DB Connections controls the maximum number of shared database connections, and is defined for each component. That is, DB Multiplex - Max Number of Shared DB Connections controls the maximum total number of shared database connections for the component on each Siebel Server, not an instance (task or process) of the component. A setting of -1 disables this parameter and is the default setting.

DB Multiplex - Min Number of Dedicated DB Connections (alias MinTrxDbConns). Controls the minimum number of dedicated database connections within an Application Object Manager process. Dedicated database connections are used primarily by specialized Siebel components, such as Siebel EAI, that need transactions to span multiple Application Object Manager operations. The DB Multiplex - Min Number of Dedicated DB Connections parameter is defined for each instance of the component. That is, DB Multiplex - Min Number of Dedicated DB Connections controls the minimum number of dedicated database connections for each instance (process) of the component, not for the entire component. This functionality is different from the parameters that configure shared database connections. A setting of -1 disables this parameter and is the default setting.

DB Multiplex - Min Number of Shared DB Connections (alias MinSharedDbConns). One of two parameters that configure shared database connections. (The other parameter is DB Multiplex - Max Number of Shared DB Connections.) Shared connections are used by most Application Object Manager operations. DB Multiplex - Min Number of Shared DB Connections controls the minimum number of shared database connections, and is defined for each component. That is, DB Multiplex - Min Number of Shared DB Connections controls the minimum number of shared database connections a component tries to maintain on each Siebel Server across all instances of this component. A setting of -1 disables this parameter and is the default setting.


Note:

Set the DB Multiplex - Min Number of Shared DB Connections parameter less than the value of the Maximum Tasks (alias MaxTasks) parameter. Setting this value greater than MaxTasks disables database connection pooling.

Default Processes (alias DfltProcs). The default number of component processes to start on Siebel Server startup. This parameter only applies to components that are defined to run in background mode. The processes that are instantiated during Siebel Server startup connect to the database using the values for the following Siebel Server-level parameters, unless they are overridden at the component level for any of the background mode components:

  • ODBC Data Source

  • Username

  • Password

Default Tasks (alias DfltTasks). The number of processes to start for a background mode component when the component is started explicitly through the Siebel Server Manager, or when the Siebel Server is started (if the component state was last set to Running). Components with a Default Tasks parameter set to a value greater than zero start automatically when the Siebel Server is started.

EnableOpenUI (alias EnableOpenUI). When set to True for an Application Object Manager, Siebel Open UI is enabled for this application, where the parameter HighInteractivity is also True. For more information about Siebel Open UI, see "About Siebel Open UI". For more information about enabling Siebel Open UI, see the Siebel Installation Guide for the operating system you are using and Deploying Siebel Open UI.

EnableSIDataLossWarning (alias EnableSIDataLossWarning). When set to True for employee applications using the standard interactivity client, a warning dialog box appears if the user attempts to change the context without saving changes. By default, this parameter is set to True.

EnabledTC (alias EnabledTC). When set to True for an Application Object Manager, enables a terms and conditions page that users must accept to be allowed into the Siebel application. Additional configuration steps apply, which are described on My Oracle Support in article 478253.1 (Article ID).

Error Flags (alias ErrorFlags). Specifies the flags used for tracing error information. This parameter is used to turn on various types of component-specific error tracing.

HighInteractivity (alias HighInteractivity). When HighInteractivity is set to True for an Application Object Manager, and when EnableOpenUI is set to True, Siebel Open UI is enabled for this application. When HighInteractivity is set to True for an Application Object Manager, and when EnableOpenUI is set to False, high interactivity is enabled for this application. See also the description for EnableOpenUI. For more information about Siebel Open UI and high interactivity, see Chapter 4, "Configuring the Browser for Siebel Web Clients." See also the Siebel Installation Guide for the operating system you are using.

Honor MaxTasks (alias HonorMaxTasks). When the parameter value is True, a component process that reaches Max Tasks stops accepting requests from the Server Request Broker. If another request is sent, then an error message results. The process resumes accepting requests after some tasks finish. If the parameter value is False, then all of the requests are queued in the component process.

Language Code (alias Lang). The three-letter language code for the component processes. Translatable messages (including error messages) are output in the specified language. The translated message files for the language must exist in the locale subdirectory of the Siebel Server installation. For more information, see Siebel Global Deployment Guide.

Locale Code (alias LocaleCode). The three-letter locale code for the component processes. A locale is a set of rules guiding how common data is displayed to the user or is received from the user. Siebel Business Applications support formatting of data, such as dates, time, numbers, and currency, based on locale settings. Locales are administered using the Locale view in the Administration - Data screen. For more information, see Siebel Global Deployment Guide.


Note:

Siebel Business Applications use the three-letter code conventions of Microsoft for locale and language code. For more information about setting locales, see Siebel Applications Administration Guide.

Local load balancing upper threshold (alias UpperThreshold). Determines the load threshold at which a new Application Object Manager process starts, and is based on the load percentage of a given Application Object Manager process. For example, setting this parameter to 80 percent on an Application Object Manager that handles 50 concurrent sessions starts a new Application Object Manager process when 40 sessions become active. The default value is 100 percent. For more information about load balancing, see Siebel Deployment Planning Guide.


Note:

If the Application Object Manager parameter Minimum MT Servers is equal to Maximum MT Servers, then the effective value for this parameter is 100 percent, despite the actual setting.

Log Print Timestamp (alias LogTimestamp). Specifies whether to print a timestamp on records written to the trace files. The value is set to True by default, but administrators might want to override it to False for components that perform a large amount of logging (or if a high value is set for the Trace Flags or SQL Trace Flags parameters).

Maximum depth of the query (alias MaxDepthOfTheQuery). Allows you to increase the maximum parse depth of a query with a large search specification, including, for example, a large number of OR or AND clauses.

You might receive this error: The query could not be run because it is too big. If you receive errors indicating that a query cannot run because it is too big, then you might refine the query to be more selective or to use parentheses. Alternatively, you can try setting this parameter to a larger value to eliminate the error. The default value is 500.

If you need to adjust this parameter value, then the setting you choose must correlate to the default stack size for your server operating system. For example, a value of 800 will generally work on Microsoft Windows, for which the default stack size is 1 MB, while a value of 500 will generally work on Linux or UNIX operating systems, for which the default stack size is 512 KB. If you increase the stack size for your operating system, then you can use a higher setting for this parameter.

You can optionally set this parameter at the enterprise level or the server level. You can also set MaxDepthOfTheQuery in the application configuration file for the Siebel Mobile Web Client or Developer Web Client (in the [InfraObjMgr] section), or set it in the tools.cfg file for Siebel Tools.


Caution:

Changing the operating system stack size can adversely impact the computer or application performance and should not be attempted without due diligence and consultation with experts.

Maximum MT Servers (alias MaxMTServers). Specifies the maximum number of multithreaded Siebel Server processes to be run concurrently for a component that has multithreading enabled. Note that only batch mode and interactive mode components can run with multithreaded set to True. Tasks and client sessions run as threads within the multithreaded Siebel Server processes.

The number of tasks that can run in each Siebel Server process is determined by the value of the Maximum Tasks parameter divided by Maximum MT Servers. Increase or decrease the value of Maximum MT Servers based on the number of users for the given component process. For more information about this parameter, see Siebel Performance Tuning Guide.

Maximum Processes (alias MaxProcs). Specifies the maximum number of concurrent running processes for a Siebel Server component. The Siebel Server must be restarted in order for any changes to this parameter to take effect.

Maximum Tasks (alias MaxTasks). Specifies the maximum number of background mode, batch mode, or interactive mode processes or threads that can run concurrently for a component. This value applies to threads for components that have multithreading enabled, or otherwise component processes. Increase or decrease this value based on the number of users for the given component process. This value also determines the number of tasks for each component that are tracked by the Siebel Server. For more information about this parameter, see Siebel Performance Tuning Guide.


Note:

Multithreaded Siebel Server processes are not included in the counting of tasks. The tasks run as threads within the processes. These multithreaded processes are guided by the Minimum MT Servers and Maximum MT Servers parameters.

Memory Usage Based Multithread Shell Recycling (alias MemoryBasedRecycle). If it is set to True, then processes for this component are recycled automatically when virtual memory usage reaches a specified threshold. The threshold is set using the parameter Process VM Usage Lower Limit. For example, when a component is set with this parameter and the memory usage has exceeded the configured threshold, the recycling procedure begins by disabling new tasks, spawning a new process, and commencing a normal shutdown (that is, waiting for all of the tasks to finish before shutting down). The default value is False. Use this parameter to remedy your application only if excessive memory usage created by memory leaks seems to be occurring.

Minimum MT Servers (alias MinMTServers). Specifies the default number of multithreaded Siebel Server processes that are started for a component that has multithreading enabled. These processes are brought up when the component is started explicitly through the Siebel Server Manager, or when the Siebel Server is started (if the component state was last set to Running).

Additional multithreaded Siebel Server processes are started as needed (namely, when the maximum number of threads that can run in a Siebel Server process has been reached), up to the value of the Maximum MT Servers parameter. Setting this parameter to 0 disables the component. For more information about this parameter, see Siebel Performance Tuning Guide.

Minimum Up Time (alias MinUpTime). Specifies the minimum time that a multithreaded server component such as an Application Object Manager must be up for a restart to be successful (in seconds). In order for the component restart to be considered successful, the component must be running for the duration specified by this parameter. This parameter works with the Number of Restarts parameter 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 (the component instance will not be running). The default value for this parameter is 60 seconds.

Multithreaded (alias Threaded). Specifies whether the component is multithreaded or multiprocess. This parameter only applies to batch-mode and interactive-mode components. Use the default value for this parameter.


Caution:

Do not change the value of this parameter without direct guidance Global Customer Support. For help with changing the value of this parameter, create a service request (SR) on My Oracle Support. Alternatively, you can phone Global Customer Support directly to create a service request or get a status update on your current SR. Support phone numbers are listed on My Oracle Support.

Number of lines after which to flush the log file (alias LogFlushFreq). Specifies how often data is written to the log file. Set the value to n so that data is written to the log file every n lines. For example, set the value to 1 to write every line to the log file. Set the value to 0 (default value) to allow the operating system to determine when to write data to the log file.

Number of Restarts (alias NumRestart). Specifies the number of times that a multithreaded server component can be restarted if it exited with errors in less than the time set for Minimum Up Time. This parameter works with Auto Restart to determine whether multithreaded server components will be restarted. This parameter also works with the Minimum Up Time parameter 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 restarts are attempted. (In this situation, the component instance will not be running.) The default value for this parameter is 10.

Number of Retries (alias NumRetries). Specifies the number of retries for recovery. This parameter works with the Retry Interval and Retry Up Time parameters to reconnect multithreaded server components to the database if database connectivity has been lost.

Number of Sessions per SISNAPI Connection (alias SessPerSisnConn). Specifies how many sessions can be multiplexed (shared) through each SISNAPI connection, which helps to reduce the number of open network connections. SISNAPI connections are those between the Web server (SWSE) and the Application Object Manager. If Number of Sessions per SISNAPI Connection is -1, then all of the sessions are created through only one SISNAPI connection. The default value for this parameter is 20. However, while 20 is a good value to use for user sessions, it does not apply to incoming HTTP requests from other systems, for example, EAI HTTP Adapter access.

OM - Data Source (alias DataSource). Specifies the Application Object Manager data source.

OM - Named Data Source Name (alias NamedDataSource). Lists the named subsystems that the Application Object Manager preloads when it initializes. That is, all of the data sources that the Application Object Manager might use are listed in the value.

OM - Model Cache Maximum (alias ModelCacheMax). Specifies the size of the cache for model objects (also known as cached sessions) in object manager-based server components, such as Workflow Process Manager. Each model in the cache creates two database connections for the life of the model. (One connection is for insert, update, and delete operations. The other connection is for read-only operations.) The model cache improves performance for the object manager-based server components, and it is generally recommended not to disable this parameter. The default value is 10. A value of 0 disables this parameter, and the maximum setting for this parameter is 100. For more information about setting this parameter, see Siebel Performance Tuning Guide.

OM - Preload SRF Data (alias PreloadSRF). Determines whether to preload all of the Siebel repository file (SRF) information upon startup of an Application Object Manager server component. If the value is False (the default setting), then the Siebel repository file data is loaded only at first task or Siebel Web Client connection request, which can delay the startup page.


Note:

Do not set OM - Preload SRF Data to True for single-threaded object manager components, which includes EAI receivers such as MQSeries Server Receiver. If OM - Preload SRF Data is True, the Siebel Server will try to initialize the EAI receiver twice, causing it to fail.

OM - Resource Language Code (alias ResourceLanguage). Specifies the language code used for Application Object Manager resources. Each language has its own three-letter code identifier. For example, ENU identifies U.S. English. For more information, see Siebel Global Deployment Guide.

OM - Save Preferences (alias SavePreferences). Set the value for this parameter to False to prevent the Application Object Manager from creating or reading user preference files (file extension is .spf). When True (the default value) for Siebel Open UI or high interactivity applications, the Application Object Manager creates a user preference file when a user logs in, if one does not already exist. For standard interactivity applications, the Application Object Manager does not create user preference files.

OM - Timed Statistics (alias TimedStats). Enables the use of the statistics in the Administration - Server Management screen, Statistics view. Statistics include Average Connect Time (seconds), Average Response Time (milliseconds), and Average Think Time (seconds). Restart the Siebel Server for this parameter to take effect. The statistics are refreshed on completion of each task, so a specific user session must log out for the statistics for that session to be reflected in the Statistics screen. This is an advanced parameter.

When a task for a component completes its operation, both generic and component-specific statistics roll up to the component level. Only generic statistics roll up to the Siebel Server level. The statistics data will be reset when the component is restarted.

Password (alias Password). Specifies the database user password. This parameter specifies the password for the account referenced by the User Name parameter. Both the user name and password are prompted for during the initial configuration of the Siebel Server. The User Name and Password parameters are used to connect to the database for automatic startup of background mode components, for example. See also the description for the Auto Startup Mode parameter in "Siebel Server Parameters" and Table A-3.

Process VM Usage Lower Limit (alias MemoryLimit). Sets the virtual memory usage threshold (in megabytes). A component process that reaches this threshold is recycled. The parameter to enable this feature is Memory Usage Based Multithread Shell Recycling. Use this parameter to remedy your application only if excessive memory usage created by memory leaks seems to be occurring.

Process VM Usage Upper Limit (alias MemoryLimitPercent). Specifies the percentage above the value of Process VM Usage Lower Limit at which a fast shutdown is triggered.

Retry Interval (alias RetryInterval). Defines the time interval before a series of retries are made for recovery. This parameter works with the Number of Retries and Retry Up Time parameters to reconnect multithreaded server components to the database if database connectivity has been lost.

Retry Up Time (alias RetryUpTime). Specifies the minimum up-time for a new set of retries for recovery. This parameter works with the Number of Retries and Retry Interval parameters to reconnect multithreaded server components to the database if database connectivity has been lost.

Session Keepalive Timeout (alias SessKeepAlive). Specifies the time that a task waits for a message from the client before timing out. When the time-out interval passes, the task ends the client session. The default value is 7200 seconds (two hours). This is a hidden parameter.

SISNAPI Connection Maximum Idle Time (alias ConnIdleTime). Configures the connection timeout between the Web server and the Siebel Server. Valid values are numeric, specifying the period of idle time (in seconds) after which the connection is disconnected by the component. See the following table for parameter setting descriptions. It is recommended that you set this parameter to a value slightly below the firewall connection timeout value. The default value is -1.


Note:

There is no direct relationship between this parameter and the SessionTimeout parameter in the eapps.cfg configuration file. The SISNAPI Connection Maximum Idle Time parameter controls the SISNAPI connection behavior while the SessionTimeout parameter controls the user session behavior.

SISNAPI - Log Traffic (alias LogTraffic). Specifies whether the Application Object Manager records a log of all of the Siebel Internet Session API (application programming interface) messages. SISNAPI is a session-based remote procedure call (RPC) designed to support high responsiveness between the Siebel Server and client applications.

Sleep Time (alias SleepTime). Specifies the time to sleep between iterations (in seconds). This parameter is used for the sleep time of component processes running in background mode when the Siebel Server is idle.

SQL Trace Flags (alias SQLFlags). The flags for tracing of SQL statements. If this parameter is set to 1, then every SQL statement issued by the component tasks is logged to the information log file for each task. If this parameter is set to 2, then each SQL statement is logged in addition to information about the number of parse, execute, and fetch calls, and timing information about each type of call.

Static Port Number (alias PortNumber). Specifies the network port number on which a component listens for client requests. If no value is specified, then a unique port number is generated dynamically for each component, starting at port number 49150 and higher, depending on the number of components configured and the occupied ports above this number.

The Siebel Connection Broker component (alias SCBroker), which provides intraserver load balancing, listens on the port specified by this parameter. For more information, see "About Siebel Connection Broker (SCBroker)".

This parameter applies to interactive, batch, and background mode components, with the exception of all of the Application Object Manager components. The port number, whether static or dynamic, is hidden from the end user and is provided primarily so that administrators can fix the port numbers used by a component, for firewall configuration. If you are configuring this parameter, then select a port number either below 49150 or high enough to make sure that there are no conflicts with dynamically generated port numbers.

Trace Flags (alias TraceFlags). Specifies the flags for component-specific tracing information. This parameter is used to turn on various types of component-specific tracing. See the documentation for individual Siebel Server components for a description of how to set this parameter for each component.

Use IP Address (alias UseIPAddress). Specifies whether to construct the SISNAPI connection strings using the IP address instead of the hostname. The default value is True. Changing the value to False affects performance because the hostname must be looked up each time it connects.

Use Shared Log File (alias LogUseSharedFile). Specifies whether all of the tasks within a component process log to a shared file. When set to False, one log file for each task is generated.

User Name (alias Username). Specifies the database user name. This parameter specifies the user name of the database account that is used by the Siebel Server or Siebel Server components that are not started interactively or in batch mode by the Siebel Server Manager. The password for this database account must be specified by the Password parameter. Both the user name and password are prompted for during the initial configuration of the Siebel Server. The User Name and Password parameters are used to connect to the database for automatic startup of background mode components and for other purposes. See also the description for the Auto Startup Mode parameter in "Siebel Server Parameters"and Table A-3.

When you run component tasks from the Server Manager GUI, the value for the User Name parameter is used because the tasks are submitted as component jobs and started using the Server Request Broker server component, which uses the User Name parameter value. When you run component tasks from the Server Manager command-line interface, in the case of manually started batch or background mode components, the User Name parameter is that of the user who starts tasks on these components.