Siebel System Administration Guide - Oracle

Contents Administering Siebel Server Tasks138Starting a Siebel Server Task 139Pausing a Siebel Server Task 139Resuming a Siebel Server Task 140Stopping a Siebel Server Task 140Terminating a Siebel Server Task 141Configuring Siebel Server Task Dynamic ParametersChapter 8:141Using the Siebel Server ManagerCommand-Line InterfaceStarting the Siebel Server Manager Command-Line InterfaceRecommendations for Using the Command-Line InterfaceSiebel Server Manager Commands143147148Command Syntax 149Help Commands 149Siebel Server Manager Environment Commands 150List Commands 151List Command Configuration 155Server Group Management Commands 156Siebel Server Management Commands 157Component Group Definition Commands 158Component Definition Commands 160Reconfiguring Component Definition Commands 161Component Management Commands 162Task Management Commands 163Parameter Management Commands 165Named Subsystem Management Commands 167System Alert Notification Commands 168List Definition Commands 168List Parameter Override Commands 169Event Logging Commands 170Server Manager Command-Line Preferences 170Chapter 9:Siebel Server Infrastructure AdministrationAbout Server Request Broker (SRBroker)173Configuring Tasks for Server Request BrokerAbout Server Request Processor (SRProc)About Siebel Connection Broker (SCBroker)174174175About Other System Management Components176Siebel System Administration Guide Version 8.1/8.2, Rev. A7

Contents About Server Tables Cleanup (SvrTblCleanup) 176About Siebel Administrator Notification (AdminNotify)About Siebel Server Scheduler (SrvrSched) 176Administering the Siebel File System176177About the Siebel File System 177About the File System Upload and Download ProcessPartitioning the Siebel File System 179Cleaning Up the Siebel File System 184178Chapter 10: Application Object Manager AdministrationAbout the Siebel Application Object Manager191Configuring the Application Object Manager EnvironmentAbout Application Object Manager Parameters192193Application Object Manager Parameters in Server ManagerApplication Object Manager Named Subsystem ParametersAdministering the Application Object Manager194194198Chapter 11: Migrating Parameters Between EnvironmentsAbout Migrating Parameters Between EnvironmentsAbout the cfgmerge Utility201202Process of Migrating Parameters Between EnvironmentsRunning an Environment ComparisonAbout Parameter Migration Scripts202203204Reviewing and Editing a Parameter Migration ScriptRunning a Parameter Migration Script205206Appendix A: Siebel Server Components and ParametersSiebel Server Component GroupsSiebel Server Components207212Siebel Enterprise, Server, and Component ParametersSiebel Enterprise Server ParametersSiebel Server Parameters 233Generic Parameters 235228232Appendix B: Structure of the eapps.cfg FileAbout the eapps.cfg File8243Siebel System Administration Guide Version 8.1/8.2, Rev. A

Contents Parameter Descriptions of the eapps.cfg File243[swe] Section 244[defaults] Section 246[/xxx] Section 248Appendix C: Parameters in Siebel Application ConfigurationFilesOverview of Parameters in Siebel Application Configuration FilesAbout Siebel Application Configuration Files252Editing Siebel Application Configuration FilesConfiguration Parameters Index253254Description of Siebel Application ParametersData Source Parameters251263267Appendix D: Structure of the lbconfig.txt FileAbout the lbconfig.txt File277Session Manager Rules for the lbconfig.txt FileThird-Party HTTP Load Balancer Rules278278Example of a Load Balancing Configuration File279Appendix E: Siebel Management Framework APIAbout the Siebel Management Framework API MethodsExample of Enterprise-Level JMX API281283Methods Used with the Enterprise-Level Service286getServers 286getConnectedServers 287getDisconnectedServers 287getComponentAvailability 287startComponent 288shutdownComponent 288getParam 288shutdownEnterprise 288startEnterprise 289Example of Server-Level JMX API289Methods Used with the Server-Level Service293getState 293startServer 293Siebel System Administration Guide Version 8.1/8.2, Rev. A9

Contents shutdownServer 293getParam 294getStat 294getSval 294getComps 294getCompState 294startComp 295shutdownComp 295Example of Component-Level JMX API295Methods Used with the Component-Level ServicegetState 298getAvailability 298getNumRunningTasksgetParam 299getStat 299getSval 299298298Index10Siebel System Administration Guide Version 8.1/8.2, Rev. A

