Bookshelf v7.5: Configuring Siebel Analytics Scheduler

Siebel Analytics Scheduler Guide > Using Siebel Analytics Scheduler > Installation, Upgrade and Configuration Overview >

Configuring Siebel Analytics Scheduler

In Windows you set Scheduler configuration options in the Job Manager Configuration dialog box, a feature of Siebel Analytics Administration Tool. This dialog box has three tabs: Scheduler, Siebel Mail, and Siebel iBots.

In UNIX you set Scheduler configuration options in schconfig.exe, a console-based application. The configuration options in schconfig.exe are identical to those available in the Job Manager Configuration dialog box.

This section provides detailed information about the Scheduler configuration options.

To access the Job Manager Configuration dialog box

Open the Siebel Analytics Administration Tool.

Select Manage > Jobs from the toolbar.

The Job Manager window appears.

Select File > Configuration Options.

The Machine Name dialog box appears.

Enter the machine name where the Scheduler is located, and then click OK.

The Job Manager Configuration dialog box appears.

Job Manager Configuration — Scheduler Tab

The fields in the Scheduler tab describe Siebel Analytics Scheduler access to its back-end database and its general behavior. To restore the default values distributed with Scheduler, click the Defaults button. To revert to the most recently used settings, click the Revert button.

Table 3 provides a description of each field in the Scheduler tab.

Table 3. Scheduler Tab Fields
Field	Description
Database Type	The database type of the Scheduler back-end database. Select a type from the drop-down list.
Call Interface	The type of call the connection to the database will make. The call you select from the pull-down list determines the application programmer interface (API) used to access the data source. The types of call interfaces in the list will vary depending on the database type selected.
Data Source Name	Identifies the data source name (DSN) of the data source to use for the connection. For example, if the DSN of the Scheduler back-end database is ORCL8_Scheduler, you would enter ORCL8_Scheduler in this field. The DSN must contain valid logon information for a data source. If the information is invalid, the database logon will fail.
User name	The user name the Scheduler uses to log on to the data source. The user name must have read and write permissions to the back-end database. Note: It is recommended that the user name be the same as the table owner for databases like DB2 that require fully qualified table names (for example, SIEBEL.S_NQ_JOBS). Otherwise, Scheduler will not be set up properly.
Password/Confirm Password	These fields contain the password to use to log on to the data source. For security, the password is encrypted in the registry.
Timeout (Minutes)	The timeout specifies the amount of time, in minutes, that a connection to the data source will remain open after an operation completes. During this time, new operations will use this connection rather than open a new one, up to the number specified for Maximum Connections. The time is reset after each completed connection request. The default value is 60. Specify a value of 1 or greater.
Maximum Connections	The maximum number of database connections the Scheduler can open concurrently. When this limit is reached, the connection request waits until a connection becomes available. The default value is 5. Specify a value of 1 or greater.
Scheduler Script Path	The Scheduler's back-end database does not actually store the job scripts. This field refers to the path where Scheduler-created job scripts are stored. In the Job Manager, when adding or modifying a job, if a script is manually entered in the Script field, the Scheduler creates a file in the path defined by this field. The file will have a `.scs` extension. In general, users should not add or remove scripts from this directory. By default, this field is set to `$(NQUIREDIR)\Scripts\Scheduler` where `$(NQUIREDIR)` is the location in which the Siebel Analytics software is installed.
Default Script Path	This field refers to a path where user-created job scripts should be stored. In the Job Manager, if a filename is entered in the Script field when adding or modifying a job, Siebel Analytics Scheduler will examine the contents of this directory for the specified file. However, if a full path is given in the Script field, this directory is not examined. By default, this field is set to `$(NQUIREDIR)\Scripts\Common` where `$(NQUIREDIR)` is the location in which the Siebel Analytics software is installed.
Temporary File Path	This is a path that specifies where temporary files are stored during the execution of Siebel Analytics Scheduler.
Bulk Fetch Buffer Size (bytes)	This parameter is for use in the database gateways. It specifies the maximum size in bytes of a bulk fetch page for retrieving data from a data source. The default value is 33,792 bytes.
Purge Old instances after X days	Specifies the number of days after which old job instances will be deleted from the back-end database automatically. The default value is to delete after 7 days. To prevent old job instances from being deleted automatically, set the value to 0 (zero).
Purge DB every X minutes	Depending on the back-end database, deleting rows from a table may be expensive, while updates are almost always streamlined. Siebel Analytics Scheduler does not actually issue SQL DELETE statements when jobs or instances are removed. Instead, it updates the tables and flags the affected rows as deleted. After every X minutes (where X is defined as the value of this field), the actual SQL DELETE statements are issued. The default value is every 60 minutes.
Minimum Execution Threads	Siebel Analytics Scheduler is a multithreaded application. It uses a thread pool. This field specifies the minimum number of threads in this pool.
Maximum Execution Threads	This field specifies the maximum number of threads that are used in Siebel Analytics Scheduler's thread pool.
Pause When Service Starts	This is a flag that specifies that no jobs should execute when Siebel Analytics Scheduler starts. While it is paused, a user can add, modify, and remove jobs. However, no jobs will be executed. The Siebel administrator can use this field for maintenance purposes, such as shutting down the Scheduler, then setting this value, and then restarting the Scheduler to conduct maintenance. Selecting Service Management > Continue Scheduling in the Job Manager will allow the Scheduler to continue with its regular execution.

