Transfer Session

Transfers a Windows session to the console and optionally adjusts the display resolution.

Common Properties

• Name - The custom name of the node.
• Color - The custom color of the node.
• Delay Before (sec) - Waits in seconds before executing the node.
• Delay After (sec) - Waits in seconds after executing node.
• Continue On Error - Automation will continue regardless of any error. The default value is false.

info

If the ContinueOnError property is true, no error is caught when the project is executed, even if a Catch node is used.

Inputs

• Session - The session object representing the RDP connection to transfer.

Options

• Resolution Mode - How to handle display resolution during the transfer. Default is "No Change".
  • No Change - Keeps the current display resolution
  • Current Resolution - Saves and restores the current resolution after transfer
  • Custom Resolution - Sets a specific resolution after transfer
• Width - The width for custom resolution (used when Resolution Mode is "Custom Resolution"). Default is 1920.
• Height - The height for custom resolution (used when Resolution Mode is "Custom Resolution"). Default is 1080.

How It Works

The Transfer Session node transfers a Windows session to the console and optionally adjusts the display resolution. When executed, the node:

1. Validates that the robot is running with administrator privileges
2. Validates the provided session object
3. Based on the Resolution Mode option:
   • No Change: Proceeds directly to session transfer
   • Current Resolution: Saves the current resolution, transfers the session, then restores the resolution
   • Custom Resolution: Transfers the session, then sets the specified custom resolution
4. Uses tscon command to transfer the session to the console
5. Applies any requested resolution changes after the transfer

Requirements

• Administrator privileges - The robot must be run with administrator rights
• A valid session object from a previously established connection
• Windows system with console access

Error Handling

The node will return specific errors in the following cases:

• Robot is not running with administrator privileges
• No session provided or session object is invalid
• Session ID is missing from the session object
• Failed to transfer the session to console
• Requested resolution is not supported by the display
• System restart required to change resolution
• Error setting custom resolution

Usage Notes

• This node requires elevated privileges to function properly
• Transferring to console gives direct access to the physical display
• Resolution changes may require a brief delay to take effect
• The "Current Resolution" option is useful for preserving the display settings
• Custom resolution values should be within the supported range for the display
• After transferring a session, the display may temporarily change
• This node is typically used when direct console access is needed for automation