1What’s New in This ReleaseSiebel System Administration Guide provides information about performing server administrationtasks for Oracle’s Siebel Business Applications.NOTE: In general, it is assumed that you have installed Siebel Innovation Pack 2013. This innovationpack is provided for Siebel CRM version 8.1.1.11 and version 8.2.2.4. For more information, see theSiebel Installation Guide for the operating system you are using and the applicable SiebelMaintenance Release Guide on My Oracle Support.What’s New in Siebel System Administration Guide, Version 8.1/8.2,Rev. ATable 1 lists the changes described in this version of the documentation to support this release of thesoftware. The new features described in Table 1 are available in Siebel CRM version 8.1.1.11, SiebelCRM version 8.2.2.4, and later.Table 1.New Product Features in Siebel System Administration Guide, Version 8.1/8.2, Rev. ATopicDescription“About Siebel Open UI” on page 46Modified topic. Updated information about deployingapplications for Siebel Open UI.“Requirements for DeployingSiebel Applications Using StandardInteractivity” on page 50Modified topic. Standard interactivity requires that the browsersupport HTML 4.01 as a minimum.“Reconfiguring Siebel ServerComponent Definitions” onpage 100Modified topic. Updated some of the information aboutreconfiguring server component definitions.“Cleaning Up the Siebel FileSystem” on page 184Modified topic. For customers using earlier Siebel CRM version8.1.1.x releases, note that Siebel CRM version 8.1.1.5 is theminimum version for some of the functionality described inTable 25 on page 185.Siebel System Administration Guide Version 8.1/8.2, Rev. A11

What’s New in This Release Table 1.New Product Features in Siebel System Administration Guide, Version 8.1/8.2, Rev. ATopicDescription“Siebel Server ComponentGroups” on page 207Modified topics. For the component group Siebel eChannel,added the Siebel Partner Portal Object Manager component.This component is used for Siebel Partner Portal for Siebel OpenUI. Using this application requires Siebel CRM version 8.1.1.11or version 8.2.2.4 or later. For more information, see SiebelPartner Relationship Management Administration Guide.“Siebel Server Components” onpage 212“Siebel Enterprise, Server, andComponent Parameters” onpage 228Modified topics. Added a description of the parameter Maximumdepth of the query (alias MaxDepthOfTheQuery).“Description of Siebel ApplicationParameters” on page 263What’s New in Siebel System Administration Guide, Version 8.1/8.2Table 2 lists the changes described in this version of the documentation to support this release of thesoftware. The new features described in Table 2 are available in Siebel CRM version 8.1.1.11, SiebelCRM version 8.2.2.4, and later.Table 2.New Product Features in Siebel System Administration Guide, Version 8.1/8.2TopicDescriptionMultiple topicsModified topics. For Siebel CRM version 8.1.1.9 and later, andfor version 8.2.2.2 and later, the system requirements andsupported platform certifications are available from theCertifications application on My Oracle Support. Updatedreferences throughout this guide. For more information, seearticle 1492194.1 (Article ID) on My Oracle Support.“Enabling Support for SSLAcceleration in the ApplicationObject Manager”Removed topic. Information about enabling support for SSLacceleration is in Siebel Security Guide.“About Starting Siebel ServerComponents” on page 90Modified topic. Updated descriptions of component states.“About the Siebel File System” onpage 177Modified topic. You can configure the Siebel File System toexclude certain file types based on their file extensions.12Siebel System Administration Guide Version 8.1/8.2, Rev. A

What’s New in This Release Table 2.New Product Features in Siebel System Administration Guide, Version 8.1/8.2TopicDescription“Siebel Server ComponentGroups” on page 207Modified topics. Added a component group and severalcomponents that are used by the Siebel Mobile applications. Formore information, see Siebel Mobile applicationsdocumentation.“Siebel Server Components” onpage 212“Siebel Server ComponentGroups” on page 207“Siebel Server Components” onpage 212“Configuration Parameters Index”on page 254 Added the component group Handheld Synchronization SIA(alias HandheldSyncSIS) and all of its components. For the component group Handheld Synchronization (aliasHandheldSync), added the Sales Mobile Object Manager andService Mobile Object Manager components.Modified topics. For the component group Siebel Call Center,added the Self Service Object Manager component. Thiscomponent is used for Siebel eService for Siebel Open UI. Formore information, see Siebel eService Administration Guide forSiebel Open UI.Modified topic. Added the CalDAVService parameter and relatedparameters. These parameters support a CalDAV integration forthe Siebel calendar, using Siebel Enterprise ApplicationIntegration (EAI). For more information about configuring aCalDAV integration, see article 1574546.1 (Article ID) on MyOracle Support.What’s New in Siebel System Administration Guide, Version 8.1,Rev. CTable 3 lists the changes described in this version of the documentation to support this release of thesoftware. (Version 8.1, Rev. C of this guide was for Siebel CRM version 8.1.1 through 8.1.1.10.)Table 3.New Product Features in Siebel System Administration Guide, Version 8.1, Rev. CTopicDescription“About System EnvironmentVariables” on page 28Modified topic. Listed several additional environment variablesand indicated where to find more information.“About Siebel Open UI” on page 46Modified topic. Provided some additional information aboutSiebel Open UI.“About the Server Manager GUI”on page 69Modified topic. Listed the Process Failure Diagnostics view,which is described in Siebel System Monitoring and DiagnosticsGuide. This feature requires Siebel Fix Pack 8.1.1.10 or later.Siebel System Administration Guide Version 8.1/8.2, Rev. A13

