Thursday 30 July 2015

OAF: How to display Help link in custom OAF Page

Recently I saw a question in OTN Forum asking how to add the help link in custom OAF Page. Since I couldn't find much available for this, I am adding a post for achieving that.

Highlevel steps:

1. Create the .htm file (Need to have a specific structure as per the sample given below)
2. Upload the file using the Help Upload functionality.
3. Creating the target using Help Builder (I think this is optional if you are creating one help page alone)
4. Specify the Help Target for the PageLayoutRN of the Page.

Thanks to Chetan Gowda

1. Create the .htm file.


Create a .htm file with the structure similar to the sample one below:


Sample structure is given below:
 <HTML LANG="en-US" DIR="LTR">  
      <HEAD>   
           <TITLE>AJ Test Page </TITLE>   
           <LINK REL="stylesheet" HREF="../fnd/iHelp.css">  
      </HEAD>  
      <A NAME="FND_AJTEST_HLP_TestPG"></A>   
      <CENTER><H2><B>AJ Test Heading</B></H2></CENTER>   
      <H3><B>AJ Test Content</B></H3>   
      <BODY>  
           This is the help page for the AJ Test PG.  
      </BODY>  
 </HTML>  

Note:- <A NAME="FND_AJTEST_HLP_TestPG"></A>. This is used to specify the target. 

2. Upload the file using the Help Upload functionality.
Navigate to System Administration --> Help Administration --> Help Upload.

Specify the parameters as below :
     Action                        : Single File Upload
     Desktop File              : <Choose the .htm file created before> 
     Application                : FND  (Specify the application for which the file is getting created)
     Customization Level : 101 (anything above 100)


3. Creating the target using Help Builder.
Navigate to System Administration --> Help Administration --> Help Builder.  
     Create a new Node by clicking on the New Node icon.
  Prompt: AJ Test
  Data: @fnd_ajtest_hlp_testpg
  Node Application : FND

     Click on apply.
     Change the Type to 'Document' and click on 'Apply'. You can now click on the 'View' button to view the page.


4. Specify the Help Target for the PageLayoutRN of the Page.
Specify the Help Target Appl ShortName and the Help Target for the pageLayoutRN. Help Target Appl ShortName should be give as the application short name and the Help Target should be the one specified (FND_AJTEST_HLP_TestPG) in the anchor tag in the .htm file uploaded.



Now run the page(I was using 12.2.4 Jdev against 12.1.3 environment, so the screen shots looks bit different from the above images):
Click on the help link.



Have a look at the section "Oracle E-Business Siute Help" in the "System Administrator's Guide":
http://docs.oracle.com/cd/E18727_01/doc.121/e12893.pdf

Also refer the section "Help Global Button" in the Developer Guide:
Oracle Application Framework Developer's Guide Release 12.1.3 (Doc ID 1107973.1)


Feel free to point out if anything is missing/wrong in this blog.


No comments:

Post a Comment