Share via


Action Pane User Experience Guidelines

Applies To: Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

An action pane is the part of a form that organizes and displays buttons that represent the actions the form supports. An action is a task or operation that occurs when users click an action pane button. Actions enable users to use data from the current form to perform commands, open related forms, or execute custom X++ code.

Example of an action pane

Action paneExample of an action pane

Overview

An action pane contains the global actions for the following:

  • List pages

  • Details forms

The action pane divides the actions into RoleTailored tabs and groups to make it easy for users to locate the relevant action. The action pane can also contain a General tab.

Example of an action pane with callouts

Action pane with calloutsExample of an action pane with callouts

Tabs

  • File menu

    The first tab on an action pane is the File menu, which contains general actions for Microsoft Dynamics AX. The content on this menu is the same for all pages and forms.

  • RoleTailored tabs

    All tabs, except for the General tab, are RoleTailored, meaning they are related to an activity or to a set of related activities performed by one or more roles. For example, on the list of sales orders, the Sell tab is used by all personas who are performing sales activities (Susan, Michael), and the Sell tab contains all the actions they need. The Collect tab is used by all personas receiving money from customer and performing invoicing (Arnie, Annie).

  • Home tab

    The home tab (sometimes referred to as the entity tab) is the first tab and contains common actions that are used by all personas on a frequent basis.

  • General tab

    The General tab is not associated with a specific activity. Instead, it contains actions that are used by all personas on an infrequent basis.

    The General tab is not intended to be the catch-all location for actions that do not seem to fit in some other place. Every effort should be made to categorize tabs based upon roles, and only infrequently used actions common to all personas should be placed here. Frequent actions common to all personas should be placed on the home tab.

Groups

Each tab contains groups of actions. The group contains actions that are related by being of a similar type or by belonging to the same process.

Actions

Actions can be displayed by using big or small buttons. Frequent actions should appear as big buttons. There are three types of buttons: push buttons, drop-dialog buttons, and menu buttons.

  • A push button is a regular button with an icon and a label.

  • A drop-dialog button is a button that will display a form immediately below the button requesting that the user supply additional information and confirm the action.

  • A menu button contains several actions that can be accessed through the drop-down menu on the button.

Key tips

The tabs and buttons on the action pane are automatically assigned key tips based on the first character of their label. Key tips allow users to access these actions from the keyboard by pressing the Alt key. When the Alt key is pressed when a list page or details form is displayed, the assigned key tip will be displayed for each tab. Pressing an assigned key tip for the tab will display the assigned key tip for the group. Finally, pressing the key tip for the group will display the assigned key tip for the actions in the group.

Personalization

Users can customize the action pane by hiding the commands that they do not need. They can also move the commands or redisplay commands that they have previously hidden.

Resizing

The action pane has a build-in resize behavior that hides the actions in drop-down buttons as the page or form shrinks. Hiding is from right to left and is based upon whether an action has been marked as primary or not. Non-primary actions will be placed in the drop-down buttons first. Once all non-primary actions have been placed in the drop-down buttons, the process is repeated again from left to right, this time for the primary actions.

Design concepts

For each page, the actions that the user can carry out should be displayed in one central location. Some actions are used more frequently than others and should be more easily accessed. Users should easily find the actions that they need, and actions for similar tasks should be found together. Different roles need different sets of actions, and they do not need to see the actions for other roles. An action pane addresses all these issues. Additionally, an action pane resembles the ribbon in Microsoft® Office, making its use familiar to Office users.

Guidelines

This section includes both general and specific guidelines for an action pane.

General guidelines

  • All labels across all action panes for similar tabs, groups, and actions should be used consistently.

  • All actions should have a unique icon that is used consistently across all action panes for this action.

  • An action pane should have between 1 and 10 tabs.

  • No action pane tab should contain all small or all big buttons.

  • An action pane should have no collapsed groups when the application window is 1280 pixels wide.

  • When the list page is resized smaller and there is no longer room to display all of the actions, the groups should collapse, starting with the rightmost groups.

  • An action pane should have 1 to 8 actions per group.

  • Actions in an action pane group should be laid out in one of the following configurations.

    Action pane configuration

  • The leftmost group should have a large button as the first item in the group.

Specific guidelines

First Tab

The first tab should be the home tab and should have the same name as the entity. The name should be singular.

  • For list pages, the home tab should contain the New, Maintain, List, and Attachments groups in the following order.

    List page home tab

  • For details forms, the home tab should contain:

    • In view and edit mode, a Maintain, New, and Attachments groups in the order shown below.

    • In edit in grid mode, a Maintain, New, List, and Attachments groups in the order shown below.

      Details form in view mode Details form in edit in grid mode

The New group should contain:

  • The New action that opens the details form in new mode. In some cases, it may open a dialog box before it opens the details form (two-phase create).

    • The label should be “<name of entity>” with the <name of entity> singular.

    • The button should be large.

    • The button should be set as a primary action.

    • Optionally, other New actions if these actions insert a new record into the list.

      Examples

      New group example 1 New group example 2 New group example 3

  • The label of the group should be “New”.

