Imprivata OneSign Keycodes and Variables

Imprivata provides a keystroke vocabulary that lets you modify keystroke commands and text strings managed by the Imprivata APG. You can use the Imprivata OneSign keystroke vocabulary in all credential fields.

  • The Keyboard Simulation tool makes available commonly used keystroke codes. You use keystroke codes to represent single non-text keys or key combinations, such as Shift+F4.

  • You can concatenate Imprivata OneSign keystroke codes. However, you cannot use logical operators, wildcards, or escape characters.

  • You can use the Shift (+), Alt (%), or Ctrl (^) key modifiers to modify some keystrokes. The key modifiers affect only the single character immediately following the keystroke, so +f2 sends F2, not F@. You cannot group modifiers, so to send F@, enter +f+2.

  • Enclose the keycodes in braces ({}) to prevent Imprivata OneSign from interpreting them as text. For example, to send the combination Shift+Delete, enter +{DEL}.

NOTE: Keystroke codes are often used in conjunction with Credential Variables, which are the keycodes used to represent usernames, passwords, and other user-entered variable text values. For a list of credential variables, see List of Imprivata OneSign Credential Variables

Key Code

Usage

Modifier Keycodes

+, %, ^

 Use these keys to enter shift, alt, or control characters. Specify control characters with a compound statement of the form +a, %a, or ^a. Each modifier key modifies the single character that immediately follows it. For example, +a sends A. If multiple characters define a single key, enclose them in brackets ({}). For example, +{DEL} sends Shift+Delete.
Escape and Function Keycodes (can be modified by +, %, ^)

{ESC}

 Sends the Escape key.
{Fn} Sends the Function Key n.
NOTE:Don not enter a space before the number value.
Main Keyboard Keycodes (can be modified by +, %, ^)
{BKSP} Sends the Backspace key.
{CAPS} Sends the Caps Lock key.
{ENTER} Sends the Enter/Return key.
{LCONTROL} Sends the Ctrl key from the left side of the keyboard.
{SHIFT} Sends the Shift key.
{SPACE} Sends the Spacebar.
{TAB} Sends the Tab key.
{RALT DOWN} Sends Right-Alt down. Right-Alt is also known as Alt Gr.
{RALT UP} Sends Right-Alt up. Right-Alt is also known as Alt Gr.
{RCONTROL} Sends the Ctrl key from the right side of the keyboard.
Navigation Keycodes (can be modified by +, %, ^)
{DEL} Sends the Delete key.
{DOWN} Sends the Down Arrow key.
{END} Sends the End key.
{HOME} Sends the Home key.
{INS} Sends the Insert key.
{LEFT} Sends the Left Arrow key.
{PGDN} Sends the Page Down key.
{PGUP} Sends the Page Up key.
{RIGHT} Sends the Right Arrow key.
{UP} Sends the Up Arrow key.
Number Pad Keycodes (can be modified by +, %, ^)
{NUMPADn} Sends the n number key from the number pad.
NOTE: There should be no space before the number value.
{NUMLOCK} Sends the number pad Num Lock key.
{NUMPADDIVIDE} Sends the number pad / key.
{NUMPADENTER} Sends the number pad Enter key.
{NUMPADMULTIPLY} Sends the number pad * key.

Key Code

Usage

Mouse Click Codes (take no modifiers) (see note below)

{CLICK x,y WindowClassName, WindowCaption}

{DBCLICK x,y WindowClassName, WindowCaption}

{CTLCURSOR x,y WindowClassName, WindowCaption}

CLICK and DBCLICK simulate a mouse left button click or double-click at (x,y) pixels within the control. If x,y is not specified then the middle of the control is used. The x,y value should have no spaces. This is the equivalent to issuing CTLCURSOR and LBTNCLICK or LBTNDBCLICK.

CTLCURSOR positions the cursor at (x,y) within the control.
The x,y value should have no spaces.
Two optional arguments help to specify the window:

  • WindowClassName is a string that contains the window class name of the window to be used as the target. The string can be either the actual class name or a pattern that matches the class name. If no class name is specified, the target window is the top window belonging to the screen. This parameter is optional if no window caption is specified;
  • WindowCaption is a string that contains the window caption of the window to be used as the target. The string can be either the actual class name or a pattern that matches the class name. This parameter is optional.
{LBTNCLK} Simulates a left mouse button click at the current cursor location.
{LBTNDBCLK} Simulates a left mouse button double click at the current cursor location.
{RBTNCLICK} Simulates a right mouse button click at current cursor location.
{RBTNDBCLICK} Simulates a right mouse button double click at current cursor location.
NOTE: You cannot proxy mouse click codes on computers that have the mouse primary and secondary buttons switched. For example, a left-handed user who has customized the mouse button settings through the Windows Control Panel clicks the right mouse button as the primary button.

Key Code

Usage

Codes for Variables and Delays (take no modifiers)

{VAR name}

option: {VAR nameMIN xMAX y}

option: {VAR name UPCASE}

option: {VAR name LOWCASE}

Performs variable substitution and replaces the entire compound statement with the associated value. If there is no way to directly specify a control, you can use this tag to send the specified credentials to a form. Add the MIN x and MAX y arguments to set a minimum and/or a maximum length for name.

  • If the value is less than x, it is padded to x with spaces.
  • If it is greater than y, it is truncated.

To guarantee the length of the value, set x = y. The UPCASE and LOWCASE arguments force Imprivata OneSign to proxy the variable as uppercase or lowercase characters, regardless of how they are entered. For a list of credential variables, see List of Imprivata OneSign Credential Variables.
{CHARDELAY n} n is the number of milliseconds to wait between keystrokes. The default value for n is 0.
{PAUSE n} Issues all key codes up to this command, and then waits for >n milliseconds. Use this to set focus and then do a wait for focus later.
Macro Codes (take no modifiers)

{WINACT className,caption}

 Activate a window by the className and/or by specifying its caption. You can use wildcards in defining either of these parameters.
{WINCMD “MenuName -> MenuOptionName”} Activate an application menu or menu option by specifying its name and/or menu sequence. This feature only works for applications with very simple menus.

Variable Code

 Meaning
{VAR USR} Username
{VAR PWD} Password
{VAR PWDN} New Password
{VAR PWDC} Confirm Password
{VAR PWD1} Second Password
{VAR PWDN1} New Second Password
{VAR PWDC1} Confirm Second Password
{VAR PWD2} Third Password
{VAR PWDN2} New Third Password
{VAR PWDC2} Confirm Third Password
{VAR PIN} PIN
{VAR DOM} Domain
{VAR GRP} Group
{VAR SID} PatientSecure Search ID
{VAR SITE} Site
{VAR X UPCASE}
{VAR X LOWCASE} 		Submit uppercase variables
Submit lowercase variables

NOTE: You do not have to use valid credentials. If you choose to use valid credentials, use proper security precautions when using this feature.