Siebel Deployment Planning Guide > Siebel Architecture Overview >

About Siebel Internet Session Network API

Siebel Internet Session Network API (SISNAPI) is a Siebel proprietary message-body format running on top of TCP/IP. SISNAPI is used for communications between the Web server, Siebel Gateway Name Server, and Siebel Servers.

When a client request comes to the Web server, the Siebel Web Server Extension (SWSE) intercepts the request and forwards it in SISNAPI format. The SISNAPI message-body format has the following parts:

• HTTP header
• Object Manager method name
• Method arguments as key-value pairs

HTTP Header

When the Siebel Web Server Extension (SWSE) requests a new connection, the initial packets of the first SISNAPI message contain an HTTP header. This header includes a Uniform Resource Locator (URL) that provides routing information to the Siebel Enterprise Server, Siebel Server, and server component. Third-party HTTP load balancers use routing rules to parse the URL and route the message to the correct Siebel Server.

Connection Multiplexing

SISNAPI TCP/IP connections are specific to an Application Object Manager on one Siebel Server. Before a new connection is opened, the Application Object Manager checks to see whether an existing connection is available. If so, then an existing connection is used. Once the connection is established, it remains open to be used by subsequent messages in the session or to be reused by other sessions. For more information about connection multiplexing, see Siebel Performance Tuning Guide.

Transport Layer Security (TLS) or Secure Sockets Layer (SSL)

Transport Layer Security (TLS) or Secure Sockets Layer (SSL) encryption and authentication can be configured for SISNAPI connections. For more information, see Siebel Security Guide. See also the Siebel Installation Guide for the operating system you are using.

User Request Types

The Siebel Web Server Extension (SWSE) generates three types of user requests. Each request type creates a new connection to a Siebel Server through the load balancer: initial request, retry request, and reconnect request. The Siebel native load balancing module in the SWSE recognizes these request types and automatically routes them correctly. If you use a third-party HTTP load balancer, then you must configure routing rules to handle these requests.

• Initial request. The SWSE generates this request to start a new user session as follows:
  • The SWSE receives the request to start a user session.
  • The SWSE creates the SISNAPI message. The HTTP header specifies the Siebel Enterprise Server and the desired server component. The message does not specify a Siebel Server name. The SWSE forwards the message to a third-party HTTP load balancer, if installed.
  • The load balancer parses the URL and compares it to routing rules that have been entered in the load balancer.
  • The load balancer uses these routing rules to route the message to a Siebel Server specified in the routing rule. If no SISNAPI connection exists to the Siebel Server, then a new one is created.
  • The Siebel Server receives the message and creates a new user session. The Siebel Server forwards address information back to the Web server.
  • The Web server creates a cookie containing the address information. The Web server receives the cookie information in subsequent session requests. The SWSE includes this information in the SISNAPI HTTP header.
  • The load balancer receives subsequent messages and forwards them directly to the specified Siebel Server and server component through the open SISNAPI connection.
• Retry request. If a Siebel Server rejects an initial request, then the request is routed back to the SWSE and the following occurs:
  • The SWSE modifies the URL contained in the HTTP header by appending the letters RR to it.
  • The SWSE forwards the message to the load balancer, if installed.
  • The load balancer applies the routing rule that has been entered for RR messages. Typically, this is a round-robin routing rule that forwards the message to another Siebel Server.
• Reconnect request. The SWSE generates a reconnect request when it receives a user request for an existing user session that does not have a SISNAPI connection. The SWSE uses the session cookie information to include the Siebel Server address in the SISNAPI HTTP header.

  The reconnect request opens a new SISNAPI connection. Reconnect requests can occur for several reasons:

  • The SISNAPI connection was opened by Web Server 1, but a Web server load balancer routes subsequent session messages to Web Server 2, which does not have an existing connection.
  • The SISNAPI connection timeout is exceeded and the connection is closed.
  • The network environment closes the connection, for example due to a firewall time-out.