IA-Connect Session (Preview)

Reference

IA-Connect is a Robotic Process Automation (RPA) platform which adds RPA functionality from the Cloud to on-premises virtual machines or over Citrix or Microsoft Remote Desktop (RDS) connections. This is the module for automating the environment, session, file management and configuring IA-Connect.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Ultima Labs
URL	https://www.ultima.com/ultima-labs
Email	IAConnect@ultima.com

Connector Metadata
Publisher	Ultima Labs
Website	https://www.ultima.com/ultima-labs
Privacy policy	https://www.ultima.com/privacy-policy
Categories	IT Operations;Productivity

IA-Connect is a Robotic Process Automation (RPA) platform which adds RPA functionality from Power Automate Cloud Flows to on-premises virtual machines or over Citrix or Microsoft Remote Desktop (RDS) connections. The IA-Connect Connectors provide over 800 actions, allowing you to automate every type of on-premise application directly from a Power Automate Cloud Flow. All IA-Connect actions are available directly from your Power Automate Cloud Flow providing easy integration between Cloud based and on-premises applications, the ability to leverage existing Power Automate conditions, loops, dynamic content, expressions and exception handling in your RPA processes. Utilising the IA-Connect Connectors also provides full execution history and auditability from the Flow run history whilst also removing the need to have a separate application/console/studio for developing your RPA processes.

Prerequisites

To use any of the IA-Connect Connectors, you must install the IA-Connect software. This is free to test for 30 days, following which you will require an IA-Connect license.

The IA-Connect software consists of two main components:

The IA-Connect Orchestrator, which is an Azure WebApp which you would host in your own Azure tenant. This handles the routing and security of RPA Flows to one or more on-premises or cloud-based virtual machines.
The IA-Connect Agent and Director, which is installed onto the virtual machines where the software you wish to automate is accessible. Additionally, the IA-Connect Agent can run inside a Citrix or Microsoft Remote Desktop Services (RDS) session, where the RPA commands are passed down a virtual channel into the remote session for execution. The IA-Connect Agent can be run from a network share and does not require installation.

Available IA-Connect Connectors

The available IA-Connect Connectors are:

IA-Connect Dynamic Code
IA-Connect Java
IA-Connect JML
IA-Connect Mainframe
IA-Connect Microsoft Office
IA-Connect SAP GUI
IA-Connect Session
IA-Connect UI
IA-Connect Web Browser

How to get credentials

