Application and OHW-RC Configuration Files and Setup Running the application

19-4 Oracle Fusion Middleware Developers Guide for Oracle Help 20 ADF Rich Client Help Provider 20-1 20 ADF Rich Client Help Provider If you have an ADF Faces application and wish to incorporate online help into your application, ADF Faces, also known as ADF Rich Client, provides an easy way to do that. You can create an online help system with help topics which are integrated with components of the application. This chapter describes how to configure OHW-RC as a help provider, lists other ADF Rich Client help providers, and also describes how to use HelpTopicId attribute to associate help topics with your application. This chapter contains the following sections: ■ Section 20.1, Integrating Online Help With ADF Faces Application ■ Section 20.2, Registering OHW-RC as an ADF Rich Client Help Provider ■ Section 20.3, Using HelpTopicId Attribute ■ Section 20.4, Using Other Help Providers

20.1 Integrating Online Help With ADF Faces Application

When you integrate a help topic with an ADF Faces component, a help icon a blue circle with a question mark appears with the component. When you click the help icon, the related help topic appears in a new window, as shown in Figure 20–1 . 20-2 Oracle Fusion Middleware Developers Guide for Oracle Help Figure 20–1 Help Icon in an ADF Faces Application Integrating an online help with an application is an easy process, descibed in the following steps: ■ Register a help provider with your application ■ Create a properties file that contains the topic ID and help text for each help topic ■ Associate the UI components with help topics by using the HelpTopicId attribute For more information about integrating online help with an application, see Displaying Help for Components section in Oracle Fusion Middleware Web User Interface Developers Guide for Oracle Application Development Framework.

20.2 Registering OHW-RC as an ADF Rich Client Help Provider

ADF Rich Client Faces includes a variety of help providers. You can use a combination of the different help providers or create your own help provider class. You can also use OHW-RC as a help provider. You need to perform the following tasks in order to set up OHW-RC as a Help Provider in an ADF Rich Client application: 1. Deploy OHW-RC as a web application: a. Deploy an RC application to web application server. b. Note down the context-root of this deployment. c. Open the web.xml file in this deployment. d. Find the OHW-RC servlet instance. 2. Develop the jspx Web pages. a. Create an ADF Faces-based Web application.