Browser version scriptSkip Headers

Oracle® Applications Cloud Extending the Applications
Release 13.2
Part Number E50709-02
Go to Documentation Home
Home
Go to contents  page
Contents
Book<br />List
Book
List
Go to Feedback page
Contact
Us

Go to previous page
Previous
Go to previous page
Next
PDF

7 Customizing Help

This chapter contains the following:

Help File Customization

Embedded Help Customization

Help File Customization

Help File Customization: Overview

If you have the appropriate job roles, then you can customize the help files in the help site. Use the Manage Custom Help page to maintain both predefined and custom help files. You can create, duplicate, edit, and delete custom files, or set their status to Active or Inactive. For predefined files, you can only duplicate them or set their status.

For each help file, predefined or custom, use help locations to determine where the help file appears in the application and in the help site. You have various options in how you add custom help, for example by uploading a file or specifying a URL. You can upload files of any type, and your URL can also point to files of any type.

Note

To make a copy of all custom help for testing, migration, or other purposes, create a configuration package then use the export and import feature in the Setup and Maintenance work area. The configuration package must use a source implementation project that contains the Define Help Configuration task list and you must select the following objects to export: Help Configuration and Help Topic.

Customizing Help in Help Windows

Many help files can be accessed from help windows in the application. If you want to customize help in the context of a help window, for example create a custom help file and add a link to it from a specific help window, then start by opening that help window. When you click the Manage Custom Help link, you go to the Manage Custom Help page, and the help location fields are automatically populated with values that correspond to the help window. This way you can easily select existing files to add to the same help location, and when you create a new file, the same help location appears by default.

Restriction

Aside from links to help files, some help windows also display informational text. You can't use the Manage Custom Help page to edit this text. Your technical administrators can do so using developer tools (not available in Oracle Cloud implementations).

Customizing Help by Help Location

Open the Manage Custom Help page directly from the home page of Oracle Fusion Applications Help or from search result pages.

Tip

When you search in the Manage Custom Help page, make sure that the Custom Help Only check box is not selected if you are looking for predefined help.

Editing Specific Files

To edit a specific file, you can either find it in the Manage Custom Help page, or open the file itself and click the Edit link.

Customizing Glossary Terms

You can find glossary terms in the Manage Custom Help page, or go to Navigator - Glossary in Oracle Fusion Applications Help to open the Glossary tab, search for the term, and click Edit.

Adding UPK to the Settings and Actions Menu

If your enterprise has purchased Oracle User Productivity Kit (UPK) content, then your administrator can also add a UPK item to the Settings and Actions menu in the global area of Oracle Fusion Applications. When users select this menu item, they access UPK content specific to the page that they are on.

Help Types: Explained

Oracle Fusion Applications Help contains various types of help content, including demos, examples, FAQs, glossary terms, help topics, and PDF guides. A business process or product can be supported by some or all of these help types.

Demo

Demos are Oracle User Productivity Kit (UPK) topics that visually demonstrate how to use the application to complete a short task or portion of a task. Demos can also provide an introduction to complex dashboards and work areas.

Example

Examples provide real use cases of features to illustrate how and when to use the feature, or scenarios to illustrate abstract concepts. Worked examples show exactly what you need to do to achieve a specific result, emphasizing decisions that you make and values that you enter.

FAQ

FAQs, or frequently asked questions, provide brief answers to questions that you might have regarding a task or page. For example, they can briefly explain what a term means, why something happened, how you can perform an action, or what happens if you perform the action.

Glossary

Glossary terms provide definitions for words or phrases used in help. You can search or browse glossary terms in the Glossary tab of Oracle Fusion Applications Help. Where the links are available, you can also see the definition when you hover over the term in help content for other help types.

Help Topic

Help topics explain key concepts, illustrate how application components work together, or assist in decision-making by explaining points to consider or the options you have. Help topics can also provide reference, overview, and other information.

PDF Guide

PDF guides in Oracle Fusion Applications Help provide, in a book format, information usually not found in other help types. There are other guides that present a collection of help content from the other help types, except demos, in an organized and logical format. These guides, for example, address specific business processes and setup offerings. You can find these guides by going to Navigator - Documentation Library in Oracle Fusion Applications Help.

Help Locations: Explained

Help locations determine where users can find help files, custom or not, from either the application or the help site.

Help locations include:

Page or Section Values