In order to receive your license and begin your 30-day free trial, please submit a request on our website (https://www.ultima.com/IA-Connect/Power-Automate).

Once a trial request is received, we will contact you via the email address provided to assist with setting up the IA-Connect software and to provide you with the trial license. This is a fully featured trial and will enable you to test any of the 800 actions across all 9 IA-Connect Connectors within your own environment during the trial period.

Get started with your connector

After submitting a trial request for IA-Connect, you will be able to download a ZIP file containing the IA-Connect software and documentation covering the installation and setup. We will also contact you to offer support and guidance through the installation process as required.

Support

During the trial period, you can contact Ultima Labs (IAConnect@ultima.com) for support and assistance.

Upon purchasing IA-Connect licenses you will receive support tokens which can be redeemed for bespoke training or support from Ultima's UK-based Technical Service Centre (TSC).

Known issues, common errors and FAQs

Our Knowledge Base contains a number of articles covering any known issues, common errors that may occur when using the IA-Connect Connectors and frequently asked questions. This is accessible at https://support.ultima.com/ultimalabs and an account to access these resources is provided during the IA-Connect trial and upon purchasing an IA-Connect license.

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
API Key	securestring	The API Key for this api	True
IA-Connect Orchestrator address	string	Specify the IA-Connect Orchestrator address without the HTTP(S) component	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add file to ZIP	ZIPs a file (stores the file into a compression archive).
Add folder to ZIP	ZIPs files in a folder into a ZIP file (stores the files into a compression archive).
Add new Orchestrator automation task	Add a new Orchestrator automation task into a queue that can be monitored from a Flow. Tasks can either be ready to run immediately or be deferred to run at a later time.
Add new Orchestrator deferred task	Add a new Orchestrator deferred task into a queue that can be monitored from a Flow. The task will be deferred to a specified time in the future. Use this action to temporarily suspend a task for a specified amount of time (for example if you are waiting for something).
Add permission to file	Adds a permission to a file on the computer where the IA-Connect Agent is running.
Add permission to folder	Adds a permission to a folder on the computer where the IA-Connect Agent is running.
Attach to IA-Connect session by index	Attaches to the specified IA-Connect Director session by index (e.g. attach to first Citrix ICA session). This is the session into which commands to an IA-Connect Agent are sent.
Attach to IA-Connect session by name	Attaches to the specified IA-Connect Director session by name. This is the session into which commands to an IA-Connect Agent are sent.
Attach to most recent IA-Connect session	Attaches to the IA-Connect Director session which most recently connected (optionally of a specified type). This is the session into which commands to an IA-Connect Agent are sent.
Attach to tier 1 IA-Connect session	Attaches to the IA-Connect Director session of the Director receiving the SOAP and / or REST messages. This is the session into which commands to an IA-Connect Agent are sent.
Break folder security inheritance	Breaks security inheritance on a folder on the computer where the IA-Connect Agent is running.
Bring IA-Connect Agent GUI to front	Brings the IA-Connect Agent GUI to the front so it is visible onscreen.
Calibrate mouse_event	Calibrates the mouse_event method by moving the mouse by the specified number of pixels and then reading the new mouse position.
Change Orchestrator automation task status	Changes the selected Orchestrator automation task status to completed, failed or new.
Clear clipboard	Clears the contents of the clipboard in the IA-Connect Agent user session.
Close IA-Connect Agent	Closes the IA-Connect Agent. This does not affect the user session where the IA-Connect Agent was running.
Configure next hop IA-Connect Director	Configure the next-hop Director in a double-hop scenario. This is only required if the default IA-Connect next-hop Director settings are not suitable.
Copy file	Copies a file on the computer where the IA-Connect Agent is running.
Copy file from client to server	Copies a file from the local computer (running the IA-Connect Director) to the remote computer (running the IA-Connect Agent).
Copy file to clipboard	Copies the specified local file to the clipboard in the IA-Connect Agent user session.
Create directory	Creates a directory (folder) on the computer where the IA-Connect Agent is running.
Create Remote Desktop Session (RDS) launch file	Create a Remote Desktop Session (RDS) launch file which can be used to automatically launch a Remote Desktop Session using specified parameters, instead of requiring automation of the Remote Desktop client UI. A RDS launch file has the extension '.rdp' and is often called a RDP file.
Defer existing Orchestrator automation task	Defer an existing Orchestrator task which is already in the queue. The task will be deferred to a specified time in the future. This is commonly used to re-defer an existing task (i.e. the task was previously deferred and now needs to be deferred again). Use this action to temporarily suspend a task for a specified amount of time (for example if you are waiting for something).
Delete directory	Deletes a directory (folder) on the computer where the IA-Connect Agent is running.
Delete file	Deletes a file on the computer where the IA-Connect Agent is running.
Delete files	Deletes files within a specified folder matching a pattern on the computer where the IA-Connect Agent is running.
Delete Orchestrator automation task	Delete an Orchestrator automation task that has been deferred.
Deletes a user credential	Deletes a credential in the user's profile in the IA-Connect Agent session. Credentials can be viewed from the Windows Control Panel.
Disable IA-Connect next hop	Disables next-hop so that all future commands will be processed by the Agent which receives them (as opposed to being forwarded on to the next hop Agent).
Disconnect remote session	Disconnects the remote session where the IA-Connect Agent is running. This is not the same as logging off and will leave the remote session running in a disconnected state. This action can be used where you wish to connect back to the remote session later and continue from the same state, rather than starting a new session.
Does directory exist	Reports true or false as to whether a directory (folder) exists on the computer where the IA-Connect Agent is running.
Does file exist	Reports true or false as to whether a file exists on the computer where the IA-Connect Agent is running.
Does IA-Connect session exist by name	Returns if the specified IA-Connect Director session exists. This is the session into which commands to an IA-Connect Agent are sent. The name will be known from an earlier 'Attach' action.
Double left click mouse	Double clicks the left mouse button in the IA-Connect Agent user session.
Double left click mouse at coordinate	Double clicks the left mouse button in the IA-Connect Agent user session at the specified coordinates.
Download HTTP file	Downloads a file to the computer where the IA-Connect Agent is running using HTTP(S).
Enable folder security inheritance	Enables security inheritance on a folder on the computer where the IA-Connect Agent is running.
Enable IA-Connect next hop	Enables the next hop which will forward all future commands received onto the IA-Connect Agent running in the next hop session.
Expand environment variable	Expands a string containing environment variables (e.g. %USERPROFILE% or %TEMP%) in the IA-Connect Agent user session.
Expand password string	Accepts an input string which contains references to IA-Connect stored passwords and returns that string with the references replaced by the stored passwords.
Generate password	Generates a password containing dictionary words, numbers, symbols, characters as defined in a template format.
Get all IA-Connect command statistics	Returns all currently stored statistics on which commands the IA-Connect Agent has executed in the current session.
Get all Orchestrator automation tasks	Retrieves all the Orchestrator automation tasks that match the filters.
Get available IA-Connect Sessions	Retrieves a list of IA-Connect Director sessions (available connections to sessions where the IA-Connect Agent is running, such as local, Microsoft RDP or Citrix ICA).
Get client hostname	Returns the hostname of the client where the IA-Connect Director is running.
Get clipboard	Gets the current content of the clipboard in the IA-Connect Agent user session.
Get CSV text as collection	Returns a CSV file on the computer where the IA-Connect Agent is running as a collection (table). Only requires read only access to CSV file.
Get current mouse coordinate	Gets the current mouse cursor position in the IA-Connect Agent user session.
Get default printer	Gets the name of the default printer for the user in the IA-Connect Agent session.
Get disk free space	Returns the amount of free space for a specified disk on the computer where the IA-Connect Agent is running.
Get environment info	Returns information about the environment in which the IA-Connect Agent user session is running.
Get file security permissions	Returns a list of permissions currently set on a file on the computer where the IA-Connect Agent is running.
Get file size	Returns the size (in bytes) of a file on the computer where the IA-Connect Agent is running.
Get files	Returns a list of files in a folder (matching a CSV list of patterns) on the computer where the IA-Connect Agent is running.
Get folder security permissions	Returns a list of permissions currently set on a folder on the computer where the IA-Connect Agent is running.
Get folders	Returns all sub-folders within a specified folder on the computer where the IA-Connect Agent is running.
Get IA-Connect Agent current license state	Returns whether the IA-Connect Agent is currently licensed and if licensed, the properties of the license.
Get IA-Connect Agent info	Returns the properties of the IA-Connect Agent, including the version number and the path to the Agent executable.
Get IA-Connect Agent log	Returns the current IA-Connect Agent log, either as a file or by reading the contents and returning it in an output variable.
Get IA-Connect Agent log level	Returns the current IA-Connect Agent logging level. The logging levels are set from 1 to 4, with 1 being the lowest level and 4 being the highest.
Get IA-Connect Agent process count	Returns the number of instances of the IA-Connect Agent currently running in the user session. This is useful for detecting if there are multiple instances of the IA-Connect Agent running.
Get IA-Connect Agent session info	Returns information about the IA-Connect Agent user session.
Get IA-Connect Director uptime	Returns the uptime of this IA-Connect Director in seconds (i.e. how long the Director has been running).
Get IA-Connect next hop status	Reports on the next hop Director status for the Agent which receives this command. If next-hop is enabled, that Agent is forwarding commands to the next hop (via the next-hop Director). If next-hop is disabled, that Agent is processing commands itself (the default).
Get last input info	Gets the time since the last user input was received in the IA-Connect Agent user session.
Get list of drives	Returns a list of drives on the computer where the IA-Connect Agent is running.
Get list of printers	Returns a list of all available printers in the IA-Connect Agent session.
Get machine domain	Returns the domain of the machine that is running the IA-Connect Agent user session.
Get machine name	Returns the name of the machine that is running the IA-Connect Agent user session.
Get mouse move method	Gets the current mouse move method.
Get next Orchestrator automation task	Retrieves the next Orchestrator automation task matching the given search critieria.
Get Orchestrator automation task	Retrieves a specfic Orchestrator automation task.
Get Orchestrator Flow stats	Returns a list of Flow stats from the IA-Connect Orchestrator. Used for reporting purposes. You can optionally use one or more filters to limit the returned results.
Get parent process Id	Returns the process Id of the parent process for any running process in the IA-Connect Agent user session which has the specified process Id.
Get process by process Id	Returns whether a process with the specified process Id is running in the IA-Connect Agent user session. Process Ids are unique so only one process can match the Id. Process Ids are dynamic and are different for every launch of an application.
Get process count by name	Returns a count of running processes in the IA-Connect Agent user session which has the specified process name.
Get process Id command line properties	Returns the command line properties for any running process in the IA-Connect Agent user session which has the specified process Id.
Get processes	Returns a list of running processes in the IA-Connect Agent user session. This can optionally be filtered by providing a process name.
Get screen resolution	Returns the screen resolution of the IA-Connect Agent user session (as seen by the user session).
Get stored password	Retrieves a previously generated or stored password.
Is directory accessible	Returns whether a directory (folder) is accessible and whether permissions are restricting access to it on the computer where the IA-Connect Agent.
Is screen reader enabled	Returns whether the screen reader has been enabled in the IA-Connect Agent user session.
Is TCP port responding	Reports whether a network TCP port is responding to a connection attempt by the IA-Connect Agent. This could be a TCP port on the computer where the IA-Connect Agent is running (enter 'localhost' for the remote host) or on any remote computer. If the IA-Connect Agent successfully connects to a TCP port, it immediately closes the TCP connection.
Keep session alive	Keeps the IA-Connect Agent user session alive by moving the mouse at the specified interval to prevent the session from becoming idle.
Kill all other IA-Connect Agents	Kills any other instances of the IA-Connect Agent that are currently running in the user session. This will ensure that only one instance of the IA-Connect Agent is running.
Kill IA-Connect session by name	Kills the specified IA-Connect Director session if it exists. This is the session into which commands to an IA-Connect Agent are sent. The name will be known from an earlier 'Attach' action.
Kill process	Kills any running process in the IA-Connect Agent user session which has the specified process name.
Kill process ID	Kills a running process in the IA-Connect Agent user session which has the specified process Id. Process Ids are unique so only one process can match the Id. Process Ids are dynamic and are different for every launch of an application.
Launch Remote Desktop Session (RDS)	Launch a Remote Desktop Session (RDS) using a RDP launch file.
Left click mouse	Clicks the left mouse button in the IA-Connect Agent user session.
Left click mouse at coordinate	Clicks the left mouse button in the IA-Connect Agent user session at the specified coordinates.
Left hold mouse	Holds the left mouse button in the IA-Connect Agent user session for the specified amount of seconds.
Left hold mouse at coordinate	Holds the left mouse button at the specified coordinates in the IA-Connect Agent user session for the specified amount of seconds.
Left mouse button down	Presses (and does not release) the left mouse button in the IA-Connect Agent user session. To release the mouse, use the left mouse button up action.
Left mouse button up	Releases the left mouse button in the IA-Connect Agent user session.
Left mouse drag between coordinates	Performs a left mouse button drag between the two specified coordinates in the IA-Connect Agent user session.
Logoff remote session	Logs off the remote session where the IA-Connect Agent is running.
Mark Flow as complete	Mark a Flow as complete, which informs the IA-Connect Orchestrator that the assigned worker machine is now available to process other Flows.
Middle click mouse	Clicks the middle mouse button in the IA-Connect Agent user session.
Middle click mouse at coordinate	Clicks the middle mouse button in the IA-Connect Agent user session at the specified coordinates.
Middle hold mouse	Holds the middle mouse button in the IA-Connect Agent user session for the specified amount of seconds.
Middle hold mouse at coordinate	Holds the middle mouse button at the specified coordinates in the IA-Connect Agent user session for the specified amount of seconds.
Middle mouse button down	Presses (and does not release) the middle mouse button in the IA-Connect Agent user session. To release the mouse, use the middle mouse button up action.
Middle mouse button up	Releases the middle mouse button in the IA-Connect Agent user session.
Middle mouse drag between coordinates	Performs a middle mouse button drag between the two specified coordinates in the IA-Connect Agent user session.
Move file	Moves a file on the computer where the IA-Connect Agent is running.
Move mouse relative	Moves the mouse in the IA-Connect Agent user session by the specified number of pixels, relative to it's current position.
Move mouse to coordinate	Moves the mouse in the IA-Connect Agent user session to the specified pixel coordinates.
Purge directory	Purges a directory (folder) on the computer where the IA-Connect Agent is running, removing all files stored within the directory.
Read all text from file	Reads the text contents of a file on the computer where the IA-Connect Agent is running.
Read from a user credential	Reads a username and password from a credential in the user's profile in the IA-Connect Agent session. Credentials can be viewed from the Windows Control Panel. Both the username and password can be retrieved from a Generic credential while only the username can be retrieved from a Windows credential.
Remove identity from file security	Removes an identity (e.g. user, group or computer) from the security permissions on a file on the computer where the IA-Connect Agent is running.
Remove identity from folder security	Removes an identity (e.g. a user, group or computer) from the security permissions on a folder on the computer where the IA-Connect Agent is running.
Replace variable data in INI file	Updates a single variable in an INI file.
Reset IA-Connect command statistics	Resets any currently stored statistics on which commands the IA-Connect Agent has executed in the current session.
Reset next hop IA-Connect Director settings	Resets any custom IA-Connect Director settings that have been set, restoring the default settings.
Right click mouse	Clicks the right mouse button in the IA-Connect Agent user session.
Right click mouse at coordinate	Clicks the right mouse button in the IA-Connect Agent user session at the specified coordinates.
Right hold mouse	Holds the right mouse button in the IA-Connect Agent user session for the specified amount of seconds.
Right hold mouse at coordinate	Holds the right mouse button at the specified coordinates in the IA-Connect Agent user session for the specified amount of seconds.
Right mouse button down	Presses (and does not release) the right mouse button in the IA-Connect Agent user session. To release the mouse, use the right mouse button up action.
Right mouse button up	Releases the right mouse button in the IA-Connect Agent user session.
Right mouse drag between coordinates	Performs a right mouse button drag between the two specified coordinates in the IA-Connect Agent user session.
Run alternative IA-Connect Agent	Runs an alternative IA-Connect Agent (for example a later version) by loading the Agent executable from a file location.
Run alternative IA-Connect Agent sent from director	Runs an alternative IA-Connect Agent (for example a later version) by uploading the alternative Agent from the IA-Connect Director and then loading the alternative Agent executable.
Run generic IA-Connect Agent command	Runs a generic IA-Connect Agent command passing arguments as JSON and returning output data as JSON. Used to run Agent commands when the Director and Inspector are older versions than the Agent and hence don't understand the command.
Run process	Launch a process, command or application.
Send key events	Sends global key press events to the IA-Connect Agent user session.
Send keys	Sends global key presses to the IA-Connect Agent user session.
Send password key events	Sends global key press events to the IA-Connect Agent user session, specifically for entering a password.
Send password keys	Sends global key presses to the IA-Connect Agent user session, specifically for entering a password.
Set clipboard	Sets the content of the clipboard in the IA-Connect Agent user session.
Set default printer	Sets the default printer for the user in the IA-Connect Agent session.
Set IA-Connect Agent command timeout	Sets the command timeout that the IA-Connect Agent will use for each command that is executed.
Set IA-Connect Agent GUI opacity	Sets the opacity of the IA-Connect Agent from 1 (visible) to 0 (transparent).
Set IA-Connect Agent GUI position	Sets the onscreen position of the IA-Connect Agent GUI to the specified location.
Set IA-Connect Agent GUI topmost	Sets the IA-Connect Agent as topmost. This means that the IA-Connect Agent will always be visible on screen and cannot be hidden behind other application windows.
Set IA-Connect Agent log level	Sets the IA-Connect Agent logging level to the specified value (1 being the lowest level and 4 being the highest).
Set IA-Connect Director log level	Sets the IA-Connect Director logging level to the specified value (1 being the lowest level and 4 being the highest).
Set IA-Connect license code	Uploads an old-style (7.0 and 7.1) Agent domain license to the IA-Connect Agent.
Set IA-Connect license key	Licenses the IA-Connect Agent with a license key. This can be a license string or the friendly name of a license held in the IA-Connect Orchestrator.
Set mouse cursor position	Sets the mouse cursor in the IA-Connect Agent user session to the specified position.
Set mouse move method	Sets the current mouse move method to either mouse_event or setcursorpos.
Set mouse multiplier	Sets the mouse multiplier in the IA-Connect Agent user session. This can be useful during development if you encounter issues with remote desktop scaling.
Set owner on file	Sets the owner on a file on the computer where the IA-Connect Agent is running.
Set owner on folder	Sets the owner on a folder on the computer where the IA-Connect Agent is running.
Set screen reader	Enables or disables the screen reader in the IA-Connect Agent user session.
Stop keep session alive	Stops the IA-Connect Agent user session keep alive.
Take screenshot	Takes a screenshot of the IA-Connect Agent user session and returns it as a Base64 encoded string.
Turn mouse wheel	Turns the mouse wheel (positive or negative notches) in the IA-Connect Agent user session.
UnZIP file	Unzips a file which has been compressed using ZIP compression.
Update Orchestrator Flow stats result	Update the result statistics for the current Worker Flow in the IA-Connect Orchestrator. This is used to modify the final result of a Flow stat in the IA-Connect Orchestator which is typically used for reporting purposes. This only works for the current Flow (the Orchestrator detects the Flow run Id). You cannot modify the stats for any other Flow.
Wait for IA-Connect next hop session to connect	Waits for the next hop session to connect and for the IA-Connect Agent to be running in the next hop session.
Wait for IA-Connect session to close by name	Waits for the specified IA-Connect Director session to close. This is the session into which commands to an IA-Connect Agent are sent. The name will be known from an earlier 'Attach' action.
Wiggle mouse	Moves the mouse back and forth by the specified number of coordinates.
Write text file	Creates a text file on the computer where the IA-Connect Agent is running and writes text into the file.
Write to a user credential	Writes a username and password to a credential in the user's profile in the IA-Connect Agent session, creating that credential if it doesn't exist. Credentials can be viewed from the Windows Control Panel.
Write to CSV file	Creates a CSV file on the computer where the IA-Connect Agent is running. The CSV file is created from a collection (table) or from a table in JSON format.

Add file to ZIP

Operation ID:: AddFileToZIP

ZIPs a file (stores the file into a compression archive).

Parameters

Name	Key	Required	Type	Description
Source file path to add to ZIP	SourceFilenameToAddToZIP	True	string	The file path to the file to be added to the zip. This must be accessible from the session where the IA-Connect Agent is running.
Output ZIP file path	OutputZIPFilename	True	string	The file path that the ZIP should be output to. This must be accessible from the session where the IA-Connect Agent is running.
Add filename to folder in ZIP	AddFilenameToFolderInZIP		string	If you want to add the source file to a folder in the ZIP file, enter the folder name here.
Source filename to add to ZIP comment	SourceFilenameToAddToZIPComment		string	An optional comment for this file added to the ZIP.
Compress	Compress		boolean	Should the file be compressed when zipping?
Add to existing ZIP file	AddToExistingZIPFile		boolean	Set to True to add to an existing ZIP file.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Add folder to ZIP

Operation ID:: AddFolderToZIP

ZIPs files in a folder into a ZIP file (stores the files into a compression archive).

Parameters

Name	Key	Required	Type	Description
Source folder to add to ZIP	SourceFolderToAddToZIP	True	string	The path to the folder to be added to the zip. This must be accessible from the session where the IA-Connect Agent is running.
Output ZIP file path	OutputZIPFilename	True	string	The file path that the ZIP should be output to. This must be accessible from the session where the IA-Connect Agent is running.
Add files to folder in ZIP	AddFilesToFolderInZIP		string	If you want to add the source files to a folder in the ZIP file, enter the folder name here.
Compress	Compress		boolean	Should the folder be compressed when zipping?
Add to existing ZIP file	AddToExistingZIPFile		boolean	Set to True to add to an existing ZIP file.
Include subfolders	IncludeSubfolders		boolean	Should subfolders within the source folder also be added to the ZIP?
Include files regular expression	IncludeFilesRegEx		string	An optional regular expression to allow you to specify which files should be extracted. Matches filename only.
Exclude files regular expression	ExcludeFilesRegEx		string	An optional regular expression to allow you to specify which files should be excluded from extraction. Matches filename only.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of files added successfully	FilesAddedSuccessfully	integer	The number of files that were successfully added to the ZIP.
Number of files excluded	FilesExcluded	integer	The number of files that were excluded (if using the 'Exclude files regular expression' input).

Add new Orchestrator automation task

Operation ID:: TasksAddNewTask

Add a new Orchestrator automation task into a queue that can be monitored from a Flow. Tasks can either be ready to run immediately or be deferred to run at a later time.

Parameters

Name	Key	Required	Type	Description
Set automation name	SetAutomationName		string	Select 'Auto' if you want to use the flow name as the task name or select 'Manual' and enter a name in 'Automation name' field to use that name.
Automation name	AutomationName		string	This will only be used if 'Manual' is chosen in the 'Set automation name' field. A friendly name given to help identify the task later or to associate it with a particular flow. Multiple tasks can use the same automation name.
Task input data	TaskInputData		string	Optional data to make available to the task when it starts. You are free to store data in any format, but JSON is a commonly used format.
Process stage	ProcessStage		string	The point at where the automation process / flow should start. This is an optional string value which will be unique to the specific process / flow. This will be used by a condition within the process / flow to decide what step to perform next. For example: If you want the process / flow to start at the 'Exchange' stage, enter the value 'Exchange'.
Priority	Priority		integer	Set the priority level of this automation task (1 being highest level).
SLA in minutes	SLA		integer	Set the amount of minutes required for your SLA. Set this to 0 if you don't have an SLA. By default automation tasks close to the end of the SLA will take priority over other tasks.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Task Id	TaskId	integer	The Id of the Orchestrator automation task that was created.

Add new Orchestrator deferred task

Operation ID:: TasksAddNewDeferral

Add a new Orchestrator deferred task into a queue that can be monitored from a Flow. The task will be deferred to a specified time in the future. Use this action to temporarily suspend a task for a specified amount of time (for example if you are waiting for something).

Parameters

Name	Key	Required	Type	Description
Set automation name	SetAutomationName		string	Select 'Auto' if you want to use the flow name as the task name or select 'Manual' and enter a name in 'Automation name' field to use that name.
Automation name	AutomationName		string	This will only be used if 'Manual' is chosen in the 'Set automation name' field. A friendly name given to help identify the task later or to associate it with a particular flow. Multiple tasks can use the same automation name.
Deferral time in minutes	DeferralTimeInMinutes		integer	How many minutes should the automation task be delayed for.
Deferral stored data	DeferralStoredData		string	Optional data to store with this task. It will become available to the process / flow when it continues from a deferral. This is generally used to store data you have calculated during your process / flow that you need to become available again after deferral. You are free to store data in any format, but JSON is a commonly used format.
Process stage	ProcessStage		string	The point at where the automation process / flow should continue after deferral. This is an optional string value which will be unique to the specific process / flow. This will be used by a condition within the deferred process / flow to decide what step to perform next. For example: If you want the process / flow to continue at the 'Exchange' stage when it continues after deferral, enter the value 'Exchange'.
Priority	Priority		integer	Set the priority level of this task (1 being highest level).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Task Id	TaskId	integer	The Id of the deferral task that was created.

Add permission to file

Operation ID:: AddPermissionToFile

Adds a permission to a file on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
File path	FilePath	True	string	The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.
Identity	Identity	True	string	The identity of the user or group to be assigned the permission. This can be in the form 'username', 'DOMAIN\username' or 'username@domainfqdn'.
Permission	Permission	True	string	Provide the permission to be assigned (Read, ReadAndExecute, Modify or FullControl) or leave blank for the default (Read).
Deny	Deny		boolean	Is the permission being denied?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Add permission to folder

Operation ID:: AddPermissionToFolder

Adds a permission to a folder on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Folder path	FolderPath	True	string	The full path to the folder. This must be accessible from the session where the IA-Connect Agent is running.
Identity	Identity	True	string	The identity (e.g. a user, group or computer) to be assigned the permission. This can be in the form 'username', 'DOMAIN\username' or 'username@domainfqdn'.
Permission	Permission	True	string	Provide the permission to be assigned (Read, ReadAndExecute, Modify or FullControl) or leave blank for the default (Read).
Apply to folder	ApplyToFolder		boolean	Should the permission apply to the folder itself?
Apply to sub-folders	ApplyToSubFolders		boolean	Should the permission propagate to sub-folders?
Apply to files	ApplyToFiles		boolean	Should the permission apply to the files within the folder?
Deny	Deny		boolean	Is the permission being denied?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Attach to IA-Connect session by index

Operation ID:: AttachToIAConnectSessionByIndex

Attaches to the specified IA-Connect Director session by index (e.g. attach to first Citrix ICA session). This is the session into which commands to an IA-Connect Agent are sent.

Parameters

Name	Key	Required	Type	Description
Search IA-Connect session type	SearchIAConnectSessionType		string	The session type to search for, e.g. 'Local Agent', 'Microsoft RDP', 'Citrix ICA' or 'Remote' for any type of remote session. Leave blank to search for any session type.
Search IA-Connect session index	SearchIAConnectSessionIndex		integer	The index of the session to connect to, e.g. 1 for the first matching session type, 2 for second matching session type.
Time to wait in seconds	TimeToWaitInSeconds		integer	If the session with the specified index doesn't exist, how long should IA-Connect wait for it?
Raise exception if timed out	RaiseExceptionIfTimedout		boolean	Should IA-Connect raise an exception if a new session has not connected before the timeout period has elapsed?
Virtual channel must be connected	VirtualChannelMustBeConnected		boolean	Should the IA-Connect Director validate that the virtual channel is connected when attaching to the session? This ensures that the IA-Connect Agent is running in the specified session.
Only count sessions not seen before	OnlyCountSessionsNotSeenBefore		boolean	If set to true then any sessions seen by the previously run 'Get available IA-Connect sessions' action (or the IA-Connect Inspector viewing sessions) will not be counted in the index. This allows only 'new' sessions to be counted (e.g. attach to the first new Citrix session).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Attached IA-Connect session name	AttachedIAConnectSessionName	string	The name of the IA-Connect session that was attached to.
Attached to session	AttachedToSession	boolean	Returns true if IA-Connect has attached to a session, or false if not.

Attach to IA-Connect session by name

Operation ID:: AttachToIAConnectSessionByName

Attaches to the specified IA-Connect Director session by name. This is the session into which commands to an IA-Connect Agent are sent.

Parameters

Name	Key	Required	Type	Description
IA-Connect session name	IAConnectSessionName	True	string	The name of the IA-Connect session to connect to.
Virtual channel must be connected	VirtualChannelMustBeConnected		boolean	Should the IA-Connect Director validate that the virtual channel is connected when attaching to the session? This ensures that the IA-Connect Agent is running in the specified session.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Attach to most recent IA-Connect session

Operation ID:: AttachToMostRecentIAConnectSession

Attaches to the IA-Connect Director session which most recently connected (optionally of a specified type). This is the session into which commands to an IA-Connect Agent are sent.

Parameters

Name	Key	Required	Type	Description
Search IA-Connect session type	SearchIAConnectSessionType		string	The session type to search for, e.g. 'Local Agent', 'Microsoft RDP', 'Citrix ICA' or 'Remote' for any type of remote session. Leave blank to search for any session type.
Time to wait in seconds	TimeToWaitInSeconds		integer	If there is no session of the specified type (if a specific type was specified), how long should IA-Connect wait for it?
Raise exception if timed out	RaiseExceptionIfTimedout		boolean	Should IA-Connect raise an exception if a new session has not connected before the timeout period has elapsed?
Virtual channel must be connected	VirtualChannelMustBeConnected		boolean	Should the IA-Connect Director validate that the virtual channel is connected when attaching to the session? This ensures that the IA-Connect Agent is running in the specified session.
Only count sessions not seen before	OnlyCountSessionsNotSeenBefore		boolean	If set to true then any sessions seen by the previously run 'Get available IA-Connect sessions' action (or the IA-Connect Inspector viewing sessions) will not be counted in the index. This allows only 'new' sessions to be counted (e.g. attach to the first new Citrix session).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Attached IA-Connect session name	AttachedIAConnectSessionName	string	The name of the IA-Connect session that was attached to.
Attached to session	AttachedToSession	boolean	Returns true if IA-Connect has attached to a session, or false if not.

Attach to tier 1 IA-Connect session

Operation ID:: AttachToTier1IAConnectSession

Attaches to the IA-Connect Director session of the Director receiving the SOAP and / or REST messages. This is the session into which commands to an IA-Connect Agent are sent.

Parameters

Name	Key	Required	Type	Description
Virtual channel must be connected	VirtualChannelMustBeConnected		boolean	Should the IA-Connect Director validate that the virtual channel is connected when attaching to the session? This ensures that the IA-Connect Agent is running in the specified session.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Attached tier 1 IA-Connect session name	AttachedTier1IAConnectSessionName	string	The name of the tier 1 IA-Connect session that was connected to.

Break folder security inheritance

Operation ID:: BreakFolderSecurityInheritance

Breaks security inheritance on a folder on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Folder path	FolderPath	True	string	The full path to the folder. This must be accessible from the session where the IA-Connect Agent is running.
Convert inherited to explicit	ConvertInheritedToExplicit		boolean	Should any currently inherited permissions be converted to explicit permissions?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Bring IA-Connect Agent GUI to front

Operation ID:: BringRSAGUIToFront

Brings the IA-Connect Agent GUI to the front so it is visible onscreen.

Parameters

Name	Key	Required	Type	Description
Focus	Focus		boolean	Should the IA-Connect Agent GUI be focussed?
Global left mouse click	GlobalLeftMouseClick		boolean	Should a global left mouse click be used to bring the Agent to the front? This guarantees a bring to the front event in a scenario where the focus method could be restricted by the operating system preventing applications from bringing themselves to the front.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Calibrate mouse_event

Operation ID:: CalibrateMouseEvent

Calibrates the mouse_event method by moving the mouse by the specified number of pixels and then reading the new mouse position.

Parameters

Name	Key	Required	Type	Description
Calibration size in pixels	CalibrationSizeInPixels		integer	The number of pixels that the mouse will be moved in order to calibrate. The lower the value, the less accurate the calibration will be.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Mouse X multiplier	MouseXMultiplier	double	The mouse X multiplier value. A value of 1.0 indicates no multiplier.
Mouse Y multiplier	MouseYMultiplier	double	The mouse Y multiplier value. A value of 1.0 indicates no multiplier.

Change Orchestrator automation task status

Operation ID:: TasksChangeTaskStatus

Changes the selected Orchestrator automation task status to completed, failed or new.

Parameters

Name	Key	Required	Type	Description
Task Id	TaskId	True	integer	The Id of the Orchestrator task to be modified.
Automation task new status	AutomationTaskStatus		string	The new task status for the specified automation task.
Put task on hold	TaskOnHold		boolean	If changing the status to new and you set this value to true, the task will be put on hold.
Erase task input data	EraseTaskInputData		boolean	If you set this value to true, any task input data will be erased. This is typically used to save storage space for a completed or failed task since the raw data is no longer required.
Erase deferral stored data	EraseDeferralStoredData		boolean	If you set this value to true, any deferral stored data will be erased. This is typically used to save storage space for a completed or failed task since the raw data is no longer required.

Returns

Name	Path	Type	Description
Command result	TasksChangeTaskStatusResult	boolean	The result of the command (success or failure).
Error message	ErrorMessage	string	If the command was not successful, this will contain the error message that was returned.

Clear clipboard

Operation ID:: ClearClipboard

Clears the contents of the clipboard in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Close IA-Connect Agent

Operation ID:: CloseRSAServer

Closes the IA-Connect Agent. This does not affect the user session where the IA-Connect Agent was running.

Parameters

Name	Key	Required	Type	Description
Seconds to wait	SecondsToWait		integer	The time to wait before issuing the close command so that the IA-Connect Agent can report completion of the command.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Configure next hop IA-Connect Director

Operation ID:: ConfigureNextHopDirector

Configure the next-hop Director in a double-hop scenario. This is only required if the default IA-Connect next-hop Director settings are not suitable.

Parameters

Name	Key	Required	Type	Description
SOAP enabled	SOAPEnabled		boolean	Should the SOAP interface be enabled on the next-hop Director?
REST enabled	RESTEnabled		boolean	Should the REST interface be enabled on the next-hop Director?
Web server enabled	WebServerEnabled		boolean	Should the web server (for hosting the IA-Connect Inspector) be enabled on the next-hop Director?
Director is localhost only	DirectorIsLocalhostOnly		boolean	Should the Director SOAP and REST interfaces only listen on 'localhost'? This should be set to true since no other computer should need to communicate with these interfaces.
SOAP TCP port	SOAPTCPPort		integer	If the SOAP interface were enabled, what TCP port should it run on (defaults to 8002)?
REST TCP port	RESTTCPPort		integer	If the REST interface were enabled, what TCP port should it run on (defaults to 8002)?
SOAP uses HTTPS	SOAPUsesHTTPS		boolean	Is the SOAP interface using HTTPS (instead of HTTP)? If set to True then a certificate is required on the first-hop computer to facilitate HTTPS. This can be shared with the certificate used for REST.
REST uses HTTPS	RESTUsesHTTPS		boolean	Is the REST interface using HTTPS (instead of HTTP)? If set to True then a certificate is required on the first-hop computer to facilitate HTTPS. This can be shared with the certificate used for SOAP.
Increment Director TCP port by SessionId	IncrementDirectorTCPPortBySessionId		boolean	To ensure the Director TCP port is unique (if there are multiple parallel sessions using double-hop from the same first-hop host), the first-hop Session Id can be added to the Director TCP port. This is only required if either SOAP or REST is enabled on the first-hop Director and these are typically not enabled because named pipes are used by default.
SOAP uses user authentication	SOAPUsesUserAuthentication		boolean	Set to True if you want the HTTP SOAP TCP port to use user authentication. Refer to the IA-Connect Installation Guide for information on how to set this up.
REST uses user authentication	RESTUsesUserAuthentication		boolean	Set to True if you want the HTTP REST TCP port to use user authentication. Refer to the IA-Connect Installation Guide for information on how to set this up.
Command named pipe enabled	CommandNamedPipeEnabled		boolean	Should the first-hop Agent use named pipes to communicate with the first-hop Director? This is the default communication method.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Copy file

Operation ID:: CopyFile

Copies a file on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Source file path	SourceFilePath	True	string	The full path to the source file. This must be accessible from the session where the IA-Connect Agent is running.
Destination file path	DestFilePath	True	string	The full path to the destination where the file should be copied to. This must be accessible from the session where the IA-Connect Agent is running.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Copy file from client to server

Operation ID:: CopyFileFromClientToServer

Copies a file from the local computer (running the IA-Connect Director) to the remote computer (running the IA-Connect Agent).

Parameters

Name	Key	Required	Type	Description
Client file path	ClientFilePath	True	string	The file path to copy the file from (on the local computer running the IA-Connect Director).
Server file path	ServerFilePath	True	string	The file path to copy the file into (on the computer running the IA-Connect Agent).
Compress	Compress		boolean	Should the file be compressed when copying?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Copy file to clipboard

Operation ID:: CopyFileToClipboard

Copies the specified local file to the clipboard in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
File name	Filepath	True	string	The file path to the local file to be copied to the clipboard.
Cut	Cut		boolean	If set to true then the file will be cut instead of copied.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	CopyFileToClipboardResult	boolean	The result of the command (success or failure).
Error message	ErrorMessage	string	If the command was not successful, this will contain the error message that was returned.

Create directory

Operation ID:: CreateDirectory

Creates a directory (folder) on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Directory path	DirectoryPath	True	string	The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.
Error if already exists	ErrorIfAlreadyExists		boolean	Should IA-Connect raise an error if the directory (folder) already exists?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Create Remote Desktop Session (RDS) launch file

Operation ID:: GenerateRDPFile

Create a Remote Desktop Session (RDS) launch file which can be used to automatically launch a Remote Desktop Session using specified parameters, instead of requiring automation of the Remote Desktop client UI. A RDS launch file has the extension '.rdp' and is often called a RDP file.

Parameters

Name	Key	Required	Type	Description
Remote address	RemoteAddress	True	string	The address of the remote system to connect to. This could be an IP address, hostname or Fully Qualified Domain Name (FQDN).
Output folder path	OutputFolderPath	True	string	The folder in which to save the RDP file.
RDP filename	RDPFileName	True	string	The name of the RDP file which will be created in the output folder path.
Overwrite RDP file if already exists	OverwriteRDPFileIfAlreadyExists		boolean	Set to true to automatically overwrite any RDP file with the same folder / filename. Set to false if a new RDP file should not be created if an existing RDP file with the same folder / filename already exists.
Trust remote computer	TrustRemoteComputer		boolean	Set to true to mark the remote address as trusted (in the Windows registry), mainly for device redirection purposes, eliminating a popup you might receive when launching the RDP file.
Store credentials	StoreCredentials		boolean	Set to true to create a user credential to hold the Remote Desktop authentication details. This can allow you to connect to the Remote Desktop system without being prompted for authentication.
UserName	UserName		string	If storing a credential to hold the Remote Desktop authentication details, this allows you to specify the username to store in the credential.
Password	Password		string	If storing a credential to hold the Remote Desktop authentication details, this allows you to specify the password to store in the credential.
Credential type	CredentialType		string	If storing a credential to hold the Remote Desktop authentication details, the allows you to specify the credential type: Windows or Generic. For saving a RDP credential, you would typically create a Windows credential.
Credential persistence	CredentialPersistence		string	If storing a credential to hold the Remote Desktop authentication details, this alows you to specify the credential persistence: Session (lasts just for this login session), LocalMachine (persists for this user across sessions and reboots on this computer only) or Enterprise (could roam for this across between machines). The default when creating RDP files is 'Session'.
Redirect printers	RedirectPrinters		boolean	Should printers in the local session be mapped into the remote desktop session? This setting might be enforced at the remote end and hence not take effect.
Redirect all drives	RedirectAllDrives		boolean	Should all drive letters (e.g. C:) in the local session be mapped into the remote desktop session? This setting might be enforced at the remote end and hence not take effect.
Redirect clipboard	RedirectClipboard		boolean	Should the clipboard be shared between the local and remote system, allowing copy and paste between the two systems? This setting might be enforced at the remote end and hence not take effect.
Fullscreen	Fullscreen		boolean	Should the remote desktop session be fullscreen.
Desktop width	DesktopWidth		integer	The width of the remote desktop session in pixels if the remote desktop session is not fullscreen.
Desktop height	DesktopHeight		integer	The height of the remote desktop session in pixels if the remote desktop session is not fullscreen.
Use multi monitor	UseMultiMonitor		boolean	Set to false if a fullscreen remote desktop session should only use a single monitor. Set to true if a fullscreen remote desktop session should use all monitors. Has no effect on a single-monitor system (and hence most virtual machines).
Session colour depth	SessionBPP		integer	The colour depth of the remote desktop session in bits per pixel (BPP). A higher number results in more colours. Supported values are 15, 16, 24, 32.
Smart sizing	SmartSizing		boolean	Set to true for the local computer to automatically scale the contents of the remote session to fit the windows size. Set to false to not automatically scale.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
RDP file path	RDPFilePath	string	The full path of the generated RDP file.

Defer existing Orchestrator automation task

Operation ID:: TasksDeferExistingTask

Defer an existing Orchestrator task which is already in the queue. The task will be deferred to a specified time in the future. This is commonly used to re-defer an existing task (i.e. the task was previously deferred and now needs to be deferred again). Use this action to temporarily suspend a task for a specified amount of time (for example if you are waiting for something).

Parameters

Name	Key	Required	Type	Description
Task Id	TaskId	True	integer	The Id of the existing Orchestrator automation task to defer (or defer again).
Deferral time in minutes	DeferralTimeInMinutes		integer	How many minutes should the automation task be delayed for.
Deferral stored data	DeferralStoredData		string	Optional data to store with this task. It will become available to the process / flow when it continues from a deferral. This is generally used to store data you have calculated during your process / flow that you need to become available again after deferral. You are free to store data in any format, but JSON is a commonly used format.
Process stage	ProcessStage		string	The point at where the automation process / flow should continue after deferral. This is an optional string value which will be unique to the specific process / flow. This will be used by a condition within the deferred process / flow to decide what step to perform next. For example: If you want the process / flow to continue at the 'Exchange' stage when it continues after deferral, enter the value 'Exchange'.
Priority	Priority		integer	Set the priority level of this task (1 being highest level).

Returns

Name	Path	Type	Description
Command result	TasksDeferExistingTaskResult	boolean	The result of the command (success or failure).
Error message	ErrorMessage	string	If the command was not successful, this will contain the error message that was returned.

Delete directory

Operation ID:: DeleteDirectory

Deletes a directory (folder) on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Directory path	DirectoryPath	True	string	The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.
Recursive	Recursive		boolean	Should subdirectories (subfolders) and files in the directory also be deleted?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Delete file

Operation ID:: DeleteFile

Deletes a file on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
File path	Filename	True	string	The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Delete files

Operation ID:: DeleteFiles

Deletes files within a specified folder matching a pattern on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Directory path	DirectoryPath	True	string	The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.
Pattern	Pattern		string	A pattern to match against files to be deleted, for example . for all files or *.txt for files with a .txt extension.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of files deleted	NumberOfFilesDeleted	integer	The number of files that were deleted successfully.
Number of files failed to delete	NumberOfFilesFailedToDelete	integer	The number of files that could not be deleted.

Delete Orchestrator automation task

Operation ID:: TasksDeleteTask

Delete an Orchestrator automation task that has been deferred.

Parameters

Name	Key	Required	Type	Description
Task Id	TaskId	True	integer	The Id of the Orchestrator automation task to delete.

Returns

Name	Path	Type	Description
Command result	TasksDeleteTaskResult	boolean	The result of the command (success or failure).
Error message	ErrorMessage	string	If the command was not successful, this will contain the error message that was returned.

Deletes a user credential

Operation ID:: CredentialDelete

Deletes a credential in the user's profile in the IA-Connect Agent session. Credentials can be viewed from the Windows Control Panel.

Parameters

Name	Key	Required	Type	Description
Credential address	CredentialAddress	True	string	The name / address of the credential.
Credential type	CredentialType	True	string	The credential type: Windows or Generic.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	CredentialDeleteResult	boolean	The result of the command (success or failure).
Error message	ErrorMessage	string	If the command was not successful, this will contain the error message that was returned.

Disable IA-Connect next hop

Operation ID:: DisableNextHop

Disables next-hop so that all future commands will be processed by the Agent which receives them (as opposed to being forwarded on to the next hop Agent).

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Disconnect remote session

Operation ID:: DisconnectSession

Disconnects the remote session where the IA-Connect Agent is running. This is not the same as logging off and will leave the remote session running in a disconnected state. This action can be used where you wish to connect back to the remote session later and continue from the same state, rather than starting a new session.

Parameters

Name	Key	Required	Type	Description
Seconds to wait	SecondsToWait		integer	The time to wait before issuing the disconnect command to the operating system so that the IA-Connect Agent can report completion of the command.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Does directory exist

Operation ID:: DirectoryExists

Reports true or false as to whether a directory (folder) exists on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Directory path	DirectoryPath	True	string	The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Directory exists	DirectoryExists	boolean	Returns true if the directory (folder) exists, or false if not.

Does file exist

Operation ID:: FileExists

Reports true or false as to whether a file exists on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
File path	Filename	True	string	The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
File exists	FileExists	boolean	Returns true if the file exists, or false if not.

Does IA-Connect session exist by name

Operation ID:: DoesIAConnectSessionExistByName

Returns if the specified IA-Connect Director session exists. This is the session into which commands to an IA-Connect Agent are sent. The name will be known from an earlier 'Attach' action.

Parameters

Name	Key	Required	Type	Description
IA-Connect session name	IAConnectSessionName	True	string	The name of the IA-Connect session to check.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
IA-Connect session exists	IAConnectSessionExists	boolean	Returns true if a session with the specified name exists, or false if not.

Double left click mouse

Operation ID:: DoubleLeftClickMouse

Double clicks the left mouse button in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Delay in milliseconds	DelayInMilliseconds		integer	The delay between each click, in milliseconds.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Double left click mouse at coordinate

Operation ID:: DoubleLeftClickMouseAtCoordinate

Double clicks the left mouse button in the IA-Connect Agent user session at the specified coordinates.

Parameters

Name	Key	Required	Type	Description
X pixels	XCoord	True	integer	The X coordinate value (in pixels).
Y pixels	YCoord	True	integer	The Y coordinate value (in pixels).
Delay in milliseconds	DelayInMilliseconds		integer	The delay between each click, in milliseconds.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Download HTTP file

Operation ID:: DownloadHTTPFile

Downloads a file to the computer where the IA-Connect Agent is running using HTTP(S).

Parameters

Name	Key	Required	Type	Description
Download URL	DownloadURL	True	string	The HTTP or HTTPS download URL.
Save file path	SaveFilename		string	The full path to the save filename. If this field is blank and you have specified 'Return contents as string' as True then the file will not be saved to the computer.
Overwrite existing file	OverwriteExistingFile		boolean	If a file already exists with the name specified in the 'Save file path' input, should it be overwritten?
Passthrough authentication	PassthroughAuthentication		boolean	Should the user's credentials be passed on to the web server? This would typically only be used for internal Intranet sites.
User Agent	UserAgent		string	This allows you to set the User Agent reported to the web page. Typically this is not required and should only be changed if a webpage requires a particular Agent String.
Accept	Accept		string	This parameter specifies which content types are supported. This should only be changed if the content you are downloading requires a different content type.
Support TLS10	SupportTLS10		boolean	Set to True to support TLS 1.0 encryption protocol.
Support TLS11	SupportTLS11		boolean	Set to True to support TLS 1.1 encryption protocol.
Support TLS12	SupportTLS12		boolean	Set to True to support TLS 1.2 encryption protocol.
Auto decompress deflate	AutoDecompressDeflate		boolean	Some web content is returned compressed using 'deflate' compression. Setting this value to True informs the web server that 'deflate' is supported and, if the content is sent using this compression, it will automatically be decompressed.
Auto decompress GZip	AutoDecompressGZIP		boolean	Some web content is returned compressed using 'GZIP' compression. Setting this value to True informs the web server that 'GZIP' is supported and, if the content is sent using this compression, it will automatically be decompressed.
Return contents as string	ReturnContentsAsString		boolean	Should the file contents be returned as a string?
Return content encoding	ReturnContentEncoding		string	The encoding of the downloaded content. This is only used if 'Return contents as string' is True and it defines the encoding of the downloaded content so it can be interpreted correctly.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Download file contents	DownloadFileContents	string	The contents of the downloaded file.

Enable folder security inheritance

Operation ID:: EnableFolderSecurityInheritance

Enables security inheritance on a folder on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Folder path	FolderPath	True	string	The full path to the folder. This must be accessible from the session where the IA-Connect Agent is running.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Enable IA-Connect next hop

Operation ID:: EnableNextHop

Enables the next hop which will forward all future commands received onto the IA-Connect Agent running in the next hop session.

Parameters

Name	Key	Required	Type	Description
Next hop Director address	NextHopDirectorAddress		string	The optional address for the Next hop IA-Connect Director to forward commands to if none of the 'Next hop Director address is localhost', 'Next hop Director address is hostname', 'Next hop Director address is FQDN' or 'Next hop Director address is named pipe' parameters are set to true.
Next hop Director TCP port	NextHopDirectorTCPPort		integer	The TCP port that the next hop Director is listening on (the Director on the computer that the Agent is running on).
Next hop Director uses HTTPS	NextHopDirectorUsesHTTPS		boolean	Set to True if the next hop Director is using HTTPS, or false if not.
Next hop Director address is localhost	NextHopDirectorAddressIsLocalhostname		boolean	The next hop director address (relative to the Agent) is 'localhost'.
Next hop Director address is hostname	NextHopDirectorAddressIsHostname		boolean	The next hop director address is the hostname of the computer running the Agent (i.e. the one running the Agent and the Director).
Next hop Director address is FQDN	NextHopDirectorAddressIsFQDN		boolean	The next hop director address is the fully qualified domain name (FQDN) of the computer running the Agent (i.e. the one running the Agent and the Director).
Next hop Director address is named pipe	NextHopDirectorAddressIsNamedPipe		boolean	The next hop director address (relative to the Agent) is using a named pipe instead of a TCP/IP web service. This is the default to avoid using TCP/IP ports on the first-hop.
Increment next hop Director TCP port by Session Id	IncrementNextHopDirectorTCPPortBySessionId		boolean	To ensure the next hop Director TCP port is unique (if there are multiple parallel sessions using next-hop from the same host), the Session Id can be added to the Next hop Director TCP port.
Disable before enabling	DisableBeforeEnable		boolean	Should double-hop be disabled (if currently active) before enabling again? If set to true (the default), any new double-hop enablement instructions will replace the previous ones. If set to false, this will enable triple-hop since the instructions will be received by the double-hop IA-Connect Agent.
Check next hop Director is running	CheckNextHopDirectorIsRunning		boolean	Next hop requires a running IA-Connect Director on the same computer as the Agent. If this setting is true, the Agent will check the next-hop Director is running as described and will fail to enable next hop if the next hop Director is not running. If this setting is false, the Agent will not perform any checks and simply enable next-hop.
Check next hop Agent is running	CheckNextHopAgentIsRunning		boolean	Next hop requires a running IA-Connect Director on the same computer as the Agent AND a running IA-Connect Agent in the next-hop session. If this setting is true, the Agent will check the next-hop Agent is running as described and will fail to enable next hop if the next hop Agent is not running. If this setting is false, the Agent will not perform any checks and simply enable next-hop.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Active next hop Director address	ActiveNextHopDirectorAddress	string	The address of the active next hop Director, if one is being used.
Active next hop Director TCP port	ActiveNextHopDirectorTCPPort	integer	The TCP port of the active next hop Director, if one is being used.
Active next hop Director uses HTTPS	ActiveNextHopDirectorUsesHTTPS	boolean	Returns true if the active next hop Director is using HTTPS.
Active next hop Director URL	ActiveNextHopDirectorURL	string	The URL of the active next hop Director.

Expand environment variable

Operation ID:: ExpandEnvironmentVariable

Expands a string containing environment variables (e.g. %USERPROFILE% or %TEMP%) in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Input string	InputString	True	string	The input string containing environment variables.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Output string	OutputString	string	The string with any environment variables expanded.

Expand password string

Operation ID:: ExpandPasswordString

Accepts an input string which contains references to IA-Connect stored passwords and returns that string with the references replaced by the stored passwords.

Parameters

Name	Key	Required	Type	Description
Input string	InputString		string	The input string which contains IA-Connect stored password identifiers. For example: 'Welcome new starter, your new account password is {IAConnectPassword:GeneratedPassword}' where 'GeneratedPassword' is the name of a stored IA-Connect password.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Output string	OutputString	string	The output string which contains the input string with password identifiers replaced by the actual passwords. For example: 'Welcome new starter, your new account password is Fantastic12Monkeys!'.

Generate password

Operation ID:: GeneratePassword

Generates a password containing dictionary words, numbers, symbols, characters as defined in a template format.

Parameters

Name	Key	Required	Type	Description
Password format	PasswordFormat	True	string	The format of the generated password. The symbol 'w' represents a dictionary word, 'n' represents a number, 's' represents a symbol, 'l' represents a lower-case letter, 'L' represents an upper-case letter. For example wnnws might generate Pluto35Marmite!
Minimum length	MinimumLength		integer	The minimum length of the generated password. If the generated password is too short, additional dictionary words will be added until the length is met.
Return as plain text	ReturnAsPlainText		boolean	Set to true to return the password as plain text.
Store password as identifier	StorePasswordAsIdentifier		string	If an identifier is supplied, this password will be stored encrypted inside the Agent for later retrieval / usage by any commands which can make use of stored credentials. These passwords are only stored in memory and are lost when the Agent is closed. For example: MyExchangePassword.
Supported symbols	SupportedSymbols		string	Allows you to provide a list of symbols to be randomly used when the symbol 's' is used in the format of a generated password. If not specifed, a built-in list is used. For example: !$()*.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Plain text password	PlainTextPassword	string	The password in plain text if requested. The password might be requested in plain text because the password is a one-time password intended to be transmitted via SMS or email (for example) and hence needs to be seen as-is.

Get all IA-Connect command statistics

Operation ID:: GetAllCommandStats

Returns all currently stored statistics on which commands the IA-Connect Agent has executed in the current session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command statistics JSON	CommandStatsJSON	string	The list of commands executed by the IA-Connect Agent in the current session, in JSON format. This list will contain the name of each action and the number of times that it was executed.

Get all Orchestrator automation tasks

Operation ID:: TasksGetAllTasks

Retrieves all the Orchestrator automation tasks that match the filters.

Parameters

Name	Key	Type	Description
Automation name filter	AutomationName	string	Leave blank to return Orchestrator automation tasks with any name. Enter a value to only retrieve tasks with this automation name.
Automation task status filter	AutomationTaskStatus	string	Filter the automation by the specified automation task status. Leave the field blank to return all automation task statuses.
Minutes until deferral date	MinutesUntilDeferralDate	integer	Only return Orchestrator automation tasks that are ready to run within the specified number of minutes. Set to 0 if you only want automation tasks that are ready to run now. Leave blank if you want to retrieve tasks regardless of deferral.
Minimum priority level	MinimumPriorityLevel	integer	Only return Orchestrator automation tasks that have the specifed priority level or higher. For example: Setting 2 will return tasks with a priority level of 1 and 2.
Sort by deferral date	SortByDeferralDate	boolean	Set to true to return the data sorted by the deferral date and time. Set to false to have the data returned in the order is it stored.

Returns

Name	Path	Type	Description
Automation Tasks	AutomationTasks	array of object	A table containing all the Orchestrator automation tasks that meet the given search criteria.
items	AutomationTasks	object
Number of automation tasks	NumberOfAutomationTasks	integer	The number of automation tasks returned.

Get available IA-Connect Sessions

Operation ID:: GetAvailableIAConnectSessions

Retrieves a list of IA-Connect Director sessions (available connections to sessions where the IA-Connect Agent is running, such as local, Microsoft RDP or Citrix ICA).

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
IA-Connect sessions JSON	IAConnectSessionsJSON	string	A list of all IA-Connect sessions, formatted as JSON.
Number of IA-Connect sessions	NumberOfIAConnectSessions	integer	The total number of IA-Connect sessions that are open.
Number of local IA-Connect sessions	NumberOfLocalIAConnectSessions	integer	The number of local IA-Connect sessions that are open.
Number of Citrix ICA IA-Connect sessions	NumberOfCitrixICAIAConnectSessions	integer	The number of Citrix ICA IA-Connect sessions that are open.
Number of Microsoft RDP IA-Connect sessions	NumberOfMicrosoftRDPIAConnectSessions	integer	The number of Microsoft RDP IA-Connect sessions that are open.

Get client hostname

Operation ID:: GetRemoteSessionClientHostname

Returns the hostname of the client where the IA-Connect Director is running.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Client hostname	ClientHostname	string	The hostname of the client where the IA-Connect Director is running.

Get clipboard

Operation ID:: GetClipboardData

Gets the current content of the clipboard in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Clipboard data	ClipboardData	string	The data contained within the clipboard.

Get CSV text as collection

Operation ID:: GetCSVTextAsCollection

Returns a CSV file on the computer where the IA-Connect Agent is running as a collection (table). Only requires read only access to CSV file.

Parameters

Name	Key	Required	Type	Description
CSV file path	CSVFilePath	True	string	The full path to the CSV file. This must be accessible from the session where the IA-Connect Agent is running.
First line is header	FirstLineIsHeader		boolean	Is the first line in the CSV file a header row?
Trim headers	TrimHeaders		boolean	Should the headers be trimmed to remove any leading or trailing whitespace?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
CSV data JSON	CSVDataJSON	string	The contents of the CSV file, in JSON format.

Get current mouse coordinate

Operation ID:: GetCursorPos

Gets the current mouse cursor position in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
X pixels	X	integer	The X coordinate value (in pixels).
Y pixels	Y	integer	The Y coordinate value (in pixels).

Get default printer

Operation ID:: GetDefaultPrinter

Gets the name of the default printer for the user in the IA-Connect Agent session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Default printer name	DefaultPrinterName	string	The name of the default printer for the user.

Get disk free space

Operation ID:: GetDiskFreeSpace

Returns the amount of free space for a specified disk on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Drive letter	DriveLetter	True	string	The drive letter of the disk to check.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Disk free space bytes	FreeSpaceBytes	integer	The amount of free disk space, in bytes.
Disk free space KB	FreeSpaceKB	integer	The amount of free disk space, in kilobytes.
Disk free space MB	FreeSpaceMB	integer	The amount of free disk space, in megabytes.
Disk free space GB	FreeSpaceGB	integer	The amount of free disk space, in gigabytes.

Get environment info

Operation ID:: GetEnvironmentInfo

Returns information about the environment in which the IA-Connect Agent user session is running.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
OS major version	OSVersionMajor	integer	The operating system major version.
OS minor version	OSVersionMinor	integer	The operating system minor version.
OS build version	OSVersionBuild	integer	The operating system build version.
OS is 64bit	OSIs64Bit	boolean	Returns true if the operating system is 64bit.
Processor count	ProcessorCount	integer	The processor count.
Total physical RAM in MB	TotalPhysicalRAMInMB	integer	The amount of physical RAM (in MB).
Total virtual RAM in MB	TotalVirtualRAMInMB	integer	The amount of virtual RAM (in MB).
Available physical RAM in MB	AvailablePhysicalRAMInMB	integer	The amount of physical RAM that is currently available (in MB).
Available virtual RAM in MB	AvailableVirtualRAMInMB	integer	The amount of virtual RAM that is currently available (in MB).
OS full name	OSFullName	string	The operating system full name, e.g. Microsoft Windows Server 2019 Standard.
Installed UI culture name	InstalledUICultureName	string	The user interface language installed with the operating system, e.g. en-US.
Current UI culture name	CurrentUICultureName	string	The default user interface language, e.g. en-US.
Current culture name	CurrentCultureName	string	The default user locale, e.g. en-GB.

Get file security permissions

Operation ID:: GetFileSecurityPermissions

Returns a list of permissions currently set on a file on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
File path	FilePath	True	string	The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Security permissions JSON	SecurityPermissionsJSON	string	The permissions currently set on the specified file, in JSON format.

Get file size

Operation ID:: GetFileSize

Returns the size (in bytes) of a file on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
File path	Filename	True	string	The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
File size	FileSize	integer	The size of the file, in bytes.

Get files

Operation ID:: GetFiles

Returns a list of files in a folder (matching a CSV list of patterns) on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Directory path	DirectoryPath	True	string	The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.
Patterns CSV	PatternsCSV	True	string	A comma separated list of file patterns to match, for example . for all files or '.txt,.docx' for files with either a .txt or .docx extension.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Files JSON	FilesJSON	string	A list of files contained within the folder, in JSON format.
Number of files read successfully	NumberOfFilesReadSuccessfully	integer	The number of files that were read successfully.
Number of files failed to read	NumberOfFilesFailedToRead	integer	The number of files that could not be read.

Get folder security permissions

Operation ID:: GetFolderSecurityPermissions

Returns a list of permissions currently set on a folder on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Folder path	FolderPath	True	string	The full path to the folder. This must be accessible from the session where the IA-Connect Agent is running.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Security permissions JSON	SecurityPermissionsJSON	string	The permissions currently set on the specified folder, in JSON format.

Get folders

Operation ID:: GetFolders

Returns all sub-folders within a specified folder on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Directory path	DirectoryPath	True	string	The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Folders JSON	FoldersJSON	string	A list of subfolders contained within the folder, in JSON format.
Number of folders read successfully	NumberOfFoldersReadSuccessfully	integer	The number of subfolders that were read successfully.
Number of folders failed to read	NumberOfFoldersFailedToRead	integer	The number of subfolders that could not be read.

Get IA-Connect Agent current license state

Operation ID:: GetLicenseState

Returns whether the IA-Connect Agent is currently licensed and if licensed, the properties of the license.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Is licensed	IsLicensed	boolean	Returns true if the IA-Connect Agent is currently licensed, or false if not.
License type	LicenseType	string	The type of IA-Connect license being used.
Agent domain name	CustomerNETBIOSDomainName	string	The NetBIOS domain name of the machine where the IA-Connect Agent is running, if licensed by domain name (IA-Connect 7.0 or 7.1).
Director hostnames	DirectorHostnameCSV	string	The hostname(s) of the machines where the IA-Connect Director can be installed, if licensed by hostname (post IA-Connect 7.2).
Customer display name	CustomerDisplayName	string	The customer name to be displayed in the title bar of the IA-Connect Agent.
Vendor name	VendorName	string	The IA-Connect vendor name.
License expiry date	LicenseExpiryDate	string	The expiry date of the IA-Connect license.
Days until license expires	DaysUntilLicenseExpires	integer	The number of remaining days until the IA-Connect license expires.
License features	LicenseFeatures	string	Additional license features, typically providing access to additional functionality.
Is JML license	IsJMLLicense	boolean	Does this license provide access to JML functionality.

Get IA-Connect Agent info

Operation ID:: GetIAConnectAgentInfo

Returns the properties of the IA-Connect Agent, including the version number and the path to the Agent executable.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
IA-Connect Agent version	IAConnectAgentVersion	string	The full version number of the IA-Connect Agent.
DotNet CLR version	DotNetCLRVersion	string	The DotNet Common Language Runtime (CLR) version.
IA-Connect Agent run as username	IAConnectAgentRunAsUsername	string	The username of the user session that the IA-Connect Agent is running in.
IA-Connect Agent run as userdomain	IAConnectAgentRunAsUserdomain	string	The user domain of the user session that the IA-Connect Agent is running in.
IA-Connect Agent path	IAConnectAgentPath	string	The full path to the IA-Connect Agent executable.
IA-Connect Agent is 64bit process	IAConnectAgentIs64bitProcess	boolean	Returns true if the IA-Connect Agent is a 64bit process, or false if not.
IA-Connect Agent release version	IAConnectAgentReleaseVersion	string	The IA-Connect Agent release version, for example 8.0.

Get IA-Connect Agent log

Operation ID:: GetIAConnectAgentLog

Returns the current IA-Connect Agent log, either as a file or by reading the contents and returning it in an output variable.

Parameters

Name	Key	Required	Type	Description
Save log to file	SaveLogToFile		boolean	Should the IA-Connect Agent log be saved as a file?
Local save folder	LocalSaveFolder		string	The filepath to the folder to save the IA-Connect Agent log into.
Use Agent log filename	UseAgentLogFilename		boolean	Should the log file be given the same name as the name of the log file on the Agent? If set to false then you can set 'Local save filename' to specify the filename.
Local save filename	LocalSaveFilename		string	The filename only of the local save file for the IA-Connect Agent log. This will only be used if 'Use Agent log filename' is set to false.
Place log content in data item	PlaceLogContentInDataItem		boolean	Should the contents of the log be returned in an output variable?
Compress	Compress		boolean	Should the alternative IA-Connect Agent executable be compressed during the upload?
Max bytes to read	MaxBytesToRead		integer	The maximum number of bytes to read from the Agent log (from the end backwards). This can be set to 0 or -1 to retrieve the entire log.
Return last command logs only	ReturnLastCommandOnly		boolean	Should the IA-Connect Agent log be restricted to the result of the last command rather than the entire log?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Agent log contents	IAConnectAgentLogContentsBase64	string	The contents of the IA-Connect Agent log.
Local saved log filename	IAConnectAgentLogFilenameOnly	string	The path to the saved log filename.

Get IA-Connect Agent log level

Operation ID:: GetRemoteLoggingLevel

Returns the current IA-Connect Agent logging level. The logging levels are set from 1 to 4, with 1 being the lowest level and 4 being the highest.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Log level	LoggingLevel	integer	The current logging level of the IA-Connect Agent.

Get IA-Connect Agent process count

Operation ID:: GetAgentProcessCount

Returns the number of instances of the IA-Connect Agent currently running in the user session. This is useful for detecting if there are multiple instances of the IA-Connect Agent running.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of processes	NumberOfProcesses	integer	The number of IA-Connect Agent processes that are currently running in the user session.

Get IA-Connect Agent session info

Operation ID:: GetRemoteSessionInfo

Returns information about the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Session Id	SessionId	integer	The current remote user session Id.
Session type	SessionType	integer	The type of remote session, either 1 (Citrix), 2 (RDP) or 0 (Console).
Session type name	SessionTypeName	string	The type of remote session, either ICA (Citrix), RDP or Console.

Get IA-Connect Director uptime

Operation ID:: GetDirectorUpTime

Returns the uptime of this IA-Connect Director in seconds (i.e. how long the Director has been running).

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Director uptime in seconds	UpTimeInSeconds	integer	The number of seconds that the IA-Connect Director has been running.

Get IA-Connect next hop status

Operation ID:: GetNextHopStatus

Reports on the next hop Director status for the Agent which receives this command. If next-hop is enabled, that Agent is forwarding commands to the next hop (via the next-hop Director). If next-hop is disabled, that Agent is processing commands itself (the default).

Parameters

Name	Key	Required	Type	Description
Check next hop Director is running	CheckNextHopDirectorIsRunning		boolean	Next hop requires a running IA-Connect Director on the same computer as the Agent. If this setting is true, the Agent will check the next-hop Director is running as described. If this setting is false, the Agent will not perform any checks and will simply check the next-hop status.
Check next hop Agent is running	CheckNextHopAgentIsRunning		boolean	Next hop requires a running IA-Connect Director on the same computer as the Agent AND a running IA-Connect Agent in the next-hop session. If this setting is true, the Agent will check the next-hop Agent is running as described. If this setting is false, the Agent will not perform any checks and will simply check the next-hop status.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Next hop enabled	NextHopEnabled	boolean	Returns true if next hop is currently enabled.
Active next hop Director address	ActiveNextHopDirectorAddress	string	The address of the active next hop Director, if one is being used.
Active next hop Director TCP port	ActiveNextHopDirectorTCPPort	integer	The TCP port of the active next hop Director, if one is being used.
Active next hop Director uses HTTPS	ActiveNextHopDirectorUsesHTTPS	boolean	Returns true if the active next hop Director is using HTTPS.
Active next hop Director is running	ActiveNextHopDirectorIsRunning	boolean	Returns true if the active next hop Director is running, or false if not.
Active next hop Director URL	ActiveNextHopDirectorURL	string	The URL of the active next hop Director.
Active next hop Agent is running	ActiveNextHopAgentIsRunning	boolean	Returns true if the active next hop Agent is running, or false if not.

Get last input info

Operation ID:: GetLastInputInfo

Gets the time since the last user input was received in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Last input total seconds	LastInputTotalSeconds	integer	The number of seconds that have elapsed since the last input.
Last input total minutes	LastInputTotalMinutes	integer	The number of minutes that have elapsed since the last input.
Last input total hours	LastInputTotalHours	integer	The number of hours that have elapsed since the last input.

Get list of drives

Operation ID:: GetListOfDrives

Returns a list of drives on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Drives JSON	DrivesJSON	string	A list of drives on the computer where the IA-Connect Agent is running, in JSON format.

Get list of printers

Operation ID:: GetListOfPrinters

Returns a list of all available printers in the IA-Connect Agent session.

Parameters

Name	Key	Required	Type	Description
List local printers	ListLocalPrinters		boolean	Should local printers be returned?
List network printers	ListNetworkPrinters		boolean	Should network printers be returned?
Return detailed information	ReturnDetailedInformation		boolean	Should detailed information such as location, port name, driver name and status of each printer be returned?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Printers JSON	PrintersJSON	string	A list of all printers found, in JSON format.
Number of printers	NumberOfPrinters	integer	The number of printers that were found.

Get machine domain

Operation ID:: GetMachineDomain

Returns the domain of the machine that is running the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Domain name	DomainName	string	The NetBIOS domain name of the machine that is running the IA-Connect Agent user session.
DNS domain name	DNSDomainName	string	The DNS domain name of the machine that is running the IA-Connect Agent user session.

Get machine name

Operation ID:: GetMachineName

Returns the name of the machine that is running the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Machine name	MachineName	string	The name of the machine that is running the IA-Connect Agent user session.

Get mouse move method

Operation ID:: GetMouseMoveMethod

Gets the current mouse move method.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Mouse move method	MouseMoveMethod	string	Returns the current mouse move method (either mouse_event or setcursorpos).

Get next Orchestrator automation task

Operation ID:: TasksGetNextTask

Retrieves the next Orchestrator automation task matching the given search critieria.

Parameters

Name	Key	Type	Description
Automation name	AutomationName	string	Leave blank to return Orchestrator automation tasks with any name. Enter a value to only retrieve tasks with this automation name.
Minimum priority level	MinimumPriorityLevel	integer	Only return Orchestrator automation tasks that have the specifed priority level or higher. For example: Setting 2 will return tasks with a priority level of 1 and 2.
Change status to	StatusChange	string	If set to 'Retrieved': When retrieving a task the task status will change to 'Retrieved' to prevent other actions from trying to run the same task. If set to 'Do nothing' the task status will not be changed.
Minutes until deferral date	MinutesUntilDeferralDate	integer	Only return Orchestrator automation tasks that are ready to run within the specified number of minutes. Set to 0 if you only want automation tasks that are ready to run now.
Ignore SLA	IgnoreSLA	boolean	Set this to true to ignore any SLAs that have been set on the task. By default a task with an SLA that will soon breach takes priority over everything else.

Returns

Name	Path	Type	Description
Task retrieved	TaskRetrieved	boolean	Set to true if a task was retrieved. Set to false if there were no tasks matching the search critieria.
Task Id	TaskId	integer	The id of the retrieved Orchestrator automation task.
Automation name	AutomationNameOutput	string	The name of the retrieved automation task.
Deferral date and time	DeferralDateTime	string	The date and time when the retrieved Orchestrator task is scheduled to be ready. This will be returned as a string in UTC.
Deferral stored data	DeferralStoredData	string	Optional data that was stored when the task was deferred. This is usually data that you need to continue the process / flow, but you can use this field for any purpose.
Deferral count	DeferralCount	integer	How often this task was deferred. This will typically be 0 for a new task which was never deferred or 1 or more for a deferred task. Each time a deferred task was deferred again, the Orchestrator will automatically increase this number.
Task input data	TaskInputData	string	Optional data that was stored when the task was created. This is usually data that was used to start the process / flow, but you can use this field for any purpose.
Priority	Priority	integer	The priority level of this Orchestrator task (1 being highest level).
Automation task status	AutomationTaskStatus	string	The status of the retrieved Orchestrator task.
Process stage	ProcessStage	string	The point at which the deferred process / flow should continue after deferral. This is an optional string value which will be unique to the specific process / flow. This will be used by a condition within the deferred process / flow to decide what step to perform next.
Received date and time	ReceivedDateTime	string	The date and time the task was initially received by the Orchestrator. This will be returned as a string in UTC.
Minutes until deferral date	MinutesUntilDeferralDateOutput	integer	The number of minutes until this task's deferral date (ie. when this task is ready to run). If this task is ready to run the minutes will be 0.

Get Orchestrator automation task

Operation ID:: TasksGetTask

Retrieves a specfic Orchestrator automation task.

Parameters

Name	Key	Required	Type	Description
Task Id	TaskId	True	integer	The Id of the Orchestrator task you want to retrieve.

Returns

Name	Path	Type	Description
Automation name	AutomationName	string	The name of the retrieved Orchestrator task.
Deferral date and time	DeferralDateTime	string	The date and time when the retrieved Orchestrator task is scheduled to be ready. This will be returned as a string in UTC.
Deferral stored data	DeferralStoredData	string	Optional data that was stored when the task was deferred. This is usually data that you need to continue the process / flow.
Deferral count	DeferralCount	integer	How often this task was deferred. This will typically be 0 for a new task which was never deferred or 1 or more for a deferred task. Each time a deferred task was deferred again, the Orchestrator will automatically increase this number.
Task input data	TaskInputData	string	Optional data that was stored when the task was created. This is usually data that was used to start the process / flow, but you can use this field for any purpose.
Priority	Priority	integer	The priority level of this Orchestrator task (1 being highest level).
Automation task status	AutomationTaskStatus	string	The status of the retrieved Orchestrator task.
Process stage	ProcessStage	string	The point at where the automation process / flow should continue after deferral. This is an optional string value which will be unique to the specific process / flow. This will be used by a condition within the deferred process / flow to decide what step to perform next. For example: If you want the process / flow to continue at the 'Exchange' stage when it continues after deferral, enter the value 'Exchange'.
Received date and time	ReceivedDateTime	string	The date and time the task was initially received by the Orchestrator. This will be returned as a string in UTC.
Minutes until deferral date	MinutesUntilDeferralDate	integer	The number of minutes until this task's deferral date (ie. when this task is ready to run). If this task is ready to run the minutes will be 0.
On hold	OnHold	boolean	Is set to true if the task is on hold. An old hold task will never be retrieved by the 'Get next Orchestrator automation task' action and hence will never be processed in a normal workflow.

Get Orchestrator Flow stats

Operation ID:: GetOrchestratorFlowStats

Returns a list of Flow stats from the IA-Connect Orchestrator. Used for reporting purposes. You can optionally use one or more filters to limit the returned results.

Parameters

Name	Key	Type	Description
Within last number of days	WithinLastNumberOfDays	integer	Filter results to retrieve only those started within the last specified number of days. Set to 0 to not filter.
Flow name	SearchFlowName	string	Filter results to retrieve only those with the specified Flow name. Set to blank to not filter by flow name.
Flow last action result	SearchFlowLastActionResult	boolean	Filter results to retrieve only those with the specified last action result. Set to true to only retrieve successful Flows. Set to false to only retrieve failed Flows. Don't set a value / set to blank to not filter by Flow last action result.
Flow start time start window	SearchFlowStartTimeStartWindow	date-time	Filter results to retrieve only those which started after the specified start time. Set to blank to not filter. For example: '2022-01-24T07:00:00' would return all Orchestrator Flow stats for Flows that started on or after 07.00 hours on the 24th of January 2022. All datetimes are in UTC (GMT+0) so you may wish to use the Convert DateTime action to convert your local time to UTC.
Flow start time end window	SearchFlowStartTimeEndWindow	date-time	Filter results to retrieve only those which started before the specified start time. Set to blank to not filter. For example: '2022-01-25T07:00:00' would return all Orchestrator Flow stats for Flows that started on or before 07.00 hours on the 25th of January 2022. All datetimes are in UTC (GMT+0) so you may wish to use the Convert DateTime action to convert your local time to UTC.

Returns

Name	Path	Type	Description
Orchestrator Flow stats JSON	OrchestratorFlowStatsJSON	string	A list of all Orchestrator Flow stats, in JSON format.
Number of Flow stats	NumberOfOrchestratorFlowStats	integer	The number of Flow stats that were returned.

Get parent process Id

Operation ID:: GetParentProcessId

Returns the process Id of the parent process for any running process in the IA-Connect Agent user session which has the specified process Id.

Parameters

Name	Key	Required	Type	Description
Process Id	ProcessId	True	integer	The process ID of the child process.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Parent process Id	ParentProcessId	integer	The process ID of the parent process.
Parent process still running	ParentProcessStillRunning	boolean	Returns true if the parent process is still running and has not exited.
Parent process name	ParentProcessName	string	The process name of the parent process.

Get process by process Id

Operation ID:: GetProcessByPID

Returns whether a process with the specified process Id is running in the IA-Connect Agent user session. Process Ids are unique so only one process can match the Id. Process Ids are dynamic and are different for every launch of an application.

Parameters

Name	Key	Required	Type	Description
Process Id	ProcessId	True	integer	The process ID of the process to get.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Process running	ProcessRunning	boolean	Returns true if a process with the provided process ID was found.

Get process count by name

Operation ID:: GetProcessCountByName

Returns a count of running processes in the IA-Connect Agent user session which has the specified process name.

Parameters

Name	Key	Required	Type	Description
Process name	ProcessName	True	string	The process name.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of processes	NumberOfProcesses	integer	The number of processes that match the process name provided.

Get process Id command line properties

Operation ID:: GetProcessIdCommandLine

Returns the command line properties for any running process in the IA-Connect Agent user session which has the specified process Id.

Parameters

Name	Key	Required	Type	Description
Process Id	ProcessId	True	integer	The process ID of the process to retrieve the command line properties from.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Process command line	ProcessCommandLine	string	The command line properties for the process.
Process arguments	ProcessArguments	string	The arguments that were used when starting the process.
Process current working directory	ProcessCurrentWorkingDirectory	string	The process current working directory.
Process image path name	ProcessImagePathName	string	The path to the executable which started the process.

Get processes

Operation ID:: GetProcesses

Returns a list of running processes in the IA-Connect Agent user session. This can optionally be filtered by providing a process name.

Parameters

Name	Key	Required	Type	Description
Process name	ProcessName		string	An optional filter for the process name.
Get process commandline	GetProcessCommandLine		boolean	If set to true, the process command-line details will be returned.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of processes	NumberOfProcesses	integer	The number of processes running in the user session.
Processes JSON	ProcessesJSON	string	The list of processes running in the user session, in JSON format.

Get screen resolution

Operation ID:: GetScreenResolution

Returns the screen resolution of the IA-Connect Agent user session (as seen by the user session).

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of screens	NumberOfScreens	integer	The number of screens that were detected.
Horizontal resolution	HorizontalResolution	integer	The horizontal resolution of the first screen.
Vertical resolution	VerticalResolution	integer	The vertical resolution of the first screen.
Second display horizontal resolution	SecondDisplayHorizontalResolution	integer	The horizontal resolution of the second screen, if one was detected.
Second display vertical resolution	SecondDisplayVerticalResolution	integer	The vertical resolution of the second screen, if one was detected.
Third display horizontal resolution	ThirdDisplayHorizontalResolution	integer	The horizontal resolution of the third screen, if one was detected.
Third display vertical resolution	ThirdDisplayVerticalResolution	integer	The vertical resolution of the third screen, if one was detected.
Fourth display horizontal resolution	FourthDisplayHorizontalResolution	integer	The horizontal resolution of the fourth screen, if one was detected.
Fourth display vertical resolution	FourthDisplayVerticalResolution	integer	The vertical resolution of the fourth screen, if one was detected.
Virtual screen left edge pixels	VirtualScreenLeftEdgePixels	integer	The left edge of the entire screen (including all displays that were detected).
Virtual screen top edge pixels	VirtualScreenTopEdgePixels	integer	The top edge of the entire screen (including all displays that were detected).
Virtual screen width pixels	VirtualScreenWidthPixels	integer	The width of the entire screen (including all displays that were detected).
Virtual screen height pixels	VirtualScreenHeightPixels	integer	The height of the entire screen (including all displays that were detected).

Get stored password

Operation ID:: GetStoredPassword

Retrieves a previously generated or stored password.

Parameters

Name	Key	Required	Type	Description
Password identifier	PasswordIdentifier		string	The identifier of the stored password. These passwords are only stored in memory and are lost when the Agent is closed. For example: MyExchangePassword.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Plain text password	PlainTextPassword	string	The password in plain text. The password might be needed in plain text if the password is a one-time password intended to be transmitted via SMS or email (for example) and hence needs to be seen as-is.

Is directory accessible

Operation ID:: DirectoryIsAccessible

Returns whether a directory (folder) is accessible and whether permissions are restricting access to it on the computer where the IA-Connect Agent.

Parameters

Name	Key	Required	Type	Description
Directory path	DirectoryPath	True	string	The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Directory accessible	DirectoryAccessible	boolean	Returns true if the directory is accessible, or false if not.
Directory access unauthorised	DirectoryAccessUnauthorised	boolean	Returns true if the directory is unaccessible as permissions are restricting access to it, or false if not.

Operation ID:: IsScreenReaderEnabled

Returns whether the screen reader has been enabled in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Screen reader enabled	ScreenReaderEnabled	boolean	Returns true if the screen reader has been enabled.

Is TCP port responding

Operation ID:: IsTCPPortResponding

Reports whether a network TCP port is responding to a connection attempt by the IA-Connect Agent. This could be a TCP port on the computer where the IA-Connect Agent is running (enter 'localhost' for the remote host) or on any remote computer. If the IA-Connect Agent successfully connects to a TCP port, it immediately closes the TCP connection.

Parameters

Name	Key	Required	Type	Description
Remote host	RemoteHost	True	string	The IPv4 address, DNS address or hostname of the computer to connect to. Enter 'localhost' to check a TCP port on the computer where the IA-Connect Agent is running. Examples: 192.168.1.10 or www.test.com or vm-server19.
TCP port	TCPPort	True	integer	The TCP port number to connect to on the specified remote (or local) host. A TCP port must be 1 or higher and 65535 or lower. Examples of common well-known ports are 80 (HTTP), 443 (HTTPS), 445 (SMB / file sharing).
Timeout in seconds	TimeoutInSeconds		integer	The maximum number of seconds to wait for the TCP connection. This defaults to 10 seconds but most working connections would be expected to connect within a few seconds (over the Internet) or less than a second (local network).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
TCP port connected	TCPPortConnected	boolean	Set to true if the TCP port connected or false if the TCP port failed to connect.
Connection error message	ConnectionErrorMessage	string	The error message if the TCP port failed to connect. This will commonly be a DNS / name lookup error or a timeout.

Keep session alive

Operation ID:: KeepSessionAlive

Keeps the IA-Connect Agent user session alive by moving the mouse at the specified interval to prevent the session from becoming idle.

Parameters

Name	Key	Required	Type	Description
X wiggle	XWiggle		integer	The number of pixels to move the mouse horizontally.
Y wiggle	YWiggle		integer	The number of pixels to move the mouse vertically.
Wiggle delay in seconds	WiggleDelayInSeconds		double	The number of seconds between the mouse movements when wiggling.
Idle threshold in seconds	IdleThresholdInSeconds		integer	The number of seconds that should have elapsed since the last input before moving the mouse.
Idle check period in seconds	IdleCheckPeriodInSeconds		integer	The number of seconds between checking the last input time (to check if the idle threshold has been passed).
Total keepalive runtime in seconds	TotalKeepaliveRuntimeInSeconds		integer	The total number of seconds to keep the session alive for.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	KeepSessionAliveResult	boolean	The result of the command (success or failure).
Error message	ErrorMessage	string	If the command was not successful, this will contain the error message that was returned.

Kill all other IA-Connect Agents

Operation ID:: KillAllOtherAgents

Kills any other instances of the IA-Connect Agent that are currently running in the user session. This will ensure that only one instance of the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of Agents killed	NumberOfAgentsKilled	integer	The number of IA-Connect Agent processes that were killed.
Number of Agents failed to kill	NumberOfAgentsFailedToKill	integer	The number of IA-Connect Agent processes that failed to be killed.

Kill IA-Connect session by name

Operation ID:: KillIAConnectSessionByName

Kills the specified IA-Connect Director session if it exists. This is the session into which commands to an IA-Connect Agent are sent. The name will be known from an earlier 'Attach' action.

Parameters

Name	Key	Required	Type	Description
IA-Connect session name	IAConnectSessionName	True	string	The name of the IA-Connect session to kill.
Attach to tier 1 IA-Connect session on success	AttachToTier1IAConnectSessionOnSuccess		boolean	Should IA-Connect connect back to the tier 1 IA-Connect session (the IA-Connect Director session of the Director that is receiving the SOAP and / or REST messages) if the session has successfully closed?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
IA-Connect session killed	IAConnectSessionKilled	boolean	Returns true if the session with the specified name was killed, or false if not.
Attached tier 1 IA-Connect session name	AttachedTier1IAConnectSessionName	string	The name of the tier 1 IA-Connect session that was connected to.

Kill process

Operation ID:: KillProcess

Kills any running process in the IA-Connect Agent user session which has the specified process name.

Parameters

Name	Key	Required	Type	Description
Process name	ProcessName	True	string	The process to kill. e.g. notepad.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of processes killed	NumberOfProcessesKilled	integer	The number of processes that were killed.

Kill process ID

Operation ID:: KillProcessID

Kills a running process in the IA-Connect Agent user session which has the specified process Id. Process Ids are unique so only one process can match the Id. Process Ids are dynamic and are different for every launch of an application.

Parameters

Name	Key	Required	Type	Description
Process ID	ProcessID	True	integer	The process ID of the process to kill.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of processes killed	NumberOfProcessesKilled	integer	The number of processes that were killed.

Launch Remote Desktop Session (RDS)

Operation ID:: LaunchRemoteDesktopSession

Launch a Remote Desktop Session (RDS) using a RDP launch file.

Parameters

Name	Key	Required	Type	Description
RDP file path	RDPFilePath	True	string	The full path to a RDP file (which could either pre-exist or be created using the action: 'Create Remote Desktop Session (RDS) launch file').
Trust remote computer	TrustRemoteComputer		boolean	Set to true to mark the remote address (set in the RDP file) as trusted (in the Windows registry), mainly for device redirection purposes, eliminating a popup you might receive when launching the RDP file.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	LaunchRemoteDesktopSessionResult	boolean	The result of the command (success or failure).
Error message	ErrorMessage	string	If the command was not successful, this will contain the error message that was returned.

Left click mouse

Operation ID:: LeftClickMouse

Clicks the left mouse button in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Left click mouse at coordinate

Operation ID:: LeftClickMouseAtCoordinate

Clicks the left mouse button in the IA-Connect Agent user session at the specified coordinates.

Parameters

Name	Key	Required	Type	Description
X pixels	XCoord	True	integer	The X coordinate value (in pixels).
Y pixels	YCoord	True	integer	The Y coordinate value (in pixels).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Left hold mouse

Operation ID:: LeftHoldMouse

Holds the left mouse button in the IA-Connect Agent user session for the specified amount of seconds.

Parameters

Name	Key	Required	Type	Description
Seconds to hold	SecondsToHold	True	double	The number of seconds to hold down the left mouse button.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Left hold mouse at coordinate

Operation ID:: LeftHoldMouseAtCoordinate

Holds the left mouse button at the specified coordinates in the IA-Connect Agent user session for the specified amount of seconds.

Parameters

Name	Key	Required	Type	Description
X pixels	XCoord	True	integer	The X coordinate value (in pixels).
Y pixels	YCoord	True	integer	The Y coordinate value (in pixels).
Seconds to hold	SecondsToHold	True	double	The number of seconds to hold down the left mouse button.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Left mouse button down

Operation ID:: LeftMouseButtonDown

Presses (and does not release) the left mouse button in the IA-Connect Agent user session. To release the mouse, use the left mouse button up action.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Left mouse button up

Operation ID:: LeftMouseButtonUp

Releases the left mouse button in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Left mouse drag between coordinates

Operation ID:: LeftMouseDragBetweenCoordinates

Performs a left mouse button drag between the two specified coordinates in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Start X pixels	StartXCoord	True	integer	The start X coordinate value (in pixels).
Start Y pixels	StartYCoord	True	integer	The start Y coordinate value (in pixels).
End X pixels	EndXCoord	True	integer	The end X coordinate value (in pixels).
End Y pixels	EndYCoord	True	integer	The end Y coordinate value (in pixels).
Number of steps	NumberOfSteps		integer	The number of steps that the drag action should be broken into.
Total time in seconds	TotalTimeInSeconds		double	The total time that the drag action should take from start to finish.
Maximum movement pixel jitter	MaximumMovementPixelJitter		integer	The maximum pixel jitter whilst performing the drag action. The higher the value, the less 'smooth' the drag action will appear.
Maximum end pixel jitter	MaximumEndPixelJitter		integer	The maximum pixel jitter at the end of the drag action. The higher the value, the less precise the drag will be when reaching the end coordinate.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Logoff remote session

Operation ID:: LogoffSession

Logs off the remote session where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Seconds to wait	SecondsToWait		integer	The time to wait after issuing the log off command to the operating system so that the IA-Connect Agent can report completion of the command.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Mark Flow as complete

Operation ID:: WorkflowCompleted

Mark a Flow as complete, which informs the IA-Connect Orchestrator that the assigned worker machine is now available to process other Flows.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Middle click mouse

Operation ID:: MiddleClickMouse

Clicks the middle mouse button in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Middle click mouse at coordinate

Operation ID:: MiddleClickMouseAtCoordinate

Clicks the middle mouse button in the IA-Connect Agent user session at the specified coordinates.

Parameters

Name	Key	Required	Type	Description
X pixels	XCoord	True	integer	The X coordinate value (in pixels).
Y pixels	YCoord	True	integer	The Y coordinate value (in pixels).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Middle hold mouse

Operation ID:: MiddleHoldMouse

Holds the middle mouse button in the IA-Connect Agent user session for the specified amount of seconds.

Parameters

Name	Key	Required	Type	Description
Seconds to hold	SecondsToHold	True	double	The number of seconds to hold down the middle mouse button.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Middle hold mouse at coordinate

Operation ID:: MiddleHoldMouseAtCoordinate

Holds the middle mouse button at the specified coordinates in the IA-Connect Agent user session for the specified amount of seconds.

Parameters

Name	Key	Required	Type	Description
X pixels	XCoord	True	integer	The X coordinate value (in pixels).
Y pixels	YCoord	True	integer	The Y coordinate value (in pixels).
Seconds to hold	SecondsToHold	True	double	The number of seconds to hold down the middle mouse button.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Middle mouse button down

Operation ID:: MiddleMouseButtonDown

Presses (and does not release) the middle mouse button in the IA-Connect Agent user session. To release the mouse, use the middle mouse button up action.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Middle mouse button up

Operation ID:: MiddleMouseButtonUp

Releases the middle mouse button in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Middle mouse drag between coordinates

Operation ID:: MiddleMouseDragBetweenCoordinates

Performs a middle mouse button drag between the two specified coordinates in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Start X pixels	StartXCoord	True	integer	The start X coordinate value (in pixels).
Start Y pixels	StartYCoord	True	integer	The start Y coordinate value (in pixels).
End X pixels	EndXCoord	True	integer	The end X coordinate value (in pixels).
End Y pixels	EndYCoord	True	integer	The end Y coordinate value (in pixels).
Number of steps	NumberOfSteps		integer	The number of steps that the drag action should be broken into.
Total time in seconds	TotalTimeInSeconds		double	The total time that the drag action should take from start to finish.
Maximum movement pixel jitter	MaximumMovementPixelJitter		integer	The maximum pixel jitter whilst performing the drag action. The higher the value, the less 'smooth' the drag action will appear.
Maximum end pixel jitter	MaximumEndPixelJitter		integer	The maximum pixel jitter at the end of the drag action. The higher the value, the less precise the drag will be when reaching the end coordinate.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Move file

Operation ID:: MoveFile

Moves a file on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Source file path	SourceFilePath	True	string	The full path to the source file. This must be accessible from the session where the IA-Connect Agent is running.
Destination file path	DestFilePath	True	string	The full path to the destination where the file should be moved to. This must be accessible from the session where the IA-Connect Agent is running.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Move mouse relative

Operation ID:: MoveMouseRelative

Moves the mouse in the IA-Connect Agent user session by the specified number of pixels, relative to it's current position.

Parameters

Name	Key	Required	Type	Description
X pixels	XCoord	True	integer	The number of X pixels to move the mouse, starting from it's current position.
Y pixels	YCoord	True	integer	The number of Y pixels to move the mouse, starting from it's current position.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Move mouse to coordinate

Operation ID:: MoveMouseToCoordinate

Moves the mouse in the IA-Connect Agent user session to the specified pixel coordinates.

Parameters

Name	Key	Required	Type	Description
X pixels	XCoord	True	integer	The X coordinate value (in pixels) to move the mouse to.
Y pixels	YCoord	True	integer	The Y coordinate value (in pixels) to move the mouse to.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Purge directory

Operation ID:: PurgeDirectory

Purges a directory (folder) on the computer where the IA-Connect Agent is running, removing all files stored within the directory.

Parameters

Name	Key	Required	Type	Description
Directory path	DirectoryPath	True	string	The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.
Recursive	Recursive		boolean	Should all subfolders also be purged?
Delete top level	DeleteTopLevel		boolean	Should the top level folder also be deleted?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Read all text from file

Operation ID:: ReadAllTextFromFile

Reads the text contents of a file on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
File path	Filename	True	string	The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
File text contents	FileTextContents	string	The text contents of the file.

Read from a user credential

Operation ID:: CredentialRead

Reads a username and password from a credential in the user's profile in the IA-Connect Agent session. Credentials can be viewed from the Windows Control Panel. Both the username and password can be retrieved from a Generic credential while only the username can be retrieved from a Windows credential.

Parameters

Name	Key	Required	Type	Description
Credential address	CredentialAddress	True	string	The name / address of the credential.
Credential type	CredentialType	True	string	The credential type: Windows or Generic.
Symmetric encryption key	SymmetricKey		string	An optional symmetric encryption key used to decrypt the credential password (use if the credential was encrypted with a key). Only usable with Generic Credentials since the password for a Windows credential cannot be retrieved.
Store password as identifier	StorePasswordAsIdentifier		string	If an identifier is supplied, the retrieved credential password will be stored encrypted inside the Agent for later retrieval / usage by any commands which can make use of stored credentials. These passwords are only stored in memory and are lost when the Agent is closed. Only usable with Generic Credentials since the password for a Windows credential cannot be retrieved. For example: MyExchangePassword.
Dont return password	DontReturnPassword		boolean	If set to true, the credential password won't be returned. This is useful if you are storing the password within the Agent for use by further commands (i.e. 'Store password as identifier' is true), but you don't actually need to know the password within your workflow.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
User name	UserName	string	The credential user name.
Password	Password	string	The credential password.

Remove identity from file security

Operation ID:: RemoveIdentityFromFileSecurity

Removes an identity (e.g. user, group or computer) from the security permissions on a file on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
File path	FilePath	True	string	The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.
Identity to remove	IdentityToRemove	True	string	The identity of the user or group to be removed. This can be in the form 'username', 'DOMAIN\username' or 'username@domainfqdn'.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Permission was removed	PermissionWasRemoved	boolean	Returns true if the permission was removed successfully.

Remove identity from folder security

Operation ID:: RemoveIdentityFromFolderSecurity

Removes an identity (e.g. a user, group or computer) from the security permissions on a folder on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Folder path	FolderPath	True	string	The full path to the folder. This must be accessible from the session where the IA-Connect Agent is running.
Identity to remove	IdentityToRemove	True	string	The identity of the user or group to be removed. This can be in the form 'username', 'DOMAIN\username' or 'username@domainfqdn'.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Permission was removed	PermissionWasRemoved	boolean	Returns true if the permission was removed successfully.

Replace variable data in INI file

Operation ID:: ReplaceVariableDataInINIFile

Updates a single variable in an INI file.

Parameters

Name	Key	Required	Type	Description
INI file path	InputFilename	True	string	The full path to the INI file. This must be accessible from the session where the IA-Connect Agent is running.
Output INI file path	OutputFilename		string	If you want to write the updated INI file to an alternative file, enter the full path to the output file here. The input INI file will be unmodifed - the output INI file will hold the changes.
INI search section	SearchSection		string	The optional name of the section holding the variable to change.
INI search variable name	SearchVariable		string	The name of the variable to update.
Replacement data	ReplaceData		string	The replacement data to update the variable to.
INI file encoding	InputFilenameEncoding		string	Provide the INI file encoding (Unicode, UTF8, UTF7 or ASCII) or specify the encoding value (e.g. 1252 for Western Europe).
Create new file if input file does not exist	CreateNewFileIfNotExists		boolean	If the input file does not exist, should a new one be created?
Write space before equals	WriteSpaceBeforeEquals		boolean	Should a space be written before the equals ( = ) sign?
Write space after equals	WriteSpaceAfterEquals		boolean	Should a space be written after the equals ( = ) sign?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Reset IA-Connect command statistics

Operation ID:: ResetCommandStats

Resets any currently stored statistics on which commands the IA-Connect Agent has executed in the current session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Reset next hop IA-Connect Director settings

Operation ID:: ResetNextHopDirectorSettings

Resets any custom IA-Connect Director settings that have been set, restoring the default settings.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Right click mouse

Operation ID:: RightClickMouse

Clicks the right mouse button in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Right click mouse at coordinate

Operation ID:: RightClickMouseAtCoordinate

Clicks the right mouse button in the IA-Connect Agent user session at the specified coordinates.

Parameters

Name	Key	Required	Type	Description
X pixels	XCoord	True	integer	The X coordinate value (in pixels).
Y pixels	YCoord	True	integer	The Y coordinate value (in pixels).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Right hold mouse

Operation ID:: RightHoldMouse

Holds the right mouse button in the IA-Connect Agent user session for the specified amount of seconds.

Parameters

Name	Key	Required	Type	Description
Seconds to hold	SecondsToHold	True	double	The number of seconds to hold down the right mouse button.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Right hold mouse at coordinate

Operation ID:: RightHoldMouseAtCoordinate

Holds the right mouse button at the specified coordinates in the IA-Connect Agent user session for the specified amount of seconds.

Parameters

Name	Key	Required	Type	Description
X pixels	XCoord	True	integer	The X coordinate value (in pixels).
Y pixels	YCoord	True	integer	The Y coordinate value (in pixels).
Seconds to hold	SecondsToHold	True	double	The number of seconds to hold down the right mouse button.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Right mouse button down

Operation ID:: RightMouseButtonDown

Presses (and does not release) the right mouse button in the IA-Connect Agent user session. To release the mouse, use the right mouse button up action.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Right mouse button up

Operation ID:: RightMouseButtonUp

Releases the right mouse button in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Right mouse drag between coordinates

Operation ID:: RightMouseDragBetweenCoordinates

Performs a right mouse button drag between the two specified coordinates in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Start X pixels	StartXCoord	True	integer	The start X coordinate value (in pixels).
Start Y pixels	StartYCoord	True	integer	The start Y coordinate value (in pixels).
End X pixels	EndXCoord	True	integer	The end X coordinate value (in pixels).
End Y pixels	EndYCoord	True	integer	The end Y coordinate value (in pixels).
Number of steps	NumberOfSteps		integer	The number of steps that the drag action should be broken into.
Total time in seconds	TotalTimeInSeconds		double	The total time that the drag action should take from start to finish.
Maximum movement pixel jitter	MaximumMovementPixelJitter		integer	The maximum pixel jitter whilst performing the drag action. The higher the value, the less 'smooth' the drag action will appear.
Maximum end pixel jitter	MaximumEndPixelJitter		integer	The maximum pixel jitter at the end of the drag action. The higher the value, the less precise the drag will be when reaching the end coordinate.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Run alternative IA-Connect Agent

Operation ID:: RunAlternativeIAConnect

Runs an alternative IA-Connect Agent (for example a later version) by loading the Agent executable from a file location.

Parameters

Name	Key	Required	Type	Description
Filename	Filename	True	string	The full path to the alternative IA-Connect Agent.exe to be ran. This path must be accessible from the session where the IA-Connect Agent is currently running.
Arguments	Arguments		string	Any optional arguments to pass to the IA-Connect Agent.exe when it runs.
Load into memory	LoadIntoMemory		boolean	Should the alternative IA-Connect Agent be ran in memory? If set to true, the new Agent is loaded into memory and executed within an Assembly of the existing Agent. If set to false, the new Agent is executed as a normal process and the existing Agent EXE will exit.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Run alternative IA-Connect Agent sent from director

Operation ID:: RunAlternativeIAConnectSentFromDirector

Runs an alternative IA-Connect Agent (for example a later version) by uploading the alternative Agent from the IA-Connect Director and then loading the alternative Agent executable.

Parameters

Name	Key	Required	Type	Description
Local filename	LocalFilename	True	string	The full path to the alternative IA-Connect Agent.exe that is accessible from the IA-Connect director.
Remote filename	RemoteFilename	True	string	The full path to the location to copy the alternative IA-Connect Agent.exe (on the remote system). If not specified, a temporary filename will be chosen. If the alternative IA-Connect Agent is being loaded into memory then this file won't be created (since it's not needed) unless you set 'Save to disk even if running from memory' to true. You would only set this to true if you wanted to use IA-Connect's Dynamic Code actions which required 'Reference executing assembly' (e.g. to access IA-Connect internal methods).
Compress	Compress		boolean	Should the alternative IA-Connect Agent executable be compressed during the upload?
Arguments	Arguments		string	Any optional arguments to pass to the IA-Connect Agent.exe when it runs.
Permit downgrade	PermitDowngrade		boolean	Should earlier versions of IA-Connect Agent be allowed?
Skip version check	SkipVersionCheck		boolean	Should the version of the IA-Connect Agents (existing and new) not be checked at all, resulting in the new version being used in all scenarios (even same version)?
Load into memory	LoadIntoMemory		boolean	Should the alternative IA-Connect Agent be ran in memory? If set to true, the new Agent is loaded into memory and executed within an Assembly of the existing Agent. If set to false, the new Agent is executed as a normal process and the existing Agent EXE will exit.
Save to disk even if running from memory	SaveToDiskEvenIfRunningFromMemory		boolean	Should the alternative IA-Connect Agent be saved to disk even if it is being ran in memory? You would only set this to true if you wanted to use IA-Connect's Dynamic Code actions which required 'Reference executing assembly' (e.g. to access IA-Connect internal methods).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Alternative file copied	AlternativeFileCopied	boolean	Reports if the alternative IA-Connect Agent was used.