The Maintain group should contain:

  • The Edit action that opens the details form in edit mode.

    • The icon should be AXID 10040 AXID 10040.

    • The label should be “Edit”.

    • The button should be large.

    • The button should be set as a primary action.

  • For a list page only, the Maintain group should also include an Edit in grid action that opens the details form in edit in grid mode, displaying all of the records from the list in an editable grid (never in view mode).

    • The icon should be AXID 10011 AXID 10011.

    • The label should be “Edit in grid”.

    • The button should be small.

    • The button should be set as a primary action.

  • Optionally, other Maintain actions that relate to maintaining the entity that are not related to a specific activity.

  • The Delete action that deletes the selected record in the list.

    • The icon should be AXID 10121 AXID 10121.

    • The label should be “Delete”.

    • The button should be small.

    • The button should be set as a primary action.

      Examples for a list page

      Maintain group example 1 Maintain group example 2 Maintain group example 3

      Examples for a details form

      Example 1 of Maintain group for detail form Example 2 of Maintain group for detail form

  • The label for this group should be “Maintain”.

Between the Maintain group and List group, common actions that are not related to a specific activity that is important or used frequently should be displayed.

Common actions between Maintain and List groups

The List group should contain:

  • The Refresh action that refreshes the contents of the list page.

    • The icon should be AXID 11437 AXID 11437.

    • The label should be “Refresh”.

    • The button should be large.

    • The button should not be set as a primary action.

  • The Export to Microsoft Excel action that opens Microsoft Excel with the contents of the list page.

    • The icon should be AXID 10156 AXID 10156.

    • The label should be “Export to Microsoft Excel”.

    • The button should be large.

    • The button should not be set as a primary action.

  • The List group should always be to the left of the Attachments group on the home tab.

    List group example

  • The label for this group should be “List”.

The Attachments group should contain:

  • The Attachments action that opens the Attachments form that displays the documents attached to this entity.

    • The icon should be AXID 10442 AXID 10442.

    • The label should be “Attachments”.

    • The button should be large.

    • The button should not be set as a primary action.

  • The Attachments group should always be the rightmost group on the home tab.

    Attachment group example

  • The label for this group should be “Attachments”.

Activity tabs

All actions that relate to a specific activity should be grouped by those activities.

  • These tabs should be given names of activities that the user of this list page or details form will understand. These names should consist of action verbs.

    Examples

    Vendors – Purchase, Invoice

    Customers – Sell, Invoice, Collect, Manage Projects, Market

    Sales Orders – Sell, Pick and Pack, Invoice

General tab

  • If there are common infrequent actions that are not related to a specific activity, these actions should be displayed on the last tab that should be named “General”.

  • Actions displayed on the General tab should not be repeated on other tabs.

Labels and text

This section contains general labels and text guidelines for an action pane, and labels and text guidelines for groups and actions.

General labels and text guidelines

  • Tab titles, group titles, and action labels should be in sentence case.

  • There should be no abbreviations or acronyms on the action pane.

Activity tabs

  • Tab titles should be activity-based and be expressed in the imperative mood, for example, Receive, Purchase, and Invoice.

    Note

    The "General" tab name is an exception to this guideline.

  • Tab titles should not exceed 20 characters.

  • Tab titles should not be the same as the title of the list that the tab "lives" in.

The following table has suggested tab names for specific customer model process groups.

Customer model process group

Suggested tab name

Analyze Marketplace

Analyze

Develop Marketing Plan / Conduct Campaign

Market

Establish Sales Forecast

Forecast

Manage Sales Force

Generate Sales / Schedule Customer Activities

Quote

Make the Sale / Process Sales Orders

Sell

Invoice

Product Design / Project Engineering

Design

Operation Planning

Schedule

Requisition

Purchasing

Purchase

Return

Receiving

Receive

Quality Assurance

Inspect products

Warehouse Operations

Manage inventory / Pick and pack

Production

Perform / Produce

Shipping

Deliver

Plan Service / Fulfill Service Contracts /Handle Customer Enquiries

Manage performance

Deliver Service

Deliver

Project Management

Manage projects

Pay

Pay

Collect

Collect

Treasury Management / Capital Assets / Close

Manage accounts / Manage assets

Recruit Workforce /Retain Workforce

Manage workers

Motivate Workforce

Manage Organization

Manage organization

Groups labels and text guidelines

  • Group titles that are named after an activity should be in the imperative mood.

  • Group titles should not have the same title as the tab that the group "lives" in.

  • Group titles should be only one or two words and should not exceed 20 characters.

Actions labels and text guidelines

  • Action button names should be in sentence case and should use as few prepositions and conjunctions as possible without losing the meaning of the button.

  • The action buttons should generally carry out actions and have names to match those actions. The purpose is to ensure that users understand what action they will invoke by clicking a button.

  • The following prefixes should not be used in an action button label if users can view, edit, and add in the form:

    • Open

    • View

    • Edit

    • Modify

    • Add

    Instead, the action should just be named after the content it is showing. For example, it should be named "Customer" if the customer who is related to the record can be viewed but also edited.

  • If the form allows only viewing, then the prefix “View” can be used in the action label.

  • If the action is a specific action in which the user is adding an item, then the prefix “Add” can be used in the action label.

  • An action that points to another list should use plural in the action label if possible.

    Example: The action "Purchase Orders" in the Related Information group uses plural in the action label.

  • Action labels should inherit the same name as other buttons or actions that link to the same menu item.

    Exception: If the existing name is ambiguous or misleading, the text properties of the action label should be changed, but UI text in existing forms should not be modified. (The menu item name should not be changed.)

  • Action labels should not exceed 25 characters.

  • Action button names for buttons in the New group should be nouns. For example, use "Customer" instead of "Create customer."