2.8. The IDERI note Hotkey Support Components

The IDERI note Hotkey Support Components are an optional product package within the IDERI note product suite that allow instant creation or update of IDERI note messages with a single press of a keyboard hotkey or a simple and inexpensive hardware device like a push-button that is attached to a workstation PC via USB or bluetooth. Other device form factors include foot pedals or switches and are available from a variety of retailers and manufacturers, prices usually range from $10 to $100 for such devices. This chapter contains a gentle introduction into the IDERI note Hotkey Support Components, for more detailed information about this topic continue reading in chapter 7.13.

2.8.1. Overview

One of the most common use case for the operation of the IDERI note Hotkey Support Components is a situation where a workplace with a workstation PC is being operated in an environment with public access, like a clerk at a counter. At such workplaces, difficult situations can quickly emerge with upset or unpleasant customers and therefore immediate help is needed to deescalate situations or protect the employee from threats or harm by security personnel or coworkers. In such emergency situations there is usually not a lot of time to maybe unlock the PC, start IDERI note administrator, type a message, select the recipients and eventually create the IDERI note message seeking for help and assistance. Even running a customized batch file using the IDERI note command line tools from a desktop shortcut may already be asking too much in such events.

Other situations for the operation of the IDERI note Hotkey Support Components quickly come to mind, such as central places with hardware alert buttons that are accessible by employees in order to trigger an evacuation or other alert-like actions.

Using the IDERI note Hotkey Support Components, creation of an IDERI note message can be as easy as pressing a hardware button which could be mounted under the desk, or by activating a foot pedal. If the IDERI note environment runs in professional licensing mode, the IDERI note Hotkey Support Components can create or update an IDERI note message even with the screen locked or no interactive user logged in. The number of hotkeys that can be configured for the IDERI note Hotkey Support Components is practically only limited by PC hardware capabilities and thus most probably by the number of USB ports. Each hotkey that is configured for usage with the IDERI note Hotkey Support Components can trigger a series of operations that can include the creation of a new IDERI note message, the update of an existing message or the cancellation of an existing message or simply cancellation of the message that was last sent from the workstation where the IDERI note Hotkey Support Components are installed. Since the number of operations that are executed in order is also only limited by PC hardware capabilities, any number of different IDERI note messages to different IDERI note servers with the same or different textual content can be sent with only one key press.

2.8.2. Compatible Hardware

The IDERI note Hotkey Support Components work by assigning a keyboard key combination to an action or a sequence of actions. Therefore, any hardware device that acts as a keyboard should be usable with the IDERI note Hotkey Support Components. Usually such devices come with a custom configuration software that allows the assignment of a keyboard key with a modifier combination (Ctrl, Alt or Shift) to the device, thereby programming its firmware. This procedure has to be done only once and can be performed by IT personnel prior to hooking up the device to the USB port of a workstation PC, where subsequently the device will just work with the builtin Windows HID keyboard driver. After assigning a keyboard key to the hardware device using its configuration software, a hotkey can be created with the IDERI note Hotkey Support Components configuration software, simply by assigning the same key and modifier combination that was previously programmed into the device’s firmware to the IDERI note hotkey using the IDERI note Hotkey Support Components control panel applet. Acquiring compatible hardware is in the responsibility of IDERI note customers and IDERI will not recommend or endorse a specific manufacturer or model. However, finding a variety of devices where to choose from on the internet should not be a major difficulty.

2.8.3. Using variables in the message text

When creating a new message or updating an existing message using the IDERI note Hotkey Support Components, environment variables can be used in the message text, using the familiar %VARIABLENAME% notation (the name of the variable enclosed in percent signs). In order to have environment variables resolved in the context of the user triggering the creation of the message, the checkbox labeled “Resolve environment variable as user” has to be checked during definition of the message (see also figures 7.43 and 7.47).

Three additional variables ¹ are also available which must also be enclosed in percent signs: AD.COMPUTER.LOCATION, AD.COMPUTER.DESCRIPTION and AD.USER.DISPLAYNAME. The string %AD.COMPUTER.LOCATION% when used as part of the message text for a new or updated IDERI note message will expand to the Active Directory® location attribute of the computer where the hotkey is executed and the string %AD.COMPUTER.DESCRIPTION% will expand to the description attribute of the computer object in Active Directory®. AD.USER.DISPLAYNAME will expand to the displayName attribute of the user executing the hotkey. This way you can configure generic text content for hotkey messages that can still reference the originating computer’s or user’s individual attributes. However, this requires that both the location and the description of your computers and the displayName attribute of your users are dutifully maintained within your Active Directory®.

Attention

Resolution of %AD.USER.DISPLAYNAME% if no user is logged in

If no user is currently logged in and a hotkey is executed on the Windows® logon screen, the %AD.USER.DISPLAYNAME% string cannot be resolved to the displayName attribute of the logged on user. In this case, the string %AD.USER.DISPLAYNAME% will be resolved like the %AD.COMPUTER.DESCRIPTION% string, i.e. to the description attribute of the computer object in Active Directory®.

For additional information on the IDERI note Hotkey Support Components, read section 7.13. This section covers both configuration and functionality of the IDERI note Hotkey Support Components in full detail.

Footnotes

[1]	For versions prior to version 3.7 the three variable values AD.LOCATION, AD.DESCRIPTION und AD.DISPLAYNAME were documented at this place. These variables can still be used but their usage for new hotkey functionality is discouraged.