Run generic IA-Connect Agent command

Operation ID:: RunCommand

Runs a generic IA-Connect Agent command passing arguments as JSON and returning output data as JSON. Used to run Agent commands when the Director and Inspector are older versions than the Agent and hence don't understand the command.

Parameters

Name	Key	Required	Type	Description
IA-Connect Agent command name	CommandName	True	string	The internal name of the IA-Connect Agent command. A list of command names can be provided by the action 'GetAgentActionsInClass'.
Input JSON	InputJSON		string	The input to the IA-Connect Agent command, in JSON format.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Output JSON	OutputJSON	string	The output from the IA-Connect Agent command, in JSON format.
Error message	ErrorMessage	string	The details of the error message from the failed command.

Run process

Operation ID:: RunProcess

Launch a process, command or application.

Parameters

Name	Key	Required	Type	Description
Process name	ProcessName	True	string	The process to run. e.g. notepad.exe or C:\windows\system32\notepad.exe.
Arguments	Arguments		string	Any command-line arguments to use when starting the application.
Working Folder	WorkingDirectory		string	The working folder/directory for the process.
Use Shell execute	UseShellExecute		boolean	Should the process be started by using the operating system shell?
Create no window	CreateNoWindow		boolean	Should the process be started with no window?
Window style	WindowStyle		string	Provide the window style (normal, maximised, minimised or hidden).
Wait for process	WaitForProcess		boolean	Should we wait for the process to finish? This would likely only be used when running a program or script that needed to finish before we can continue.
Redirect standard output	RedirectStandardOutput		boolean	Should the standard output be redirected?
Redirect standard error	RedirectStandardError		boolean	Should the standard error be redirected?
Redirect standard error to output	RedirectStandardErrorToOutput		boolean	Should standard error be redirected to output?
Standard output encoding	StandardOutputEncoding		string	Provide the standard output encoding (UTF8, UTF7, UTF16, ASCII or UTF16BE).
Standard error encoding	StandardErrorEncoding		string	Provide the standard error encoding (UTF8, UTF7, UTF16, ASCII or UTF16BE).
RunAs Domain name	RunAsDomain		string	The domain of the run as user. If domain is not specified then the username should be in the format username@domainFQDN.
RunAs Username	RunAsUsername		string	The username of the run as user.
RunAs Password	RunAsPassword		password	The password of the run as user.
RunAs load user profile	RunAsLoadUserProfile		boolean	Should the Windows user profile of the run as user be loaded?
RunAs elevate	RunAsElevate		boolean	Should the process run elevated?
Timeout in seconds	TimeoutInSeconds		integer	The maximum number of seconds to wait for the process to finish.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Process started	ProcessStarted	boolean	Returns true if the process was started.
Exit code	ExitCode	integer	Returns the process exit code.
Process timed out	ProcessTimedOut	boolean	Returns true if the process has timed out.
Process Id	ProcessId	integer	The process ID of the process that was started.
Standard output	StandardOutput	string	The standard output contents.
Standard error	StandardError	string	The standard error contents.