What’s New in This Release What’s New in Siebel System Administration Guide, Version 8.2,Rev. CTable 4 lists the changes described in this version of the documentation to support this release of thesoftware. (Version 8.2, Rev. C of this guide was for Siebel CRM version 8.2.2 through 8.2.2.3.)Table 4.New Product Features in Siebel System Administration Guide, Version 8.2, Rev. CTopicDescription“About System EnvironmentVariables” on page 28Modified topic. Listed several additional environment variablesand indicated where to find more information.“About Siebel Open UI” on page 46Modified topic. Provided some additional information aboutSiebel Open UI.“About the Server Manager GUI”on page 69Modified topic. Listed the Process Failure Diagnostics view,which is described in Siebel System Monitoring and DiagnosticsGuide. This feature requires Siebel Fix Pack 8.2.2.3 or later.14Siebel System Administration Guide Version 8.1/8.2, Rev. A

2Siebel Enterprise ServerArchitectureThis chapter provides an overview of Oracle’s Siebel Enterprise Server architecture includingintroductory information about the Siebel Gateway Name Server, Siebel Enterprise Server, SiebelServers, Siebel Server components, the Siebel File System and File System Manager, and the SiebelManagement Framework. This chapter includes the following topics: About the Siebel Environment on page 15 About the Siebel Gateway Name Server on page 16 About the Siebel Enterprise Server on page 17 About the Siebel Server on page 18 About Siebel Server Components on page 21 About the Siebel File System and the File System Manager on page 25 About the Siebel Management Pack on page 25About the Siebel EnvironmentThe Siebel Business Applications environment consists of the following entities, listed in Table 5.Table 5.Siebel Application EntitiesEntityCommentsSiebel clientsClient types include Siebel Web Client, Siebel Mobile Web Client,Siebel Developer Web Client, Siebel Mobile applications, SiebelWireless Client, and Siebel Handheld client. The Siebel Tools clientis a special-purpose client for developers. For descriptions of mostof these Siebel client types, see Chapter 4, “Configuring the Browserfor Siebel Web Clients.”Siebel Enterprise ServerThe logical grouping of Siebel Servers for a multiple serverdeployment. (For a single Siebel Server and single Web serverdeployment, the Siebel Enterprise Server contains a single SiebelServer.) The Siebel Enterprise Server, collectively with the SiebelGateway Name Server, provides both batch mode and interactiveservices to and on behalf of Siebel clients.Siebel Gateway Name ServerThe name server for a single server deployment.Siebel databaseThe Siebel tables, indexes, and seed data installed on the RDBMS.Database client software is also required.Siebel System Administration Guide Version 8.1/8.2, Rev. A15

