Enabling Help For Oracle E-Business – uPerform On-Premise Manuals

To implement and use Context-Sensitive Help for Oracle E-Business with the application, you will perform six procedures:

Create a template for use with Oracle E-Business.
Publish the website.
Specify a designated author account for Oracle E-Business.
Record an Oracle E-Business document with the application and republish the website to make the document available for Context-Sensitive Help.
Modify an Oracle E-Business end user account for use with Context-Sensitive Help.
Request Context-Sensitive Help from Oracle E-Business.

Creating a Template for Use with Oracle E-Business

Context-Sensitive Help for Oracle E-Business is driven by context identifiers. Each screen in Oracle has a unique context identifier. Context identifiers are gathered collectively for a procedure and when inserted into the transaction code property of a document, will call context-specific help on the screen in which the end user is working.

Transaction code is a term and property used to identify a process, and it is used in two separate instances:

Transaction code property: The website matches this document property to the associated Oracle screen when a call for help is made from Oracle.
Transaction code block: In a document, this block displays the transaction code pertaining to the document created. For Oracle documents, it is recommended that the display of this block be disabled within the template.

In the application, create a template.

NOTE:

A project administrator typically creates and customizes templates. For more information, refer to Creating Context-Sensitive Help.
Select the Blocks tab.
Select Purpose.
Turn off the display of the Transaction Code block in a document.
Select the Properties tab.
Ensure the transaction code property is selected.
Select File > Save.
Click the Publications tab.
Select Website.
Select Transaction Code(s) from the Build from Property field.
Select Comma(,) from the Multiple Values Separated By field.
Select File > Save.

Publishing the Website

The website must be published to a web server that is accessible by Oracle E-Business before authors can record documents. As part of website publishing, you will also generate quick launch pages to enable communication between the website and Oracle E-Business.

For information on publishing the website, Publishing the Website.

Specifying an Author Account for Oracle E-Business

The Oracle system administrator must create a designated author account in Oracle E-Business. This account communicates with the website to generate the screen data necessary to request help from Oracle E-Business.

You must log into Oracle E-Business using the designated author account in order to record help-ready documents. Context-Sensitive Help is not available when logged via the author account.

For more information on creating user accounts, refer to the Oracle E-Business documentation.

On the website server, locate the csh_capture_context.html file. For example: http://[webservername]/[website name]/website/xml/assets/csh_capture_context.html.
Copy the URL, including the filename.
Paste the URL, including the filename, into the Applications Web Help Agent profile setting User column for the author in Oracle E-Business.

NOTE:

For more information on setting system profile values, refer to the Oracle E-Business documentation.
Save the author settings.

Recording an Oracle E-Business Document

Log into Oracle E-Business using the author account created in Specifying an Author Account for Oracle E-Business.
Create a new document using the template created in Creating a Template for Use with Oracle E-Business.

Perform one of the following options:

If You Want To

Then

Record and edit the document and gather context identifiers later

Record and edit the document using the Editor and the procedures described in the Creating Content user manual.
After you are finished recording, revisit the Oracle screens and click on the help icon on each screen captured in the recorded document.
NOTE: This will open a new browser window containing the context identifier for the screen.
Repeat Step 2 until context identifiers for all screens within the procedure have been collected.

Record the document and gather context identifiers as you complete the document

Record the document, pausing the recorder after each screen recorded.
Click the help icon for each screen.
NOTE: This will open a new browser window containing the context identifier for the screen.
Repeat until context identifiers for all screens within the procedure have been collected.

Highlight and copy the context identifier string from the browser window.
Open the document created in Step 2.
Select File > Properties.
Select Properties.
Paste the context identifier string into the Transaction Code property of the document.
Click OK.
Save the document.
Add the document to the website using the procedures described in Building a Website.
Publish the document using the procedures described in Publishing Content.
Republish the website using the procedures described in the Building a Website.

NOTE:

When the website is republished, the document will be available for the end user via the help icon in Oracle.

Perform the following optional configuration steps to create a link to Oracle Help from the website:

Navigate to the website. For example: http://[webservername]/[web\-site name]/website/xml/assets.
Locate the .Website.xslt file.
Create a backup of the file.
Open the original file in Notepad or an XML Editor.

Edit the following variables:

Field

Description

<xsl:variable name="sys\-temHelpLocation" select="''"/>

The URL for the default help in Oracle.

Example: <xsl:variable name="systemHelpLo\-cation" select="'http://acmeoraclehelp.com/index.htm'"/>

<xsl:variable name="sys\-temHelpTitle" select="''"/>

The Help title that displays to an end user.

Example: <xsl:variable name="systemHelpTi\-tle" select="'Oracle Help'"/>

Select File > Save.

Modifying Oracle E-Business End User Accounts for Context-Sensitive Help

You must modify all existing user accounts to enable Context-Sensitive Help. An Oracle administrator creates end user accounts based on the needs of the company. While there are several options for defining system profile values for existing users, this procedure demonstrates defining a system profile value for an individual user.

Log into Oracle as a system administrator.
Navigate to the system profile values.

Define system profile values for the user.

NOTE:

Refer to the Oracle documentation for information about the System Profile Values Site, Application, Responsibility, and User, and to choose the system profile value that is most appropriate for your end user community. If you are using multiple locales on the website, you must specify the account by User.

On the website server, locate the redirect.html file. For example: http://[webserver name]/[website name]/website/xml/assets/redirect.html.
Copy the URL, including the filename.

Perform one of the following options:

If You Want To

Then

Create an end user account for Oracle E-Business 12

Paste the URL into the Applications Web Help Agent profile setting User column for the end user in Oracle.

Create an end user account for Oracle E-Business 11.5

Paste the URL into the Applications Web Help Agent profile setting User column for the end user in Oracle.
Append ?rwd=true to the end of the URL string.

Example: http://[webserver name]/[website name]/website/xml/assets/redi\-rect.html?rwd=true.

NOTE:

For more information on setting system profile values, refer to the Oracle documentation.

Save the end user settings.

Requesting Help from Oracle E-Business

Log into Oracle E-Business as an end user.
Navigate to the desired screen.
Click the help icon for a screen.

NOTE:

The website searches for available help for the screen based on the publication settings specified in the template and the context identifier specified in the document.
Oracle E-Business will open a new browser window displaying the following potential help options:
- If a single help document has been created, the document displays in the new browser window.
- If more than one help document has been created, a list of documents displays in the browser window.
- If no help document has been created, an HTTP 404 (Page Not Found) error displays in the new browser window.