IA-Connect Session
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 |
| IAConnect@ultima.com |
| Connector Metadata | |
|---|---|
| Publisher | Ultima Labs |
| Website | https://www.ultima.com/ultima-labs |
| Privacy policy | https://www.ultima.com/privacy-policy |
| Categories | IT Operations;Productivity |
IA-Connect is a Robotic Process Automation (RPA) platform which adds RPA functionality from Power Automate Cloud Flows to on-premises virtual machines or over Citrix or Microsoft Remote Desktop (RDS) connections. The IA-Connect Connectors provide over 800 actions, allowing you to automate every type of on-premise application directly from a Power Automate Cloud Flow. All IA-Connect actions are available directly from your Power Automate Cloud Flow providing easy integration between Cloud based and on-premises applications, the ability to leverage existing Power Automate conditions, loops, dynamic content, expressions and exception handling in your RPA processes. Utilising the IA-Connect Connectors also provides full execution history and auditability from the Flow run history whilst also removing the need to have a separate application/console/studio for developing your RPA processes.
Prerequisites
To use any of the IA-Connect Connectors, you must install the IA-Connect software. This is free to test for 30 days, following which you will require an IA-Connect license.
The IA-Connect software consists of two main components:
The IA-Connect Orchestrator, which is an Azure WebApp which you would host in your own Azure tenant. This handles the routing and security of RPA Flows to one or more on-premises or cloud-based virtual machines.
The IA-Connect Agent and Director, which is installed onto the virtual machines where the software you wish to automate is accessible. Additionally, the IA-Connect Agent can run inside a Citrix or Microsoft Remote Desktop Services (RDS) session, where the RPA commands are passed down a virtual channel into the remote session for execution. The IA-Connect Agent can be run from a network share and does not require installation.
Available IA-Connect Connectors
The available IA-Connect Connectors are:
- IA-Connect Dynamic Code
- IA-Connect Java
- IA-Connect JML
- IA-Connect Mainframe
- IA-Connect Microsoft Office
- IA-Connect SAP GUI
- IA-Connect Session
- IA-Connect UI
- IA-Connect Web Browser
How to get credentials
In order to receive your license and begin your 30-day free trial, please submit a request on our website (https://www.ultima.com/IA-Connect/Power-Automate).
Once a trial request is received, we will contact you via the email address provided to assist with setting up the IA-Connect software and to provide you with the trial license. This is a fully featured trial and will enable you to test any of the 800 actions across all 9 IA-Connect Connectors within your own environment during the trial period.
Get started with your connector
After submitting a trial request for IA-Connect, you will be able to download a ZIP file containing the IA-Connect software and documentation covering the installation and setup. We will also contact you to offer support and guidance through the installation process as required.
Support
During the trial period, you can contact Ultima Labs (IAConnect@ultima.com) for support and assistance.
Upon purchasing IA-Connect licenses you will receive support tokens which can be redeemed for bespoke training or support from Ultima's UK-based Technical Service Centre (TSC).
Known issues, common errors and FAQs
Our Knowledge Base contains a number of articles covering any known issues, common errors that may occur when using the IA-Connect Connectors and frequently asked questions. This is accessible at https://support.ultima.com/ultimalabs and an account to access these resources is provided during the IA-Connect trial and upon purchasing an IA-Connect license.
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
| IA-Connect Orchestrator address | string | Specify the IA-Connect Orchestrator address without the HTTP(S) component | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add file to ZIP |
ZIPs a file (stores the file into a compression archive). |
| Add folder to ZIP |
ZIPs files in a folder into a ZIP file (stores the files into a compression archive). |
| Add new Orchestrator automation task |
Add a new Orchestrator automation task into a queue that can be monitored from a Flow. Tasks can either be ready to run immediately or be deferred to run at a later time. |
| Add new Orchestrator deferred task |
Add a new Orchestrator deferred task into a queue that can be monitored from a Flow. The task will be deferred to a specified time in the future. Use this action to temporarily suspend a task for a specified amount of time (for example if you are waiting for something). |
| Add permission to file |
Adds a permission to a file on the computer where the IA-Connect Agent is running. |
| Add permission to folder |
Adds a permission to a folder on the computer where the IA-Connect Agent is running. |
| Attach to IA-Connect session by index |
Attaches to the specified IA-Connect Director session by index (e.g. attach to first Citrix ICA session). This is the session into which commands to an IA-Connect Agent are sent. |
| Attach to IA-Connect session by name |
Attaches to the specified IA-Connect Director session by name. This is the session into which commands to an IA-Connect Agent are sent. |
| Attach to most recent IA-Connect session |
Attaches to the IA-Connect Director session which most recently connected (optionally of a specified type). This is the session into which commands to an IA-Connect Agent are sent. |
| Attach to tier 1 IA-Connect session |
Attaches to the IA-Connect Director session of the Director receiving the SOAP and / or REST messages. This is the session into which commands to an IA-Connect Agent are sent. |
| Break folder security inheritance |
Breaks security inheritance on a folder on the computer where the IA-Connect Agent is running. |
| Bring IA-Connect Agent GUI to front |
Brings the IA-Connect Agent GUI to the front so it is visible onscreen. |
| Calibrate mouse_event |
Calibrates the mouse_event method by moving the mouse by the specified number of pixels and then reading the new mouse position. |
| Change Orchestrator automation task status |
Changes the selected Orchestrator automation task status to completed, failed or new. |
| Clear clipboard |
Clears the contents of the clipboard in the IA-Connect Agent user session. |
| Close IA-Connect Agent |
Closes the IA-Connect Agent. This does not affect the user session where the IA-Connect Agent was running. |
| Configure next hop IA-Connect Director |
Configure the next-hop Director in a double-hop scenario. This is only required if the default IA-Connect next-hop Director settings are not suitable. |
| Convert rectangle coordinates |
Converts a rectangle pixel coordinate from virtual to physical or physical to virtual. If you wish to convert a point, simply set Right=Left and Bottom=Top. Physical coordinates map directly to pixels on the monitor. Virtual coordinates are DPI scaled. If the underlying display scaling of all display devices is 100%, both physical and virtual coordinates are the same. |
| Copy file |
Copies a file on the computer where the IA-Connect Agent is running. |
| Copy file from client to server |
Copies a file from the local computer (running the IA-Connect Director) to the remote computer (running the IA-Connect Agent). |
| Copy file to clipboard |
Copies the specified local file to the clipboard in the IA-Connect Agent user session. |
| Create directory |
Creates a directory (folder) on the computer where the IA-Connect Agent is running. |
| Create Remote Desktop Session (RDS) launch file |
Create a Remote Desktop Session (RDS) launch file which can be used to automatically launch a Remote Desktop Session using specified parameters, instead of requiring automation of the Remote Desktop client UI. A RDS launch file has the extension '.rdp' and is often called a RDP file. |
| Defer existing Orchestrator automation task |
Defer an existing Orchestrator task which is already in the queue. The task will be deferred to a specified time in the future. This is commonly used to re-defer an existing task (i.e. the task was previously deferred and now needs to be deferred again). Use this action to temporarily suspend a task for a specified amount of time (for example if you are waiting for something). |
| Delete an Agent thread |
Deletes an Agent thread, or all Agent threads, killing (terminating, aborting) the thread first, if it is still running. An Agent thread can be used to run certain actions in a thread, permitting the actions to run for a long time (longer than the RPA timeout) or to run in parallel with other actions. Processes or flows monitoring the Agent thread will receive an 'Agent thread Id does not exist' error. |
| Delete directory |
Deletes a directory (folder) on the computer where the IA-Connect Agent is running. |
| Delete file |
Deletes a file on the computer where the IA-Connect Agent is running. |
| Delete files |
Deletes files within a specified folder matching a pattern on the computer where the IA-Connect Agent is running. |
| Delete Orchestrator automation task |
Delete an Orchestrator automation task that has been deferred. |
| Delete password in Agent memory |
Delete a password stored in Agent memory, or delete all Agent stored passwords. |
| Deletes a user credential |
Deletes a credential in the user's profile in the IA-Connect Agent session. Credentials can be viewed from the Windows Control Panel. |
| Disable IA-Connect next hop |
Disables next-hop so that all future commands will be processed by the Agent which receives them (as opposed to being forwarded on to the next hop Agent). |
| Disconnect remote session |
If the IA-Connect Agent is running in a remote session, this action disconnects the remote session. 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. If the IA-Connect Agent is running locally, this action will lock the 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). |
| Draw rectangle on screen |
Draws a rectangle on screen to aid in identifying screen coordinates, or the output of an action which reports screen coordinates. The rectangle is automatically removed after 5 seconds. |
| Enable folder security inheritance |
Enables security inheritance on a folder on the computer where the IA-Connect Agent is running. |
| Enable IA-Connect next hop |
Enables the next hop which will forward all future commands received onto the IA-Connect Agent running in the next hop session. |
| Expand environment variable |
Expands a string containing environment variables (e.g. %USERPROFILE% or %TEMP%) in the IA-Connect Agent user session. |
| Expand password string |
Accepts an input string which contains references to IA-Connect stored passwords and returns that string with the references replaced by the stored passwords. |
| Generate password |
Generates a password containing dictionary words, numbers, symbols, characters as defined in a template format. |
| Get Agent threads |
Returns a list of Agent threads. An Agent thread can be used to run certain actions in a thread, permitting the actions to run for a long time (longer than the RPA timeout) or to run in parallel with other actions. Typically, once an Agent thread has completed and its data retrieved, the Agent thread is deleted and won't appear on the list of threads. |
| Get all IA-Connect command statistics |
Returns all currently stored statistics on which commands the IA-Connect Agent has executed in the current session. |
| Get all Orchestrator automation tasks |
Retrieves all the Orchestrator automation tasks that match the filters. |
| Get available IA-Connect Sessions |
Retrieves a list of IA-Connect Director sessions (available connections to sessions where the IA-Connect Agent is running, such as local, Microsoft RDP or Citrix ICA). |
| Get client hostname |
Returns the hostname of the client where the IA-Connect Director is running. |
| Get clipboard |
Gets the current content of the clipboard in the IA-Connect Agent user session. |
| Get CSV text as collection |
Returns a CSV file on the computer where the IA-Connect Agent is running as a collection (table). Only requires read only access to CSV file. |
| Get current mouse coordinate |
Gets the current mouse cursor position in the IA-Connect Agent user session. |
| Get default printer |
Gets the name of the default printer for the user in the IA-Connect Agent session. |
| Get Director client type and session information |
Returns the details of the local or remote session being handled by the tier 1 Director. |
| 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 failed action error message from flow result JSON |
Deserialises the JSON output of one or more flow result() expressions and retrieves the first located error message from a failed action. The error message can be stored in the JSON in a variety of formats. This action processes known formats and returns the first located error message. |
| Get file contents as Base64 |
Retrieve the contents of the specified file in Base64 format, a format suitable for transmission via API and easily converted back into the original text or binary format. |
| 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 Flow stats from Orchestrator |
Returns a list of Flow stats from the IA-Connect Orchestrator. Used for reporting purposes. You can optionally use one or more filters to limit the returned results. |
| Get 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 generic credential from Orchestrator |
Retrieves a generic credential that has been stored in the IA-Connect Orchestrator. A credential can hold usernames, passwords, hostnames, URLs and other generic data. |
| 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 global coordinate configuration |
Retrieves the configuration of the IA-Connect Agent global coordinate system configuration, which is used to display element locations (for example: during mouse inspection) and calculate mouse positions (for example: when performing global mouse actions). |
| 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 failed action from Orchestrator flow stats |
Retrieves details of the last action which passed through the IA-Connect Orchestrator to a worker, if that action had failed. This action is most commonly used during error handling. |
| 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 login history from Orchestrator |
Returns the IA-Connect Orchestrator login history for reporting purposes. You can optionally use one or more filters to limit the returned results. |
| 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 mouse multiplier |
Retrieves the global mouse multiplier in the IA-Connect Agent user session. This defaults to (1, 1) but could have been changed by the 'Set mouse multiplier' action. |
| Get next Orchestrator automation task |
Retrieves the next Orchestrator automation task matching the given search criteria. |
| Get Orchestrator automation task |
Retrieves a specific Orchestrator automation task. |
| 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 pixel colour at coordinate |
Returns the RGB colour of a pixel at a given coordinate. |
| 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. For the IA-Connect local Agent running on a physical desktop or laptop, this will provide information about all display devices and their scaling. On a virtual machine, typically only one display will be reported, unless the virtual machine has been configured to present multiple displays (uncommon). In a remote session, typically only one display will be reported, even if that display spans multiple local displays, since remote sessions usually create a single virtual display. |
| Get stored password |
Retrieves a previously generated or stored password. |
| Get worker availability stats from Orchestrator |
Returns worker availability stats from the IA-Connect Orchestrator. Used for reporting purposes. You can optionally use one or more filters to limit the returned results. |
| Get worker flow usage heatmap from Orchestrator |
Returns worker flow usage daily heatmap from the IA-Connect Orchestrator. Used for reporting purposes. You can optionally use one or more filters to limit the returned results. |
| Is directory accessible |
Returns whether a directory (folder) is accessible and whether permissions are restricting access to it on the computer where the IA-Connect Agent. |
| Is screen reader enabled |
Returns whether the screen reader has been enabled in the IA-Connect Agent user session. |
| Is session locked |
Reports whether the session that the IA-Connect Agent is running in is locked. |
| Is TCP port responding |
Reports whether a network TCP port is responding to a connection attempt by the IA-Connect Agent. This could be a TCP port on the computer where the IA-Connect Agent is running (enter 'localhost' for the remote host) or on any remote computer. If the IA-Connect Agent successfully connects to a TCP port, it immediately closes the TCP connection. |
| Keep session alive |
Keeps the IA-Connect Agent user session alive by moving the mouse at the specified interval to prevent the session from becoming idle. |
| Kill all other IA-Connect Agents |
Kills any other instances of the IA-Connect Agent that are currently running in the user session. This will ensure that only one instance of the IA-Connect Agent is running. |
| Kill an Agent thread |
Kills (terminates, aborts) an Agent thread. An Agent thread can be used to run certain actions in a thread, permitting the actions to run for a long time (longer than the RPA timeout) or to run in parallel with other actions. The Agent thread is not deleted (use the action 'Delete an Agent thread' to delete threads) to allow any processes or flows monitoring the Agent thread to receive the 'IA-Connect Agent thread has been aborted' error. |
| Kill IA-Connect session by name |
Kills the specified IA-Connect Director session if it exists. This is the session into which commands to an IA-Connect Agent are sent. The name will be known from an earlier 'Attach' action. |
| Kill process |
Kills any running process in the IA-Connect Agent user session which has the specified process name. |
| Kill process ID |
Kills a running process in the IA-Connect Agent user session which has the specified process Id. Process Ids are unique so only one process can match the Id. Process Ids are dynamic and are different for every launch of an application. |
| Launch Remote Desktop Session (RDS) |
Launch a Remote Desktop Session (RDS) using a RDP launch file. |
| Left click mouse |
Clicks the left mouse button in the IA-Connect Agent user session. |
| Left click mouse at coordinate |
Clicks the left mouse button in the IA-Connect Agent user session at the specified coordinates. |
| Left hold mouse |
Holds the left mouse button in the IA-Connect Agent user session for the specified amount of seconds. |
| Left hold mouse at coordinate |
Holds the left mouse button at the specified coordinates in the IA-Connect Agent user session for the specified amount of seconds. |
| Left mouse button down |
Presses (and does not release) the left mouse button in the IA-Connect Agent user session. To release the mouse, use the left mouse button up action. |
| Left mouse button up |
Releases the left mouse button in the IA-Connect Agent user session. |
| Left mouse drag between coordinates |
Performs a left mouse button drag between the two specified coordinates in the IA-Connect Agent user session. |
| Lock session |
Locks the session that the IA-Connect Agent is running in. |
| 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. |
| Raise exception |
Raise an exception with the specified message if the input exception is not blank. This is useful to trigger an exception message in your flow (HTTP 400) which will then be caught by an error handling stage, if an earlier action had an error. This exception is not recorded in the IA-Connect Orchestrator flow run stats. |
| Read all text from file |
Reads the text contents of a file on the computer where the IA-Connect Agent is running. |
| Read from a user credential |
Reads a username and password from a credential in the user's profile in the IA-Connect Agent session. Credentials can be viewed from the Windows Control Panel. Both the username and password can be retrieved from a Generic credential while only the username can be retrieved from a Windows credential. |
| Remove identity from file security |
Removes an identity (e.g. user, group or computer) from the security permissions on a file on the computer where the IA-Connect Agent is running. |
| Remove identity from folder security |
Removes an identity (e.g. a user, group or computer) from the security permissions on a folder on the computer where the IA-Connect Agent is running. |
| Replace variable data in INI file |
Updates a single variable in an INI file. |
| Reset IA-Connect command statistics |
Resets any currently stored statistics on which commands the IA-Connect Agent has executed in the current session. |
| Reset next hop IA-Connect Director settings |
Resets any custom IA-Connect Director settings that have been set, restoring the default settings. |
| Retrieve the status of an Agent thread |
Retrieves the status of an Agent thread and optionally retrieve the thread output data. An Agent thread can be used to run certain actions in a thread, permitting the actions to run for a long time (longer than the RPA timeout) or to run in parallel with other actions. |
| Right click mouse |
Clicks the right mouse button in the IA-Connect Agent user session. |
| Right click mouse at coordinate |
Clicks the right mouse button in the IA-Connect Agent user session at the specified coordinates. |
| Right hold mouse |
Holds the right mouse button in the IA-Connect Agent user session for the specified amount of seconds. |
| Right hold mouse at coordinate |
Holds the right mouse button at the specified coordinates in the IA-Connect Agent user session for the specified amount of seconds. |
| Right mouse button down |
Presses (and does not release) the right mouse button in the IA-Connect Agent user session. To release the mouse, use the right mouse button up action. |
| Right mouse button up |
Releases the right mouse button in the IA-Connect Agent user session. |
| Right mouse drag between coordinates |
Performs a right mouse button drag between the two specified coordinates in the IA-Connect Agent user session. |
| Run alternative IA-Connect Agent |
Runs an alternative IA-Connect Agent (for example a later version) by loading the Agent executable from a file location. |
| Run alternative IA-Connect Agent sent from director |
Runs an alternative IA-Connect Agent (for example a later version) by uploading the alternative Agent from the IA-Connect Director and then loading the alternative Agent executable. |
| Run generic IA-Connect Agent command |
Runs a generic IA-Connect Agent command passing arguments as JSON and returning output data as JSON. Used to run Agent commands when the Director and Inspector are older versions than the Agent and hence don't understand the command. |
| Run process |
Launch a process, command or application. |
| Send key events |
Sends global key press events to the IA-Connect Agent user session. |
| Send keys |
Sends global key presses to the IA-Connect Agent user session. |
| Send password key events |
Sends global key press events to the IA-Connect Agent user session, specifically for entering a password. |
| Send password keys |
Sends global key presses to the IA-Connect Agent user session, specifically for entering a password. |
| Set clipboard |
Sets the content of the clipboard in the IA-Connect Agent user session. |
| Set default printer |
Sets the default printer for the user in the IA-Connect Agent session. |
| Set IA-Connect Agent command timeout |
Sets the command timeout that the IA-Connect Agent will use for each command that is executed. |
| Set IA-Connect Agent global coordinate configuration |
Configures the IA-Connect Agent global coordinate system, which is used to display element locations (for example: during mouse inspection) and calculate mouse positions (for example: when performing global mouse actions). The defaults provide the latest functionality, but you may use this action to revert to the behaviour in previous versions of the Agent or specify that an API is using a different coordinate system. |
| Set IA-Connect Agent GUI opacity |
Sets the opacity of the IA-Connect Agent from 1 (visible) to 0 (transparent). |
| Set IA-Connect Agent GUI position |
Sets the onscreen position of the IA-Connect Agent GUI to the specified location. |
| Set IA-Connect Agent GUI topmost |
Sets the IA-Connect Agent as topmost. This means that the IA-Connect Agent will always be visible on screen and cannot be hidden behind other application windows. |
| Set IA-Connect Agent log level |
Sets the IA-Connect Agent logging level to the specified value (1 being the lowest level and 4 being the highest). |
| Set IA-Connect Director log level |
Sets the IA-Connect Director logging level to the specified value (1 being the lowest level and 4 being the highest). |
| Set IA-Connect license code |
Uploads an old-style (7.0 and 7.1) Agent domain license to the IA-Connect Agent. |
| Set IA-Connect license key |
Licenses the IA-Connect Agent with a license key. This can be a license string or the friendly name of a license held in the IA-Connect Orchestrator. |
| Set mouse cursor position |
Sets the mouse cursor in the IA-Connect Agent user session to the specified position. |
| Set mouse move method |
Sets the current mouse move method to either mouse_event or setcursorpos. |
| Set mouse multiplier |
Sets the global 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. |
| Store password in Agent memory |
Store a password into Agent memory (encrypted) where it can be used from any actions which support stored passwords. Passwords are only stored in memory and are lost when the Agent is closed. |
| 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. |
| Unlock session |
Unlocks the session that the IA-Connect Agent is running in. This requires the IA-Connect Unlocker Credential Provider to be installed on the computer hosting the session since only a Credential Provider can unlock a computer. |
| UnZIP file |
Unzips a file which has been compressed using ZIP compression. |
| Update Orchestrator Flow stats result |
Update the result statistics for the current Worker Flow in the IA-Connect Orchestrator. This is used to modify the final result of a Flow stat in the IA-Connect Orchestrator which is typically used for reporting purposes. This only works for the current Flow (the Orchestrator detects the Flow run Id). You cannot modify the stats for any other Flow. |
| Wait for Agent thread to complete successfully |
Waits for an Agent thread to complete and optionally retrieve the thread output data. An Agent thread can be used to run certain actions in a thread, permitting the actions to run for a long time (longer than the RPA timeout) or to run in parallel with other actions. If the Agent thread completes, but in failure, an exception will be raised. |
| Wait for IA-Connect next hop session to connect |
Waits for the next hop session to connect and for the IA-Connect Agent to be running in the next hop session. |
| Wait for IA-Connect session to close by name |
Waits for the specified IA-Connect Director session to close. This is the session into which commands to an IA-Connect Agent are sent. The name will be known from an earlier 'Attach' action. |
| Wiggle mouse |
Moves the mouse back and forth by the specified number of coordinates. |
| Write text file |
Creates a text file on the computer where the IA-Connect Agent is running and writes text into the file. |
| Write to a user credential |
Writes a username and password to a credential in the user's profile in the IA-Connect Agent session, creating that credential if it doesn't exist. Credentials can be viewed from the Windows Control Panel. |
| Write to CSV file |
Creates a CSV file on the computer where the IA-Connect Agent is running. The CSV file is created from a collection (table) or from a table in JSON format. |
Add file to ZIP
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 new Orchestrator automation task
Add a new Orchestrator automation task into a queue that can be monitored from a Flow. Tasks can either be ready to run immediately or be deferred to run at a later time.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Set automation name
|
SetAutomationName | string |
Select 'Auto' if you want to use the flow name as the task name or select 'Manual' and enter a name in 'Automation name' field to use that name. |
|
|
Automation name
|
AutomationName | string |
This will only be used if 'Manual' is chosen in the 'Set automation name' field. A friendly name given to help identify the task later or to associate it with a particular flow. Multiple tasks can use the same automation name. |
|
|
Task input data
|
TaskInputData | string |
Optional data to make available to the task when it starts. You are free to store data in any format, but JSON is a commonly used format. |
|
|
Process stage
|
ProcessStage | string |
The point at where the automation process / flow should start. This is an optional string value which will be unique to the specific process / flow. This will be used by a condition within the process / flow to decide what step to perform next. For example: If you want the process / flow to start at the 'Exchange' stage, enter the value 'Exchange'. |
|
|
Priority
|
Priority | integer |
Set the priority level of this automation task (1 being highest level). |
|
|
SLA in minutes
|
SLA | integer |
Set the amount of minutes required for your SLA. Set this to 0 if you don't have an SLA. By default automation tasks close to the end of the SLA will take priority over other tasks. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Task Id
|
TaskId | integer |
The Id of the Orchestrator automation task that was created. |
Add new Orchestrator deferred task
Add a new Orchestrator deferred task into a queue that can be monitored from a Flow. The task will be deferred to a specified time in the future. Use this action to temporarily suspend a task for a specified amount of time (for example if you are waiting for something).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Set automation name
|
SetAutomationName | string |
Select 'Auto' if you want to use the flow name as the task name or select 'Manual' and enter a name in 'Automation name' field to use that name. |
|
|
Automation name
|
AutomationName | string |
This will only be used if 'Manual' is chosen in the 'Set automation name' field. A friendly name given to help identify the task later or to associate it with a particular flow. Multiple tasks can use the same automation name. |
|
|
Deferral time in minutes
|
DeferralTimeInMinutes | integer |
How many minutes should the automation task be delayed for. |
|
|
Deferral stored data
|
DeferralStoredData | string |
Optional data to store with this task. It will become available to the process / flow when it continues from a deferral. This is generally used to store data you have calculated during your process / flow that you need to become available again after deferral. You are free to store data in any format, but JSON is a commonly used format. |
|
|
Process stage
|
ProcessStage | string |
The point at where the automation process / flow should continue after deferral. This is an optional string value which will be unique to the specific process / flow. This will be used by a condition within the deferred process / flow to decide what step to perform next. For example: If you want the process / flow to continue at the 'Exchange' stage when it continues after deferral, enter the value 'Exchange'. |
|
|
Priority
|
Priority | integer |
Set the priority level of this task (1 being highest level). |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Task Id
|
TaskId | integer |
The Id of the deferral task that was created. |
Add permission to file
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 | True | string |
The name of the IA-Connect session to connect to. |
|
Virtual channel must be connected
|
VirtualChannelMustBeConnected | boolean |
Should the IA-Connect Director validate that the virtual channel is connected when attaching to the session? This ensures that the IA-Connect Agent is running in the specified session. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
Attach to most recent IA-Connect session
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. |
Change Orchestrator automation task status
Changes the selected Orchestrator automation task status to completed, failed or new.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task Id
|
TaskId | True | integer |
The Id of the Orchestrator task to be modified. |
|
Automation task new status
|
AutomationTaskStatus | string |
The new task status for the specified automation task. |
|
|
Put task on hold
|
TaskOnHold | boolean |
If changing the status to new and you set this value to true, the task will be put on hold. |
|
|
Erase task input data
|
EraseTaskInputData | boolean |
If you set this value to true, any task input data will be erased. This is typically used to save storage space for a completed or failed task since the raw data is no longer required. |
|
|
Erase deferral stored data
|
EraseDeferralStoredData | boolean |
If you set this value to true, any deferral stored data will be erased. This is typically used to save storage space for a completed or failed task since the raw data is no longer required. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
TasksChangeTaskStatusResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
Clear clipboard
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
Convert rectangle coordinates
Converts a rectangle pixel coordinate from virtual to physical or physical to virtual. If you wish to convert a point, simply set Right=Left and Bottom=Top. Physical coordinates map directly to pixels on the monitor. Virtual coordinates are DPI scaled. If the underlying display scaling of all display devices is 100%, both physical and virtual coordinates are the same.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Rectangle left edge screen pixel X-coordinate
|
RectangleLeftPixelXCoord | True | integer |
The left pixel edge of the rectangle to convert. Can be in virtual or physical pixels depending on the conversion type. |
|
Rectangle top edge screen pixel Y-coordinate
|
RectangleTopPixelYCoord | True | integer |
The top pixel edge of the rectangle to convert. Can be in virtual or physical pixels depending on the conversion type. |
|
Rectangle right edge screen pixel X-coordinate
|
RectangleRightPixelXCoord | True | integer |
The right pixel edge of the rectangle to convert. Can be in virtual or physical pixels depending on the conversion type. |
|
Rectangle bottom edge screen pixel Y-coordinate
|
RectangleBottomPixelYCoord | True | integer |
The bottom pixel edge of the rectangle to convert. Can be in virtual or physical pixels depending on the conversion type. |
|
Conversion type
|
ConversionType | True | string |
The type of conversion: From physical to virtual (PhysicalToVirtual or P2V) or virtual to physical (VirtualToPhysical or V2P). |
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Converted rectangle left edge screen pixel X-coordinate
|
ConvertedRectangleLeftPixelXCoord | integer |
The left pixel edge of the converted rectangle. Can be in virtual or physical pixels depending on the conversion type. |
|
Converted rectangle top edge screen pixel Y-coordinate
|
ConvertedRectangleTopPixelYCoord | integer |
The top pixel edge of the converted rectangle. Can be in virtual or physical pixels depending on the conversion type. |
|
Converted rectangle right edge screen pixel X-coordinate
|
ConvertedRectangleRightPixelXCoord | integer |
The right pixel edge of the converted rectangle. Can be in virtual or physical pixels depending on the conversion type. |
|
Converted rectangle bottom edge screen pixel Y-coordinate
|
ConvertedRectangleBottomPixelYCoord | integer |
The bottom pixel edge of the converted rectangle. Can be in virtual or physical pixels depending on the conversion type. |
|
Converted rectangle width
|
ConvertedRectangleWidth | integer |
The width in pixels of the converted rectangle. Can be in virtual or physical pixels depending on the conversion type. |
|
Converted rectangle height
|
ConvertedRectangleHeight | integer |
The height in pixels of the converted rectangle. Can be in virtual or physical pixels depending on the conversion type. |
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
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
CopyFileToClipboardResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
Create directory
Creates a directory (folder) on the computer where the IA-Connect Agent is running.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Directory path
|
DirectoryPath | True | string |
The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running. |
|
Error if already exists
|
ErrorIfAlreadyExists | boolean |
Should IA-Connect raise an error if the directory (folder) already exists? |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
Create Remote Desktop Session (RDS) launch file
Create a Remote Desktop Session (RDS) launch file which can be used to automatically launch a Remote Desktop Session using specified parameters, instead of requiring automation of the Remote Desktop client UI. A RDS launch file has the extension '.rdp' and is often called a RDP file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Remote address
|
RemoteAddress | True | string |
The address of the remote system to connect to. This could be an IP address, hostname or Fully Qualified Domain Name (FQDN). |
|
Output folder path
|
OutputFolderPath | True | string |
The folder in which to save the RDP file. |
|
RDP filename
|
RDPFileName | True | string |
The name of the RDP file which will be created in the output folder path. |
|
Overwrite RDP file if already exists
|
OverwriteRDPFileIfAlreadyExists | boolean |
Set to true to automatically overwrite any RDP file with the same folder / filename. Set to false if a new RDP file should not be created if an existing RDP file with the same folder / filename already exists. |
|
|
Trust remote computer
|
TrustRemoteComputer | boolean |
Set to true to mark the remote address as trusted (in the Windows registry), mainly for device redirection purposes, eliminating a popup you might receive when launching the RDP file. |
|
|
Store credentials
|
StoreCredentials | boolean |
Set to true to create a user credential to hold the Remote Desktop authentication details. This can allow you to connect to the Remote Desktop system without being prompted for authentication. |
|
|
UserName
|
UserName | string |
If storing a credential to hold the Remote Desktop authentication details, this allows you to specify the username to store in the credential. |
|
|
Password
|
Password | string |
If storing a credential to hold the Remote Desktop authentication details, this allows you to specify the password to store in the credential. |
|
|
Credential type
|
CredentialType | string |
If storing a credential to hold the Remote Desktop authentication details, the allows you to specify the credential type: Windows or Generic. For saving a RDP credential, you would typically create a Windows credential. |
|
|
Credential persistence
|
CredentialPersistence | string |
If storing a credential to hold the Remote Desktop authentication details, this allows you to specify the credential persistence: Session (lasts just for this login session), LocalMachine (persists for this user across sessions and reboots on this computer only) or Enterprise (could roam for this across between machines). The default when creating RDP files is 'Session'. |
|
|
Redirect printers
|
RedirectPrinters | boolean |
Should printers in the local session be mapped into the remote desktop session? This setting might be enforced at the remote end and hence not take effect. |
|
|
Redirect all drives
|
RedirectAllDrives | boolean |
Should all drive letters (e.g. C:) in the local session be mapped into the remote desktop session? This setting might be enforced at the remote end and hence not take effect. |
|
|
Redirect clipboard
|
RedirectClipboard | boolean |
Should the clipboard be shared between the local and remote system, allowing copy and paste between the two systems? This setting might be enforced at the remote end and hence not take effect. |
|
|
Fullscreen
|
Fullscreen | boolean |
Should the remote desktop session be fullscreen. |
|
|
Desktop width
|
DesktopWidth | integer |
The width of the remote desktop session in pixels if the remote desktop session is not fullscreen. |
|
|
Desktop height
|
DesktopHeight | integer |
The height of the remote desktop session in pixels if the remote desktop session is not fullscreen. |
|
|
Use multi monitor
|
UseMultiMonitor | boolean |
Set to false if a fullscreen remote desktop session should only use a single monitor. Set to true if a fullscreen remote desktop session should use all monitors. Has no effect on a single-monitor system (and hence most virtual machines). |
|
|
Session colour depth
|
SessionBPP | integer |
The colour depth of the remote desktop session in bits per pixel (BPP). A higher number results in more colours. Supported values are 15, 16, 24, 32. |
|
|
Smart sizing
|
SmartSizing | boolean |
Set to true for the local computer to automatically scale the contents of the remote session to fit the windows size. Set to false to not automatically scale. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
RDP file path
|
RDPFilePath | string |
The full path of the generated RDP file. |
Defer existing Orchestrator automation task
Defer an existing Orchestrator task which is already in the queue. The task will be deferred to a specified time in the future. This is commonly used to re-defer an existing task (i.e. the task was previously deferred and now needs to be deferred again). Use this action to temporarily suspend a task for a specified amount of time (for example if you are waiting for something).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task Id
|
TaskId | True | integer |
The Id of the existing Orchestrator automation task to defer (or defer again). |
|
Deferral time in minutes
|
DeferralTimeInMinutes | integer |
How many minutes should the automation task be delayed for. |
|
|
Deferral stored data
|
DeferralStoredData | string |
Optional data to store with this task. It will become available to the process / flow when it continues from a deferral. This is generally used to store data you have calculated during your process / flow that you need to become available again after deferral. You are free to store data in any format, but JSON is a commonly used format. |
|
|
Process stage
|
ProcessStage | string |
The point at where the automation process / flow should continue after deferral. This is an optional string value which will be unique to the specific process / flow. This will be used by a condition within the deferred process / flow to decide what step to perform next. For example: If you want the process / flow to continue at the 'Exchange' stage when it continues after deferral, enter the value 'Exchange'. |
|
|
Priority
|
Priority | integer |
Set the priority level of this task (1 being highest level). |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
TasksDeferExistingTaskResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
Delete an Agent thread
Deletes an Agent thread, or all Agent threads, killing (terminating, aborting) the thread first, if it is still running. An Agent thread can be used to run certain actions in a thread, permitting the actions to run for a long time (longer than the RPA timeout) or to run in parallel with other actions. Processes or flows monitoring the Agent thread will receive an 'Agent thread Id does not exist' error.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Thread Id
|
ThreadId | integer |
If you previously ran an Agent action as a thread, provide the thread Id to terminate and delete the thread. This thread Id will have been provided as an output of the action previous run as a thread. If the specified Agent thread Id does not exist, an exception will be raised. |
|
|
Delete all Agent threads
|
DeleteAllAgentThreads | boolean |
Set to true to delete all Agent threads. Set to false (the default) to delete a single Agent thread specified by the 'Thread Id' input. |
|
|
Raise exception if Agent thread fails to delete
|
RaiseExceptionIfAgentThreadFailsToDelete | boolean |
Set to true to raise an exception if an Agent thread fails to delete. Note that this might cause an exception to be raised if an Agent thread completes while issuing this action (since it will no longer exist at the point of deletion). Set to false (the default) to ignore errors while deleting Agent threads. The output 'Number of Agent threads deleted' will report how many Agent threads were deleted. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Number of Agent threads deleted
|
NumberOfAgentThreadsDeleted | integer |
If 'Delete all Agent threads' is true, this output will hold the number of Agent threads deleted (0 or higher). If 'Delete all Agent threads' is false and an Agent thread Id was provided, this output will be set to 0 or 1. |
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. |
Delete Orchestrator automation task
Delete an Orchestrator automation task that has been deferred.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task Id
|
TaskId | True | integer |
The Id of the Orchestrator automation task to delete. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
TasksDeleteTaskResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
Delete password in Agent memory
Delete a password stored in Agent memory, or delete all Agent stored passwords.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Delete all passwords
|
DeleteAllPasswords | boolean |
Set to true to delete all passwords stored in Agent memory. Set to false (the default) to delete a single password matching the provided identifier. |
|
|
Identifier
|
Identifier | string |
A unique identifier for the password to delete. For example: SAPGUILogon. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
DeletePasswordInAgentMemoryResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
Deletes a user credential
Deletes a credential in the user's profile in the IA-Connect Agent session. Credentials can be viewed from the Windows Control Panel.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Credential address
|
CredentialAddress | True | string |
The name / address of the credential. |
|
Credential type
|
CredentialType | True | string |
The credential type: Windows or Generic. |
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
CredentialDeleteResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
Disable IA-Connect next hop
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
If the IA-Connect Agent is running in a remote session, this action disconnects the remote session. 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. If the IA-Connect Agent is running locally, this action will lock the 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 before losing contact (which would only occur in a remote session). |
|
|
Do not disconnect if local Agent
|
DoNotDisconnectIfLocalAgent | boolean |
If set to true and the IA-Connect Agent is running in a local session (i.e. directly on the worker) then this action will be silently ignored. This is useful because disconnecting a local Agent would lock the session and hence limit RPA functions until the session is unlocked. |
|
|
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 | True | string |
The name of the IA-Connect session to check. |
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
IA-Connect session exists
|
IAConnectSessionExists | boolean |
Returns true if a session with the specified name exists, or false if not. |
Double left click mouse
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. |
Draw rectangle on screen
Draws a rectangle on screen to aid in identifying screen coordinates, or the output of an action which reports screen coordinates. The rectangle is automatically removed after 5 seconds.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Rectangle left edge screen pixel X-coordinate
|
RectangleLeftPixelXCoord | True | integer |
The left pixel edge of the rectangle to display. Can be in virtual or physical pixels depending on the input 'Coordinates are physical'. |
|
Rectangle right edge screen pixel X-coordinate
|
RectangleRightPixelXCoord | True | integer |
The right pixel edge of the rectangle to display. Can be in virtual or physical pixels depending on the input 'Coordinates are physical'. |
|
Rectangle top edge screen pixel Y-coordinate
|
RectangleTopPixelYCoord | True | integer |
The top pixel edge of the rectangle to display. Can be in virtual or physical pixels depending on the input 'Coordinates are physical'. |
|
Rectangle bottom edge screen pixel Y-coordinate
|
RectangleBottomPixelYCoord | True | integer |
The bottom pixel edge of the rectangle to display. Can be in virtual or physical pixels depending on the input 'Coordinates are physical'. |
|
Pen colour
|
PenColour | string |
The colour of the rectangle to be drawn (e.g. red, green, blue, yellow, purple or orange) or a string hex code e.g. #FF0000. |
|
|
Pen thickness pixels
|
PenThicknessPixels | integer |
The thickness (in pixels) of the highlight rectangle border. |
|
|
Seconds to display
|
SecondsToDisplay | integer |
The number of seconds to display the rectangle. |
|
|
Coordinates are physical
|
CoordinatesArePhysical | boolean |
Set to true if the coordinates being provided are physical screen coordinates. Set to false if the coordinates being provided are virtual. If the underlying display scaling is 100%, both physical and virtual coordinates are the same. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
DrawRectangleOnScreenResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
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). |
|
|
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. |
|
|
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. |
|
|
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. |
Expand password string
Accepts an input string which contains references to IA-Connect stored passwords and returns that string with the references replaced by the stored passwords.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Input string
|
InputString | string |
The input string which contains IA-Connect stored password identifiers. For example: 'Welcome new starter, your new account password is {IAConnectPassword:GeneratedPassword}' where 'GeneratedPassword' is the name of a stored IA-Connect password. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Output string
|
OutputString | string |
The output string which contains the input string with password identifiers replaced by the actual passwords. For example: 'Welcome new starter, your new account password is Fantastic12Monkeys!'. |
Generate password
Generates a password containing dictionary words, numbers, symbols, characters as defined in a template format.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Password format
|
PasswordFormat | True | string |
The format of the generated password. The symbol 'w' represents a dictionary word, 'n' represents a number, 's' represents a symbol, 'l' represents a lower-case letter, 'L' represents an upper-case letter. For example wnnws might generate Pluto35Marmite! |
|
Minimum length
|
MinimumLength | integer |
The minimum length of the generated password. If the generated password is too short, additional dictionary words will be added until the length is met. Set to 0 if there is no minimum length requirement. |
|
|
Return as plain text
|
ReturnAsPlainText | boolean |
Set to true to return the password as plain text. |
|
|
Store password as identifier
|
StorePasswordAsIdentifier | string |
If an identifier is supplied, this password will be stored encrypted inside the Agent for later retrieval / usage by any commands which can make use of stored credentials. These passwords are only stored in memory and are lost when the Agent is closed. For example: MyExchangePassword. |
|
|
Supported symbols
|
SupportedSymbols | string |
Allows you to provide a list of symbols to be randomly used when the symbol 's' is used in the format of a generated password. If not specified, a built-in list is used. For example: !$()*. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Plain text password
|
PlainTextPassword | string |
The password in plain text if requested. The password might be requested in plain text because the password is a one-time password intended to be transmitted via SMS or email (for example) and hence needs to be seen as-is. |
Get Agent threads
Returns a list of Agent threads. An Agent thread can be used to run certain actions in a thread, permitting the actions to run for a long time (longer than the RPA timeout) or to run in parallel with other actions. Typically, once an Agent thread has completed and its data retrieved, the Agent thread is deleted and won't appear on the list of threads.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Sort order
|
SortOrder | string |
The sort order for the output list of Agent threads. Supported sort orders are 'None', 'ThreadStartTime', 'ThreadStartTime_Desc', 'ThreadEndTime', 'ThreadEndTime_Desc', 'ThreadId', 'ThreadId_Desc', 'ThreadActionName', 'ThreadActionName_Desc', 'ThreadRuntime', 'ThreadRuntime_Desc'. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Number of Agent threads
|
NumberOfAgentThreads | integer |
The number of Agent threads which are still running or available for retrieval. Typically, once an Agent thread has completed and its data retrieved, the Agent thread is deleted and won't appear on the list of threads. |
|
Agent threads
|
AgentThreads | array of object |
The list of Agent threads and all available thread information (except the internal thread data). |
|
ThreadId
|
AgentThreads.ThreadId | integer | |
|
IAConnectActionName
|
AgentThreads.IAConnectActionName | string | |
|
ThreadStartDateTimeUTC
|
AgentThreads.ThreadStartDateTimeUTC | date-time | |
|
ThreadCompletedDateTimeUTC
|
AgentThreads.ThreadCompletedDateTimeUTC | date-time | |
|
ThreadRuntimeInSeconds
|
AgentThreads.ThreadRuntimeInSeconds | integer | |
|
ThreadStarted
|
AgentThreads.ThreadStarted | boolean | |
|
ThreadRunning
|
AgentThreads.ThreadRunning | boolean | |
|
ThreadCompleted
|
AgentThreads.ThreadCompleted | boolean | |
|
ThreadSuccess
|
AgentThreads.ThreadSuccess | boolean | |
|
ThreadStatusMessage
|
AgentThreads.ThreadStatusMessage | string | |
|
ThreadErrorMessage
|
AgentThreads.ThreadErrorMessage | string |
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 all Orchestrator automation tasks
Retrieves all the Orchestrator automation tasks that match the filters.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation name filter
|
AutomationName | string |
Leave blank to return Orchestrator automation tasks with any name. Enter a value to only retrieve tasks with this automation name. |
|
|
Automation task status filter
|
AutomationTaskStatus | string |
Filter the automation by the specified automation task status. Leave the field blank to return all automation task statuses. |
|
|
Minutes until deferral date
|
MinutesUntilDeferralDate | integer |
Only return Orchestrator automation tasks that are ready to run within the specified number of minutes. Set to 0 if you only want automation tasks that are ready to run now. Leave blank if you want to retrieve tasks regardless of deferral. |
|
|
Minimum priority level
|
MinimumPriorityLevel | integer |
Only return Orchestrator automation tasks that have the specified priority level or higher. For example: Setting 2 will return tasks with a priority level of 1 and 2. |
|
|
Sort by deferral date
|
SortByDeferralDate | boolean |
Set to true to return the data sorted by the deferral date and time. Set to false to have the data returned in the order is it stored. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Automation Tasks
|
AutomationTasks | array of object |
A table containing all the Orchestrator automation tasks that meet the given search criteria. |
|
items
|
AutomationTasks | object | |
|
Number of automation tasks
|
NumberOfAutomationTasks | integer |
The number of automation tasks returned. |
Get available IA-Connect Sessions
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 Director client type and session information
Returns the details of the local or remote session being handled by the tier 1 Director.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Remote client type
|
RemoteClientType | string |
The remote client type ('Local', 'Citrix ICA' or 'Microsoft RDP'). |
|
Virtual channel connected
|
VirtualChannelConnected | boolean |
True, if the virtual channel is connected, between the Director and the Agent. |
|
Director version
|
DirectorVersion | string |
The version of the IA-Connect Director DLL. For example: 1.67.21.0. |
|
Director release version
|
DirectorReleaseVersion | string |
The IA-Connect release version of the IA-Connect Director. For example: 9.4. |
|
Agent version
|
AgentVersion | string |
The version of the IA-Connect Agent EXE that this Director is connected to. For example: 1.74.21.0. |
|
Agent release version
|
AgentReleaseVersion | string |
The IA-Connect release version of the IA-Connect Agent that this Director is connected to. For example: 9.4. |
|
Agent is licensed
|
AgentIsLicensed | boolean |
True, if the IA-Connect Agent that this Director is connected to, is licensed. False, if the IA-Connect Agent is not licensed. Null if the Agent license state is unknown. |
|
Agent license features
|
AgentLicenseFeatures | string |
A comma separated list of IA-Connect license features assigned to the IA-Connect Agent that this Director is connected to. For example: JML, DEV. |
|
Director hostname
|
DirectorHostname | string |
The hostname of the computer the Director is running on. For example: vmrpa1. |
|
Director NetBIOS domain name
|
DirectorNetBIOSDomainName | string |
The NetBIOS domain name of the computer the Director is running on. For example: domain1. If the computer is not a member of a domain, this typically returns the hostname. |
|
Director DNS domain name
|
DirectorDNSDomainName | string |
The DNS domain name of the computer the Director is running on. For example: domain1.myorg.local. If the computer is not a member of a domain, this typically returns the hostname. |
|
Attached to next hop Director
|
AttachedToNextHopDirector | boolean |
Set to false if the IA-Connect session is currently attached to the Agent this Director is connected to. Set to true if the Director is forwarding all actions (i.e. attached) to another Director (which is connected to a different Agent). For example, if this Director is a local Director communicating with a local Agent, but the IA-Connect session is currently attached to Citrix, this value will be true. |
|
Next hop Director session type
|
NextHopDirectorSessionType | string |
If this Director is attached to a next hop Director, this value will hold the next hop session type. For example, if this Director is a local Director communicating with a local Agent, but the IA-Connect session is currently attached to Citrix, this value will be 'Citrix ICA', whereas the 'Remote client type' value will be 'Local' (representing a local Director forwarding actions to Citrix). |
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 failed action error message from flow result JSON
Deserialises the JSON output of one or more flow result() expressions and retrieves the first located error message from a failed action. The error message can be stored in the JSON in a variety of formats. This action processes known formats and returns the first located error message.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Flow result JSON
|
PowerAutomateResultJSON | True | array of string |
An array of JSON which should contain the outputs from one or more flow result() expressions. If you are only processing the output of a single flow result() expression, simply enter that into the first array item. |
|
Search status
|
SearchStatus | string |
The status of the action that contains the error message. This should only be changed if you are searching for a status different to the default of 'Failed'. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Action error message
|
ActionErrorMessage | string |
Returns the action error message extracted from the result JSON. If an error message could not be located, a blank value will be returned. |
|
Action name
|
ActionName | string |
Returns the name of the action associated with the error message. |
|
Action code
|
ActionCode | string |
Returns the result code of the action associated with the error message. |
Get file contents as Base64
Retrieve the contents of the specified file in Base64 format, a format suitable for transmission via API and easily converted back into the original text or binary format.
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. |
|
Compress
|
Compress | boolean |
Set to true to GZip compress the file contents before converting to Base64. The file is untouched, all operations are performed in memory. This feature is only useful if you are able to GUnzip the file contents after you have retrieved the Base64 (when decoding back to the original file contents text or binary data). Set to false if you are passing the Base64 directly to an action which accepts Base64 as input and doesn't have a GUnzip feature. |
|
|
Max file size
|
MaxFileSize | integer |
The maximum size of the file, above which an exception will be raised instead of retrieving the file contents. This allows you to avoid the situation where the Agent is asked to retrieve a huge file, which will ultimately cause the action to time out. Set to -1 to disable the file size check. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
File contents as Base64
|
FileContentsAsBase64 | string |
The file contents in Base64 format. |
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 | True | string |
The full path to the file. This must be accessible from the session where the IA-Connect Agent is running. |
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Security permissions JSON
|
SecurityPermissionsJSON | string |
The permissions currently set on the specified file, in JSON format. |
Get file size
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 Flow stats from Orchestrator
Returns a list of Flow stats from the IA-Connect Orchestrator. Used for reporting purposes. You can optionally use one or more filters to limit the returned results.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Within last number of days
|
WithinLastNumberOfDays | integer |
Filter results to retrieve only those started within the last specified number of days. Set to 0 to not filter. |
|
|
Flow name
|
SearchFlowName | string |
Filter results to retrieve only those with the specified Flow name. Set to blank to not filter by flow name. |
|
|
Flow last action result
|
SearchFlowLastActionResult | boolean |
Filter results to retrieve only those with the specified last action result. Set to true to only retrieve successful Flows. Set to false to only retrieve failed Flows. Don't set a value / set to blank to not filter by Flow last action result. |
|
|
Flow start time start window
|
SearchFlowStartTimeStartWindow | date-time |
Filter results to retrieve only those which started after the specified start time. Set to blank to not filter. For example: '2022-01-24T07:00:00' would return all Orchestrator Flow stats for Flows that started on or after 07.00 hours on the 24th of January 2022. All datetimes are in UTC (GMT+0) so you may wish to use the Convert DateTime action to convert your local time to UTC. |
|
|
Flow start time end window
|
SearchFlowStartTimeEndWindow | date-time |
Filter results to retrieve only those which started before the specified start time. Set to blank to not filter. For example: '2022-01-25T07:00:00' would return all Orchestrator Flow stats for Flows that started on or before 07.00 hours on the 25th of January 2022. All datetimes are in UTC (GMT+0) so you may wish to use the Convert DateTime action to convert your local time to UTC. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Orchestrator Flow stats JSON
|
OrchestratorFlowStatsJSON | string |
A list of all Orchestrator Flow stats, in JSON format. |
|
Number of Flow stats
|
NumberOfOrchestratorFlowStats | integer |
The number of Flow stats that were returned. |
Get 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 generic credential from Orchestrator
Retrieves a generic credential that has been stored in the IA-Connect Orchestrator. A credential can hold usernames, passwords, hostnames, URLs and other generic data.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Friendly name
|
FriendlyName | string |
Friendly name of the credential stored in the Orchestrator. |
|
|
Retrieve plain text password
|
RetrievePlainTextPassword | boolean |
If checked, the password for the specified Orchestrator generic credential will be returned as plain text if the Orchestrator generic credential setting 'Do not expose password' has been disabled (allowing passwords to be retrieved). It is recommended to not retrieve passwords as plain text and instead to use IA-Connect actions that support stored passwords (for example: 'Input password into UIA action') where the Orchestrator will insert the password directly into the action at run-time. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Username
|
Username | string |
The username held in the generic credential. |
|
Plain text password
|
PlainTextPassword | string |
The password held in the generic credential. Orchestrator passwords are stored encrypted, but will be returned as plain text to allow you to pass them on to actions which require them. |
|
Host name
|
Hostname | string |
The host name or domain name held in the generic credential, if used. |
|
URL
|
Url | string |
The URL held in the generic credential, if used. |
|
Generic property 1
|
GenericProperty1 | string |
A generic property held in the generic credential, if used. This could be used to store data that might be associated with the credential. |
|
Generic property 2
|
GenericProperty2 | string |
A generic property held in the generic credential, if used. This could be used to store data that might be associated with the credential. |
|
Generic property 3
|
GenericProperty3 | string |
A generic property held in the generic credential, if used. This could be used to store data that might be associated with the credential. |
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. |
|
License features
|
LicenseFeatures | string |
Additional license features, typically providing access to additional functionality. |
|
Is JML license
|
IsJMLLicense | boolean |
Does this license provide access to JML functionality. |
Get IA-Connect Agent global coordinate configuration
Retrieves the configuration of the IA-Connect Agent global coordinate system configuration, which is used to display element locations (for example: during mouse inspection) and calculate mouse positions (for example: when performing global mouse actions).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Multi monitor functionality
|
MultiMonitorFunctionality | string |
Returns 'PrimaryMonitor' if the IA-Connect Agent is currently configured to only support highlighting elements and performing global mouse actions on the primary display device. Returns 'MultiMonitor' if the IA-Connect Agent will highlight elements on all monitors (the default since IA-Connect 9.4). |
|
Auto set mouse inspection multiplier
|
AutoSetMouseInspectionMultiplier | boolean |
Returns true if the IA-Connect Agent automatically calculates the mouse inspection multiplier on the primary display device at Agent startup and every time mouse inspection is performed (the default since IA-Connect 9.4). Returns false if the IA-Connect Agent requires the mouse inspection multiplier to be set manually (the only available option in IA-Connect 9.3 and earlier). This option only has any effect when multi-monitor mode is disabled. |
|
Auto set global mouse multiplier
|
AutoSetGlobalMouseMultiplier | boolean |
Returns true if the IA-Connect Agent automatically calculates the global mouse movement multiplier on the primary display device at Agent startup and every time mouse inspection is performed (the default since IA-Connect 9.4). Returns false if the IA-Connect Agent requires the global mouse movement multiplier to be set manually (the only available option in IA-Connect 9.3 and earlier). This option only has any effect when multi-monitor mode is disabled. |
|
Mouse inspection X multiplier
|
MouseInspectionXMultiplier | double |
The current horizontal (X) mouse inspection multiplier (for when the Agent highlights what is under the mouse). For example: If IA-Connect is displaying the inspection rectangle at half the actual mouse X location, this value will be 0.5. The multiplier only has any effect when 'Multi monitor functionality' is disabled, since multipliers are calculated dynamically when the IA-Connect Agent is configured to be multi-monitor aware. |
|
Mouse inspection Y multiplier
|
MouseInspectionYMultiplier | double |
The current vertical (Y) mouse inspection multiplier (for when the Agent highlights what is under the mouse). For example: If IA-Connect is displaying the inspection rectangle at half the actual mouse Y location, this value will be 0.5. The multiplier only has any effect when 'Multi monitor functionality' is disabled, since multipliers are calculated dynamically when the IA-Connect Agent is configured to be multi-monitor aware. |
|
Global mouse X multiplier
|
GlobalMouseXMultiplier | double |
The current horizontal (X) global mouse movement multiplier (for when the Agent moves the mouse). The multiplier only has any effect when 'Multi monitor functionality' is disabled, since multipliers are calculated dynamically when the IA-Connect Agent is configured to be multi-monitor aware. |
|
Global mouse Y multiplier
|
GlobalMouseYMultiplier | double |
The current vertical (Y) global mouse movement multiplier (for when the Agent moves the mouse). The multiplier only has any effect when 'Multi monitor functionality' is disabled, since multipliers are calculated dynamically when the IA-Connect Agent is configured to be multi-monitor aware. |
|
Global mouse move method
|
GlobalMouseMoveMethod | string |
Returns the current global mouse movement method (either mouse_event or setcursorpos). |
|
Java coordinate system
|
JavaCoordinateSystem | string |
Returns the current Java coordinate system which can be 'Virtual' (the default) or 'Physical' (new in IA-Connect 9.4). Virtual coordinates are DPI scaled whereas physical coordinates map directly to pixels. This value should be set to whatever coordinate system is being presented by the Java Access Bridge. |
|
SAP GUI coordinate system
|
SAPGUICoordinateSystem | string |
Returns the current SAP GUI scripting API coordinate system which can be 'Virtual' (the default) or 'Physical' (new in IA-Connect 9.4). Virtual coordinates are DPI scaled whereas physical coordinates map directly to pixels. This value should be set to whatever coordinate system is being presented by the SAP GUI scripting API. |
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 |
|---|---|---|---|---|
|
Compress
|
Compress | boolean |
Should the alternative IA-Connect Agent executable be compressed during the upload? |
|
|
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? |
|
|
Save log to file
|
SaveLogToFile | boolean |
Should the IA-Connect Agent log be saved as a file? |
|
|
Place log content in data item
|
PlaceLogContentInDataItem | boolean |
Should the contents of the log be returned in an output variable? |
|
|
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. |
|
|
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. |
|
|
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 failed action from Orchestrator flow stats
Retrieves details of the last action which passed through the IA-Connect Orchestrator to a worker, if that action had failed. This action is most commonly used during error handling.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Worker allocated to flow run
|
WorkerAllocatedToFlowRun | boolean |
Returns true if there is a worker allocated to this flow run, and hence information can be provided regarding the last action error. Returns false if there is no worker allocated to this flow run (either one was never allocated or the worker has now been made available to another flow run) and hence no information can be provided regarding the last error. |
|
Last action failed
|
LastActionFailed | boolean |
Returns true if the last action in this flow run (that runs on a worker allocated to this flow run) failed: The other outputs from this action will hold the details. Returns false if the last action in this flow run did not fail: The other outputs will be blank. |
|
Last failed action request path
|
LastFailedActionRequestPath | string |
If the last action in this flow run (that runs on a worker allocated to this flow run) failed, this output will contain the action request path. This can be used to determine which action failed. If the last action in this flow run did not fail, this value will be blank. |
|
Last failed action error message
|
LastFailedActionErrorMessage | string |
If the last action in this flow run (that runs on a worker allocated to this flow run) failed, this output will contain the error message. If the last action in this flow run did not fail, this value will be blank. |
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 login history from Orchestrator
Returns the IA-Connect Orchestrator login history for reporting purposes. You can optionally use one or more filters to limit the returned results.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Within last number of days
|
WithinLastNumberOfDays | integer |
Filter results to retrieve only Orchestrator logins within the specified number of days. Set to 0 to not filter. |
|
|
Email address
|
SearchByEmail | string |
Filter results to retrieve only Orchestrator logins with the specified email address. Set to blank to not filter by email address. |
|
|
Login history time start window
|
SearchLoginHistoryTimeStartWindow | date-time |
Filter results to retrieve only Orchestrator logins after the specified start time. Set to blank to not filter. For example: '2022-01-24T07:00:00' would return all Orchestrator logins on or after 07.00 hours on the 24th of January 2022. All datetimes are in UTC (GMT+0) so you may wish to use the Convert DateTime action to convert your local time to UTC. |
|
|
Login history time end window
|
SearchLoginHistoryTimeEndWindow | date-time |
Filter results to retrieve only Orchestrator logins before the specified start time. Set to blank to not filter. For example: '2022-01-25T07:00:00' would return all Orchestrator logins on or before 07.00 hours on the 25th of January 2022. All datetimes are in UTC (GMT+0) so you may wish to use the Convert DateTime action to convert your local time to UTC. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Orchestrator login history JSON
|
OrchestratorLoginHistoryJSON | string |
A list of all Orchestrator logins meeting the specified filters, in JSON format. |
|
Number of Orchestrator logins
|
NumberOfOrchestratorLogins | integer |
The number of Orchestrator logins returned. |
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 mouse multiplier
Retrieves the global mouse multiplier in the IA-Connect Agent user session. This defaults to (1, 1) but could have been changed by the 'Set mouse multiplier' action.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
X multiplier
|
MouseXMultiplier | double |
The current horizontal (X) global mouse multiplier (for when the Agent moves the mouse). The multiplier only has any effect when 'Multi monitor functionality' is disabled. |
|
Y multiplier
|
MouseYMultiplier | double |
The current vertical (Y) global mouse multiplier (for when the Agent moves the mouse). The multiplier only has any effect when 'Multi monitor functionality' is disabled. |
|
Mouse move method
|
MouseMoveMethod | string |
Returns the current global mouse move method (either mouse_event or setcursorpos). |
Get next Orchestrator automation task
Retrieves the next Orchestrator automation task matching the given search criteria.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Automation name
|
AutomationName | string |
Leave blank to return Orchestrator automation tasks with any name. Enter a value to only retrieve tasks with this automation name. |
|
|
Minimum priority level
|
MinimumPriorityLevel | integer |
Only return Orchestrator automation tasks that have the specified priority level or higher. For example: Setting 2 will return tasks with a priority level of 1 and 2. |
|
|
Change status to
|
StatusChange | string |
If set to 'Retrieved': When retrieving a task the task status will change to 'Retrieved' to prevent other actions from trying to run the same task. If set to 'Do nothing' the task status will not be changed. |
|
|
Minutes until deferral date
|
MinutesUntilDeferralDate | integer |
Only return Orchestrator automation tasks that are ready to run within the specified number of minutes. Set to 0 if you only want automation tasks that are ready to run now. |
|
|
Ignore SLA
|
IgnoreSLA | boolean |
Set this to true to ignore any SLAs that have been set on the task. By default a task with an SLA that will soon breach takes priority over everything else. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Task retrieved
|
TaskRetrieved | boolean |
Set to true if a task was retrieved. Set to false if there were no tasks matching the search criteria. |
|
Task Id
|
TaskId | integer |
The id of the retrieved Orchestrator automation task. |
|
Automation name
|
AutomationNameOutput | string |
The name of the retrieved automation task. |
|
Deferral date and time
|
DeferralDateTime | string |
The date and time when the retrieved Orchestrator task is scheduled to be ready. This will be returned as a string in UTC. |
|
Deferral stored data
|
DeferralStoredData | string |
Optional data that was stored when the task was deferred. This is usually data that you need to continue the process / flow, but you can use this field for any purpose. |
|
Deferral count
|
DeferralCount | integer |
How often this task was deferred. This will typically be 0 for a new task which was never deferred or 1 or more for a deferred task. Each time a deferred task was deferred again, the Orchestrator will automatically increase this number. |
|
Task input data
|
TaskInputData | string |
Optional data that was stored when the task was created. This is usually data that was used to start the process / flow, but you can use this field for any purpose. |
|
Priority
|
Priority | integer |
The priority level of this Orchestrator task (1 being highest level). |
|
Automation task status
|
AutomationTaskStatus | string |
The status of the retrieved Orchestrator task. |
|
Process stage
|
ProcessStage | string |
The point at which the deferred process / flow should continue after deferral. This is an optional string value which will be unique to the specific process / flow. This will be used by a condition within the deferred process / flow to decide what step to perform next. |
|
Received date and time
|
ReceivedDateTime | string |
The date and time the task was initially received by the Orchestrator. This will be returned as a string in UTC. |
|
Minutes until deferral date
|
MinutesUntilDeferralDateOutput | integer |
The number of minutes until this task's deferral date (ie. when this task is ready to run). If this task is ready to run the minutes will be 0. |
Get Orchestrator automation task
Retrieves a specific Orchestrator automation task.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Task Id
|
TaskId | True | integer |
The Id of the Orchestrator task you want to retrieve. |
|
Change status to
|
StatusChange | string |
If set to 'Retrieved': When retrieving a task the task status will change to 'Retrieved' to prevent other actions from trying to run the same task. If set to 'Do nothing' the task status will not be changed. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Automation name
|
AutomationName | string |
The name of the retrieved Orchestrator task. |
|
Deferral date and time
|
DeferralDateTime | string |
The date and time when the retrieved Orchestrator task is scheduled to be ready. This will be returned as a string in UTC. |
|
Deferral stored data
|
DeferralStoredData | string |
Optional data that was stored when the task was deferred. This is usually data that you need to continue the process / flow. |
|
Deferral count
|
DeferralCount | integer |
How often this task was deferred. This will typically be 0 for a new task which was never deferred or 1 or more for a deferred task. Each time a deferred task was deferred again, the Orchestrator will automatically increase this number. |
|
Task input data
|
TaskInputData | string |
Optional data that was stored when the task was created. This is usually data that was used to start the process / flow, but you can use this field for any purpose. |
|
Priority
|
Priority | integer |
The priority level of this Orchestrator task (1 being highest level). |
|
Automation task status
|
AutomationTaskStatus | string |
The status of the retrieved Orchestrator task. |
|
Process stage
|
ProcessStage | string |
The point at where the automation process / flow should continue after deferral. This is an optional string value which will be unique to the specific process / flow. This will be used by a condition within the deferred process / flow to decide what step to perform next. For example: If you want the process / flow to continue at the 'Exchange' stage when it continues after deferral, enter the value 'Exchange'. |
|
Received date and time
|
ReceivedDateTime | string |
The date and time the task was initially received by the Orchestrator. This will be returned as a string in UTC. |
|
Minutes until deferral date
|
MinutesUntilDeferralDate | integer |
The number of minutes until this task's deferral date (ie. when this task is ready to run). If this task is ready to run the minutes will be 0. |
|
On hold
|
OnHold | boolean |
Is set to true if the task is on hold. An old hold task will never be retrieved by the 'Get next Orchestrator automation task' action and hence will never be processed in a normal workflow. |
Get 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 pixel colour at coordinate
Returns the RGB colour of a pixel at a given coordinate.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Left X pixels
|
LeftXPixels | True | integer |
The X position of the pixel to read. On a single display, the left-most X pixel is 0. On a multi-monitor display, the left-most X pixel could be negative (depending on which display is marked as primary, and where it is relative to the other displays). |
|
Top Y pixels
|
TopYPixels | True | integer |
The Y position of the pixel to read. On a single display, the top-most Y pixel is 0. On a multi-monitor display, the top-most Y pixel could be negative (depending on which display is marked as primary, and where it is relative to the other displays). |
|
Hide Agent
|
HideAgent | boolean |
Set to true to automatically hide the Agent (if visible) to ensure it doesn't obscure the pixel being read. |
|
|
Use physical coordinates
|
UsePhysicalCoordinates | boolean |
Set to true to specify that the provided coordinates are physical (not DPI scaled and hence matching the physical pixels on the display). Set to false (the default) to specify that the provided coordinates are virtual (DPI scaled). UIA, Java and Web actions typically use virtual coordinates. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Red value
|
RedValue | integer |
Returns the red value of the pixel from 0 (no red) to 255 (full red). |
|
Green value
|
GreenValue | integer |
Returns the green value of the pixel from 0 (no green) to 255 (full green). |
|
Blue value
|
BlueValue | integer |
Returns the blue value of the pixel from 0 (no blue) to 255 (full blue). |
|
Alpha value
|
AlphaValue | integer |
Returns the alpha value of the pixel from 0 (completely transparent) to 255 (fully opaque). |
|
RRGGBB hex value
|
RRGGBBHexValue | string |
Returns the RRGGBB hex value of the pixel. For example: FF0000 is full red, 00FF00 is full green, 0000FF is blue, 000000 is black, FFFFFF is full white. |
|
AARRGGBB hex value
|
AARRGGBBHexValue | string |
Returns the AARRGGBB hex value of the pixel which is the same as RRGGBB, but with the hex alpha value included at the start. For fully opaque pixels (the most common), this will hold the value FFRRGGBB. For example: FFFF0000 is fully opaque full red. |
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. For the IA-Connect local Agent running on a physical desktop or laptop, this will provide information about all display devices and their scaling. On a virtual machine, typically only one display will be reported, unless the virtual machine has been configured to present multiple displays (uncommon). In a remote session, typically only one display will be reported, even if that display spans multiple local displays, since remote sessions usually create a single virtual display.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Horizontal resolution
|
HorizontalResolution | integer |
The horizontal physical resolution of the primary screen. Physical coordinates map directly to pixels on the monitor. |
|
Vertical resolution
|
VerticalResolution | integer |
The vertical physical resolution of the primary screen. Physical coordinates map directly to pixels on the monitor. |
|
Number of screens
|
NumberOfScreens | integer |
The number of screens that were detected. |
|
Second display horizontal resolution
|
SecondDisplayHorizontalResolution | integer |
The horizontal physical resolution of the second screen, if one was detected. Physical coordinates map directly to pixels on the monitor. |
|
Second display vertical resolution
|
SecondDisplayVerticalResolution | integer |
The vertical physical resolution of the second screen, if one was detected. Physical coordinates map directly to pixels on the monitor. |
|
Third display horizontal resolution
|
ThirdDisplayHorizontalResolution | integer |
The horizontal physical resolution of the third screen, if one was detected. Physical coordinates map directly to pixels on the monitor. |
|
Third display vertical resolution
|
ThirdDisplayVerticalResolution | integer |
The vertical physical resolution of the third screen, if one was detected. Physical coordinates map directly to pixels on the monitor. |
|
Fourth display horizontal resolution
|
FourthDisplayHorizontalResolution | integer |
The horizontal physical resolution of the fourth screen, if one was detected. Physical coordinates map directly to pixels on the monitor. |
|
Fourth display vertical resolution
|
FourthDisplayVerticalResolution | integer |
The vertical physical resolution of the fourth screen, if one was detected. Physical coordinates map directly to pixels on the monitor. |
|
Virtual screen left edge pixels
|
VirtualScreenLeftEdgePixels | integer |
The left edge of the entire virtual display (all detected displays). Virtual coordinates are DPI scaled. |
|
Virtual screen top edge pixels
|
VirtualScreenTopEdgePixels | integer |
The top edge of the entire virtual display (all detected displays). Virtual coordinates are DPI scaled. |
|
Virtual screen width pixels
|
VirtualScreenWidthPixels | integer |
The width of the entire virtual display (all detected displays). Virtual coordinates are DPI scaled. |
|
Virtual screen height pixels
|
VirtualScreenHeightPixels | integer |
The height of the entire virtual display (all detected displays). Virtual coordinates are DPI scaled. |
|
Primary display scaling
|
PrimaryDisplayScaling | double |
The DPI scaling multiplier of the primary display as a decimal. For example: 100% would be returned as 1.0 and 125% would be returned as 1.25. |
|
Second display scaling
|
SecondDisplayScaling | double |
The DPI scaling multiplier of the second display as a decimal. For example: 100% would be returned as 1.0 and 125% would be returned as 1.25. |
|
Third display scaling
|
ThirdDisplayScaling | double |
The DPI scaling multiplier of the third display as a decimal. For example: 100% would be returned as 1.0 and 125% would be returned as 1.25. |
|
Fourth display scaling
|
FourthDisplayScaling | double |
The DPI scaling multiplier of the fourth display as a decimal. For example: 100% would be returned as 1.0 and 125% would be returned as 1.25. |
|
Physical screen left edge pixels
|
PhysicalScreenLeftEdgePixels | integer |
The left edge of the entire physical display (all detected displays). Physical coordinates map directly to pixels on the monitor. |
|
Physical screen top edge pixels
|
PhysicalScreenTopEdgePixels | integer |
The top edge of the entire physical display (all detected displays). Physical coordinates map directly to pixels on the monitor. |
|
Physical screen width pixels
|
PhysicalScreenWidthPixels | integer |
The width of the entire physical display (all detected displays). Physical coordinates map directly to pixels on the monitor. |
|
Physical screen height pixels
|
PhysicalScreenHeightPixels | integer |
The height of the entire physical display (all detected displays). Physical coordinates map directly to pixels on the monitor. |
|
Primary display left edge pixels
|
PrimaryDisplayLeftEdgePixels | integer |
The left physical edge of the primary display. Physical coordinates map directly to pixels on the monitor. |
|
Primary display top edge pixels
|
PrimaryDisplayTopEdgePixels | integer |
The top physical edge of the primary display. Physical coordinates map directly to pixels on the monitor. |
|
Second display left edge pixels
|
SecondDisplayLeftEdgePixels | integer |
The left physical edge of the second display, if one was detected. Physical coordinates map directly to pixels on the monitor. |
|
Second display top edge pixels
|
SecondDisplayTopEdgePixels | integer |
The top physical edge of the second display, if one was detected. Physical coordinates map directly to pixels on the monitor. |
|
Third display left edge pixels
|
ThirdDisplayLeftEdgePixels | integer |
The left physical edge of the third display, if one was detected. Physical coordinates map directly to pixels on the monitor. |
|
Third display top edge pixels
|
ThirdDisplayTopEdgePixels | integer |
The top physical edge of the third display, if one was detected. Physical coordinates map directly to pixels on the monitor. |
|
Fourth display left edge pixels
|
FourthDisplayLeftEdgePixels | integer |
The left physical edge of the fourth display, if one was detected. Physical coordinates map directly to pixels on the monitor. |
|
Fourth display top edge pixels
|
FourthDisplayTopEdgePixels | integer |
The top physical edge of the fourth display, if one was detected. Physical coordinates map directly to pixels on the monitor. |
Get stored password
Retrieves a previously generated or stored password.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Password identifier
|
PasswordIdentifier | string |
The identifier of the stored password. These passwords are only stored in memory and are lost when the Agent is closed. For example: MyExchangePassword. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Plain text password
|
PlainTextPassword | string |
The password in plain text. The password might be needed in plain text if the password is a one-time password intended to be transmitted via SMS or email (for example) and hence needs to be seen as-is. |
Get worker availability stats from Orchestrator
Returns worker availability stats from the IA-Connect Orchestrator. Used for reporting purposes. You can optionally use one or more filters to limit the returned results.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Within last number of days
|
WithinLastNumberOfDays | integer |
Filter results to retrieve only those started within the last specified number of days. Set to 0 to not filter. |
|
|
Flow name
|
SearchFlowName | string |
Filter results to retrieve only those with the specified Flow name. Set to blank to not filter by flow name. |
|
|
Flow start time start window
|
SearchFlowStartTimeStartWindow | date-time |
Filter results to retrieve only those which started after the specified start time. Set to blank to not filter. For example: '2022-01-24T07:00:00' would return all Orchestrator Flow stats for Flows that started on or after 07.00 hours on the 24th of January 2022. All datetimes are in UTC (GMT+0) so you may wish to use the Convert DateTime action to convert your local time to UTC. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Worker availability stats JSON
|
WorkerAvailabilityStatsJSON | string |
A list of worker availability stats, in JSON format. |
|
Number of worker availability stats
|
NumberOfWorkerAvailabilityStats | integer |
The number of worker availability stats that were returned. |
Get worker flow usage heatmap from Orchestrator
Returns worker flow usage daily heatmap from the IA-Connect Orchestrator. Used for reporting purposes. You can optionally use one or more filters to limit the returned results.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Flow start time start window
|
SearchStartDateStartWindow | True | date-time |
Filter results to retrieve only worker flow usage heatmap after the specified start date (time component is ignored). Set to blank to not filter. For example: '2022-01-24T00:00:00' would return a worker heatmap for Flows that started on or after the 24th of January 2022. All datetimes are in UTC (GMT+0) so you may wish to use the Convert DateTime action to convert your local time to UTC. |
|
Flow start time end window
|
SearchStartDateEndWindow | True | date-time |
Filter results to retrieve only worker flow usage heatmap before the specified start date (time component is ignored). Set to blank to not filter. For example: '2022-01-25T00:00:00' would return a worker heatmap for Flow that started on or before the 25th of January 2022. All datetimes are in UTC (GMT+0) so you may wish to use the Convert DateTime action to convert your local time to UTC. |
|
Time zone minutes offset from UTC
|
TimeZoneMinutesOffsetFromUTC | integer |
The time zone offset from UTC in minutes to align the daily heatmap. For example: If you specify 60 minutes, the daily heatmaps run from 01:00 UTC to 01:00 UTC. |
|
|
IA-Connect worker names
|
WorkerNames | string |
A list of the names of IA-Connect Workers to return a heatmap for, in JSON or CSV format. If left blank, a heatmap will be generated for all workers currently known to the Orchestrator. For example: [{"WorkerName": "Worker1"}, {"WorkerName": "Worker2"}] (JSON format) or Worker1,Worker2 (CSV format). |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Worker flow usage heatmap JSON
|
WorkerFlowUsageHeatmapJSON | string |
A worker flow usage heatmap, in JSON format. |
|
Number of worker flow usage heatmap items
|
NumberOfWorkerFlowUsageHeatmapItems | integer |
The number of worker flow usage heatmap items that were returned. One item per worker per day. |
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. |
Is session locked
Reports whether the session that the IA-Connect Agent is running in is locked.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Session is locked
|
SessionIsLocked | boolean |
Set to true if the session that the IA-Connect Agent is running in is locked. |
Is TCP port responding
Reports whether a network TCP port is responding to a connection attempt by the IA-Connect Agent. This could be a TCP port on the computer where the IA-Connect Agent is running (enter 'localhost' for the remote host) or on any remote computer. If the IA-Connect Agent successfully connects to a TCP port, it immediately closes the TCP connection.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Remote host
|
RemoteHost | True | string |
The IPv4 address, DNS address or hostname of the computer to connect to. Enter 'localhost' to check a TCP port on the computer where the IA-Connect Agent is running. Examples: 192.168.1.10 or www.test.com or vm-server19. |
|
TCP port
|
TCPPort | True | integer |
The TCP port number to connect to on the specified remote (or local) host. A TCP port must be 1 or higher and 65535 or lower. Examples of common well-known ports are 80 (HTTP), 443 (HTTPS), 445 (SMB / file sharing). |
|
Timeout in seconds
|
TimeoutInSeconds | integer |
The maximum number of seconds to wait for the TCP connection. This defaults to 10 seconds but most working connections would be expected to connect within a few seconds (over the Internet) or less than a second (local network). |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
TCP port connected
|
TCPPortConnected | boolean |
Set to true if the TCP port connected or false if the TCP port failed to connect. |
|
Connection error message
|
ConnectionErrorMessage | string |
The error message if the TCP port failed to connect. This will commonly be a DNS / name lookup error or a timeout. |
Keep session alive
Keeps the IA-Connect Agent user session alive by moving the mouse at the specified interval to prevent the session from becoming idle.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
X wiggle
|
XWiggle | integer |
The number of pixels to move the mouse horizontally. |
|
|
Y wiggle
|
YWiggle | integer |
The number of pixels to move the mouse vertically. |
|
|
Wiggle delay in seconds
|
WiggleDelayInSeconds | double |
The number of seconds between the mouse movements when wiggling. |
|
|
Idle threshold in seconds
|
IdleThresholdInSeconds | integer |
The number of seconds that should have elapsed since the last input before moving the mouse. |
|
|
Idle check period in seconds
|
IdleCheckPeriodInSeconds | integer |
The number of seconds between checking the last input time (to check if the idle threshold has been passed). |
|
|
Total keepalive runtime in seconds
|
TotalKeepaliveRuntimeInSeconds | integer |
The total number of seconds to keep the session alive for. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
KeepSessionAliveResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
Kill all other IA-Connect Agents
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 an Agent thread
Kills (terminates, aborts) an Agent thread. An Agent thread can be used to run certain actions in a thread, permitting the actions to run for a long time (longer than the RPA timeout) or to run in parallel with other actions. The Agent thread is not deleted (use the action 'Delete an Agent thread' to delete threads) to allow any processes or flows monitoring the Agent thread to receive the 'IA-Connect Agent thread has been aborted' error.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Thread Id
|
ThreadId | True | integer |
If you previously ran an Agent action as a thread, provide the thread Id to terminate the thread (permanently stop the thread from running). This thread Id will have been provided as an output of the action previous run as a thread. |
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
KillAgentThreadResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
Kill 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 | True | string |
The name of the IA-Connect session to kill. |
|
Attach to tier 1 IA-Connect session on success
|
AttachToTier1IAConnectSessionOnSuccess | boolean |
Should IA-Connect connect back to the tier 1 IA-Connect session (the IA-Connect Director session of the Director that is receiving the SOAP and / or REST messages) if the session has successfully closed? |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
IA-Connect session killed
|
IAConnectSessionKilled | boolean |
Returns true if the session with the specified name was killed, or false if not. |
|
Attached tier 1 IA-Connect session name
|
AttachedTier1IAConnectSessionName | string |
The name of the tier 1 IA-Connect session that was connected to. |
Kill process
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. |
Launch Remote Desktop Session (RDS)
Launch a Remote Desktop Session (RDS) using a RDP launch file.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
RDP file path
|
RDPFilePath | True | string |
The full path to a RDP file (which could either pre-exist or be created using the action: 'Create Remote Desktop Session (RDS) launch file'). |
|
Trust remote computer
|
TrustRemoteComputer | boolean |
Set to true to mark the remote address (set in the RDP file) as trusted (in the Windows registry), mainly for device redirection purposes, eliminating a popup you might receive when launching the RDP file. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
LaunchRemoteDesktopSessionResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
Left click mouse
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
Lock session
Locks the session that the IA-Connect Agent is running in.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Lock after minutes of action inactivity
|
LockAfterMinutesOfActionInactivity | integer |
If set to a value greater than 0, the Agent won't lock immediately but will instead lock after the specified number of minutes of action inactivity (the Agent not receiving any actions). This stops the Agent from continually locking and unlocking when there are many flows running back-to-back. Set to 0 to lock immediately. The default value is 5 minutes. |
|
|
Seconds to wait after lock
|
SecondsToWaitAfterLock | integer |
After locking, wait for the specified number of seconds. This gives the session time to fully lock. This is generally used if you expect the possibility of an unlock event (i.e. another session starting) immediately after locking, which could fail if the previous session is still locking. Only used if 'Lock after minutes of action inactivity' is set to 0 (causing an immediate lock). |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
LockSessionResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
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
Raise exception
Raise an exception with the specified message if the input exception is not blank. This is useful to trigger an exception message in your flow (HTTP 400) which will then be caught by an error handling stage, if an earlier action had an error. This exception is not recorded in the IA-Connect Orchestrator flow run stats.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Input exception
|
InputException | string |
If this input exception is not an empty string, an exception will be raised with the provided 'Exception message'. If this input exception is blank, this action will do nothing. |
|
|
Exception message
|
ExceptionMessage | string |
The exception message to raise. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
RaiseExceptionResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
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. |
Read from a user credential
Reads a username and password from a credential in the user's profile in the IA-Connect Agent session. Credentials can be viewed from the Windows Control Panel. Both the username and password can be retrieved from a Generic credential while only the username can be retrieved from a Windows credential.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Credential address
|
CredentialAddress | True | string |
The name / address of the credential. |
|
Credential type
|
CredentialType | True | string |
The credential type: Windows or Generic. |
|
Symmetric encryption key
|
SymmetricKey | string |
An optional symmetric encryption key used to decrypt the credential password (use if the credential was encrypted with a key). Only usable with Generic Credentials since the password for a Windows credential cannot be retrieved. |
|
|
Store password as identifier
|
StorePasswordAsIdentifier | string |
If an identifier is supplied, the retrieved credential password will be stored encrypted inside the Agent for later retrieval / usage by any commands which can make use of stored credentials. These passwords are only stored in memory and are lost when the Agent is closed. Only usable with Generic Credentials since the password for a Windows credential cannot be retrieved. For example: MyExchangePassword. |
|
|
Dont return password
|
DontReturnPassword | boolean |
If set to true, the credential password won't be returned. This is useful if you are storing the password within the Agent for use by further commands (i.e. 'Store password as identifier' is true), but you don't actually need to know the password within your workflow. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
User name
|
UserName | string |
The credential user name. |
|
Password
|
Password | string |
The credential password. |
Remove identity from file security
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 unmodified - 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
Retrieve the status of an Agent thread
Retrieves the status of an Agent thread and optionally retrieve the thread output data. An Agent thread can be used to run certain actions in a thread, permitting the actions to run for a long time (longer than the RPA timeout) or to run in parallel with other actions.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Thread Id
|
ThreadId | True | integer |
If you previously ran an Agent action as a thread, provide the thread Id to retrieve the status of the thread. This thread Id will have been provided as an output of the action previous run as a thread. |
|
Retrieve thread output data
|
RetrieveThreadOutputData | boolean |
Set to true to retrieve the thread output data in JSON format. It is recommended to retrieve thread output data by calling the same action used to create the thread, setting the input 'Retrieve output data for thread Id' to the thread Id, but this option allows you to directly retrieve the thread output data and optionally not delete the data. |
|
|
Delete thread after output data retrieved
|
ClearOutputDataFromMemoryOnceRead | boolean |
If the thread has completed successfully and the output data was retrieved (see the input 'Retrieve thread output data'), set this input to true to delete the thread after the results have been returned. This will delete the thread output data and the thread itself, so you will be unable to query the thread again. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Thread has started
|
ThreadStarted | boolean |
True if the thread has started. False if the thread hasn't started yet, which would suggest that something has gone wrong since the thread starts immediately. |
|
Thread is running
|
ThreadRunning | boolean |
True if the thread is currently running. False if either the thread never started (highly unlikely) or if the thread has now completed. |
|
Thread is completed
|
ThreadCompleted | boolean |
True if the thread has completed. False if either the thread never started (highly unlikely) or if the thread is still running. |
|
Thread successful
|
ThreadSuccess | boolean |
True if the thread has successfully completed. False if the thread never started (highly unlikely), the thread is still running or if the thread failed. |
|
Thread runtime in seconds
|
ThreadRuntimeInSeconds | integer |
The total number of seconds the thread has been running. |
|
IA-Connect action name
|
IAConnectActionName | string |
The internal name of the IA-Connect Agent action being run as a thread. |
|
Thread status message
|
ThreadStatusMessage | string |
A text string describing the status of the thread. This message is calculated from the ThreadStarted,ThreadRunning,ThreadCompleted,ThreadSuccess properties. This text string is language independent (it will not change to match locale). |
|
Thread error message
|
ThreadErrorMessage | string |
If the thread has failed, this output contains the error message. |
|
Thread output data JSON
|
ThreadOutputJSON | string |
If 'Retrieve thread output data' is set to true, this output holds the raw thread output data in JSON format. |
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 | string |
The full path to the location to copy the alternative IA-Connect Agent.exe (on the remote system). If not specified, a temporary filename will be chosen. If the alternative IA-Connect Agent is being loaded into memory then this file won't be created (since it's not needed) unless you set 'Save to disk even if running from memory' to true. You would only set this to true if you wanted to use IA-Connect's Dynamic Code actions which required 'Reference executing assembly' (e.g. to access IA-Connect internal methods). |
|
|
Compress
|
Compress | boolean |
Should the alternative IA-Connect Agent executable be compressed during the upload? |
|
|
Arguments
|
Arguments | string |
Any optional arguments to pass to the IA-Connect Agent.exe when it runs. |
|
|
Permit downgrade
|
PermitDowngrade | boolean |
Should earlier versions of IA-Connect Agent be allowed? |
|
|
Skip version check
|
SkipVersionCheck | boolean |
Should the version of the IA-Connect Agents (existing and new) not be checked at all, resulting in the new version being used in all scenarios (even same version)? |
|
|
Load into memory
|
LoadIntoMemory | boolean |
Should the alternative IA-Connect Agent be ran in memory? If set to true, the new Agent is loaded into memory and executed within an Assembly of the existing Agent. If set to false, the new Agent is executed as a normal process and the existing Agent EXE will exit. |
|
|
Save to disk even if running from memory
|
SaveToDiskEvenIfRunningFromMemory | boolean |
Should the alternative IA-Connect Agent be saved to disk even if it is being ran in memory? You would only set this to true if you wanted to use IA-Connect's Dynamic Code actions which required 'Reference executing assembly' (e.g. to access IA-Connect internal methods). |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Alternative file copied
|
AlternativeFileCopied | boolean |
Reports if the alternative IA-Connect Agent was used. |
Run generic IA-Connect Agent command
Runs a generic IA-Connect Agent command passing arguments as JSON and returning output data as JSON. Used to run Agent commands when the Director and Inspector are older versions than the Agent and hence don't understand the command.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
IA-Connect Agent command name
|
CommandName | True | string |
The internal name of the IA-Connect Agent command. A list of command names can be provided by the action 'GetAgentActionsInClass'. |
|
Input JSON
|
InputJSON | string |
The input to the IA-Connect Agent command, in JSON format. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Output JSON
|
OutputJSON | string |
The output from the IA-Connect Agent command, in JSON format. |
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. |
|
|
Is password
|
IsPassword | boolean |
Is the input a password value? If so, the alternative 'Send password key events' action should be used. |
|
|
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. |
|
|
Is password
|
IsPassword | boolean |
Is the input a password value? If so, the alternative 'Send password keys' action should be used. |
|
|
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. If this is a 'Stored' password, enter in the format {IAConnectPassword:StoredPasswordIdentifier} and set the 'stored password' input to true. If this is an Orchestrator generic credential, enter in the format {OrchestratorCredential:FriendlyName} and set the 'stored password' input to true. |
|
Interval in milliseconds
|
Interval | integer |
The number of milliseconds between each key press event. |
|
|
Dont interpret symbols
|
DontInterpretSymbols | boolean |
Should symbols in the password not be interpreted as special keys (e.g. {SHIFT} for Shift, {CTRL} for Ctrl)? This should be set to true if you are attempting to input the actual symbols. |
|
|
Password contains stored password
|
PasswordContainsStoredPassword | boolean |
Set to true if the password is an IA-Connect stored password identifier (for example: generated by the 'Generate password' action) or an IA-Connect Orchestrator generic credential (for example: If using IA-Connect with a PA flow). |
|
|
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. If this is a 'Stored' password, enter in the format {IAConnectPassword:StoredPasswordIdentifier} and set the 'stored password' input to true. If this is an Orchestrator generic credential, enter in the format {OrchestratorCredential:FriendlyName} and set the 'stored password' input to true. |
|
Interval in milliseconds
|
Interval | integer |
The number of milliseconds between each key press. |
|
|
Dont interpret symbols
|
DontInterpretSymbols | boolean |
Should symbols in the password not be interpreted as special keys (e.g. + for Shift, ^ for Ctrl)? This should be set to true if you are attempting to input the actual symbols. |
|
|
Password contains stored password
|
PasswordContainsStoredPassword | boolean |
Set to true if the password is an IA-Connect stored password identifier (for example: generated by the 'Generate password' action) or an IA-Connect Orchestrator generic credential (for example: If using IA-Connect with a PA flow). |
|
|
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 global coordinate configuration
Configures the IA-Connect Agent global coordinate system, which is used to display element locations (for example: during mouse inspection) and calculate mouse positions (for example: when performing global mouse actions). The defaults provide the latest functionality, but you may use this action to revert to the behaviour in previous versions of the Agent or specify that an API is using a different coordinate system.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Multi monitor functionality
|
MultiMonitorFunctionality | string |
Set to 'Primary display only' (PrimaryMonitor) to revert to older behaviour, which only supports highlighting elements and performing global mouse actions on the primary display device (the only available mode in IA-Connect 9.3 and earlier). Set to 'All displays' (MultiMonitor) to enable highlighting elements and performing global mouse actions on all monitors, and to automatically detect DPI scaling on each monitor (the default since IA-Connect 9.4). Set to 'Not set' (NotSet) to make no change. |
|
|
Auto set mouse inspection multiplier
|
AutoSetMouseInspectionMultiplier | string |
Set to 'Auto' (1) (the default since IA-Connect 9.4) to automatically calculate the mouse inspection multiplier on the primary display device at Agent startup and every time mouse inspection is performed. Set to 'Manual' (0) to require the inspection multiplier to be set manually (the only available option in IA-Connect 9.3 and earlier). Set to blank or 'NotSet' to leave this option unchanged. This option only has any effect when 'Multi monitor functionality' is disabled. |
|
|
Auto set global mouse multiplier
|
AutoSetGlobalMouseMultiplier | string |
Set to 'Auto' (1) (the default since IA-Connect 9.4) to automatically calculate the global mouse movement multiplier on the primary display device at Agent startup and every time mouse inspection is performed. Set to 'Manual' (0) to require the global mouse movement multiplier to be set manually (the only available option in IA-Connect 9.3 and earlier). Set to blank or 'NotSet' to leave this option unchanged. This option only has any effect when 'Multi monitor functionality' is disabled. |
|
|
Mouse inspection X multiplier
|
MouseInspectionXMultiplier | double |
The horizontal (X) mouse inspection multiplier to set (for when the Agent highlights what is under the mouse). For example: If IA-Connect is displaying the inspection rectangle at half the actual mouse X location, set a value of 0.5. Set to 0 to leave the current value unchanged. This option only has any effect when 'Multi monitor functionality' is disabled and 'Auto set mouse inspection multiplier' is disabled. |
|
|
Mouse inspection Y multiplier
|
MouseInspectionYMultiplier | double |
The vertical (Y) mouse inspection multiplier to set (for when the Agent highlights what is under the mouse). For example: If IA-Connect is displaying the inspection rectangle at half the actual mouse Y location, set a value of 0.5. Set to 0 to leave the current value unchanged. This option only has any effect when 'Multi monitor functionality' is disabled and 'Auto set mouse inspection multiplier' is disabled. |
|
|
Global mouse X multiplier
|
GlobalMouseXMultiplier | double |
The horizontal (X) global mouse movement multiplier to set (for when the Agent moves the mouse). Set to 0 to leave the current value unchanged. This option only has any effect when 'Multi monitor functionality' is disabled. |
|
|
Global mouse Y multiplier
|
GlobalMouseYMultiplier | double |
The vertical (Y) global mouse movement multiplier to set (for when the Agent moves the mouse). Set to 0 to leave the current value unchanged. This option only has any effect when 'Multi monitor functionality' is disabled. |
|
|
Apply to mouse_event
|
GlobalMouseMultiplierApplyToMouseEvent | boolean |
This specifies whether to apply the global mouse multiplier values to the mouse_event method. This option only has any effect when 'Multi monitor functionality' is disabled. |
|
|
Apply to SetCursorPos
|
GlobalMouseMultiplierApplyToSetCursorPos | boolean |
This argument specifies whether to apply the global mouse multiplier values to the SetCursorPos method. This option only has any effect when 'Multi monitor functionality' is disabled. |
|
|
Apply to current mouse move method
|
GlobalMouseMultiplierApplyToCurrentMouseMoveMethod | boolean |
This argument specifies whether to apply the global mouse multiplier values to the current mouse move method (for example: if SetCursorPos is the current mouse move method, the multiplier will apply to SetCursorPos). If this is set to true, the inputs 'Apply to mouse_event' and 'Apply to SetCursorPos' are ignored. This option only has any effect when 'Multi monitor functionality' is disabled. |
|
|
Java coordinate system
|
JavaCoordinateSystem | string |
Set to 'Virtual' (the default and the only available option in IA-Connect 9.3 and earlier) to inform the Agent that the Java Access Bridge is providing virtual (DPI scaled) coordinates. Set to 'Physical' to inform the Agent that the Java Access Bridge is providing physical coordinates (which map directly to pixels). Set to 'Not set' (NotSet) to make no change. |
|
|
SAP GUI coordinate system
|
SAPGUICoordinateSystem | string |
Set to 'Virtual' (the default and the only available option in IA-Connect 9.3 and earlier) to inform the Agent that the SAP GUI scripting API is providing virtual (DPI scaled) coordinates. Set to 'Physical' to inform the Agent that the SAP GUI scripting API is providing physical coordinates (which map directly to pixels). Set to 'Not set' (NotSet) to make no change. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
SetAgentGlobalCoordinateConfigurationResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
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
Licenses the IA-Connect Agent with a license key. This can be a license string or the friendly name of a license held in the IA-Connect Orchestrator.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
License key
|
LicenseString | True | string |
The IA-Connect license key string or the friendly name of a license held in the IA-Connect Orchestrator (if controlling IA-Connect via the IA-Connect Orchestrator). |
|
Store in registry
|
StoreInRegistry | boolean |
Should the IA-Connect license be temporarily stored in the registry? This ensures that the IA-Connect Agent will be licensed for the duration of the user session, even if the Agent is closed and re-launched. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Days until license expires
|
DaysUntilLicenseExpires | integer |
The number of remaining days until the IA-Connect license expires. |
Set mouse cursor position
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 global 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 horizontal (X) global mouse multiplier to set (for when the Agent moves the mouse). The multiplier only has any effect when 'Multi monitor functionality' is disabled. |
|
|
Y multiplier
|
MouseYMultiplier | double |
The vertical (Y) global mouse multiplier to set (for when the Agent moves the mouse). The multiplier only has any effect when 'Multi monitor functionality' is disabled. |
|
|
Apply to mouse_event
|
ApplyToMouseEvent | boolean |
This argument specifies whether to apply the global mouse multiplier values to the mouse_event method. |
|
|
Apply to SetCursorPos
|
ApplyToSetCursorPos | boolean |
This argument specifies whether to apply the global mouse multiplier values to the SetCursorPos method. |
|
|
Apply to current mouse move method
|
ApplyToCurrentMouseMoveMethod | boolean |
This argument specifies whether to apply the global mouse multiplier values to the current mouse move method (for example: if SetCursorPos is the current mouse move method, the multiplier will apply to SetCursorPos). If this is set to true, the inputs 'Apply to mouse_event' and 'Apply to SetCursorPos' are ignored. |
|
|
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
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
StopKeepSessionAliveResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
Store password in Agent memory
Store a password into Agent memory (encrypted) where it can be used from any actions which support stored passwords. Passwords are only stored in memory and are lost when the Agent is closed.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Identifier
|
Identifier | True | string |
A unique identifier for the password. If the identifier is already in use, it will be overwritten. For example: SAPGUILogon. Passwords are retrieved using the phrase {IAConnectPassword:Identifier}. |
|
Password
|
Password | True | password |
The password to store. |
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
StorePasswordInAgentMemoryResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
Take screenshot
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. On a single display, the left-most X pixel is 0. On a multi-monitor display, the left-most X pixel could be negative (depending on which display is marked as primary, and where it is relative to the other displays). |
|
|
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. On a single display, the top-most Y pixel is 0. On a multi-monitor display, the top-most Y pixel could be negative (depending on which display is marked as primary, and where it is relative to the other displays). |
|
|
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). |
|
|
Use display device
|
UseDisplayDevice | boolean |
Should the IA-Connect Agent take the display device information into consideration? This will work better with DPI-scaling and will provide support for multiple displays. |
|
|
Raise exception on error
|
RaiseExceptionOnError | boolean |
If set the true: The IA-Connect Agent will raise an exception if the screenshot fails (for example, if the session is locked). If set the false: The IA-Connect will return a blank bitmap if the screenshot fails and will populate the 'Screenshot successful' and 'Screenshot error message' outputs. |
|
|
Hide Agent
|
HideAgent | boolean |
Set to true to automatically hide the Agent (if visible) to ensure it doesn't obscure the screenshot. |
|
|
Use physical coordinates
|
UsePhysicalCoordinates | boolean |
Set to true to specify that the provided coordinates are physical (not DPI scaled and hence matching the physical pixels on the display). Set to false (the default) to specify that the provided coordinates are virtual (DPI scaled). UIA, Java and Web actions typically use virtual coordinates. |
|
|
Display device Id
|
DisplayDeviceId | integer |
This input only works when the input 'Use display device' is set to true. Set to 0 (the default) to include all monitors. Set to 1 to only include the primary monitor. Set to 2 or higher to only include the relevant secondary monitor. |
|
|
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. This can be viewed using the provided utility 'Base64 to bitmap'. |
|
Screenshot successful
|
ScreenshotSuccessful | boolean |
Set to true if the screenshot is successful. Set to false if the screenshot failed and 'Raise exception on error' was set to false. An exception will be raised if the screenshot failed and 'Raise exception on error' was set to true. |
|
Screenshot error message
|
ScreenshotErrorMessage | string |
If the screenshot failed and 'Raise exception on error' was set to false, this output field will hold the error message. This is an alternative to setting 'Raise exception on error' to true, which will result in an exception if there is an error performing the screenshot. |
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
Unlock session
Unlocks the session that the IA-Connect Agent is running in. This requires the IA-Connect Unlocker Credential Provider to be installed on the computer hosting the session since only a Credential Provider can unlock a computer.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Unlock password
|
UnlockPassword | True | string |
The password to unlock the current session. This is the Windows user password for the account which is logged into the session that is currently locked. If this is a 'Stored' password, enter in the format {IAConnectPassword:StoredPasswordIdentifier} and set the 'stored password' input to true. If this is an Orchestrator generic credential, enter in the format {OrchestratorCredential:FriendlyName} and set the 'stored password' input to true. |
|
Password contains stored password
|
PasswordContainsStoredPassword | boolean |
Set to true if the password is an IA-Connect stored password identifier (for example: generated by the 'Generate password' action) or an IA-Connect Orchestrator generic credential (for example: If using IA-Connect with a PA flow). |
|
|
Detect if locked
|
DetectIfLocked | True | boolean |
Should the IA-Connect Agent attempt to detect if the session is locked. If set to true and the session is not detected as being locked, this action will simply do nothing (since there is nothing to do). Only set to false if IA-Connect is mis-detecting whether the session is locked and you want to force an unlock attempt (which will fail if the session isn't locked). |
|
Detect Credential Provider
|
DetectCredentialProvider | True | boolean |
Should the IA-Connect Agent attempt to detect the existence of the IA-Connect Unlocker Credential Provider before sending an unlock request. You should only disable this if the IA-Connect Credential Provider is present and running but, for some reason, the IA-Connect Agent isn't detecting it. |
|
Seconds to wait for unlock
|
SecondsToWaitForUnlock | integer |
How long (in seconds) should the IA-Connect Agent wait for evidence that the desktop has successfully unlocked (by detecting the desktop unlock state). By default this is up to 5 seconds. Set to 0 to disable this feature and continue without checking that the desktop has unlocked. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Session unlock performed
|
SessionUnlockPerformed | boolean |
Set to true if the session was locked and an unlock action was performed. Set to false if the session wasn't locked and 'Detect if locked' was set to true, resulting in no action being performed. |
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). |
Update Orchestrator Flow stats result
Update the result statistics for the current Worker Flow in the IA-Connect Orchestrator. This is used to modify the final result of a Flow stat in the IA-Connect Orchestrator which is typically used for reporting purposes. This only works for the current Flow (the Orchestrator detects the Flow run Id). You cannot modify the stats for any other Flow.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Flow last action success
|
FlowLastActionSuccess | boolean |
Set to true to specify that the last action in an Orchestrator Flow stat is a success. Set to false to specify that the last action in an Orchestrator Flow stat is a failure. Leave this field blank if you don't want to update the flow last action status (for example: If you only wish to update the last action code. |
|
|
Flow last action error message
|
FlowLastActionErrorMessage | string |
If specifying that the Flow last action was a failure, provide an error message here. |
|
|
Flow last action code
|
FlowLastActionCode | integer |
An optional code to assign to the Flow stat. This is typically used as an error code (for example, to distinguish between System and Business exceptions), but could be used as a success code. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
UpdateOrchestratorFlowStatsResultResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
Wait for Agent thread to complete successfully
Waits for an Agent thread to complete and optionally retrieve the thread output data. An Agent thread can be used to run certain actions in a thread, permitting the actions to run for a long time (longer than the RPA timeout) or to run in parallel with other actions. If the Agent thread completes, but in failure, an exception will be raised.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Thread Id
|
ThreadId | True | integer |
If you previously ran an Agent action as a thread, provide the thread Id to retrieve the status of the thread. This thread Id will have been provided as an output of the action previous run as a thread. |
|
Seconds to wait for thread
|
SecondsToWaitForThread | True | integer |
How many seconds to wait for the thread to complete. If the thread hasn't completed in this time, an exception will be raised (unless 'Raise exception if thread not completed' is set to false). |
|
Retrieve thread output data
|
RetrieveThreadOutputData | boolean |
Set to true to retrieve the thread output data in JSON format. It is recommended to retrieve thread output data by calling the same action used to create the thread, setting the input 'Retrieve output data for thread Id' to the thread Id, but this option allows you to directly retrieve the thread output data and optionally not delete the data. |
|
|
Delete thread after output data retrieved
|
ClearOutputDataFromMemoryOnceRead | boolean |
If the thread has completed successfully and the output data was retrieved (see the input 'Retrieve thread output data'), set this input to true to delete the thread after the results have been returned. This will delete the thread output data and the thread itself, so you will be unable to query the thread again. |
|
|
Raise exception if thread not completed
|
RaiseExceptionIfThreadNotCompleted | boolean |
If set to true and the thread hasn't completed in the specified time, an exception will be raised. If set to false, this action will wait up to the requested time (for the thread to complete) and report the thread status (see the outputs 'Thread is running' etc). An exception will always be raised if the thread completes, but in failure. |
|
|
Raise exception if thread error
|
RaiseExceptionIfThreadError | boolean |
If set to true (the default behaviour) and the thread has an error condition (thread completed but not successful), an exception will be raised, and the thread will be deleted. If set to false, the error will be stored in the output 'Thread error message' and the thread will not be deleted (you should delete the thread using the action 'Delete an Agent thread' when appropriate). |
|
|
Seconds to wait per call
|
SecondsToWaitPerCall | integer |
The 'Seconds to wait for thread' will be broken down into smaller time slices to avoid timeouts. This optional input allows you to specify the size of the smaller time slice. Do not set to a value larger than 80% of the RPA timeout, or you may receive timeout errors. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Thread has started
|
ThreadStarted | boolean |
True if the thread has started. False if the thread hasn't started yet, which would suggest that something has gone wrong since the thread starts immediately. Only useful if 'Raise exception if thread not completed' is set to false, since otherwise an exception will be raised if the thread hasn't completed in the specified wait time. |
|
Thread is running
|
ThreadRunning | boolean |
True if the thread is currently running. False if either the thread never started (highly unlikely) or if the thread has now completed. Only useful if 'Raise exception if thread not completed' is set to false, since otherwise an exception will be raised if the thread hasn't completed in the specified wait time. |
|
Thread is completed
|
ThreadCompleted | boolean |
True if the thread has completed. False if either the thread never started (highly unlikely) or if the thread is still running. Only useful if 'Raise exception if thread not completed' is set to false, since otherwise an exception will be raised if the thread hasn't completed in the specified wait time. |
|
Thread successful
|
ThreadSuccess | boolean |
True if the thread has successfully completed. False if the thread never started (highly unlikely), the thread is still running or if the thread failed. Only useful if 'Raise exception if thread not completed' is set to false, since otherwise an exception will be raised if the thread hasn't completed in the specified wait time. |
|
Thread runtime in seconds
|
ThreadRuntimeInSeconds | integer |
The total number of seconds the thread has been running. |
|
IA-Connect action name
|
IAConnectActionName | string |
The internal name of the IA-Connect Agent action being run as a thread. |
|
Thread status message
|
ThreadStatusMessage | string |
A text string describing the status of the thread. This message is calculated from the ThreadStarted,ThreadRunning,ThreadCompleted,ThreadSuccess properties. This text string is language independent (it will not change to match locale). |
|
Thread error message
|
ThreadErrorMessage | string |
If the thread has failed, this output contains the error message. Only useful if 'Raise exception if thread error' is set to false, since otherwise an exception will be raised if the thread has an error. |
|
Thread output data JSON
|
ThreadOutputJSON | string |
If 'Retrieve thread output data' is set to true, this output holds the raw thread output data in JSON format. |
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). |
|
|
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. |
|
|
Time in seconds to wait
|
SecondsToWait | double |
The maximum number of seconds to wait for the next hop session to connect. |
|
|
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. |
|
|
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. |
|
|
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 | True | string |
The name of the IA-Connect session to check. |
|
Time to wait in seconds
|
TimeToWaitInSeconds | integer |
If there is no session of the specified type (if a specific type was specified), how long should IA-Connect wait for it? |
|
|
Raise exception if timed out
|
RaiseExceptionIfTimedout | boolean |
Should IA-Connect raise an exception if a new session has not connected before the timeout period has elapsed? |
|
|
Attach to tier 1 IA-Connect session on success
|
AttachToTier1IAConnectSessionOnSuccess | boolean |
Should IA-Connect connect back to the tier 1 IA-Connect session (the IA-Connect Director session of the Director that is receiving the SOAP and / or REST messages) if the session has successfully closed? |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
IA-Connect session closed
|
IAConnectSessionClosed | boolean |
Returns true if the session with the specified name has closed, or false if not. |
|
Attached tier 1 IA-Connect session name
|
AttachedTier1IAConnectSessionName | string |
The name of the tier 1 IA-Connect session that was connected to. |
Wiggle mouse
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
Write to a user credential
Writes a username and password to a credential in the user's profile in the IA-Connect Agent session, creating that credential if it doesn't exist. Credentials can be viewed from the Windows Control Panel.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Credential address
|
CredentialAddress | True | string |
The name / address of the credential. |
|
User name
|
UserName | True | string |
The credential user name. |
|
Password
|
Password | True | string |
The credential password. |
|
Credential type
|
CredentialType | True | string |
The credential type: Windows or Generic. |
|
Credential persistence
|
CredentialPersistence | string |
The credential persistence: Session (lasts just for this login session), LocalMachine (persists for this user across sessions and reboots on this computer only) or Enterprise (could roam for this across between machines). |
|
|
Symmetric encryption key
|
SymmetricKey | string |
An optional symmetric encryption key used to encrypt the credential. You can only retrieve this credential if you know the key. Only usable with Generic Credentials. |
|
|
Store password as identifier
|
StorePasswordAsIdentifier | string |
If an identifier is supplied, this password will also be stored encrypted inside the Agent for later retrieval / usage by any commands which can make use of stored credentials. These passwords are only stored in memory and are lost when the Agent is closed. For example: MyExchangePassword. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
CredentialWriteResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |
Write to CSV file
Creates a CSV file on the computer where the IA-Connect Agent is running. The CSV file is created from a collection (table) or from a table in JSON format.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Properties
|
Properties | object | ||
|
Input table JSON
|
InputTableJSON | string |
A table of data to write to the CSV file, in JSON format. |
|
|
Output CSV file path
|
CSVFilePath | True | string |
The full path to the CSV file. This must be accessible from the session where the IA-Connect Agent is running. |
|
Output encoding
|
OutputEncoding | string |
The text encoding format to use when writing to the CSV file. Supported encodings are UTF8, UTF7, Unicode and ASCII. |
|
|
Workflow
|
Workflow | True | string |
Add the following expression here: workflow() |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
Command result
|
WriteCollectionToCSVFileResult | boolean |
The result of the command (success or failure). |
|
Error message
|
ErrorMessage | string |
If the command was not successful, this will contain the error message that was returned. |