Siebel Loyalty Administration Guide > Getting Started with Siebel Loyalty >

Setting Up Server Components for Siebel Loyalty

There are two server components defined for the Loyalty engine:

  • eLoyalty Process Engine - Realtime. Processes the requests from users when they click the Process button to process a transaction or tier. For each request submitted from a client, a separate Siebel task is started that processes the object exits when done.
  • eLoyalty Process Engine - Batch. Performs back-end processing. Once started, this component runs in the background and processes objects as they are created in the database. Each of its Siebel tasks continue to wait for objects to process until the component or server is shut down.

Setting Up the Realtime Server Component

To set up the realtime component, you must configure several parameters. In addition, you can choose whether to run this component in synchronous or asynchronous mode.

For information about setting up a second realtime server component, see Creating a Second Realtime Engine Component for Siebel Loyalty.

NOTE:  If your company has multiple Siebel applications installed, these parameter settings will only affect Siebel Loyalty, and not any of the other applications.

Parameters of the Realtime Component

You should set the following parameters for the realtime component:

  • Maximum Tasks. This parameter determines the maximum number of tasks the component can run. Set its value based on the number of users who will be using realtime processing through the user interface.
  • MinMTServers and MaxMTServers. Set the value of these two parameters to one. This is because only one process should be running for this component in the enterprise.
Running the Realtime Component in Synchronous and Asynchronous Mode

When the user clicks the Process button, the realtime component can process the request in one of the following modes:

  • Synchronous. The client waits for transaction processing to be completed before control is returned to the client. The user cannot do anything until the processing is completed. When control is returned to the user, the record reflects changes such as change in status or number of points.
  • Asynchronous. The client submits a transaction and control returns to the client immediately. The user can continue working, but the user must requery the transaction to see if the processing is completed (by looking at the Status) and to check the results.

The decision about which mode to use depends on the load in the deployment. There is typically a satisfactory response time in synchronous mode with a few hundred users and a light to medium load. You should use asynchronous mode if there are thousands of users all using real time processing, which is not common.

In a typical deployment, realtime processing is not used heavily, so the application runs in synchronous mode by default.

To configure the processing mode

  • Use Siebel Tools to change the user property ComponentRequestMode defined in the business service LOY Processing Engine.

    Acceptable values for this user property are Sync and Async.

Setting Up the Batch Server Component

To set up the batch component, you can configure its parameters and you can set up a workflow to start this component when the server starts.

Parameters of the Batch Server Component

You can configure the batch server component by changing the parameters that are used in processing, which are summarized in Table 9. All of the parameters in this table apply only to eLoyalty Processing Engine - Batch.

Table 9. Parameters Used in Batch Processing
Display Name
Default Value


LOY - Engine Number of Runs


The number of times to query after the queue becomes empty. This parameter should the value -1 or > 0. If -1, then the engine keeps running indefinitely until it is shut down. Otherwise, it will query the specified number of times after the current query has run out of records.


LOY - Engine Number of Tasks


The number of processing threads that will be automatically started when the loyalty engine server component is started. By default, it is 0, which means that there is no processing thread started, but there is one queue manager thread started. If -1, then no queue manager thread will be started either. If 4, then 4 processing threads plus one queue manager thread will be started per MT server.


LOY - Engine Search Specification



Currently not supported. Reserved for future use.


LOY - Engine Sleep Time (secs.)


The time (in seconds) for which the engine should wait after it has processed the records and there are no more records in the next query. After sleeping for that time, the engine will requery.

Starting the Batch Server Component

The batch component must be started whenever the server is started. You can automate this process by using a workflow included in the product, which can be invoked on server startup to initialize the server.

To start the batch component, you must know:

  • The number of servers and number of processes on each server. This number is determined by the administrator based on the transaction load.
  • The number of threads desired in each process. This number is determined based on the hardware being used. For each process, at least two threads are necessary—the queue manager thread and the processing thread. There can be more than one processing thread, depending on the number of CPUs and other resources available. Having too many threads will cause an unnecessary paging and using too few threads will cause slow processing. It is best to use two or three threads per process.

NOTE:  Before starting the component, be sure that the keys have been correctly defined, as described in Setting Up Server Keys for Siebel Loyalty.

To initialize the server component manually

  1. Be sure that the component parameters MinMTServers and MaxMTServers are set to the Number of Processes desired on each server.
  2. For each server:
    1. Calculate (# of processes on server) x (1 + # of Processing Threads/Process)
    2. Submit this number of component requests for the eLoyalty Processing Engine - Batch.

      You can submit these component requests from the User Interface or from the server manager.

NOTE:  Before using a workflow to initialize the server, you must set up the workflow so it runs whenever you start the server. For more information about setting up workflows, see Siebel Business Process Designer Administration Guide.

To use a workflow to initialize the server component

  1. In Siebel Tools, set up the workflow LOY Engine - Start Engine workflow by specifying the following two process properties:
    • NumberOfProcesses
    • NumberOfProcessingThreadsPerProcess.
  2. Activate this workflow.

    When you start the server component eLoyalty Process Engine - Batch, this workflow will submit the component requests to start the required number of processes.

Siebel Loyalty Administration Guide