Send key events

Operation ID:: SendKeyEvents

Sends global key press events to the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Text	Text	True	string	The text to be sent.
Interval in milliseconds	Interval		integer	The number of milliseconds between each key press event.
Dont interpret symbols	DontInterpretSymbols		boolean	Should symbols in the text not be interpreted as special keys (e.g. {SHIFT} for Shift, {CTRL} for Ctrl)? This should be set to true if you are attempting to input the actual symbols.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Send keys

Operation ID:: SendKeys

Sends global key presses to the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Text	Text	True	string	The text to be sent.
Interval in milliseconds	Interval		integer	The number of milliseconds between each key press.
Dont interpret symbols	DontInterpretSymbols		boolean	Should symbols in the text not be interpreted as special keys (e.g. + for Shift, ^ for Ctrl)? This should be set to true if you are attempting to input the actual symbols.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Send password key events

Operation ID:: SendPasswordKeyEvents

Sends global key press events to the IA-Connect Agent user session, specifically for entering a password.

Parameters

Name	Key	Required	Type	Description
Password	Password	True	password	The password to be sent.
Interval in milliseconds	Interval		integer	The number of milliseconds between each key press event.
Dont interpret symbols	DontInterpretSymbols		boolean	Should symbols in the password not be interpreted as special keys (e.g. {SHIFT} for Shift, {CTRL} for Ctrl)? This should be set to true if you are attempting to input the actual symbols.
Password contains stored password	PasswordContainsStoredPassword		boolean	Set to true if the password contains (or is entirely) an IA-Connect stored password identifier, in the format {IAConnectPassword:StoredPasswordIdentifier}. This stored password could have been generated by the 'Generate password' action, for example.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Send password keys

