Desktop Client Commands

Desktop Client Commands

Table of Script Commands

Command

Description

AlertInfo / AlertError

Commands to show text messages to users.

BringToForeground

Attempt to force the main app window to desktop’s foreground.

InteractiveSelectBookmark

Allows manual intervention when selecting and injecting user credentials. Primarily for Flash, Java or IE compatibility mode web apps.

LaunchUrl

Opens a web URL in the user’s default browser.

LeftClick

Performs a left mouse click at the specified location.

LogInfo / LogError

Write a message to the agent’s log file.

OnError

Controls the processing of a script in the event of a runtime error.

SaveChanges

Saves the changes to a bookmark’s password after the bmNewPassword attribute has been referenced.

SelectBookmark

Finds the most suitable bookmark credentials for the running application.

SelectControl

Selects a control on the target application’s foreground window.

SendKeys

Injects the supplied text to the foreground window.

SendText

Changes the text of a selected windows control.

StartProcess

Starts a desktop app when a web vault tile is clicked.

UnSelect

Clears the last selected control.

Wait

Pauses script execution for a specified number of milliseconds.

WaitProcess

The WaitProcess command pauses the execution of the script until a matching process is identified, or the timeout expires.

WhenWindow

Defines a block of script that will run when the specified window becomes the foreground window.

WhenVaultLaunch

Defines a block of script that will run once if the app is started from the web vault.

Table of Bookmark Attributes

Attribute

Data Source

bmAppArgument

Template: Command Line Arguments field

bmAppPath

Template: Path to App field

bmEnc1

Bookmark: Extra Encrypted 1 field

bmEnc2

Bookmark: Extra Encrypted 2 field

bmTitle

Bookmark: Title field

bmNewPassword

Forces new password generation, if policy available

bmOldPassword

Current password, or password prior to last bmNewPassword reference

bmNotes

Bookmark: Notes field

bmPassword

Bookmark: Password field

bmUsername

Bookmark: Username field

bmTemplateName

Template: Name field

bmTemplateDescription

Template: Description field

Table of SendKeys Special Keys

Note

The SendKeys option values must be typed in exactly as shown.

E.g. SendKeys BACKSPACE SendKeys UP_ARROW

See also SendKeys.

Required Key

SendKeys Option

Alt

ALT

Backspace

BACKSPACE

Break

BREAK

Control

CTRL

Caps Lock

CAPSLOCK

Del

DEL

Delete

DELETE

Down Arrow

DOWN_ARROW

End

END

Enter

ENTER

Esc/Escape

ESCAPE

Help

HELP

Home

HOME

Ins

INS

Insert

INSERT

Left Arror

LEFT_ARROW

Num Lock

NUMLOCK

Page Down

PAGEDOWN

Page Up

PAGEUP

Print Screen

PRINTSCREEN

Right Arrow

RIGHT_ARROW

Scroll Lock

SCROLLLOCK

Shift

SHIFT

Tab

TAB

Up Arrow

UP_ARROW

Function Key 1

F1

Function Key 2

F2

Function Key 3

F3

Function Key 4

F4

Function Key 5

F5

Function Key 6

F6

Function Key 7

F7

Function Key 8

F8

Function Key 9

F9

Function Key 10

F10

Function Key 11

F11

Function Key 12

F12

Function Key 13

F13

Function Key 14

F14

Function Key 15

F15

Function Key 16

F16

Keypad ‘+’

KEYPAD_ADD

Keypad ‘-‘

KEYPAD_SUBTRACT

Keypad ‘*’

KEYPAD_MULTIPLY

Keypad ‘/’

KEYPAD_DIVIDE

    • Related Articles

    • Desktop Scripting

      Structure of a Script A Desktop DSL Script has the following functional sections (not all are required for all apps): Error Directive Determines the impact of errors on the script run. Process Start and Identification Ensures the correct windows ...

    • My1Login Desktop Client Overview

      Introduction The Desktop Client (DTC) is My1Login’s Windows solution for integrating Single Sign On with legacy (desktop, terminal) applications and web based applications. The Desktop Client runs on the user’s desktop. It monitors the processes ...

    • Desktop Scripting Overview

      Purpose The My1Login Desktop Scripting language is a Domain Specific Language (Desktop DSL), targeted at controlling and responding to Windows desktop applications, with the aim of injecting user credentials that are stored in the My1Login system. It ...

    • Script Example - Using Notepad

      Script Example - Using Notepad This section introduces a basic script that interacts with the windows Notepad application. The script does three things: It inserts some text in the Notepad window when Notepad starts. It shows a message to the user ...

    • Commenting Desktop Scripts

      The Desktop Scripting Language supports both inline and block comments. Inline Comments C# / C++ style single line comments are supported. Any text starting with two “/”s is ignored to the end of the line. Example: // This is a comment UnSelect // ...