Siebel Remote and Replication Manager Administration Guide > Configuring the Remote Client > Process of Configuring the Remote Client >

Modifying the Siebel Configuration File


This task is a step in Process of Configuring the Remote Client.

The remote client reads configuration parameters in the Siebel configuration file to determine the location of the Siebel Server folders, the Siebel File Server folders, and the server database installation. The siebel.cfg file for Siebel Sales is an example of a configuration file.

You must set the values for the configuration parameters before you configure Siebel Remote. If you install a Siebel application, then the Siebel installation program creates a siebel.cfg file in the following folder on the remote client. This file includes default values for each configuration parameter:

bin

Siebel Remote reads the configuration parameters from the configuration file that the Windows shortcut specifies for the remote client or for the synchronizer, depending on whether the user starts synchronization while using the remote client or uses the stand-alone synchronizer. The Installer sets up the shortcut to use siebel.cfg as the configuration file, by default. You can modify this setting.

Siebel Remote reads the configuration information from the configuration file when it does a synchronization. For example, if you use Siebel Call Center, then it reads configuration information from the uagent.cfg file. The user can choose the File menu, Database, and then the Synchronize menu item to start a synchronization.

To modify the Siebel configuration file

  1. Locate, and then open the configuration file in a text editor.

    For more information, see Locating the Siebel Application Configuration File.

  2. Locate the Siebel section, and then do the following work:
    1. Set the ClientRootDir parameter.

      The ClientRootDir parameter is the name of the installation folder that resides on the remote client.

    2. Set the DockRepositoryName parameter.

      The DockRepositoryName parameter is the name of the SRF (Siebel Repository File) that you are currently using. This parameter must contain the same value as the SRF file on the Siebel Server.

    3. If the remote client uses Quick Start, then set the EnableFQDN parameter to False.

      If the user connects to a VPN and then restarts the remote client with Quick Start, then Siebel Remote might display the following error message:

    Page cannot be displayed.

    To avoid this situation, you must set EnableFQDN to false. Setting EnableFQDN to false might affect other functionality, such as the behavior of a pop-up blocker. For more information, see Configuring Siebel Remote to Use Siebel QuickStart to Start the Remote Client, and Siebel System Administration Guide.

  3. Locate the Local section, and then do the following work:
    1. Set the DockConnString parameter.

      The DockConnString parameter is the logical network address of the Siebel Server where Siebel Remote connects to synchronize. For more information, see Formatting the DockConnString Parameter and Using VPN When Synchronizing Through the Internet.

    2. Set the TableOwner parameter.

      The TableOwner parameter is the name of the account on the local database where the Siebel schema resides. The default value is SIEBEL.

    3. Set the DockTxnsPerCommit parameter.

      For more information, see Recommended Configurations for Setting the Number of Transactions That Siebel Remote Applies Before a Commit.

  4. Optional. Modify the configuration file to use a different data source.

    If your organization requires data and applications that are stored on separate devices, then you can use a data source that is different from the one that you specify in the Local section of the configuration file.

    CAUTION:  Make sure you modify the description of the existing local data source in the configuration file. Do not add more local data sources to the configuration file because Siebel Remote does not support these additional local data sources.

    1. In the Local section of the configuration file, edit the information of the data source so that it identifies the location of the sse_data.dbf file.
    2. Open the ODBC Data Source Administrator program, and then choose the SEAW Local Db default instance.
    3. Click Configure.
    4. Click the Database tab.
    5. Edit the name of the local database file so that it identifies the location of your local database file.
    6. Click OK two times.
  5. Optional. Specify a location for the SRF.

    Beginning with Siebel CRM Version 7.7, you can locate the SRF outside of the SIEBEL_ROOT\objects\language folder. To place the SRF file in a location of your choice, you do the following steps:

    1. Place a copy of the SRF in a location of your choice.
    2. In the Siebel section of the configuration file, set the value of the RepositoryFile parameter to the full path of where the SRF file resides, including the name of the SRF.

      For example:

    c:\my custom folder\siebel.srf

  6. Optional. Configure the sort order.

    For more information, see Configuring the Sort Order.

  7. Save your modifications, and then close the configuration file.
  8. Implement your modifications across the Siebel Enterprise.

    You must apply any modification that you make to the repository file to the Siebel Servers that serve the modified application to the Web clients. For more information, see Upgrading a Regional Node.

Recommended Configurations for Setting the Number of Transactions That Siebel Remote Applies Before a Commit

Table 8 describes recommended configurations for setting the number of transactions that Siebel Remote applies before a commit. The DockTxnsPerCommit parameter sets the number of transactions that Siebel Remote applies to the local database before it does a commit. You must set this configuration parameter to a value that satisfies the requirements at your site. The default value is 500.

Table 8. Recommended Configurations for Setting the Number of Transactions
Situation
Recommended Configuration

