Siebel Object Interfaces Reference > Customizing Siebel Object Interfaces > Process of Customizing a Siebel Object Interface >

Setting the Connect String

The connect string is a text string that describes the URL that is required to connect to a server component on the Siebel Server. It specifies the protocol and the details of the Client Application Manager service on the Siebel Server. The Siebel client or a program that is external to Siebel CRM must use this string to connect to the Siebel Server.

Format of the Connect String Parameter

The connect string uses the following format:

host="siebel.transport.encryption.compression://host:port/EnterpriseServer/AppObjMgr_lang" lang="lang_code"

For example:

SiebelApplication.Login "host=""siebel://host/EnterpriseServer/SCCObjMgr_enu"" "lang="ENU"", "CCONWAY", "CCONWAY"

Table 3 describes how to set each variable in the connect string.

The format of the connect string is optional. You can enter only the transport variable and use a period (.) to separate it from siebel. For example:

siebel.tcpip://host/siebel/AppObjMgr_lang

If you specify any of the other variables, then you must use a period (.) as a placeholder for each variable that you do not specify. For example:

siebel...zlib://myhost/siebel/SCCObjMgr_enu

Examples of Using the Connect String

This topic includes examples of using the connect string.

Example Connect String for COM Data Control in Server Mode

The following example includes a connect string for COM Data Control that operates in server mode:

   'COM Data Control : SERVER Mode
   lstr = "host=" + """siebel://frashid/Siebel/SSEObjMgr_enu"""
   'Format of the connect string is
   '"host=" + """siebel://host/enterprise/App. Object Mgr_lang"""
   lng = "lang=" + """ENU"""
   retval = siebDataCtl.Login(lng + lstr, "username", "password")

Example Connect String for COM Data Control in Local Mode

The following example includes a connect string for COM Data Control that operates in Local Mode:

   'COM Data Control : LOCAL Mode
   lstr = "cfg=" + """C:\Siebel\8.1\Client_2\BIN\ENU\siebel.cfg,ServerDataSrc"""

   'Format of the connect string is
   '"cfg=" + """Absolute path of the CFG file, DataSource"""
   'Datasource = ServerDataSrc or Local or Sample
   lng = "lang=" + """ENU"""
   retval = siebDataCtl.Login(lng + lstr, "username", "password")

If in Local Mode, then COM Data Control must reside on the same computer as the Siebel Mobile Web Client.

Example Connect String for COM Data Control When Using Siebel VB

The following example includes a connect string for COM Data Control that uses Siebel VB. The Char(34) code indicates a double quote:

ConnStr = "host =" & char(34) & "siebel://HOST/ENTERPRISE_SERVER/SCCObjMgr_enu/SIEBEL_SERVER" + char(34) & " Lang = " & char(34) & "LANG" & char(34)

Using Load Balancing with the Connect String

You can use Siebel native load balancing across Siebel Servers with the following Siebel object interface: Siebel Java Data Bean

To use load balancing with the connect string

1. Modify the predefined connect string so that it directs requests to an appropriate virtual host.

   This host includes specific Siebel Servers. Each Siebel Server includes the required object manager.

2. Specify the path to the file that defines the virtual host.

Connect String That Uses Load Balancing with Siebel Java Data Bean

A connect string that uses native Siebel load balancing with Siebel Java Data Bean uses the following format:

host="siebel://VirtualHost/EnterpriseServer/AppObjMgr_lang"

If you use Java code to connect to the Siebel Server, then Siebel CRM reads virtual host definitions from the following property in the siebel.properties file:

siebel.conmgr.virtualhosts

The siebel.properties file must reside in the classpath of the Java Virtual Machine.

For information about using virtual hosts in the siebel.properties file, see Transports and Interfaces: Siebel Enterprise Application Integration.