Using the Info Button

This article applies to versions 4.6.2 and later of P2 Explorer. For more, see Release History.

Overview

The Info Button is a small, clickable button positioned on an Explorer page by a page designer, usually alongside the area or control that it is describing.

The Info Button is used to share contextual information for an area of your page. This information is available to all users of the page, for viewing or editing.

When you click an Info Button, the Explore panel opens to show Knowledge Management and Commentary relating to a control, or area of the page. This initially holds no information, although in the example below, the Knowledge Management fields have already been updated, and there is already a comment.

1. Explore icon: This icon appears when the Explore panel is open (in this case, for the selected Info Button).
  Click the icon to open/close the Explore Panel.
2. Info Button header: The header is 'Explore', with a sub-header showing the info button's Title.
  Click the pin to keep the panel open, otherwise it will close if you click elsewhere in Explorer (for example on a display, or on the ribbon). Click again to unpin. See more: Explore Panel Pinned.
  Click the Close button to close the Explore panel for this case.
  Click the Help button to open contextual help.
3. Knowledge Management: The default fields Purpose and Instructions, for defining the purpose of this area of the page, as well as any instructions that can be followed. See more: Knowledge Management.
4. Commentary: Users can comment on this area of the page. See more: Commentary.

A page can have several info buttons, each with Knowledge Management and Commentary designed to be relevant to its context, or its physical area on the page.

This page has six Info Buttons, each one for describing its separate area

Each Info Button on a page has been configured, by the page designer, to have a title and a context key.

Note that Info Button styles may vary.

Knowledge Management

Knowledge Management for the Info Button is used for capturing and sharing knowledge about the page section the Info Button relates to.

The default Knowledge Management fields are:

  • Purpose: What this display is intended for.
  • Instructions: Any special instructions applicable to this display

Knowledge Management is also available in a public display's Display Information.

Read more: Knowledge Management

Commentary

This is where Explorer users can comment on the section of the page that is defined by the Info button. Comments are displayed with the most recent shown first.

To add a new comment, type in the comment edit box (you can include mentions @ and hashtags #) then click Save.

When adding a comment, there is a Live Preview tab below the edit box, showing the entity and user names, if any have been used.

Note: Live Preview only applies to version 4.6.2. In later versions, mentions are supported natively and a text format toolbar is also available.

Any user can reply to a comment. If you have Commentary privileges, or if you made the original comment, you can edit or delete comments.

Read more: Mentions and Hashtags in Commentary, Formatting Text

Explore Panel Pinned

When the Explore Panel is pinned, it remains open as you click different Info Buttons. Each time you click on an Info Button, the Explore panel is updated for its contents.

 


How it Works

The example below illustrates how the Info Button can be used by more than one user to view or update information for a certain section of a page.

1. A user, P2 User 2, opens a page: Info Button Tutorial.
2. P2 User 2 clicks on the Info Button. The Info Button's contents (blank) open in the Explore panel.
3. P2 User 2 edits and saves the Knowledge Management fields (Purpose and Instructions).
4. A different user, P2 User 3, opens the page and clicks on the Info Button. The Knowledge Management is available for viewing and editing by this second user.

Context Key

The Context Key can be seen when you hover over a button, as part of the tooltip. An Info Button's context, together with its position, indicates what it is used for.

The Context Key can be a fixed value, or a page variable that changes when you select something on the page, such as a product type, or a period.

The highlighted word (Hunter) is the context key for this Info Button

Title

The Title appears in the Explore panel when you click the Info Button. The title can be configured to include the Context Key.

This Info Button has been configured to include the context key in the title

Using the Info Button

Use the Info Button to view or edit the information it contains.

View Tooltip

Hover your mouse over the Info Button to view the tooltip. This contains the context key, in quotes ('Hunter', in this example).

 

Open Knowledge Management

Click the Info Button to open its content in the Explore panel.

 

Edit Knowledge Management

When you have clicked to open the Explore panel for the Info Button, you can view or edit its Knowledge Management fields, and add or reply to comments.

These sections in the Knowledge Management article describe how to Edit Knowledge Management fields.

Unsaved Changes

If you are editing the Knowledge Management fields for an Info Button, and then open the Explore panel for another item (for example, you click on a different Info Button), you can still manage your unsaved changes. This feature is useful if you want to check on some background or get further information, before saving your changes.

Read about how to manage Unsaved Changes.


What to Watch out for

Changing Context

Depending on how an Info Button is configured, the Context Key could be a variable, which changes as you change selections on a page.

When you save Knowledge Management using an Info Button, it is saved with that context key. Thus, one Info Button can be used to save and view multiple sets of Knowledge Management, each linked to its own context key.

For example:

1. Select entity "Hunter".
2. Click the Info Button to view or edit Knowledge Management and Commentary for that context key.
1. Select entity "Earl".
2. Click the Info Button to view or edit Knowledge Management and Commentary for that context key.

Saving Changes

Remember that Knowledge Management is shared between users. When you save changes, this overwrites anything previously saved by another user.

Copies of a Page

When you save a copy of a page, by clicking the Save As button on the Page ribbon tab, the Info Buttons are copied to the new page; however, the Knowledge Management fields and Commentary are empty in the new page.

 

Release History

  • Using the Info Button 4.6.2 (this release)
    • This version of Explorer introduces a Commentary section, which can include mentions @ and hashtags #.
    • In version 4.6.4, a text formatting toolbar was introduced.
  • Using the Info Button 4.6.0
    • Info Button first introduced.

 

Comments are closed