IA-Connect Session (Preview)

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 650 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 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 650 actions across all 8 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 connection10060 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 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.

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.

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.

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.

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 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 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).

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.

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.

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.

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 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

Uploads an new-style (7.2 onwards) license to the IA-Connect Agent.

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.

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.

Add file to ZIP

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

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 permission to file

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

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

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

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 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

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

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

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

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

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.

Clear clipboard

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

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

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

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

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

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

Create directory

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

Delete directory

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

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

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.

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).

Parameters

Name Key Required Type Description
Workflow
Workflow True string

Add the following expression here: workflow()

Returns

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.

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

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

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

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 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

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

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

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

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

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

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.

Get all IA-Connect command statistics

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 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).

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

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

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

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

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

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

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

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

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 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

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

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

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

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

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.

Get IA-Connect Agent info

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

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

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

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

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

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

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

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

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

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

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

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

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 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.

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

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

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

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

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

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).

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.

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.

Is screen reader enabled

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.

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.

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

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.

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

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 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

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

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.

Left click mouse

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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?

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

Run process

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

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

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

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.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Send password keys

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.

Workflow
Workflow True string

Add the following expression here: workflow()

Returns

Set clipboard

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

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

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

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

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

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

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

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

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

Uploads an new-style (7.2 onwards) license to the IA-Connect Agent.

Parameters

Name Key Required Type Description
License key
LicenseString True string

The IA-Connect license key.

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

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

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

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

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

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

Set screen reader

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

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

Take screenshot

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

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

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).

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.

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

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 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

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

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