Siebel Enterprise Server Architecture About the Siebel Gateway Name ServerTable 5.Siebel Application EntitiesEntityCommentsSiebel File SystemOne or more directories that store physical files used by Siebelclients and Siebel Enterprise Server.Siebel ManagementFrameworkAn optional addition to the Siebel environment. Deploy this entityif you intend to use Siebel Management Pack, which you deploy aspart of Oracle Enterprise Manager.The Siebel Management Pack provides the underlyinginfrastructure components that are required to support thedeployment features offered by the Oracle Enterprise Manager.For more information, see Oracle Enterprise Manager GettingStarted with Application Management Pack for Siebel 10g Release5 (10.2.0.5.0). This document provides a brief introduction to theSiebel Management Pack and describes the features that this packoffers.The Siebel Enterprise Server environment represents the middle tier within the three-tiered SiebelBusiness Applications environment, between the Siebel client and the Siebel database. For moreinformation, see Siebel Deployment Planning Guide.About the Siebel Gateway Name ServerThe Siebel Gateway Name Server coordinates the Siebel Enterprise Server and Siebel Servers. Asingle Siebel Gateway Name Server can support multiple Siebel Enterprise Servers. The SiebelGateway Name Server provides the persistent backing of Siebel Enterprise Server configurationinformation, including: Definitions and assignments of component groups and components Operational parameters Connectivity informationBecause this information changes, such as during the configuration of a Siebel Server, it is writtento the siebns.dat file on the Siebel Gateway Name Server. At startup, the Siebel Server obtains itsconfiguration information from the Siebel Gateway Name Server’s siebns.dat file. For moreinformation about this file, see “Backing Up the Siebel Gateway Name Server Data” on page 41.The Siebel Gateway Name Server serves as the dynamic registry for Siebel Server and componentavailability information. At startup, a Siebel Server within the Siebel Enterprise Server notifies theSiebel Gateway Name Server of its availability and stores its connectivity information, such asnetwork addresses, in the Siebel Gateway Name Server’s nonpersistent (volatile) store. Periodically,the Siebel Gateway Name Server also flushes its current state to the siebns.dat file.Enterprise components (including the Server Manager) query the Siebel Gateway Name Server forSiebel Server availability and connectivity information. When a Siebel Server shuts down, thisnonpersistent information is cleared from the Siebel Gateway Name Server.16Siebel System Administration Guide Version 8.1/8.2, Rev. A

Siebel Enterprise Server Architecture About the Siebel Enterprise ServerIn a Windows environment, the Siebel Gateway Name Server runs as a Windows service. In a UNIXenvironment, the Siebel Gateway Name Server runs as a daemon process. The system processassociated with the Siebel Gateway Name Server is siebsvc.exe on Windows and siebsvc on UNIX.Each running Siebel Server has a corresponding Siebel Gateway Name Server system process.A single Siebel Gateway Name Server can potentially serve several databases in an environment(such as multiple development and test environments). To mitigate dependencies and improverecoverability, keep the Siebel production environment separate from other Siebel environments(development or test) by using a separate Siebel Gateway Name Server.If you decide to maintain multiple development or test environments on one Siebel Gateway NameServer, then you must use a distinct Siebel Enterprise Server for each table owner (or each Siebeldatabase, for Microsoft SQL Server).NOTE: In a Windows environment, there can be only one Siebel Gateway Name Server installed onany one computer. For more information, see Siebel Deployment Planning Guide and the SiebelInstallation Guide for the operating system you are using.Impact of FailureWhen the Siebel Gateway Name Server goes down, service to active user connections is notimmediately interrupted. All of the Siebel Server components, including Application ObjectManagers, that are currently running continue to do so. However, no new Siebel Server componentscan be started or added. Server administration functions become limited.High-Availability Solution for Siebel Gateway Name ServerSiebel Business Applications support several server clustering technologies that are platform-specificto achieve high availability for the Siebel Gateway Name Server. For more information about supportfor server clustering, see Siebel Deployment Planning Guide and the Certifications application on MyOracle Support.Resource Requirements for Siebel Gateway Name ServerThe Siebel Gateway Name Server requires very few system resources. Follow the hardwarerecommendations listed in the Certifications application on My Oracle Support.About the Siebel Enterprise ServerThe Siebel Enterprise Server is a logical grouping of Siebel Servers that supports a group of usersaccessing a common Siebel database. The Siebel Enterprise Server can be configured, managed, andmonitored as a single logical group, allowing the Siebel administrator to start, stop, monitor, or setparameters for Siebel Servers within a Siebel Enterprise Server.You can set some Siebel Server parameters at the Siebel Enterprise Server level, and theseparameters apply to every Siebel Server and component operating within that Siebel EnterpriseServer. Other parameters can be adjusted at the Siebel Server or component level to support finetuning.Siebel System Administration Guide Version 8.1/8.2, Rev. A17

Siebel Enterprise Server Architecture About the Siebel ServerParameter settings are inherited unless overrides are in effect, as follows: If a parameter is set at the server level, then the server-specific value overrides the SiebelEnterprise Server parameter setting on th

Siebel System Administration Guide Version 8.1/8.2, Rev. A 3 Contents Siebel System Administration Guide 1 Chapter 1: What's New in This Release . Administering the Siebel Server System Service on Windows 114 Administering the Siebel Server System Service on UNIX 116