Configuring the @mention component

The @mention component is a typeahead feature that is introduced for Progressive views. This component is supported for the Character field only where you can type in to provide your inputs. You can set the metadata for this component by using Developer Studio.

When you define a menu for a Character field, the Enable Menu Hotkeys property is automatically set to False. However, any hotkey definitions created earlier remain as they are. You can't add any duplicate hotkey definitions. Make sure that the menu that you attach to a hotkey is a Search Menu.

Example

To understand how the @mention component works, consider a scenario where you're composing in a new email in Microsoft Outlook for Office 365. As soon as you type @ you get a list of users in your organization and the user that you select gets added to the To list. You also get additional information about the user, such as name, email address, and a display picture if available, which helps you identify the correct user when there are multiple users of the same name.

As a scenario specific to Remedy, if an incident manager is working with an incident, the incident manager can type @ in the activity notes to get a list of agents. This helps the incident manager select a particular agent from the list of available agents.

To support the @mention component for Progressive views, the following properties are added in Developer Studio:

Property name

Property type

Property values

Description

Enable Menu Hotkeys

Boolean

  • True
  • False (Default)

Specifies if the menu hotkeys are to be enabled. To define menu hotkeys, you must set the value of this property to True.

Menu Hotkeys

String

A string

Use this property to define hotkey definitions. By default, the text "No Hotkey Defined" is displayed as the value for this property.

To configure the @mention component

  1. On the Progressive view of a form, double-click a Character field.
  2. On the Properties panel, under the Display property group, for the Enable Menu Hotkeys property, select the True value.
  3. In the Value column for the Menu Hotkeys property, click the ellipsis button.
    The Menu Hotkeys dialog box is displayed.

    menu-hotkeys.png

  4. Click Add, and then perform the following steps:

    Column

    Step

    Hotkey

    Click the first row in this column, and then select a character from the list.

    Menu Name

    Click the first row in this column, and then click the ellipsis button to select a menu from the Menu Selector dialog box.

    Active Link

    Click the first row in this column, and then click the ellipsis button to select an active link from the Active Link Selector dialog box.

    The active link that you attach to a hotkey must be an existing one and associated with the current form.

    Labels

    Click the first row in this column, and then in the box, type in labels that are separated by a semicolon.

    Auto Complete Key Stroke #

    Enter an integer value.

  5. Click OK.

Parameters for hotkey definition

The following parameters can be a part of any hotkey definition:

Parameter

Description

Hotkey

When you press this character key, the @mention component is executed based on the other parameters that you've provided in the hotkey definition. This parameter is the mandatory part of any @mention definition.

Menu Name

This is a name of the menu that is used to populate the popup. This parameter is the mandatory part of any @mention definition.

Active Link

This is a name of the active link that gets executed when you select an item from the popup. This parameter is an optional part of any @mention definition.

Labels

This is a set of labels that are defined for a menu. This parameter is an optional part of any @mention definition.

Auto Complete Key Stroke #

You can enter an integer value value for this parameter. For example, if you enter the value 3, a drop-down list appears after you type three characters in the menu. If you enter the value zero (0), the drop-down list appears as soon as type a hotkey character key.


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*