In-field Help Note Version 2.0.0.0
Embedded Help Pattern Set
 
Description
Return to Top

Use in-field help notes to clarify the information that users should enter into editable fields. The help content enables users to successfully enter the correct data in the field so that they are less likely to encounter data-entry errors. An in-field help note can also inform users about how data will be used or the downstream effect of data entered.

In-field help notes do not provide a definition for a field. Use the Terminology Definition pattern for that purpose.

Use in-field help notes for:

  • Standalone check boxes
  • Multiselect check box groups
  • Single-select radio button groups
  • Items in true/false radio button or check box groups

Note: Do not use in-field help notes for:

  • Items in single-select radio button groups
  • Items in multiselect check box groups
  • True/false radio button or check box groups (no alternative help, except a terminology definition on the prompt)

You can use in-field help notes with the UI components shown in the following table.
 
Pattern Set Decision Table
Return to Top
 
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
Return to Top
  • In-field help notes must not duplicate the Application Development Framework (ADF) converter or validator components hints for number ranges, character lengths, date ranges/validity, date and time formats, required fields (for a single field only), and so on. See the FusionGPS ADF validator and converter hints page for details. When, additional, explanatory in-field help is necessary on fields with ADF validator and converter hints, the help is shown after the ADF-provided hint text (figure 5).

  • To provide help using the appropriate help component, understand what type of check box or radio button a developer is planning to use. Read the RCUX Check Box Usage Guideline to understand the distinction between true/false check boxes and multi-select check boxes. Read the RCUX Radio Group Usage Guideline to understand the distinction between true/false radio groups and single-select radio groups.

  • Avoid using an in-field help note in a table cell if the table supports multiple rows in which the in-field help note would appear repeatedly. Consider rewriting the help using the static instruction text, terminology definition, or user assistance popup pattern. (Remember that you must change the goal of the help if you change the help pattern.)

  • For guidance on how to compose embedded help content, see the Fusion Embedded Help Content Guidelines.

  • In-field help notes appear on on focus or on hover for 400 ms. This amount of time is defined by the browser and is not under team control. In-field help notes are dismissed when users move their cursors to other fields on the screen. The following table explains the different controls options:
Component Name
On Hover
On Focus
Check Box
X
X
Single and Multiselect Choice List
X
X
Single and Multiselect List Box
X
X
Text Box and Area
 
X
Radio Button
X
X
Spin Box
 
X
Color Picker
 
X
Date Time Picker
 
X
Slider
X
 
List of Values
 
X

 

Required Screen Elements

Component Type

Required Components

Customizable/Extendable Components

Note window

Text embedded in a note window to provide field-level help, activated when users give focus or hover over the component.

Not applicable

   
Pattern Sample
Return to Top

The following types of information may be conveyed by in-field help note:

Formatting Information

Data entry validation information, such as for date formats. See the ADF converter and validator components for what demonstrations of what formatting examples are supplied by default.

Figure 1: In-Field Help Note with Example Date Format

Field Restrictions

Range and other restrictions information, such as for numbers. See the ADF converter and validator components for demonstrations of what restrictions are supplied by default.
In-Field Help Note with Number Range Restriction

Figure 2: In-Field Help Note with Number Range Restriction

Downstream Informational

Users may need to know how the data will be used downstream as it may affect their user experience.
In-Field Help Note about How Data Will Be Used Later

Figure 3: In-Field Help Note about How Data Will Be Used Later

Immediate Informational

Users may need to know what information to enter in the field.

 

In-Field Help Note about What To Enter in a Field

Figure 4: In-Field Help Note Explaining What to Enter in a Field

 

Immediate Informational with ADF Validator or Converter Hint

In-field help notes may also be combined with ADF converter and validator hint text, providing further information.

In-Field Help Note Combined with ADF Validator Hint

Figure 5: In-Field Help Note Combined with ADF Validator Hint

 
Related Guidelines
Return to Top

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.