The user uses the Synchronize Database menu item of the File menu in a Siebel application.

Set the DockTxnsPerCommit parameter to a high value. A merged transaction does not lock out another user. This configuration improves performance.

The user uses a stand-alone synchronizer.

Set the DockTxnsPerCommit parameter to a high value only if the program is the only active user on the server database. For more information, see Using the Stand-Alone Synchronizer.

The Siebel application applies transactions while the user accesses the server database through this Siebel application.

Set the DockTxnsPerCommit parameter to a low value to prevent locking out other users while Siebel Remote merges transactions.

Verifying Database Connectivity on UNIX or DB2

You can use odbcsql to verify database connectivity with SQL Anywhere on a UNIX or on a DB2 operating system.

To verify database connectivity on UNIX or DB2

  1. Set the SIEBEL_UNIXUNICODE_DB environment variable to ORACLE.
  2. Test the connection.

For more information, see Siebel Installation Guide for UNIX.

Formatting the DockConnString Parameter

Siebel Remote uses the DockConnString parameter in the configuration file to synchronize to the Siebel Server. This parameter contains the name of the computer where you install the Siebel Server software and where you extract the remote client. Make sure you set the DockConnString parameter before you initialize the remote client. You must use the following format when you set the DockConnString parameter:

siebel_server_name:network_protocol:sync_port_number:service:encryption

where:

  • siebel_server_name is the logical network address of the Siebel Server that the remote client uses to connect and synchronize.
  • network_protocol is the name of the networking protocol to use. TCP/IP is the only valid value and is the default value if you do not specify any value.
  • sync_port_number is the TCP/IP port number that Siebel Remote dedicates to the Synchronization Manager. If you do not specify any value, then the default value is 40400. For more information, see Setting the Port Number.
  • service is the TCP/IP service. SMI is the only valid value and is the default value if you do not specify any value.
  • encryption is the encryption package. The encryption facility must match the type that the Siebel Server uses. Siebel Remote supports MSCRYPTO and RSA.

The following examples are valid values for the DockConnString parameter:

SIEBAPP1:TCPIP:40400:SMI:RSA

SIEBAPP1:TCPIP:9000

SIBAPP1::9000

SIEBAPP1

All elements of the DockConnString parameter are optional except the Siebel Server name. If you do not include an element, then you must include adjacent colons. For example, the following example does not include the network protocol element:

SIBAPP1::9000

Setting the Port Number

You can modify the default value of the port number that you specify in the DockConnString parameter. You can also specify this port number as a command line option when you start the Siebel Server.

To modify the port number

  1. Make sure advanced parameters are visible.

    For more information, see Making Advanced Server Parameters Visible.

  2. To use the administrative interface to modify the port number, do the following work:
    1. Locate the record for the Synchronization Manager server component.

      For more information, see Locating the Record for a Server Component.

    2. In the bottom applet, click the Parameters tab, click Advanced, and then query the Parameter field for Static Port Number.
    3. Specify a value in the Value on Restart field.
    4. Restart the Siebel Server.
    5. Update the remote client configuration file so that it matches the setting you specified in Step c.

      For more information, see Modifying the Siebel Configuration File.

  3. To use the Server Manager command line interface to modify the port, do the following work:
    1. On the Siebel Server, navigate to the following folder:

    SIEBEL_ROOT\bin

    1. Open the Server Manager command line.

      For more information, see Opening the Command Line Interface for Server Manager.

    2. Enter the following command:

    srvrmgr> change param portnumber=port number for comp synchmgr

    1. To list the port numbers, you can enter the following command:

    list advanced param portnumber for comp synchmgr

Using VPN When Synchronizing Through the Internet

It is recommended that every synchronization occur within the corporate firewall. If your deployment must support synchronization to the Internet from outside the firewall, then it is recommended that you use a VPN (Virtual Private Network). If there is a firewall on the network between the remote client and the Siebel Server, or between the VPN Server and the Siebel Server, then the port for synchronizing with the Siebel Server must be opened on the firewall, and this port must be a port other than port 80.

If you do not use a VPN connection, then it is possible that your Internet Service Provider (ISP) or another host on the router could block communication on the port that you specify for synchronizing.

Configuring the Sort Order

You can configure the sort order for the local database or for the sample database.

Configuring the sort order

  1. Access the remote client computer, and then locate the configuration file.

    For example, locate siebel.cfg or uagent.cfg. For more information, see Modifying the Siebel Configuration File.

  2. Use a text editor to open the configuration file that you located in Step 1, and then modify the SortCollation parameter.

    The SortCollation parameter determines the sort order that the SQL Anywhere database uses. For optimal performance, it is recommended that you set the SortCollation parameter to Binary. For more information, see Siebel System Administration Guide.

Siebel Remote and Replication Manager Administration Guide Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.