Siebel Developer's Reference > Online Help Development > Employee Applications >

Location of Employee Application Help Files

The location of the help files is determined by the location where you installed your Siebel applications and by the type of Siebel client:

Siebel Web Client

Siebel Web Client runs in a standard browser from the client personal computer and does not require any additional persistent software installed on the client. The browser connects through a Web server to the Siebel eBusiness Application server, which executes business logic and accesses data from the Siebel Database.

In this implementation, help files are installed in the following location on the server:

<install dir>\public\<install language>\help, where

During the installation process, your Web server is configured so that
<install dir>\public\<install language>\
becomes the root directory for the URL
http://<hostname>/<Siebel application name>

When a Help Identifier property in a Screen object maps to a URL in the Help Id object, that URL is relative to http://<hostname>/<Siebel application name>.

Example

If you are running Siebel Call Center on the server siebsrvr, when you request the help for the Accounts screen, the page that will appear is
http://siebsrvr/callcenter/help/siebaccounts.htm. This means that you can put the help files in any directory that can be referenced from
http://<hostname>/<Siebel_application_name>.

Assume that in <install dir>\public\<install language>\, you create a directory called customizedhelp and you create a new help topic file for the Accounts screen, called accountshelp.htm. After that, you configure your Web server so that this directory is exposed to a Siebel application user. In this case, you would create Help Id objects that point to the URL customizedhelp; the Help Id object properties would be:

Property
Value
Name
ID_SCREEN_ACCOUNTS
Project
Repository Help Id
Type
Screen
HTML Help URL
customizedhelp/accountshelp.htm

Siebel Dedicated Web Client and Siebel Mobile Web Client

Siebel Dedicated Web Client is a Microsoft Windows client delivered through a Web browser that provides direct connectivity to a database server. It requires software to be installed on the client machine, but does not require a local database, Web server, or Siebel eBusiness Application server for serving up interactive user sessions. Siebel Server is still required for functionality like Assignment Manager and Replication.

Siebel Mobile Web Client is a portable Microsoft Windows client delivered through a Web browser that is designed for local data access and does not need to be connected to a server. Siebel Mobile Web Client meets the needs of field professionals who do not have continuous access to a network. Siebel Mobile Web Client uses a local database on each mobile machine. Periodically, the client must access the Siebel Remote Server through a dial-up, WAN, or LAN connection to synchronize data changes with the Siebel Database on the database server and Siebel File System. This client requires installation of Siebel software on the user's personal computer.

The software installed on the user's machine for the Siebel Dedicated Web Client and Siebel Mobile Web Client is identical—the only difference is the type of connectivity provided.

In these implementations, the location of the help files is determined by the installation directory on the client:

<install path>\public\<install language>\help, where

For example, D:\sea\webclient\public\enu\help.

During the installation process, your local Web server is configured so that
<install path>\public\<install language>\
becomes the root directory for the URL http://localhost/.

When a Help Identifier property in a Screen object maps to a URL in the Help Id object, that URL is relative to http://localhost.

Example

If you are running Siebel Call Center on your local machine, when you request the help for the Accounts screen, the page that will appear is
http://localhost/help/siebaccounts.htm. This means that you can put the help files in any directory that can be referenced from http://localhost/.

Assume that in <install path>\public\<install language>\, you created a directory called customizedhelp and you created a new help topic file for the Accounts screen, called accountshelp.htm.

In this case, you would create Help Id objects that point to the URL customizedhelp; the Help Id object properties would be:

Property
Value
Name
ID_SCREEN_ACCOUNTS
Project
Repository Help Id
Type
Screen
HTML Help URL
customizedhelp/accountshelp.htm

 Siebel Developer's Reference 
 Published: 23 October 2003