Bookshelf Home | Contents | Index | PDF     

Siebel System Administration Guide >

Structure of the lbconfig.txt File

The load balancing configuration file (lbconfig.txt) provides information about which Siebel Servers will be load-balanced. Its default location is \siebel\eapps\admin.

The file has two parts:

  • Session Manager Rules. The first section contains virtual server definitions used by Siebel load balancing. These definitions map a virtual server name to one or more physical platforms on which Siebel Servers are running. Entries can be edited to create additional virtual servers. Load balancing is managed internally by the load balancing module in the Siebel Web Server Extension (SWSE).
  • Third-Party HTTP Load Balancer Rules. The second section is provided as a guide for creating routing rules for third-party HTTP load balancers. This section lists a series of Uniform Resource Locators (URLs) that provide a path to Application Object Managers (AOMs). These URLs are included in the HTTP header of SISNAPI messages sent from the Siebel Web Server Extension (SWSE) to the load balancer. They are based on the object manager connect strings located in the Siebel Web Server Extension (SWSE) configuration file (eapps.cfg).

    The entries map these URLs to Siebel Servers where the AOMs are located. The URL and server mapping together can be used to write routing rules for the load balancer. The mapping includes the port number of the SCBroker running on the Siebel Server. SCBroker receives server requests and distributes them to AOMs running on the server.

    These entries are listed in three groups:

    • Component Rules. This group lists the servers to use for initial connection requests. The path includes the names of all the servers running the Application Object Manager.
    • Server Rules. This group lists the servers to use for server reconnection requests.
    • Round-Robin Rules. This group lists the servers to use for retry requests. The URL for these retry requests includes the string RR. There is no significance to the order of the servers in the rule. The third-party HTTP load balancer determines the order in which servers are retried.

lbconfig.txt Session Manager Rules

The syntax of a virtual server definition is as follows:

VirtualServer = sid:hostname:SCBroker_port;sid:hostname:SCBroker_port;

where:

  • VirtualServer. The name of the pool of Siebel Servers that will be load-balanced. The default name is VirtualServer. This name is included in the object manager connect strings in the Siebel Web Server Extension (SWSE) configuration file (eapps.cfg). By default, the VirtualServer pool contains all the Siebel Servers running at the time the SWSE was installed.
  • sid. The server ID of the Siebel Server. This is a unique number assigned to each Siebel Server during installation.
  • hostname. The network host name or IP address of the machine on which the Siebel Server runs. If the machine is part of a cluster, then this should be the cluster virtual host name.
  • SCBroker_port. The port number of the Siebel Connection Broker.

Third-Party HTTP Load Balancer Rules

The variables in the following rules have the following meaning:

  • enterprise. The Siebel Enterprise Server name.
  • AOM. The Application Object Manager name.
  • server. The Siebel Server name. You can change this to the TCP/IP address of the Siebel Server, if desired.
  • SCBPort. The port assigned to the Siebel Connection Broker on the Siebel Server.
  • sid. The server ID of the Siebel Server. This is a unique number assigned to each Siebel Server during installation.
Component Rules

These rules are URLs for initial connection requests. The syntax of a component rule is as follows:

/enterprise/AOM/=server:SCBport;...;

When the file is generated, a component rule is created for every enabled AOM found on every running Siebel Server.

Server Rules

These rules are URLs for server reconnection requests. The syntax of a server rule is as follows:

/enterprise/*/!sid.*=server:SCBPort;

The first asterisk in the syntax is a wildcard for the AOM. The exclamation point and dot-asterisk (.*) are wildcards that parse the server name to extract the server ID.

Not all load balancers can handle a wildcard character (*) in the middle of the URL. In these cases, create URLs with the following format:

/enterprise/AOM/!sid.*=server:SCBport;

Repeat this mapping for each combination of the AOM and Siebel Server ID.

Round-Robin Rules

These rules are URLs for server retry requests. The syntax for a round-robin rule is as follows:

/enterprise/AOM/RR=server:SCBport;...;

This syntax is the same as that of component rules, except that RR is appended to the URL. This is to alert the load balancer to apply a round-robin rule that routes this request to a different Siebel Server.

Example of a Load Balancing Configuration File

The Siebel Enterprise Server in the example has the following characteristics:

  • Enterprise name: Siebel
  • Siebel Servers: SiebServA, SiebServB
  • Siebel Connection Broker port: 2321 for both servers

Example of lbconfig.txt. Here is an example of an lbconfig.txt file. (Explanatory text at the beginning of the file is not shown):

#Section one -- Session Manager Rules:

VirtualServer=1:SiebServA:2321;2:SiebServB:2321;

******************************

#Section two -- 3rd Party Load Balancer Rules

#Component Rules:

/siebel/CRAObjMgr_enu/=SiebServA:2321;SiebServB:2321;

/siebel/eEventsObjMgr_enu/=SiebServA:2321;SiebServB:2321;

/siebel/eMarketObjMgr_enu/=SiebServA:2321;SiebServB:2321;

/siebel/SMObjMgr_enu/=SiebServA:2321;SiebServB:2321;

/siebel/eTrainingObjMgr_enu/=SiebServA:2321;SiebServB:2321;

/siebel/ERMEmbObjMgr_enu/=SiebServA:2321;SiebServB:2321;

/siebel/ERMAdminObjMgr_enu/=SiebServA:2321;SiebServB:2321;

/siebel/ERMObjMgr_enu/=SiebServA:2321;SiebServB:2321;

/siebel/SalesCEObjMgr_enu/=SiebServA:2321;SiebServB:2321;

#Server Rules:

/siebel/*/!1.*=SiebServA:2321;

/siebel/*/!2.*=SiebServB:2321;

#Round-Robin Rules:

/siebel/CRAObjMgr_enu/RR=SiebServA:2321;SiebServB:2321;

/siebel/eEventsObjMgr_enu/RR=SiebServA:2321;SiebServB:2321;

/siebel/eMarketObjMgr_enu/RR=SiebServA:2321;SiebServB:2321;

/siebel/SMObjMgr_enu/RR=SiebServA:2321;SiebServB:2321;

/siebel/eTrainingObjMgr_enu/RR=SiebServA:2321;SiebServB:2321;

/siebel/ERMEmbObjMgr_enu/RR=SiebServA:2321;SiebServB:2321;

/siebel/ERMAdminObjMgr_enu/RR=SiebServA:2321;SiebServB:2321;

/siebel/ERMObjMgr_enu/RR=SiebServA:2321;SiebServB:2321;

/siebel/SalesCEObjMgr_enu/RR=SiebServA:2321;SiebServB:2321;

    
Siebel System Administration Guide