6Administering Siebel Server Run-Time Operations

Administering Siebel Server Run-Time Operations

This chapter describes Siebel Server run-time administration tasks and processes performed by using the Siebel Server Manager GUI. It includes the following topics:

Administering Siebel Servers

This topic lists the administration tasks applicable to Siebel Servers. It includes the following information:

Related Topics

Siebel Enterprise Server Architecture

Administering the Siebel Server System Service

Related Books

Siebel Installation Guide for the operating system you are using

Siebel System Monitoring and Diagnostics Guide

    Starting a Siebel Server

    This topic describes how to start a Siebel Server.

    Note: In order to start the Siebel Server, the Siebel Server system service must be running.

    If the Auto Startup Mode (alias AutoStart) Siebel Server parameter is set to the default value of True, then the Siebel Server starts automatically when the Siebel Server system service is started.

    Note: Starting a Siebel Server starts the default number of tasks, as defined in the Default Tasks (alias DfltTasks) parameter, for each background mode component.

    This topic is part of Administering Siebel Servers.

    To start a Siebel Server

    1. Navigate to Administration - Server Management screen, then the Enterprises view.

    2. In the Servers list, select the Siebel Server of interest.

    3. Click Startup.

      The State field changes to Starting Up.

      Shutting Down a Siebel Server

      This topic describes how to shut down a Siebel Server.

      Caution: If you shut down the Siebel Server that is hosting your current Siebel Web Client session, then you lose connection to the Siebel Server and cannot restart the Siebel Server by using the Siebel Web Client. In such a case, you must restart the Siebel Server by using the Siebel Developer Web Client or the Server Manager command-line interface. You can shut down and restart Siebel Servers that do not host your Siebel Web Client session without losing your connection.

      This topic is part of Administering Siebel Servers.

      To shut down a Siebel Server

      1. Navigate to Administration - Server Management screen, then the Enterprises view.

      2. In the Servers list, select the Siebel Server of interest.

      3. Click Shutdown.

        The State field changes to Shutting Down.

      Note: Shutting down the Siebel Server does not automatically shut down the Siebel Server system service. In some cases, you must shut down not only the Siebel Server, but also the Siebel Server system service.

        Administering Siebel Server Component Groups

        This topic lists the administration tasks applicable to component groups on a Siebel Server. Enabling or disabling a server component group makes all of the components within the component group available or unavailable.

        This topic contains the following information:

        Related Topics

        Siebel Enterprise Server Architecture

          Enabling a Component Group on a Siebel Server

          This topic describes how to enable a component group on a Siebel Server.

          This topic is part of Administering Siebel Server Component Groups.

          To enable a component group on a Siebel Server

          1. Navigate to Administration - Server Configuration screen, then the Enterprises view.

          2. In the Enterprise Servers list, select the enterprise of interest.

          3. In the Component Group list, select the component group of interest (that is currently disabled).

          4. Click Enable.

            The Enable State field of the component group record changes to Enabled.

          Related Topics

          Disabling a Component Group on a Siebel Server

            Disabling a Component Group on a Siebel Server

            This topic describes how to disable a component group on a Siebel Server.

            This topic is part of Administering Siebel Server Component Groups.

            To disable a component group on a Siebel Server

            1. Navigate to Administration - Server Configuration screen, then the Enterprises view.

            2. In the Enterprise Servers list, select the enterprise of interest.

            3. In the Component Group list, select the component group of interest (that is currently enabled).

            4. Click Disable.

              The Enable State field of the component group record changes to Disabled.

            Related Topics

            Enabling a Component Group on a Siebel Server

              Starting a Server Component on a Siebel Server

              This topic describes how to start a server component on a Siebel Server.

              This topic is part of Administering Siebel Server Components.

              To start a server component on a Siebel Server

              1. Navigate to Administration - Server Management screen, then the Components view.

              2. In the Components list, select the server component of interest.

                Note: Make sure that you select the server component on the Siebel Server of interest.
              3. Click Startup.

                Shutting Down a Server Component on a Siebel Server

                To shut down a server component on a Siebel Server

                This topic describes how to shut down a server component on a Siebel Server.

                This topic is part of Administering Siebel Server Components.

                1. Navigate to Administration - Server Management screen, then the Components view.

                2. In the Components list, select the server component of interest.

                  Note: Make sure that you select the server component on the Siebel Server of interest.
                3. Click Shutdown.

                  Recovering an Unavailable Server Component

                  This topic describes how to recover a server component that has an Unavailable state.

                  This topic is part of Administering Siebel Server Components.

                  To recover a server component from an unavailable component state

                  1. Navigate to Administration - Server Management screen, then the Components view.

                  2. In the Components list, select the unavailable server component of interest.

                    Note: Make sure that you select the server component on the Siebel Server of interest.
                  3. Click Shutdown.

                    After the server component shuts down, its state changes to Shutdown.

                  4. After the server component shuts down, click Startup.

                    When the server component starts, its state changes to Starting Up. After the server component has started, the state changes to Running.

                    Pausing Server Components on a Siebel Server

                    This topic describes how to pause a server component on a Siebel Server.

                    This topic is part of Administering Siebel Server Components.

                    To pause a server component on a Siebel Server

                    1. Navigate to Administration - Server Management screen, then the Components view.

                    2. In the Components list, select the server component of interest.

                      Note: Make sure that you select the server component on the Siebel Server of interest.
                    3. Click Pause.

                      Resuming Server Components on a Siebel Server

                      This topic describes how to resume a server component on a Siebel Server that you previously paused.

                      This topic is part of Administering Siebel Server Components.

                      To resume a server component on a Siebel Server

                      1. Navigate to Administration - Server Management screen, then the Components view.

                      2. In the Components list, select the server component of interest.

                        Note: Make sure that you select the server component on the Siebel Server of interest.
                      3. Click Resume.

                        About Component Jobs

                        A component job is a request for one or more Siebel Server tasks to run. A component job is initiated by either the user or the system, and the Siebel Server runs one or more tasks to fulfill the component job. Component jobs can:

                        • Be scheduled

                        • Be repeated

                        • Use component job templates

                        Make sure that your Siebel Enterprise and Siebel Server configurations allow tasks to run for a server component.

                        If you are planning to regularly run component jobs with the same parameter values, then configure a component job template, which is a predefined component job.

                        Only batch mode component tasks are started by running a component job. Background mode components, such as Workflow Monitor Agent (alias WorkMon), are started by the Siebel Server when the component is started. The parameter Default Tasks (alias DfltTasks) defines the number of tasks started for the background mode component. Background mode component tasks can also be started by using the Server Manager command-line interface program.

                        This topic is part of Administering Component Jobs.

                        Related Topics

                        Checking Your Siebel Enterprise and Siebel Server Configurations

                        Configuring Component Job Templates

                        Using the Siebel Server Manager Command-Line Interface

                        Troubleshooting Component Jobs

                          Starting a Component Job

                          This topic describes how to create and start an individual component job. You can run a component job by using either server components or component job templates. An individual component job is scheduled to run once at a specific time.

                          This topic is part of Administering Component Jobs.

                          To start a component job

                          1. Navigate to Administration - Server Management screen, then the Jobs view.

                          2. In the Jobs list, click New.

                            The component job status field changes to Creating.

                          3. In the Component/Job field, click the drop-down list.

                            Note: If the Component/Job drop-down list contains no records, then synchronize the Siebel Server components.
                          4. In the Component/Job drop-down list, select a server component or component job and click OK.

                            If you want to use a component job template for your component job, then you must first define the component job template.

                          5. In the Job Detail view, enter data in other appropriate fields as described in the following table. Click Menu, and then Save Record.

                            Field

                            Description

                            Scheduled Start

                            The scheduled start date and time of the component job.

                            Expiration

                            The date at which the component job is no longer valid.

                            Requested Server

                            Set if you want to target a server component on a specific Siebel Server.

                            Request Key

                            Set if you want to target a component or repeating component job to a specific instance of the server component identified by the request key. In all other situations, keep this field blank.

                            Delete Interval

                            Set with Delete Unit field, this field determines the length of time before the component job is deleted. If it is not updated, then this field defaults to 1.

                            Delete Unit

                            Set with Delete Interval field, this field determines the length of time before the component job is deleted. If it is not updated, then this field defaults to Weeks.

                            Retry on Error

                            Check this box to retry the component job in case of error.

                            Sleep Time

                            This field is available when the Retry on Error check box is True and determines the amount of time before the component job is retried.

                            Number of Retries

                            This field is available when the Retry on Error check box is True and determines the number of times the component job is retried.

                          6. In the Job Parameters list, add or change any component job parameters for the component job and click New.

                            1. In the Name field, click the select button.

                              The Job Parameters dialog box appears. The parameters that appear in the Job Parameters dialog box vary depending on the server component that you specified in a prior step.

                            2. Select a parameter in the Component Parameters dialog box, and modify its value.

                            3. Click Menu, and then Save Record.

                          7. In the Jobs list, click Submit Job.

                            The Status field changes from Creating to Queued.

                          Related Topics

                          About Component Jobs

                          Configuring Component Job Templates

                          Starting a Repeating Component Job

                          Synchronizing Components on a Siebel Enterprise Server

                            Starting a Repeating Component Job

                            This topic describes how to create and start a repeating component job. You can define repeating component jobs by using either components or component job templates, and you can schedule component jobs to run repeatedly at specific times over specific intervals. In order to run repeating component jobs, both the Server Request Broker (alias SRBroker) and Server Request Processor (alias SRProc) server components must be running. If you have to run repeating jobs at unspecified times or intervals, then run repeating component jobs by using a component job template.

                            Note: It is not possible to start a business service directly as a repeating component job. To accomplish this task, you first must include the business service in a workflow process. You can then run the workflow process as a repeating component job for the Workflow Process Batch Manager component (alias WfProcBatchMgr).

                            This topic is part of Administering Component Jobs.

                            To start a repeating component job

                            1. Create a component job as described in Starting a Component Job, but do not start the component job.

                            2. In the Job Detail view, enter data in the Repeating Info fields as described in the following table. Click Menu, and then Save Record.

                            3. In the Jobs list, click Submit Job.

                              The Status field changes from Creating to Active.

                            Field

                            Description

                            Repeating?

                            Select this check box to make the component job a repeating component job.

                            Repeat Unit

                            This field determines the length of time before the component job repeats when it is set with the Repeat Interval field.

                            Repeat Interval

                            Set with Repeat Unit field, this field determines the length of time before the component job repeats.

                            Repeat From

                            This field has three possible settings:

                            Scheduled Start. Starts the next iteration of the repeating component job after the interval period has elapsed. The interval period is calculated from the time indicated by the Scheduled Start field. For example, if the repeat interval is 5 minutes, the scheduled start time is 09:00, and the component job starts at 09:02, then the next component job is scheduled to start at 09:05. Using this setting might result in a backlog of component jobs that will be started if the actual start time is later than the scheduled start time.

                            Actual Start. Starts the next iteration of the repeating component job after the interval period has elapsed. The interval period is calculated from the time the component job starts rather than the time indicated by the Scheduled Start field. For example, if the repeat interval is 5 minutes, the scheduled start time is 09:00, and the component job starts at 09:02, then the next component job is scheduled to start at 09:07.

                            End. Starts the next iteration of the repeating component job after the previous component job ends and the repeat interval has elapsed. For example, if the repeat interval is 5 minutes, the scheduled start time is 09:00, the component job starts at 09:02, and the first component job ends at 09:04, then the next component job is scheduled to start at 09:09.

                            Repetitions

                            This field determines the number of times the component job repeats.

                            Related Topics

                            Configuring Component Job Templates

                            About Component Jobs

                            Starting a Component Job

                              Deleting a Component Job or Repeating Component Job

                              This topic describes how to delete a component job. You can only delete component jobs that have a status of Creating. After the component job has been submitted, you can only cancel the component job.

                              Note: You can also delete component jobs by setting the Delete Interval and Delete Units field while creating the component job. After the component job has been started, these fields are read-only.

                              This topic is part of Administering Component Jobs.

                              To delete a component job or repeating component job during its creation

                              1. Navigate to Administration - Server Management screen, then the Jobs view.

                              2. In the Jobs list, select the component job that has a Status field value of Creating.

                              3. Click Delete.

                              Completed component jobs are deleted automatically after a configurable period of time. The fields Delete Interval and Delete Units determine this period and are set, by default, to one week.

                              Related Topics

                              Starting a Component Job

                              Administering Component Jobs

                              Canceling a Component Job or Repeating Component Job

                                Canceling a Component Job or Repeating Component Job

                                To cancel a component job or repeating component job

                                This topic describes how to cancel component jobs. You can only cancel component jobs that have a state of Queued or On-Hold.

                                This topic is part of Administering Component Jobs.

                                1. Navigate to Administration - Server Management screen, then the Jobs view.

                                2. In the Jobs list, select the component job that has a Status field value of Queued or On-Hold.

                                3. Click Cancel Job.

                                Canceled component jobs are deleted automatically after a configurable period of time. The fields Delete Interval and Delete Units determine this period and are set, by default, to one week.

                                Related Topics

                                Starting a Component Job

                                  Holding a Component Job or Repeating Component Job

                                  This topic describes how to hold component jobs. You can only hold component jobs that have a state of Queued.

                                  Holding a component job pauses the applicable task (if the task can be paused) or allows the current task to finish. No new tasks begin for the held component job.

                                  This topic is part of Administering Component Jobs.

                                  To hold a component job or repeating component job

                                  1. Navigate to Administration - Server Management screen, then the Jobs view.

                                  2. In the Jobs list, select the component job that has a Status field value of Queued.

                                    Note: You cannot hold jobs with an Active value in the Status field.
                                  3. Click Hold Job.

                                    Resuming a Component Job or Repeating Component Job

                                    This topic describes how to resume component jobs put on hold. You can only resume component jobs that have a state of On Hold.

                                    This topic is part of Administering Component Jobs.

                                    To resume a component job or repeating component job on hold

                                    1. Navigate to Administration - Server Management screen, then the Jobs view.

                                    2. In the Jobs list, select the component job that has a Status field value of On Hold.

                                    3. Click Resume Job.

                                    Related Topics

                                    Holding a Component Job or Repeating Component Job

                                      Troubleshooting Component Jobs

                                      This topic provides guidelines for resolving problems with component jobs.

                                      This topic is part of Administering Component Jobs.

                                      To resolve the problem, look for it in the list of symptoms or error messages in the following table.

                                      Table Resolving Component Job Problems

                                      Problem

                                      Cause

                                      Solution

                                      The Component/Jobs drop-down list contains no records.

                                      Batch mode components are not synchronized.

                                      Synchronize the batch mode components.

                                      Server component job is based on a new component definition that was added by using the component definition view.

                                      Synchronize the batch mode components.

                                      Related Topics

                                      Synchronizing Components on a Siebel Enterprise Server

                                        Administering Siebel Server Tasks

                                          Starting a Siebel Server Task

                                          To start a Siebel Server task, you must run a component job. For information about component jobs and administering component jobs, see the following topics:

                                          This topic is part of Administering Siebel Server Tasks.

                                            Pausing a Siebel Server Task

                                            This topic describes how to pause a Siebel Server task. You can pause Siebel Server tasks only for certain component types. The following table lists the component types and the predefined components that have this feature.

                                            This topic is part of Administering Siebel Server Tasks.

                                            To pause a Siebel Server task

                                            1. Navigate to Administration - Server Management screen, then the Tasks view.

                                            2. In the Tasks list, select the Siebel Server task of interest.

                                            3. Make sure that the Siebel Server task is on the Siebel Server of interest and is of a component type that can be paused. See the following for a list of Siebel Server component types that can be paused.

                                            4. Click Pause.

                                            The following table lists component types that can be paused.

                                            Table Pausable Component Types

                                            Component Types

                                            Predefined Component

                                            Predefined Component Alias

                                            MailMgr

                                            Email Manager

                                            MailMgr

                                            MktgSrvr

                                            Marketing Server

                                            MktgSrvr

                                            PageMgr

                                            Page Manager

                                            PageMgr

                                            ServerMgr

                                            Server Manager

                                            ServerMgr

                                            TxnMerge

                                            Transaction Merger

                                            TxnMerge

                                            TxnProc

                                            Transaction Processor

                                            TxnProc

                                            TxnRoute

                                            Transaction Router

                                            TxnRoute

                                            WorkActn

                                            Workflow Action Agent

                                            WorkActn

                                            WorkMon

                                            Workflow Monitor Agent

                                            WorkMon

                                            Administering Siebel Server Tasks

                                            Resuming a Siebel Server Task

                                              Resuming a Siebel Server Task

                                              This topic describes how to resume a paused Siebel Server task.

                                              This topic is part of Administering Siebel Server Tasks.

                                              To resume a paused Siebel Server task

                                              1. Navigate to Administration - Server Management screen, then the Tasks view.

                                              2. In the Tasks list, select the paused Siebel Server task of interest.

                                              3. Click Resume.

                                              Related Topics

                                              Administering Siebel Server Tasks

                                              Pausing a Siebel Server Task

                                                Stopping a Siebel Server Task

                                                This topic describes how to stop a Siebel Server task. You can stop running or paused Siebel Server tasks.

                                                Note: It is preferable to stop the individual tasks for a given server component rather than shutting down the server component.

                                                This topic is part of Administering Siebel Server Tasks.

                                                To stop a Siebel Server task

                                                1. Navigate to Administration - Server Management screen, then the Tasks view.

                                                2. In the Tasks list, select the running Siebel Server task of interest.

                                                3. Click Stop.

                                                Related Topics

                                                Administering Siebel Server Tasks

                                                  Terminating a Siebel Server Task

                                                  This topic describes how to terminate a Siebel Server task. Terminating a Siebel Server task signals the Siebel Server to use the operating system control to terminate the task.

                                                  This topic is part of Administering Siebel Server Tasks.

                                                  To terminate a Siebel Server task

                                                  1. Navigate to Administration - Server Management screen, then the Tasks view.

                                                  2. In the Tasks list, select the running Siebel Server task of interest.

                                                  3. Click Stop three times in succession.

                                                  Related Topics

                                                  Administering Siebel Server Tasks

                                                    Configuring Siebel Server Task Dynamic Parameters

                                                    This topic describes how to configure dynamic parameters of a Siebel Server task. Siebel Server task parameters consist of Siebel Enterprise Server, Siebel Server, and server component-level parameters, as well as task-specific parameters specified when starting a component job. After a task is running, only dynamic parameters can be changed.

                                                    This topic is part of Administering Siebel Server Tasks.

                                                    To configure Siebel Server task dynamic parameters

                                                    1. Navigate to Administration - Server Management screen, then the Tasks view.

                                                    2. In the Tasks list, select the running Siebel Server task of interest.

                                                    3. Click the Parameters tab.

                                                    4. In the Task Parameters list, change the values of the parameters that you want to modify. (Identify dynamic parameters by a check in the Effective Immediately column.)

                                                      1. Select the parameter that you want to modify.

                                                      2. In the Value field, type in the new value.

                                                      3. Click Menu, and then Save Record.

                                                    Related Topics

                                                    About Siebel System Parameters

                                                    About Task Parameters

                                                    Administering Siebel Server Tasks

                                                    Siebel Enterprise, Server, and Component Parameters