FusionGPS: Design Patterns: Embedded Help Pattern Set: Popup

User Assistance Popup

Version 2.0.0.0

Embedded Help Pattern Set


Description

Use a User Assistance Popup (UAP) to provide brief contextual help for a page or region and to provide optional links to nonembedded help related to that page or region. A UAP can contain short descriptive text, links to nonembedded help, or both.
Use the UAP to:

Introduce the tasks that users can complete on a page or page flow, or the tools that they can use to complete the tasks.
Explain how the tasks help users to complete of the broader business process.
Provide brief tips, examples, and best-practice suggestions that may be explored more fully in nonembedded help topics.
Explain defaults or system restrictions that apply to the page or region as a whole.

The links within the UAP are search results that are based on the UAP key in the document and contextual search parameters specific to the users and the page or region. The linked documents provide further help for the current task, such as in-depth conceptual information, FAQs, examples, and demos. When you click a link in the search results, the specified document opens in a new browser window.

You can associate the UAP with the following UI components and tasks:

Page header
Subheader and sub-subheader
Table toolbar in a tab with no subheader
Tab form with no subheader
Tasks listed in the Setup Table Checklist or Setup Hgrid Checklist
Dashboard region

Pattern Set Decision Table

	Static Instruction Text	In-field Help Note	Terminology Definition	Bubble Help	User Assistance Popup
Valid UI components to use this type of help	- Page header - Subheader - Sub-subheader	- Standalone check box - Multiselect check box group - Single-select choice list - Multiselect choice list - Single-select list box - Multiselect list box - Text box - Single-select radio groups - Items in true/false radio groups - Items in true/false check box groups - Color picker - Date/time picker - Flexfield - LOV - Spin box - Slider - File upload - Shuttle - Rich Text Editor	- Check box prompt - Check box group prompt - Single-select choice list - Multiselect choice list - Single-select list box - Multiselect list box - Text box - Radio group prompt - Color picker - Date/time picker - Flexfield - LOV - Column headers - Spin box - Slider - File upload - Shuttle - Rich Text Editor	- Butcon - Button - Link - Tab	- Page header - Subheader - Sub-subheader - Tab - Tasks listed in the Setup Table Checklist or Setup Hgrid Checklist, - Dashboard region
Does the user need help understanding the effects of entering a value or leaving the component blank?	N	Y	N	N	N
Does the user need a detailed description of what the UI component means or does?	N	N	Y	Y	N
Does the user need help understanding what to do on a page or within a header region?	Y	N	N	N	Y
Does the user require in-depth assistance or need to explore more information?	N	N	N	N	Y
How long is the help text, including spaces?	Less than or equal to two lines (of local area width) or 400 characters	Less than or equal to 160 characters	Less than or equal to 80 characters	Less than or equal to 80 characters	Less than or equal to 400 characters, optional links to nonembedded help


Design Considerations

Do not provide UAP help for a single UI component. Use other forms of field-specific embedded help instead.
The UAP icon is placed after the page header, subheader, or sub-subheader region if either UAP text or nonembedded help exists for that page header, subheader, or sub-subheader.

If there is a switcher, and/or if the Record Information icon is used, the display order, from left to right, should be:
Header, Subheader, Sub-subheader; Switcher; Record Information icon; UAP icon.
The UAP icon is shown if the UAP text or nonembedded help exists for tasks listed in the Setup Table Checklist or Setup Hgrid Checklist.

A UAP is always associated with a subheader or sub-subheader. If a tab with no subheader requires a UAP, the UAP icon is placed in one of the following locations:
- As the last icon in a table toolbar preceded by a separator.
- Right-justified in the top corner of the tab.
A UAP may be used in a dashboard region. It is added as the last icon in the content toolbar.
A UAP cannot be used on a popup at present. There is no facet on the af:popup component to implement the UAP.
A UAP should not be used on secondary window (dialogs) as this affords very poor usability. If you need to do this, then you should contact your UX designer and obtain approval from Apps-UX UA.
For guidance on how to compose embedded help content, see the Fusion Embedded Help Content Guidelines.


Pattern Sample

Subheaders

UAP in Subheader

Figure 1: UAP on Subheader

Tabs

If a tab contains a table only (no subheader) and requires a UAP, the UAP icon is placed in the table toolbar as the last icon. If it is the only secondary custom action in the toolbar, precede it with a divider. If there are additional secondary custom actions, use a separator before it.

UAP in Table Toolbar

Figure 2: Tab with No Subheader, Table Only

If a tab contains form fields only (no subheader) and requires a UAP, the UAP icon is placed in the upper-right corner. Space the icon three pixels evenly from borders upper right justified within the tabs region corner.

UAP in Tab, No Header

Figure 3: UAP in Tab with No Subheader, Form Only

If a tab contains form fields only and has action buttons (no subheader), the UAP icon may be placed to the right of the last action button.

Figure 4: UAP in Tab with No Subheader, Form Only, but with Action Buttons

Setup Task List

The UAP comes after the item.

UAP in Setup List

Figure 5: UAP in Setup Task List

Dashboard Region

A UAP can be added to a dashboard region. Place the icon as the last item in the content toolbar.

UAP in Dashboard Region

Figure 6: UAP in Dashboard Region

Required Screen Elements
Component Type	Required Components	Customizable/Extendable Components
Header	Header matches the page or header of the calling region (which is system generated).	Not applicable
Text	Either text or links (see next row) are required. Text associated with a page or header that provides further in-depth assistance. Note: No character or structural formatting is allowed.	Not applicable
Link	Either text (see previous row) or links are required. Links to nonembedded help topics.	Not applicable
Butcons	UAP Icon: Launches the UAP. The tooltip reads Help. More Help: Provides access to the Fusion Help User Interface Search results for the activity. The tooltip reads More Help. Manage Custom Help - Provides access to a user interface (UI) used to customize help. Shown only when a user has logged in using a secure privilege.	Not applicable
Icon Qualifier	Identifies the format type of the nonembedded help topic link. HTML PDF Generic (more formats may be added)	Not applicable


Related Guidelines

RCUX Help Usage Guideline	Describes ways that help can be displayed in the Rich Client User Experience-based UI.
Fusion Embedded Help Content Guidelines	Guidance on the creation of embedded help content for Oracle Fusion Applications.
Fusion Help UI Guideline	Guidance on which type of help to use in Oracle Fusion Applications.