Operation ID:: SendPasswordKeys

Sends global key presses to the IA-Connect Agent user session, specifically for entering a password.

Parameters

Name	Key	Required	Type	Description
Password	Password	True	password	The password to be sent.
Interval in milliseconds	Interval		integer	The number of milliseconds between each key press.
Dont interpret symbols	DontInterpretSymbols		boolean	Should symbols in the password not be interpreted as special keys (e.g. + for Shift, ^ for Ctrl)? This should be set to true if you are attempting to input the actual symbols.
Password contains stored password	PasswordContainsStoredPassword		boolean	Set to true if the password contains (or is entirely) an IA-Connect stored password identifier, in the format {IAConnectPassword:StoredPasswordIdentifier}. This stored password could have been generated by the 'Generate password' action, for example.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set clipboard

Operation ID:: SetClipboardData

Sets the content of the clipboard in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
New clipboard data	NewClipboardData		string	The data to be set in the clipboard.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set default printer

Operation ID:: SetDefaultPrinter

Sets the default printer for the user in the IA-Connect Agent session.

Parameters

Name	Key	Required	Type	Description
Default printer name	DefaultPrinterName	True	string	The name of the default printer for the user.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set IA-Connect Agent command timeout

Operation ID:: SetRPACommandTimeout

Sets the command timeout that the IA-Connect Agent will use for each command that is executed.

