Mapping Topic IDs to Help Topics

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. ADF Rich Client Help Provider 20-3 b. Create a jspx Web page; for some components input, select, etc, where you can find an attribute named helpTopicId, specify the ID you want to display with your OHW-RC instance. 3. Copy the helpsets into a direcotry under your application_rootpublic_ html folder. For example, let’s name this directory helpsets. 4. Set up the adf-settings.xml file. a. Navigate to your applications directory, and look for the .adfMETA-INF directory. Under that directory you can find the adf-settings.xml file. If the .adfMETA-INF directory is not present, create the META-INF directory under the ViewControllersrc directory. b. Enter code into adf-settings.xml; for example: adf-settings xmlns=http:xmlns.oracle.comadfsettings help-provider help-provider-classoracle.help.web.rich.helpProvider.OHWHelpProviderhel p-provider-class property property-nameohwConfigFileURLproperty-name valuehelpsetsohwconfig.xmlvalue property --property property-namegroupproperty-name valuenullvalue property-- property property-namebaseURIproperty-name valuehttp:localhost:8989help-ohw-rcf-context-rootohguidevalue property help-provider adf-settings In this adf-settings.xml file: If you want to use OHW-RC as your help provider, then, in this adf-settings.xml file, the class has to be OHWHelpProvider. Set the ohwConfigFileURL property to point to your helpsetsohwconfig.xml. Noe that you created the helpsets directory in Step 3.