Skip to main content

Welcome to the Cyara Knowledge Center

Search

Managing Pre Login Scripts

Updated: tech writers Edited:

A Pre-login script is a script that is run before a user is logged on to a desktop. This is typically used to dismiss a splash screen or enter secondary credentials. The script executes a series of keystrokes after the remote desktop connection is established.

Recording a Pre-login Script

You can only record keystrokes. You cannot capture mouse movements or actions performed outside the Pre Login Script Editor.
Note: Recording pre-login script is an experimental feature. The recorded script might require manual edits to make it work as desired.

Scripts can also be created externally and imported in to the application. To import the script, copy the script to the directory: C:\Program Files (x86)\Cyara\Cyara.Agent.DesktopManager\Scripts. For information about available script commands, see Keyboard Commands.

Note: Do not switch applications while recording the script. The focus must remain on the Editor.
  1. Login to the Desktop Manager and click Pre-Login Script Editor.
  2. In the Pre Login Script Editor, specify the IP address and login credentials of the desktop for which the script is to be created.
  3. You can either select an existing script to modify or enter a new script name and click Add to create a new script.
  4. Press the F5 key to start recording the script.
  5. The following illustration shows a script to enter secondary credentials:
    Record a script to Do this...
    Enter credentials
    1. Press the F6 key and enter the user name.
    2. Press the Enter or Tab key.
    3. Press the F7 key and enter any random keystrokes and press the Enter key.
    Close a splash screen Press the F6 key and then press the Enter key.
    Note: The username and password need not be the actual login credentials. The keystrokes are used to measure the keystroke speed (SK_DELAY).
  6. Press the F8 key to stop the recording.
  7. To replay the recording. press the F9 key.
  8. Press the F8 key to stop the replay.

Assigning a Pre-login Script

After the pre-login script is created, it can be assigned at the following levels in the Portal:
  • Agent Desktop Server
  • Environment Server
  • Environment

To assign the Pre-Login Script create a key PreLoginScript under Agent Server Attributes and define a prelogin script name as below:

Note: Before using this feature, make sure that the following configuration option is set to "true" on the Cyara Scheduler configuration file:
<add key="AgentExecutionSettings.UsesDesktopManager" value="true" />

When a Virtual Agent Campaign is run, the pre-login script is run before logging into the RDP session. The Desktop Manager applies the pre-login script that is assigned to Agent Desktop Server. If the agent is not assigned a pre-login script, the script applied at the Environment Server level or the Environment level, in that order.

Examples

The following examples show sample scripts that are recorded using the Pre Login Script Editor.

Example 1: Enter Credentials

The following example shows a script to enter secondary credentials. The SK_Delay sets the delay time between key presses to 500 milliseconds. 
SK_DELAY 500
Wait> 1
SendText>{username}
Press Tab
Wait> 0.5
SendText>{password}
Press Enter
Wait> 1.5
Press Enter

Example 2: Close a Splash Screen

The following example shows a sample script to dismiss a splash screen that is displayed before logging into a remote desktop.

Wait> 2
Press Enter
Wait> 2
Was this article helpful?
0 out of 0 found this helpful
Return to top

Related articles

Comments

0 comments

Please sign in to leave a comment.