The value in the Page or Section field on the help customization pages represents where users can click a help icon to open a help window that contains a link to the help file. In most cases, this value represents a page or region header in the application. Help windows are also available on specific tabs or windows, and in the Setup and Maintenance work area for specific task lists or tasks. You can associate a help file with multiple page or section values, or with none at all.

The page or section value reflects the logical navigation to the help window. For example, Edit Opportunity page, Revenue tab, Recommendations window does not mean that the help file is available in three different places. The help icon is in the Recommendations window, which is accessed from the Revenue tab on the Edit Opportunity page.

If the value suggests multiple locations, for example Create and Edit Opportunity pages, then the help file is available from the page header of both the Create Opportunity and Edit Opportunity pages. If the page or section value is, for example, a dashboard region that appears in multiple dashboards, then the value does not specify the page name but just the region. The help file is available from that region in multiple dashboards.

Help Hierarchies

Help files are associated with help hierarchies, which are used to categorize help files and aid users in finding help. Each help file can have multiple hierarchies, with at least one of type Business Processes. The business process hierarchy is based on the Business Process Management model. Every page or section value is predefined with a specific business process hierarchy. If you select a page or section without entering a business process hierarchy, the predefined hierarchy appears by default.

The Common Tasks navigator is based on the Welcome hierarchy type. The level 1 nodes represent categories of functional areas common to all users.

The Business Processes navigator in the help site is based on the business process hierarchy. For example, if you assign two business process hierarchies to a help file, users can find the file in both locations in the navigator. When the user clicks More Help from a help window, all help files assigned to the same business process hierarchy as the page or section value are returned as search results.

Similarly, the Products navigator is based on the Product hierarchy type, in which level 1 is the product family, level 2 is the product, and level 3 is the business activity owned by that product.

The Functional Setup navigator is based on the Functional Setup hierarchy type. The level 1 nodes for this hierarchy are:

Primary Locations

The primary location of a help file designates the hierarchy that is displayed for the help file in search results and within the help content as breadcrumbs. You cannot change the primary location of a help file that came with your help installation. Primary locations of predefined help are based on the business process hierarchy, while custom help files can have primary locations based on hierarchies of any type.

Editing Predefined Help and Glossary Terms: Points to Consider

When you open any predefined help file, including glossary terms, that came with Oracle Fusion Applications Help, you can see an edit option if you have roles allowing edit access. When you edit predefined help, keep in mind:

What Happens to the Original Files

When you edit predefined help, you are actually creating a new custom help file based on the original file, with the same help locations. The customized version replaces the original, which becomes inactive and hidden from users. You can display both versions by reactivating the original in the Manage Custom Help page.

Note

In the Search Results: Existing Help region on the Manage Custom Help page, there is no option to edit predefined help. You can duplicate a predefined help file, edit the copy, and optionally inactivate the original.

Where Predefined Help Appears

All predefined help comes with preassigned help locations, including at least one based on the hierarchy of type Business Processes. Many also have predefined page or section values that indicate where the help can be accessed from help windows in the application.

To change where predefined help appears, either in the help site navigators or in the application, create a duplicate in the Manage Custom Help page. Change or add help locations to your custom copy, and inactivate the original.

Even though glossary terms do not appear in the help site navigators, you still need to enter at least one help location to categorize the glossary term.

Considerations Specific to Glossary Terms

When you edit a predefined glossary term, the original term becomes inactive. Existing links to the glossary term, from other predefined and custom help files, will automatically point to your custom version. If you later inactivate the custom glossary term, make sure to activate the original term so that the links still work.

Links in Custom Help: Points to Consider

When you create or edit custom help, follow best practices when you include links to help files or other content. If you are working on custom help created by duplicating a predefined help file, then you may see existing links from the original file in the Help Content section. The types of links that you can work with include:

For all link types, except the standard hypertext links, you must create or edit custom help with a Text or Desktop source type. In other words, you must type the help content directly in the application or use an HTML file that you upload to help. For standard hypertext links, the source type can also be URL.

Related Help Links

Related help is the section at the end of help files that contains links to other help files. The syntax for related help contains a comma-separated list of title IDs that represent help files.

This figure provides an example of related links code.

Ofa followed immediately by: RelatedTopics(CREATE_AUTOMATIC_POSTING_CRITERIA_S_0000,
JOURNAL_ENTRIES_HOW_THEY_RE_RECORDE_0000)

Standard Hypertext Links