Parameters

Name	Key	Required	Type	Description
Command timeout in seconds	CommandTimeoutInSeconds	True	integer	The command timeout that the IA-Connect Agent will use. If reading or writing large amounts of data, you may wish to increase the timeout period.
Terminate timedout RPA command threads	TerminateTimedoutRPACommandThreads		boolean	Should the command thread be terminated if it has timed out?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set IA-Connect Agent GUI opacity

Operation ID:: SetRSAGUIOpacity

Sets the opacity of the IA-Connect Agent from 1 (visible) to 0 (transparent).

Parameters

Name	Key	Required	Type	Description
Opacity	Opacity	True	double	The opacity value to be set, between 1 (visible) and 0 (transparent).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set IA-Connect Agent GUI position

Operation ID:: SetRSAGUIPosition

Sets the onscreen position of the IA-Connect Agent GUI to the specified location.

Parameters

Name	Key	Required	Type	Description
X	X	True	integer	The X coordinate to set the Agent to, in pixels.
Y	Y	True	integer	The Y coordinate to set the Agent to, in pixels.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set IA-Connect Agent GUI topmost

Operation ID:: SetRSAGUITopmost

Sets the IA-Connect Agent as topmost. This means that the IA-Connect Agent will always be visible on screen and cannot be hidden behind other application windows.