Job Manager Configuration — Siebel Mail Tab

The fields in the Siebel Mail tab are used to configure the COM object used by Siebel Delivers to deliver SMTP mail. To restore the default values distributed with Siebel Analytics Scheduler, click the Defaults button. To revert to the most recently used settings, click the Revert button.

Table 4 provides a description of each field in the Siebel Mail tab.

Table 4. Siebel Mail Tab Fields
Field	Description
From Display Name	This field is used in the SMTP From field as a meaningful substitution for the sender's address. The default is `Siebel Delivers <iBots@defaultmailserver.com>`.
Sender Address	This is the email address on the SMTP Server that will be used as the sender's reply-to address for all mail sent from Siebel Analytics Scheduler. The initial value is `defaultuser@defaultmailserver.com`, which must be changed to reflect a valid email address.
SMTP Server	This is the name of the SMTP server that will deliver the mail. The initial value is `defaultmailserver.com`, which must be changed to a valid server name in order to deliver mail.
SMTP Port	This is the port number for SMTP on the given server. The default is port 25. Most mail servers use port 25 as the mail port.
Number of Retries Upon Failure	If for any reason Siebel Delivers fails to deliver an email, it will try to resend it. The number specified in this field sets the number of retry attempts. The default is 1.
Authenticate against SMTP Server	This specifies that the SMTP Server requires authentication to send email to an address outside of its domain. When checked, fill in the Username and Password fields for an email user on the SMTP server. When not checked, the Username and Password fields are not used.
Username	When the option Authenticate against SMTP Server is selected, this field specifies the user name for an email user on the specified SMTP server. If left blank, the email server will not authenticate any email from Siebel Delivers.
Password/Confirm Password	When the option Authenticate against SMTP Server is selected, these fields specify the user's password for the specified user name.

Job Manager Configuration — Siebel iBots Tab

Siebel iBots are functionally a combination of data stored in Siebel Analytics Web and on Siebel Analytics Scheduler. The fields in the iBots tab describe the behavior of all Siebel iBots that run on a specific Siebel Analytics Scheduler. To restore the default values distributed with the Scheduler, click the Defaults button. To revert to the most recently used settings, click the Revert button.

Table 5 provides a description of each field in the iBots tab.

Table 5. iBots Tab, Configuration Fields
Field	Description
Web Server	Specifies the URL of the server where Siebel Analytics Web resides. The default address is `http://localhost`. The mapped virtual directory must be `analytics` on this server, because this value will automatically be appended to the address. For example, the default address will be `http://localhost/analytics` at run time.
iBot Log Directory	Siebel iBots have the ability to create log files if exceptional error conditions occur. This setting specifies the directory where these files will be created. The directory must be accessible to the Scheduler application. In Windows, the default installation runs the service as a system account, which prevents Siebel Analytics Scheduler from writing to or reading from network directories.
nQS (Siebel) Administrator Name	Because Siebel Analytics Scheduler runs jobs on Siebel Analytics Server and Siebel Analytics Web on behalf of a user without storing that user's password, the server allows the Scheduler and the Web to impersonate users. To allow these applications to impersonate users, specify Administrator in this field. You must specify the actual Siebel Analytics Server Siebel "Administrator" username, not the username of a user with Siebel Analytics Server Administrator privileges.
nQS (Siebel) Administrator Password/Confirm Password	These fields contain the password for the Siebel administrator with impersonation privileges. The password is encrypted in the registry. You can change it by using the Job Manager (Windows) or `schconfig.exe` (UNIX).
Number of Global Tries	An iBot first tries to connect to the Web server to determine what information it is to deliver and to whom. This field specifies the number of times the Scheduler will attempt to connect to the server to get this information.
Minimum/Maximum Global Sleep Seconds	The minimum and maximum number of seconds during which the iBot will randomly sleep before it attempts to reconnect to the server to get global information.
Number of Request Tries	After an iBot has received the global information, it issues a series of unique requests to the server for each user. This field specifies the number of times the Scheduler will attempt to connect to the server to issue these requests.
Minimum/Maximum Request Sleep Seconds	The minimum and maximum number of seconds during which the iBot will randomly sleep before it attempts to reconnect to the server to issue requests.
Number of Delivery Tries	After a unique request has executed, the iBot tries to deliver the results to specified devices. This field specifies the number of times the Scheduler will attempt to connect to the server to deliver the results.
Minimum/Maximum Delivery Sleep Seconds	The minimum and maximum number of seconds during which the iBot will randomly sleep before it attempts to reconnect to the server to deliver results.
Max Concurrent Subscribers	Specifies how many concurrent actions or unique requests will be executed in parallel. This number represents the number of dedicated threads from the thread pool an iBot will use. You can override this setting for individual iBots in the Modify Job dialog box.