Configuring Siebel Business Applications > Configuring Help > Overview of Configuring Help >

Location of Help Files for an Employee or Partner Application


Internal employees of an enterprise use an employee application. Siebel Call Center and Siebel Sales are examples of an employee application. The location where you install Siebel CRM and the type of Siebel client determines the location of the help files.

Location of Help Files in the Siebel Web Client

The Siebel Web Client runs in a typical browser on a personal computer. It does not require a Siebel business application to be installed on the client computer. The browser connects through a Web server to the Siebel Server, which executes business logic and accesses data from the Siebel Database.

In this configuration, help files reside in the following location on the Siebel Server:

ORACLE_HOME\public\language_code\help

where:

  • ORACLE_HOME is the directory where you installed the Siebel Web Server Extensions
  • language_code is the language you chose during installation

During the installation process, Siebel CRM configures your Web server so that the ORACLE_HOME\public\language_code directory becomes the following root directory for the URL:

http://hostname/Siebel application name

If the Help Identifier property of a screen references a URL in the Help Id object, then that URL is relative to the following directory:

http://hostname/Siebel application name

Example of Locating Help Files for the Siebel Web Client

If you run Siebel Call Center on the Siebel Server, and if you request the help for the Accounts screen, then Siebel CRM displays the following page:

http://siebsrvr/callcenter/help/siebaccounts.htm

In this situation, you can place the help files in any directory that you can reference from the following directory:

http://hostname/Siebel_application_name

Assume you do the following:

  1. Create a directory named customhelp in the following directory:

    ORACLE_HOME\public\language_code\

  2. Create a new help topic file named accountshelp.htm for the Accounts screen.
  3. Configure your Web server so that Siebel CRM displays the customhelp directory to the user.

In this situation, you create Help Id objects that reference the customhelp URL. Table 78 describes the Help Id object properties:

Table 78. Example Help Id Object Properties
Property
Value

Name

ID_SCREEN_ACCOUNTS

Project

Repository Help Id

Type

Screen

HTML Help URL

customhelp/accountshelp.htm

Location of Help Files in the Siebel Developer Web Client and Siebel Mobile Web Client

Siebel CRM delivers the Siebel Developer Web Client through a Web browser that provides direct connectivity to a database server. It requires an installed Siebel business application on the client computer. It does not require a local database, Web server, or Siebel Server. Siebel CRM still requires the Siebel Server for certain functionality, such as Assignment Manager and Replication.

The Siebel Mobile Web Client is a portable client delivered through a Web browser. It is designed for local data access. It requires installation of a Siebel business application on the client computer. It does not require connection to a server. It meets the needs of field professionals who do not possess continuous access to a network. The Siebel Mobile Web Client uses a local database on each remote computer. Periodically, the client must access the Siebel Server through a network connection to synchronize data changes between the Siebel Database and the Siebel File System.

The software installed on the client computer for the Siebel Developer Web Client and Siebel Mobile Web Client is identical except for the type of connectivity provided.

The following installation directory on the Siebel client determines the location of the help files:

ORACLE_HOME\public\language_code\help

where:

  • ORACLE_HOME is the complete path to the location where you installed Siebel CRM
  • language_code is the language you chose during installation

For example:

D:\sea\webclient\public\enu\help

During the installation process, Siebel CRM configures the local Web server so that the ORACLE_HOME\public\language_code\ directory becomes the following root directory for the URL:

http://localhost

If the Help Identifier property of a screen references a URL in the Help Id object, then that URL is relative to the following directory:

http://localhost directory

Example of Locating Help Files for the Siebel Developer Web Client and Siebel Mobile Web Client

The example to configure help files for the Siebel Developer Web Client and Siebel Mobile Web Client is the same as for the Siebel Web Client except you use http://localhost instead of http://hostname/Siebel_application_name.

Configuring Siebel Business Applications Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices.