Web Page

To implement Help Integration for Oracle E-Business Suite, you must install and compile two library files that are delivered with the Developer installation. To complete the integration, modify the HELP_WEB_AGENT profile on the Oracle server to point to the Player content. This causes the Player interface to launch directly from the Oracle Help menu.

Implement Context-Sensitive Help Integration
If you want to implement context-sensitive help for Oracle E-Business Suite applications, the correct Context IDs of the objects in Oracle must be captured while the content is recorded. To enable this in Oracle E-Business Suite 12.1.1 or earlier, you must deploy or modify the custom library (CUSTOM.pll) on the Oracle server you will use to record the content. This must be done before you begin to record content. To enable this in Oracle E-Business Suite 12.1.2 or later, you can add an entry in the System Profile form.

Enable Context Recognition in Oracle E-Business Suite 12.1.1 or Earlier

To enable context recognition, you must either deploy a custom library or modify an existing one, and then modify the HELP_WEB_AGENT profile. The custom library is required for recording content only. It is not necessary for deployment of context-sensitive content from Oracle E-Business Suite. If you use the different systems for development (content creation) and production (deployment), then the custom library configuration is not necessary in the production environment. If you use the same system for development and production, then custom library only needs to be installed while the content is being recorded.

Enable Context Recognition in Oracle E-Business Suite 12.1.2 or Later
In Oracle E-Business Suite 12.1.2 or later, you add a profile in the System Profile form.

To enable context recognition in Oracle E-Business Suite 12.1.2 or later:

Launch the Oracle E-Business Suite application.
Click the System Administrator link.
Click the Profile>System link to launch the System Profile form.
Enter %UPK% in the Profile field.
Click the Site field and change the value to Yes to enable context recognition.
This change is available to all users in the E-Business Suite application.
On the File menu, click Save.
On the File menu, click Exit Oracle Applications and click OK.

Check Existing Custom Library Configuration
The .pll delivered with the Developer is written with SPECIAL7 as the default value. This default value is a suggestion. You can use anything between 1 and 15. If you have not created any Oracle specific applications that use the SPECIAL event, you can use the default. If you have created Oracle-specific applications that do use the SPECIAL event, the value of 7 may be taken, and you need to find another suitable unused value between 1 and 15.

You can use the following command lines to find an unused value instead of editing and recompiling the custom.pll file repeatedly:

cd $AU_TOP/forms/US; grep -i APP_SPECIAL.ENABLE `find . -name "*.fmb" -print`| grep SPECIAL7| grep -i PROPERTY_ON

cd $AU_TOP/resource; grep -i APP_SPECIAL.ENABLE `find . -name "*.fmb" -print`| grep SPECIAL7| g rep -i PROPERTY_ON

If you receive a result that looks like the statement below, the value is already being used.

./CSCCCCRC.fmb:app_special.enable('SPECIAL7', PROPERTY_ON);

Deploy a Custom Library
Use the following steps if you have not deployed a custom Library on your Oracle Applications server.

To deploy a custom library:

Back up your existing CUSTOM.pll to CUSTOM.pll.orig.
Locate the ODPNCustomPLL.zip file in the ORACLE folder where the Developer is installed and extract the CUSTOM.pll and ODPN.pll files. Copy them to the $AU_TOP/resource folder on the Oracle Applications server.

Note: $AU_TOP is defined as a variable and references /oracle/VIS/apps/apps_st/appl/au in both a Unix and Windows operating system.
Ensure that no one is currently using Oracle Applications (Web Forms). Shut down the Oracle Forms Server service if you are running 11i.

Note: It is not necessary to shut down any service if you are running R12.
While in the $AU_TOP/resource, compile the ODPN.pll and CUSTOM.pll library files using the command for your specific EBS version:

Oracle 11.5.10 server:
ifcmp60 module=ODPN.pll module_type=LIBRARY userid=apps/apps@<instance> compile_all=yes

ifcmp60 module=CUSTOM.pll module_type=LIBRARY userid=apps/apps@<instance> compile_all=yes

For Oracle E-Business Suite R12:
frmcmp module=ODPN.pll module_type=library userid=apps/apps@<instance> compile_all=yes

frmcmp module=CUSTOM.pll module_type=library userid=apps/apps@<instance> compile_all=yes

Note: Replace the database connect string to reflect your instance.

Note: Shutting down the Forms server is not necessary for Oracle E-Business Suite R12.

Modify an Existing Custom Library
Use the following steps if you have custom logic in your custom library (CUSTOM.pll) that you do not want to overwrite. You must place a line of code in the custom library that will call out to a new library (ODPN.pll). After doing this, you will only need to recompile your existing CUSTOM.pll if you receive new versions of ODPN.pll with software upgrades.

To modify a custom library:

Back up your existing CUSTOM.pll to CUSTOM.pll.orig.
Copy the CUSTOM.pll from the $AU_TOP/resource folder on the Oracle Applications server to a client machine that has Oracle Forms Builder installed.
Copy the APPCORE2.pll from $AU_TOP/resource folder on the Oracle Applications server to a client machine that has Oracle Forms Builder installed. This should be the same folder you used for the previous step.
Locate the ODPNCustomPLL.zip file in the ORACLE folder where the Developer is installed and extract the ODPN.pll file. Copy it to the client machine into same folder as previous file copies.
Open CUSTOM.pll using Oracle Forms Builder and attach ODPN.pll. Place this file in the same folder on the client side as your CUSTOM.pll prior to the attachment.
Answer Yes when asked to remove directory path.
Add the following code to the Event procedure:

gkod_event (event_name, 'SPECIAL7');

Note: You may use any number between 1 and 15 in the SPECIAL command as long as there are no conflicts. See Check Existing Custom Library Configuration for more details. Beginning with Oracle EBS 12.1, the SPECIAL command can be replaced with the MENUX command where X is a number between 1 and 15.
Ensure that no one is currently using Oracle Applications (Web Forms). Shut down the Oracle Forms Server service.
Copy the CUSTOM.pll and ODPN.pll files from the client to the $AU_TOP/resource folder on the Oracle Applications server.
Compile both the ODPN.pll and the CUSTOM.pll files using steps 5 and 6 in the previous section.

Modify the HELP_WEB_AGENT Profile

You must modify the HELP_WEB_AGENT profile in Oracle to point to the oracle_gateway.html in the Player content deployed on the server.

For Oracle E-Business Suite 11i , the URL consists of two parts: the path for the oracle_gateway.html file located in the \oracle\hemi folder in the Player content, plus the path of the default dbc file for the Oracle server.

Following is an example for 11i:

URL=http://<server name>:<port>/oracle/hemi/oracle_gateway.html?dbc=d:\oracle\o11iappl\fnd\11.5.0\secure\<server name>.dbc

Following is an example for R12:

URL=http://<server name>:<port>/oracle/hemi/oracle_gateway.html

To modify the HELP_WEB_AGENT profile in Oracle E-Business Suite:

Sign on to the Oracle EBS Application via the web browser as an administrator.
Click the System Administrator link and locate the System Profile.
When the java form launches, enter APPLICATIONS_HELP% in the Profile field and click Find.
Enter or edit the URL with the path to the oracle_gateway.html.

Note: For Oracle 11.5.10, include the location of the .dbc file in the URL string. Once you have completed your changes, stop and restart the Oracle Forms service.
For the profile change to take effect in the current session, exit from the Oracle application and sign in again.
Click Help in Oracle, and the Player launches.

Table of Contents