Parameters

Name	Key	Required	Type	Description
Topmost	TopMost		boolean	Should the IA-Connect Agent be set topmost (true) or should topmost be disabled (false)?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set IA-Connect Agent log level

Operation ID:: SetRemoteLoggingLevel

Sets the IA-Connect Agent logging level to the specified value (1 being the lowest level and 4 being the highest).

Parameters

Name	Key	Required	Type	Description
Log level	LoggingLevel	True	integer	The logging level that the IA-Connect Agent should be set to.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set IA-Connect Director log level

Operation ID:: SetLocalLoggingLevel

Sets the IA-Connect Director logging level to the specified value (1 being the lowest level and 4 being the highest).

Parameters

Name	Key	Required	Type	Description
Log level	LoggingLevel	True	integer	The logging level that the IA-Connect Director should be set to.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set IA-Connect license code

Operation ID:: SetLicenseCode

Uploads an old-style (7.0 and 7.1) Agent domain license to the IA-Connect Agent.

Parameters

Name	Key	Required	Type	Description
Customer NetBIOS domain name	CustomerNETBIOSDomainName	True	string	The NetBIOS domain name of the machine where the IA-Connect Agent is running.
Customer display name	CustomerDisplayName	True	string	The customer name to be displayed in the title bar of the IA-Connect Agent.
Vendor name	VendorName	True	string	The IA-Connect vendor name.
License expiry date	LicenseExpiryDate	True	string	The expiry date of the IA-Connect license.
Activation code	ActivationCode	True	string	The activation code for the IA-Connect license.
Store in registry	StoreInRegistry		boolean	Should the IA-Connect license be temporarily stored in the registry? This ensures that the IA-Connect Agent will be licensed for the duration of the user session, even if the Agent is closed and re-launched.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set IA-Connect license key

