Bookshelf Home | Contents | Index | PDF |
Configuring Siebel eBusiness Applications > Online Help Development > Employee Applications > Online Help and Siebel ToolsIn Siebel Tools, Screen, View, and Help Id objects are used to establish the link between a screen or a view and a help topic file. NOTE: Standard Siebel eBusiness Applications do not contain view-level help topic references; they are all at the screen level. See Implementing Help for a View for instructions about adding view-level help references. The following topics are included:
Screen and View ObjectsEach Screen and View object has a Help Identifier property that is used to establish the link with the Help Id object. The format of the Help Identifier property is ID_type_objdefname, where: Help Id ObjectsEach Help Id object has a HTML Help URL property that is used to identify the HTML file that contains the help topics for the screen or the view by mapping the Help Identifier to a specific URL. You can use the same value for the HTML Help URL property for different Help Id objects. The format of the HTML Help URL property is help/helptopics.htm, where:
See Location of Employee Application Help Files for additional information about where the help files are installed. Help Properties of Screens and ViewsTo determine which HTML file contains the help topics for a screen or a view you must: use your Siebel application to determine the Screen or View object used in the screen or view, then use Siebel Tools to find the Help Identifier property of the Screen or View object and then find the corresponding HTML Help URL property in the Help Id object. NOTE: Some screens are associated with generic help topics. In this case, you must use a different filename if you want to customize the help. See Customizing Help for Screens with Generic Help Topic Files for instructions. ExampleTo determine which HTML file contains the help topics for the Accounts screen, you must find which Screen object is used in the Accounts screen. To do this, in your Siebel eBusiness Application, navigate to the Accounts screen, then choose Help > About View to access the About View dialog box, shown below. In Siebel Tools, find the Accounts screen object and find the value of its Help Identifier property (ID_SCREEN_ACCOUNTS) in the Object List Editor window, shown below. When you know the value of the Help Identifier property of the Screen object (ID_SCREEN_ACCOUNTS), you can find the value of the Help Id object's HTML Help URL property (help/siebaccounts.htm) in the Object List Editor window, as shown below. Default Help TopicThe start page of the employee applications help system (siebstarthelp.htm) is defined as the default help topic for employee applications. When a user accesses help from a screen or view for which the Help Identifier property is not defined, siebstarthelp.htm appears in a separate browser window. To change the default help topic
Implementing Help for a ScreenIf you add a custom screen in your implementation of Siebel eBusiness Applications, you can create help for that screen. To do this, you must use Siebel Tools to define the Screen object with a Help Identifier property, and then add a Help Id object with a HTML Help URL property for the screen. The documentation team can develop the content using the name of the file that will be distributed to the appropriate Siebel Servers, Siebel Mobile Web Clients, and Siebel Dedicated Web Clients.
Implementing Help for a ViewTo add help for a view, you must use Siebel Tools to define the View object with a Help Identifier property, and then add a Help Id object with a HTML Help URL property for the view. At the same time, the documentation team can develop the content, and they can use the name of the file that will be distributed to the appropriate Siebel Servers, Siebel Mobile Web Clients, and Siebel Dedicated Web Clients.
Changing the Keyboard Shortcut for Accessing HelpSince most users are accustomed to accessing help by pressing the F1 key, you may want to map F1 to display online help in your Siebel application. To do this, you must add an accelerator in Siebel Tools. To change the keyboard shortcut for accessing help
Help Menu ItemsIf you create a new application using Siebel Tools, you can add options to the Help menu in your application. For example, you may want to add an option that allows the user to access the Siebel Bookshelf from within the application. The Help application menu option is configured using the Command and Menu objects. The Command object created for online help is Contents Help (SWE). For instructions about using the Command and Menu objects, see Configuring Toolbars and Menus. |
Configuring Siebel eBusiness Applications |