You can create standard hypertext links to any file or Web site as long as you ensure the stability and validity of the links, including links to other help files, custom or not. These links can appear anywhere in the body of your help file as long as they come before any related help links.

In the Help Content section, highlight the text that you want to use as link text and click the Add Link icon button.

For links to other help files, open the file to which you want to link, and click the E-Mail link. Use the URL in the autogenerated e-mail text as the link to the file.

Note

Use the full URL, for example http://www.oracle.com, when creating links.

Links to Documentation Library Content

The syntax for links to HTML files in documentation libraries is:

<span class="HP_topic-link_bridgeDocument-linkToSTDoc_"><?ofa linkToSTDoc(WCSUG4636) ?><span class="HP_topic-linktext_">Understanding Tags</span><?ofa endLink ?></span>.

WCSUG4636 is the anchor ID and Understanding Tags is the link text. You can:

Important

To ensure that you are linking to a supported documentation library, enter anchor IDs only from documentation libraries that are linked from predefined help topics.

Glossary Term Links

Glossary term links provide definitions in a note box when users hover over the term in help files.

This figure shows an example of code for a glossary term link.

Ofa followed immediately by: GlossaryTerm("accounting
period", ACCOUNTING_PERIOD_0001)

In this example, accounting period is the link text, or glossary term, and ACCOUNTING_PERIOD_001 is the identifier, or title ID.

Note

If your custom help has glossary terms and the source type is Desktop File, then make sure before uploading that the quotes around the glossary term are actual quotation marks in raw HTML, not &QUOT. Otherwise, quotation marks will appear when users view the help file.

Customizing PDF Guides: Worked Example

This example demonstrates how to customize a PDF guide that came with Oracle Fusion Applications Help. This guide is currently not available from any help window in the application.

The following table summarizes key decisions for this scenario.


Decisions to Consider

In This Example

What changes do you need to make to the guide?

Change the title of a chapter and remove a section in that chapter, to hide content about a particular subject

Which help window should the customized guide appear in?

The help window for the entire Welcome dashboard of Oracle Fusion Applications

Which help navigators should the customized guide appear in, and on which node?

Same as the original guide, plus the path associated with the help window

Do you want to limit access to the customized guide?

No, same as the original guide

Edit a copy of the original PDF guide, and use the Manage Custom Help page to replace the original PDF guide with your new file.

Copying and Editing the PDF Guide

  1. Open the original PDF guide from the help site and save a copy to your desktop. Leave open the help file for the guide.
  2. Using a PDF editor application, change the title of the chapter wherever the chapter title appears. Delete the content you want to hide from users.

Replacing the Original PDF Guide

  1. In the help file that you still have open for the original PDF guide, click the Edit link.
  2. On the Create Help page, use the default values except where indicated.
  3. Update the title to the name that you want to display to users.
  4. In the File Name field, browse for and select your customized guide.
  5. Delete any keywords or parts of the description relevant to the content you removed from the PDF guide.
  6. Add a help location with the Business Processes hierarchy type and select Information Technology Management as the level 1 node, Manage Enterprise Application Software as the level 2 node, and Use Applications as the level 3 node.
  7. Select Welcome page in the Page or Section column.
  8. Click Save and Close. The help file for the original PDF guide is automatically set to inactive.

Adding Custom UPK Content to Help: Worked Example

This example demonstrates how to add custom Oracle User Productivity Kit (UPK) topics as demo help files. These help files function like any predefined help file for demos. You can search and include these files in help windows and navigators as you would other help.

In this scenario, you are adding one demo about activity streams, to appear in a help window on the Welcome dashboard.

Note

Your demo must be made with UPK 3.6.1 or later to be added as help.

The following table summarizes key decisions for this scenario.


Decisions to Consider

In This Example

What UPK content do you want to add to help?

From a UPK module containing five topics, add one as a custom demo on the help site

Which help navigators should the demo appear in, and on which node?

Because the demo is about activity streams:

  • Search by Common Tasks navigator, under the Collaboration node

  • Search by Business Process navigator, under Information Technology Management - Manage Collaboration - Manage Collaborative Communities

Which help window should the demo appear in?

On the Welcome dashboard of Oracle Fusion Applications, in the help window in the Activity Stream region

Do you want to limit access to the help file for the demo?

No

Do you want the help file to appear in the New and Updated pane?

Yes

Generate a report of UPK document IDs, which you will use when creating custom help, to identify the UPK topic that you want to add. Publish the UPK module as a player package, then create custom help for the UPK topic that you want to use as a help demo.

Generating a UPK Document ID Report

  1. In the UPK Developer, select Details View.
  2. Right-click any column header, for example Name, and select Column Chooser.
  3. In the Column Chooser dialog box, click and drag the Document ID column header and drop it after the Name column. Close the Column Chooser dialog box.
  4. From the File menu, select to print, and save the output as a Microsoft Excel file to your desktop.

Creating the Player Package

  1. From the UPK Developer, make sure that the topic that you want to add as a demo has the See It play mode. The topic can also have other modes, but only the See It mode is included in the custom help file.
  2. Publish the module, specifying any location for the output and selecting to publish the selection only.
  3. In the Formats section of the Publish Content window, select the Player check box under the Deployment check box group.
  4. In the Player section, select the Include HTML Web Site check box, to ensure that the custom help file includes a text-only version of the UPK topic.
  5. Finish the publishing process, after optionally setting other options.
  6. Navigate to the location where you specified the output to be generated.
  7. In the Publishing Content folder, copy the PlayerPackage folder and add it to the web server where you store UPK content.

Creating Custom Help for Demos

  1. Open the help window in the Activity Stream region on the Welcome dashboard of Oracle Fusion Applications, and click Manage Custom Help.
  2. On the Manage Custom Help page, the page or section and hierarchy values are populated with the values for the Activity Stream region.
  3. Click Create.
  4. On the Create Help page, complete the fields in the General Information section, as shown in this table. Use the default values except where indicated.

    Field

    Value

    Title

    The name of the UPK topic.

    Source Type

    Oracle User Productivity Kit

    File Location

    The full URL of the player package folder on the Web server, for example, http://<your domain>.com/UPKcontent/PlayerPackage.

    Document ID

    The document ID of the UPK topic to add to the help window in the Activity Stream region. You can copy and paste this ID from the Microsoft Excel file that you generated earlier.

    Help Type

    Demo

    Help Security Group

    Unsecured

    Keywords

    Terms relevant to the demo.

    Description

    Summary of the demo.

    Include in New and Updated pane

    Selected


    The Help Location section contains values for the help window in the Activity Stream region. This help file will also appear in the Search by Business Process navigator under this predefined hierarchy.

  5. Click Save and Close.
  6. On the Manage Custom Help page, open the help locations for the help file that you just created.
  7. Add a help location with the Welcome hierarchy type and select Collaboration Features as the level 1 node.
  8. Click Save and Close.

FAQs for Help File Customization

How can I add a Youtube video to custom help?

On the Create Help page, select URL as the Source Type. Find the video in Youtube and click the Share button then click the Embed button. Copy the URL within the embed code, for example http://www.youtube.com/embed/<unique ID>, and paste it in the URL field of the Create Help page.

How can I restrict help content to specific user roles?

When you create or edit help, select a help security group that represents the set of roles that you want to have access to the help. If you do not see the Security Group field, then your administrator has not selected the Custom Help Security feature choice. The Unsecured group has no associated roles, so anyone can view the help. The predefined Secured group includes all internal employees and contingent workers, unless this group has been edited. You can create security groups and associate roles using the Manage Help Security Groups page, which you can access by starting in the Setup and Maintenance Overview page and searching for the Manage Help Security Groups task. Your new security groups are immediately available for use to secure new or edited help files.

Why can't I select and add help to a location?

You must specify a page or section to add the existing help to. To ensure that help is added to the correct help window, go to the page or section in the application, click the Help icon, and click the Manage Custom Help link in the help window. Alternatively, in the Manage Custom Help page, search for at least a page or section and a level 1 value for the Business Processes hierarchy type before selecting the Select and Add option.

You cannot select and add help to a particular hierarchy, on the Manage Custom Help page, without a page or section. To add just a hierarchy, search for the help file, add a new help location, and specify only the hierarchy information.

What happens to custom help when a help patch is applied?

Oracle Fusion Applications Help patches update all help files, both active and inactive, except custom help. Custom help files are not affected by patches. Consider reviewing inactive files to see if you want to activate the updated version, or to make similar edits to the custom versions of those files, if any.

Embedded Help Customization

Customizing Embedded Help: Highlights

You can customize help that is embedded in the application, for example hints, for all users of Oracle Fusion Applications. There are different types of embedded help.

Creating, Editing, or Deleting Help