WARNING: No help provider found for helpTopicId when trying to create Help

Question

JDEV Version: 11.1.1.0.1
Build JDEVADF_MAIN.BOXER_GENERIC_081203.1854.5188
New to JDEV and following chapter 16 - Displaying Tips, Messages, and Help
16.5.1 How to Create Resource Bundle-Based Help
Oracle® Fusion Middleware
Web User Interface Developer’s Guide for Oracle Application
Development Framework
11g Release 1 (11.1.1)
B31973-
to create Help in my application.
1. I have created helpFile.properties in view.resources which has following info
RBHELP_PH_DEFINATION=This is test help for Panel Header.
2. I have created META-INF directory at the same level as WEB-INF and created adf-settings.xml file as per instruction in the doc and registered the help provider in there.
<?xml version="1.0" encoding="windows-1252" ?>
<adf-settings xmlns="http://xmlns.oracle.com/adf/settings">
<adf-faces-config xmlns="http://xmlns.oracle.com/adf/faces/settings">
<help-provider prefix="RBHELP_">
<help-provider-class>oracle.adf.view.rich.help.ResourceBundleHelpProvider</help-provider-class>
<property>
<property-name>baseName</property-name>
<value>view.resources.helpFile</value>
</property>
</help-provider>
</adf-faces-config>
</adf-settings>
3. Created a test page to test the help out.
<?xml version='1.0' encoding='windows-1252'?>
<jsp:root xmlns:jsp="http://java.sun.com/JSP/Page" version="2.1"
xmlns:f="http://java.sun.com/jsf/core"
xmlns:h="http://java.sun.com/jsf/html"
xmlns:af="http://xmlns.oracle.com/adf/faces/rich">
<jsp:directive.page contentType="text/html;charset=windows-1252"/>
<f:view>
<af:document>
<af:form>
<af:panelStretchLayout>
<f:facet name="bottom"/>
<f:facet name="center">
<af:panelHeader text="TestHelpHeader"
helpTopicId="RBHELP_PH_DEFINATION">
<f:facet name="context"/>
<f:facet name="menuBar"/>
<f:facet name="toolbar"/>
<f:facet name="legend"/>
<f:facet name="info"/>
</af:panelHeader>
</f:facet>
<f:facet name="start"/>
<f:facet name="end"/>
<f:facet name="top"/>
</af:panelStretchLayout>
</af:form>
</af:document>
</f:view>
</jsp:root>
When i run the page i don't see a icon for defination help as shown in Table 16-1 in the doc nor do i see any Help when i hover the mouse have panel Header Text on the page.
The Default Server log window in jdev shows
WARNING: No help provider found for helpTopicId=RBHELP_PH_DEFINATION.
When i go to Package Browser and try and search for oracle.adf.view.rich.help.ResourceBundleHelpProvider i don't find it.
Am i missing something here?

Answer 1

I followed the example as shown on
http://jdevadf.oracle.com/adf-richclient-demo/faces/components/panelHeader.jspx
which shows instruction text and definition text (question mark icon)
Checking the code i ended up creating/copying the following class for HelpProvider.
package view.webapp;
import javax.faces.component.UIComponent;
import javax.faces.context.FacesContext;
import oracle.adf.view.rich.help.ResourceBundleHelpProvider;
* This class extends ResourceBundleHelpProvider. This is needed to create an implementation for
* the demo that will return a url. In this case, for the demo, the url is just hardwired
* to a value.
public class DemoHelpProvider extends ResourceBundleHelpProvider
public DemoHelpProvider()
@Override
protected String getExternalUrl(FacesContext context, UIComponent component, String topicId)
if (topicId == null)
return null;
if (topicId.contains("TOPICID_ALL") ||
topicId.contains("TOPICID_DEFN_URL") ||
topicId.contains("TOPICID_INSTR_URL") ||
topicId.contains("TOPICID_URL"))
return "/Application2-ViewController-context-root/faces/helpPages/PatchParamHelp.html";
else
return null;
}