Operation ID:: SetLicenseString

Licenses the IA-Connect Agent with a license key. This can be a license string or the friendly name of a license held in the IA-Connect Orchestrator.

Parameters

Name	Key	Required	Type	Description
License key	LicenseString	True	string	The IA-Connect license key string or the friendly name of a license held in the IA-Connect Orchestrator (if controlling IA-Connect via the IA-Connect Orchestrator).
Store in registry	StoreInRegistry		boolean	Should the IA-Connect license be temporarily stored in the registry? This ensures that the IA-Connect Agent will be licensed for the duration of the user session, even if the Agent is closed and re-launched.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Days until license expires	DaysUntilLicenseExpires	integer	The number of remaining days until the IA-Connect license expires.

Set mouse cursor position

Operation ID:: SetCursorPos

Sets the mouse cursor in the IA-Connect Agent user session to the specified position.

Parameters

Name	Key	Required	Type	Description
X pixels	X	True	integer	The X coordinate value (in pixels).
Y pixels	Y	True	integer	The Y coordinate value (in pixels).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set mouse move method

Operation ID:: SetMouseMoveMethod

Sets the current mouse move method to either mouse_event or setcursorpos.

Parameters

Name	Key	Required	Type	Description
Set mouse move method	MouseMoveMethod	True	string	Provide the mouse move method (mouse_event or setcursorpos).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set mouse multiplier

Operation ID:: SetMouseMultiplier

Sets the mouse multiplier in the IA-Connect Agent user session. This can be useful during development if you encounter issues with remote desktop scaling.

Parameters

Name	Key	Required	Type	Description
X multiplier	MouseXMultiplier		double	The current horizontal (X) mouse multiplier.
Y multiplier	MouseYMultiplier		double	The current vertical (Y) mouse multiplier.
Apply to mouse_event	ApplyToMouseEvent		boolean	This argument specifies whether to apply the mouse multiplier values to the mouse_event method.
Apply to SetCursorPos	ApplyToSetCursorPos		boolean	This argument specifies whether to apply the mouse multipler values to the SetCursorPos method.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set owner on file

Operation ID:: SetOwnerOnFile

Sets the owner on a file on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
File path	FilePath	True	string	The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.
User identity	UserIdentity	True	string	The identity of the user to be assigned ownership. This can be in the form 'username', 'DOMAIN\username' or 'username@domainfqdn'.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set owner on folder

Operation ID:: SetOwnerOnFolder

Sets the owner on a folder on the computer where the IA-Connect Agent is running.

Parameters

Name	Key	Required	Type	Description
Folder path	FolderPath	True	string	The full path to the folder. This must be accessible from the session where the IA-Connect Agent is running.
User identity	UserIdentity	True	string	The identity of the user to be assigned ownership. This can be in the form 'username', 'DOMAIN\username' or 'username@domainfqdn'.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Operation ID:: SetScreenReader

Enables or disables the screen reader in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Enable screen reader	EnableScreenReader		boolean	If set to true then the screen reader will be enabled. If set to false then the screen reader will be disabled.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Stop keep session alive

Operation ID:: StopKeepSessionAlive

Stops the IA-Connect Agent user session keep alive.

Parameters

Name	Key	Required	Type	Description
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	StopKeepSessionAliveResult	boolean	The result of the command (success or failure).
Error message	ErrorMessage	string	If the command was not successful, this will contain the error message that was returned.

Take screenshot

Operation ID:: TakeScreenshot

Takes a screenshot of the IA-Connect Agent user session and returns it as a Base64 encoded string.

Parameters

Name	Key	Required	Type	Description
Fullscreen	Fullscreen		boolean	Should the screenshot include the whole screen?
Left X pixels	LeftXPixels		integer	If not taking a screenshot of the whole screen, the X value (in pixels) from where the screenshot should start.
Top Y pixels	TopYPixels		integer	If not taking a screenshot of the whole screen, the Y value (in pixels) from where the screenshot should start.
Width pixels	WidthPixels		integer	If not taking a screenshot of the whole screen, the width of the screenshot from the start position.
Height pixels	HeightPixels		integer	If not taking a screenshot of the whole screen, the height of the screenshot from the start position.
Image format	ImageFormat		string	Provide the image format (PNG, JPG, BMP or GIF).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Screen image as Base64	ScreenBitmapBase64	string	The screen image as a Base64 encoded string.

Turn mouse wheel

Operation ID:: TurnMouseWheel

Turns the mouse wheel (positive or negative notches) in the IA-Connect Agent user session.

Parameters

Name	Key	Required	Type	Description
Wheel turns	WheelTurns	True	integer	The number of wheel turns to perform.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

UnZIP file

Operation ID:: UnZIPFile

Unzips a file which has been compressed using ZIP compression.

Parameters

Name	Key	Required	Type	Description
ZIP file path	ZIPFilename	True	string	The full path to the ZIP file to be unzipped. This must be accessible from the session where the IA-Connect Agent is running.
Extract folder	ExtractFolder		string	The folder path of the folder to extract the ZIP into. This must be accessible from the session where the IA-Connect Agent is running.
Extract all files to single folder	ExtractAllFilesToSingleFolder		boolean	If set to True, the folder structure inside the ZIP will be ignored and all files will be extracted to the specified folder.
Include files regular expression	IncludeFilesRegEx		string	An optional regular expression to allow you to specify which files should be extracted. Matches filename only.
Exclude files regular expression	ExcludeFilesRegEx		string	An optional regular expression to allow you to specify which files should be excluded from extraction. Matches filename only.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of files extracted successfully	FilesExtractedSuccessfully	integer	The number of files that were extracted from the ZIP successfully.
Number of files failed to extract	FilesFailedToExtract	integer	The number of files that failed to extract from the ZIP.
Number of files excluded	FilesExcluded	integer	The number of files that were excluded (if using the 'Exclude files regular expression' input).

Update Orchestrator Flow stats result

Operation ID:: UpdateOrchestratorFlowStatsResult

Update the result statistics for the current Worker Flow in the IA-Connect Orchestrator. This is used to modify the final result of a Flow stat in the IA-Connect Orchestator which is typically used for reporting purposes. This only works for the current Flow (the Orchestrator detects the Flow run Id). You cannot modify the stats for any other Flow.

Parameters

Name	Key	Required	Type	Description
Flow last action success	FlowLastActionSuccess		boolean	Set to true to specify that the last action in an Orchestrator Flow stat is a success. Set to false to specify that the last action in an Orchestrator Flow stat is a failure. Leave this field blank if you don't want to update the flow last action status (for example: If you only wish to update the last action code.
Flow last action error message	FlowLastActionErrorMessage		string	If specifying that the Flow last action was a failure, provide an error message here.
Flow last action code	FlowLastActionCode		integer	An optional code to assign to the Flow stat. This is typically used as an error code (for example, to distinguish between System and Business exceptions), but could be used as a success code.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	UpdateOrchestratorFlowStatsResultResult	boolean	The result of the command (success or failure).
Error message	ErrorMessage	string	If the command was not successful, this will contain the error message that was returned.

Wait for IA-Connect next hop session to connect

Operation ID:: WaitForNextHopSessionToConnect

Waits for the next hop session to connect and for the IA-Connect Agent to be running in the next hop session.

Parameters

Name	Key	Required	Type	Description
Next hop Director address	NextHopDirectorAddress		string	The optional address for the Next hop IA-Connect Director to forward commands to if none of the 'Next hop Director address is localhost', 'Next hop Director address is hostname', 'Next hop Director address is FQDN' or 'Next hop Director address is named pipe' parameters are set to true.
Next hop Director TCP port	NextHopDirectorTCPPort		integer	The TCP port that the next hop Director is listening on (the Director on the computer that the Agent is running on).
Next hop Director uses HTTPS	NextHopDirectorUsesHTTPS		boolean	Set to True if the next hop Director is using HTTPS, or false if not.
Next hop Director address is localhost	NextHopDirectorAddressIsLocalhostname		boolean	The next hop director address (relative to the Agent) is 'localhost'.
Next hop Director address is hostname	NextHopDirectorAddressIsHostname		boolean	The next hop director address is the hostname of the computer running the Agent (i.e. the one running the Agent and the Director).
Next hop Director address is FQDN	NextHopDirectorAddressIsFQDN		boolean	The next hop director address is the fully qualified domain name (FQDN) of the computer running the Agent (i.e. the one running the Agent and the Director).
Next hop Director address is named pipe	NextHopDirectorAddressIsNamedPipe		boolean	The next hop director address (relative to the Agent) is using a named pipe instead of a TCP/IP web service. This is the default to avoid using TCP/IP ports on the first-hop.
Increment next hop Director TCP port by Session Id	IncrementNextHopDirectorTCPPortBySessionId		boolean	To ensure the next hop Director TCP port is unique (if there are multiple parallel sessions using next-hop from the same host), the Session Id can be added to the Next hop Director TCP port.
Disable existing next hop	DisableExistingNextHop		boolean	Should double-hop be disabled (if currently active) before enabling again? If set to true (the default), any new double-hop enablement instructions will replace the previous ones. If set to false, this will enable triple-hop since the instructions will be received by the double-hop IA-Connect Agent.
Time in seconds to wait	SecondsToWait		double	The maximum number of seconds to wait for the next hop session to connect.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Next hop session connected	NextHopSessionConnected	boolean	Returns true if the next hop session connected before the maximum time to wait was exceeded.

Wait for IA-Connect session to close by name

Operation ID:: WaitForIAConnectSessionToCloseByName

Waits for the specified IA-Connect Director session to close. This is the session into which commands to an IA-Connect Agent are sent. The name will be known from an earlier 'Attach' action.

Parameters

Name	Key	Required	Type	Description
IA-Connect session name	IAConnectSessionName	True	string	The name of the IA-Connect session to check.
Time to wait in seconds	TimeToWaitInSeconds		integer	If there is no session of the specified type (if a specific type was specified), how long should IA-Connect wait for it?
Raise exception if timed out	RaiseExceptionIfTimedout		boolean	Should IA-Connect raise an exception if a new session has not connected before the timeout period has elapsed?
Attach to tier 1 IA-Connect session on success	AttachToTier1IAConnectSessionOnSuccess		boolean	Should IA-Connect connect back to the tier 1 IA-Connect session (the IA-Connect Director session of the Director that is receiving the SOAP and / or REST messages) if the session has successfully closed?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
IA-Connect session closed	IAConnectSessionClosed	boolean	Returns true if the session with the specified name has closed, or false if not.
Attached tier 1 IA-Connect session name	AttachedTier1IAConnectSessionName	string	The name of the tier 1 IA-Connect session that was connected to.

Wiggle mouse

Operation ID:: WiggleMouse

Moves the mouse back and forth by the specified number of coordinates.

Parameters

Name	Key	Required	Type	Description
X wiggle	XWiggle		integer	The number of pixels to move the mouse horizontally.
Y wiggle	YWiggle		integer	The number of pixels to move the mouse vertically.
Wiggle delay in seconds	WiggleDelayInSeconds		double	The number of seconds between the mouse movements.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Write text file

Operation ID:: WriteTextFile

Creates a text file on the computer where the IA-Connect Agent is running and writes text into the file.

Parameters

Name	Key	Required	Type	Description
File path	Filename	True	string	The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.
Text to write	TextToWrite		string	The text contents to be written into the file.
Append existing file	AppendExistingFile		boolean	If the file already exists, should the new text to write be appended to the end of the existing file?
Encoding	Encoding		string	Provide the file encoding (Unicode, UTF8, UTF7 or ASCII) or leave blank for the default (UTF8).
Create folder if required	CreateFolderIfRequired		boolean	If the folder to store the file in that was provided in the 'File path' parameter does not exist, should this folder be created?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Write to a user credential

Operation ID:: CredentialWrite

Writes a username and password to a credential in the user's profile in the IA-Connect Agent session, creating that credential if it doesn't exist. Credentials can be viewed from the Windows Control Panel.

Parameters

Name	Key	Required	Type	Description
Credential address	CredentialAddress	True	string	The name / address of the credential.
User name	UserName	True	string	The credential user name.
Password	Password	True	string	The credential password.
Credential type	CredentialType	True	string	The credential type: Windows or Generic.
Credential persistence	CredentialPersistence		string	The credential persistence: Session (lasts just for this login session), LocalMachine (persists for this user across sessions and reboots on this computer only) or Enterprise (could roam for this across between machines).
Symmetric encryption key	SymmetricKey		string	An optional symmetric encryption key used to encrypt the credential. You can only retrieve this credential if you know the key. Only usable with Generic Credentials.
Store password as identifier	StorePasswordAsIdentifier		string	If an identifier is supplied, this password will also be stored encrypted inside the Agent for later retrieval / usage by any commands which can make use of stored credentials. These passwords are only stored in memory and are lost when the Agent is closed. For example: MyExchangePassword.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	CredentialWriteResult	boolean	The result of the command (success or failure).
Error message	ErrorMessage	string	If the command was not successful, this will contain the error message that was returned.

Write to CSV file

Operation ID:: WriteCollectionToCSVFile

Creates a CSV file on the computer where the IA-Connect Agent is running. The CSV file is created from a collection (table) or from a table in JSON format.

Parameters

Name	Key	Required	Type	Description
Input table JSON	InputTableJSON		string	A table of data to write to the CSV file, in JSON format.
Output CSV file path	CSVFilePath	True	string	The full path to the CSV file. This must be accessible from the session where the IA-Connect Agent is running.
Output encoding	OutputEncoding		string	The text encoding format to use when writing to the CSV file. Supported encodings are UTF8, UTF7, Unicode and ASCII.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	WriteCollectionToCSVFileResult	boolean	The result of the command (success or failure).
Error message	ErrorMessage	string	If the command was not successful, this will contain the error message that was returned.