|Contextual Actions Guidelines|
Contextual actions provide related information and actions to users within the immediate context of the object instances upon which they act.
|Intended Audience for This Document|
All stakeholders involved in designing and implementing contextual actions should review this document. These stakeholders include providers and consumers.
Providers are those teams who provide contextual action dialogs for an object or objects which they own. Consumers are those teams who will enable the provided contextual actions dialogs within their applications on the appropriate objects. Example: The Trading Community team provided the contextual actions dialog for external person and organization, but various CRM, FIN and HCM teams will enable it for use in their applications. In this case Trading Community is the Provider and all the other teams are the Consumers.
This document is aimed primarily at Providers, because they are the ones involved in designing Contextual Actions dialogs.
Description and Purpose
Contextual actions quickly and easily bring related information and actions to users within the context of the object instance upon which they act. At the same time, because these contextual actions are available only when invoked by users and appear temporarily on top of the existing page, they don’t take up valuable screen real estate.
Example of a Contextual Action
The following example illustrates a users’s interaction with the contextual action (i-pop) affordance and a contextual action dialog. While there are seemingly several steps involved in interacting with the contextual action dialog, these steps are seamlessly connected to make the entire interaction seem like a single, fluid action.
|Figure 3. When you click the i-pop, a contextual action dialog that contains additional detail appears over a limited portion of the current page.|
|Note: The visual representations and interactions described in this document are proposed designs; they are subject to change based on development commitment.|
When designing contextual actions dialogs, the provider teams should keep the following guidelines in mind:
When designing interactions that navigate the user outside the current work area, no return navigation is provided, unless the new work area is launched in a separate window which can be closed.
When launching contextual actions from dialogs or dialogs from contextual actions, close the first dialog, unless you have a need for the first to remain open. For example, when the user expects to continue looking at or working with the first dialog after dismissing the second, or when doing comparisons between the two.
Contextual Actions dialogs should be modeless, rather than modal. This allows the user to work with the underlying page.
Contextual actions providers provide the regions inside the Contextual Actions dialogs, but the dialogs themselves are not provided as part of the contextual actions framework. This means that the Dialog titles and button need to be specified by the consuming teams.
Dialog Titles need to be specified by the consuming application in order to include the specific object type name for the current context. The title should be the most specific that the consuming team can provide. This will usually be the label for the field or table column in which the contextual action is enabled:
Follow this format for the title bar of the dialog:
This format for the title bar is followed for all contextual action dialogs except for the Person contextual action. In case of a Person contextual action, the title displays only the name of the person, i.e. the name on which the contextual action was initiated [object instance name].
Use Done not OK
Consumers need to ensure they use Done, not OK to close the Contextual Action dialogs since the dialog is read-only. (See the page actions guidelines for more information)
When an address is parsed into several fields, enable the glyph on the Address Line 1 field. The glyph on Address Line 1 field should be understandable from the user’s perspective since Address Line 1 is the most specific part of the address and the title of the Contextual Actions Address dialog that one would see first.
Although the glyph only appears on Address Line 1, the entire address context needs to be passed to the Contextual Actions address pop-up.
Showing Glyphs in Dialogs
In general, dialogs are a quick step en route to a primary task and should be kept as simple as possible. As a result it is not always clear whether or not it is necessary to show glyphs for objects which may appear in such dialogs (e.g. addresses returned with a list of names in a select and add dialog).
If contextual information about these objects could plausibly help users complete the main task of the dialog (e.g. pick the correct person from a list), the glyphs should be shown. If the contextual information is unlikely ever to be used to complete the task of the dialog, the glyphs may be omitted.
Validation will occur upon change focus; the round-trip to server is considered acceptable, so it is not necessary to wait until clicking the i-pop to validate. This way determining whether to display the glyph and the ability to display the dialog are consolidated into one validation.
This section describes the controls and functionality that are available to support the design team’s need for extensibility in contextual actions. Note that currently the provider is responsible for creating the entire dialog. If consumers have extensibility needs, they must submit their requirements to the provider.
Contextual actions will be available on any controls that can render data, including but not limited to the following:
Note: If you have a table cell which has an editable field in it, only enable contextual actions on the editable field, rather than both on the cell level and the editable field.
**Note on editable fields: No glyph should be displayed until data is entered into the field. Once the first character is entered, a glyph is visible.
Providing teams should consult with their UX points of contact (POCs) for a design that best suits their needs.
Tabs in Contextual Actions
No tabs are currently supported in Contextual Actions.
To avoid obscuring the underlying page, keep the Contextual Actions dialog as small as possible, no more than 100 x 130 pixels. Ensure that any imported images are scaled to maintain their aspect ratio.
Sizeable Information Blocks
The entire contextual actions dialog is considered a region. Design the information blocks of the dialog according to these guidelines:
Icon Button Groupings
Follow these guidelines when grouping icon buttons within the contextual action dialog:
The dialog automatically resizes based on its content. According to the Secondary Window Usage Guideline, the recommended maximum secondary window measurements are 512 x 384.
The object name (person name, company name) should use page title style (top level of header component) since it is in fact a page title for the content of the dialog. For the subtitle (job title, etc), use the instructional text style.
Context (Right-Click) Menus
Context menus on contextual-actions-enabled fields will be unaffected by contextual actions and should comply with existing guidelines. (See Context Menus in the Menu Guideline )
This problem can be avoided using any of the following:
Mandatory and Optional Objects
Consumers must include the contextual actions whenever a mandatory contextual action object is exposed in their application.
Customization by Customer
No customer configuration or customization is currently planned.
No Records Found
Providers incorporating glyphs in their dialogs must hide the glyph if no data can be shown for an object type in a particular context persistently (e.g. if module is not installed).
Consumers must ensure that the contextual action dialog is not opened if the field contains invalid data; in such cases user should see the appropriate invalid entry error message. In cases where the field value is valid but nothing can be displayed (e.g. data used to be correct but doesn’t exist anymore), consuming team provides a message specific to the reason for data not being present.
Note: It doesn't make sense to display a No Records Found message ("No records match your entry. Ensure your entry is correct and try again."). If the field doesn't contain valid information, then no glyph should appear and changing the entry won't affect the outcome.
Contextual Actions is not keyboard accessible in v1 since information found in each Contextual Actions dialog is accessible via other pages. The information displayed is not critical to the current task and is only secondary/alternative info.
A contrast check on the glyph color passed this contrast checker when used as large text. Since the large text sample in the checker was one pixel thinner than the glyph itself, the color has been assumed to pass. Contrast checkers are made for text, not graphics, so this was the only way to derive this information.
Here are links to some related documentation: