Activities

Connect To Remote Desktop
Disconnect From Remote Desktop
Get Remote Desktop Session

Connect To Remote Desktop

This activity creates the remote desktop connection.

NOTE: The remote desktop must be configured to receive remote commands. ( see https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/enable-psremoting?view=powershell-5.1)

Activity Parameters

The Connect To Remote Desktop activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Full Username (text box editor type) (type: string): the remote domain and username. E.g. 'domain\demouser'. (user must have permissions to perform a remote connection to the server).
Is Local machine (combo box editor type) (type: string): specify whether the remote machine is the local machine or not. For example, if the workflow is executed on a remote execution agent installed on the desired remote server, the remote server will be considered Local Machine. If this parameter is set to True, the 'Server' parameter is not needed.
Password (password box editor type) (type: string): the username's password.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for connection. (This parameter is used only when the user wants to send an encrypted password from outside the workflow, for example Flowster Portal).
Server (text box editor type) (type: string): enter the remote server. E.g. '10.20.10.1' (server IP) or 'DemoServer' (server name). ( NOTE: If the server is from a different domain, there should be a trust between the workflow execution server and the remote server. If Server name is used instead of Server IP Address, the Certificate Warning window will not open, thus no extra checks must be done by the user in the NOTE section below.

The Read Only Output variable are the possible output values that the activity will provide:

Connection (type: Object): outputs a remote desktop connection object. The Output of this activity should be used as input for all Connection parameters used for all activities placed under RDC category.
Output Session ID (type: Int32): outputs the session ID. The output of this activity should be used as Input for all SessionID parameters. E.g. 'ConnectUIRecorder' activity uses the SessionID parameter to perform operations under specified user.

NOTE: If the server throws a certificate Warning, this will pop up during the execution of the workflow. If you do not wish for this warning to be displayed, during the first execution, check the 'Don't ask me again for connections to this computer' checkbox for the desired server or use the Server Name instead of IP address.

Disconnect From Remote Desktop

This activity disconnects the remote desktop session.

Activity Parameters

The Disconnect From Remote Desktop activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type) (type: Object): use the Connection output from Connect To Remote Desktop activity. If the remote session was not opened using the 'Connect To Remote Desktop' activity, 'Server' and 'SessionID' parameters should be used.
Option (combo box editor type) (type: string): choose whether to disconnect (reset user session) or sign out (logoff user session) the user on the remote desktop.
Server (text box editor type) (type: string): enter the remote server. E.g. '10.20.10.1' (server IP) or 'DemoServer' (server name).
SessionID (text box editor type) (type: string): enter remote session ID or bind this parameter to the 'Output Session ID' parameter from 'Connect To Remote Desktop' activity.

The Read Only Output variable are the possible output values that the activity will provide:

Output Status (type: Boolean): outputs True is succeeded, otherwise False.

Get Remote Desktop Session

This activity returns the remote desktop session ID.

Activity Parameters

The Get Remote Desktop Session activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type) (type: Object): use the Connection output from Connect To Remote Desktop activity. If this parameter is specified, the 'Server' parameter is not needed anymore.
Server (text box editor type) (type: string): enter the remote server. E.g. '10.20.10.1' (server IP) or 'DemoServer' (server name).
Username (text box editor type) (type: string): enter username without domain. E.g. 'demouser'.

The Read Only Output variable are the possible output values that the activity will provide:

Output Session ID (type: Int32): outputs the session ID.

Browser not supported