IA-Connect Session

The Id of the Orchestrator task to add the note to.

The note text message.

If the source system supports different note types (for example, a work note, a closure note or a comment), enter the note type here. This will be interpreted differently, depending on the source system. Currently supported types are 'WorkNote' (the default), 'CloseNote', 'Comment'. If there is only one type of note, enter 'WorkNote'. If you have a custom work note, enter 'Other'.

If you have a custom note type, choose a 'Note type' of 'Other' and enter the custom type into this field.

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.

The file path that the ZIP should be output to. This must be accessible from the session where the IA-Connect Agent is running.

If you want to add the source file to a folder in the ZIP file, enter the folder name here.

An optional comment for this file added to the ZIP.

Should the file be compressed when zipping?

Set to True to add to an existing ZIP file.

Add the following expression here: workflow()

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.

The file path that the ZIP should be output to. This must be accessible from the session where the IA-Connect Agent is running.

If you want to add the source files to a folder in the ZIP file, enter the folder name here.

Should the folder be compressed when zipping?

Set to True to add to an existing ZIP file.

Should subfolders within the source folder also be added to the ZIP?

An optional regular expression to allow you to specify which files should be extracted. Matches filename only.

An optional regular expression to allow you to specify which files should be excluded from extraction. Matches filename only.

Add the following expression here: workflow()

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.

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.

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.

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

Set the priority level of this automation task (1 being highest level).

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.

Add the following expression here: workflow()

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.

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.

How many minutes should the automation task be delayed for.

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.

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

Set the priority level of this task (1 being highest level).

Add the following expression here: workflow()

The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.

The identity of the user or group to be assigned the permission. This can be in the form 'username', 'DOMAIN\username' or 'username@domainfqdn'.

Provide the permission to be assigned (Read, ReadAndExecute, Modify or FullControl) or leave blank for the default (Read).

Is the permission being denied?

Add the following expression here: workflow()

The full path to the folder. This must be accessible from the session where the IA-Connect Agent is running.

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

Provide the permission to be assigned (Read, ReadAndExecute, Modify or FullControl) or leave blank for the default (Read).

Should the permission apply to the folder itself?

Should the permission propagate to sub-folders?

Should the permission apply to the files within the folder?

Is the permission being denied?

Add the following expression here: workflow()

The optional tag of the worker to allocate. Tags allow you to categorise workers into groups. Tag names are not case-sensitive. You can specify multiple tags by entering them on separate lines, and the allocation mechanism will then consider any worker with any of those tags. You can perform a wildcard search using the format Wildcard: Tag* (e.g. Wildcard: JML*), and a regular expression search using the format RegEx: TagExpression (e.g. RegEx: ^JML).

The optional name of the worker to allocate. Worker names are not case-sensitive. You can specify multiple workers by entering them on separate lines, and the allocation mechanism will then consider any worker with a matching name. You can perform a wildcard search using the format Wildcard: Name* (e.g. Wildcard: vmrpa*), and a regular expression search using the format RegEx: Expression (e.g. RegEx: ^vmrpa).

If set to true and a suitable worker could not be allocated, an exception will be raised. If set to false (the default) and a suitable worker could not be allocated, the Orchestrator will return HTTP status code 500, causing the PA flow to wait, according to the 'Retry policy'.

Add the following expression here: workflow()

The Id of the Orchestrator task to be assigned.

The Id of the user to assign the task to. Use this input if assigning the task to a user, and you know the user Id. Use the user Id or user name input, not both, or if assigning to a group, leave this input blank.

The name of the user to assign the task to. Use this input if assigning the task to a user, and you know the user name. Use the user Id or user name input, not both, or if assigning to a group, leave this input blank.

The Id of the group to assign the task to. Use this input if assigning the task to a group, and you know the group Id. Use the group Id or group name input, not both, or if assigning to a user, leave this input blank.

The name of the group to assign the task to. Use this input if assigning the task to a group, and you know the group name. Use the group Id or group name input, not both, or if assigning to a user, leave this input blank.

If the user assignment fields are blank and this field is set to true, any currently assigned user will be removed, otherwise user assignments will be left unchanged.

If the group assignment fields are blank and this field is set to true, any currently assigned group will be removed, otherwise group assignments will be left unchanged.

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.

The index of the session to connect to, e.g. 1 for the first matching session type, 2 for second matching session type.

If the session with the specified index doesn't exist, how long should IA-Connect wait for it?

Should IA-Connect raise an exception if a new session has not connected before the timeout period has elapsed?

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.

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

Add the following expression here: workflow()

The name of the IA-Connect session to connect to.

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.

Add the following expression here: workflow()

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.

If there is no session of the specified type (if a specific type was specified), how long should IA-Connect wait for it?

Should IA-Connect raise an exception if a new session has not connected before the timeout period has elapsed?

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.

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

Add the following expression here: workflow()

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.

Add the following expression here: workflow()

The full path to the folder. This must be accessible from the session where the IA-Connect Agent is running.

Should any currently inherited permissions be converted to explicit permissions?

Add the following expression here: workflow()

Should the IA-Connect Agent GUI be focussed?

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.

Add the following expression here: workflow()

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.

Add the following expression here: workflow()

The Id of the Orchestrator task to be modified.

The new task status for the specified automation task.

If changing the status to new and you set this value to true, the task will be put on hold.

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.

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.

If you set this value to true and the Orchestrator task is linked to a source system (for example, ServiceNow), the Orchestrator will perform any actions specified in the Source system configuration in the Orchestrator (for example, close the ticket).

If the task status is being changed to 'Completed' or 'Failed', this input allows you to provide a task closure reason, which will be stored in the task. In addition, if the Orchestrator task is linked to a source system (for example, ServiceNow) and 'Update source system' is set to true, the reason will also be passed to the source system (for example, as a ServiceNow work note).

Add the following expression here: workflow()

The time to wait before issuing the close command so that the IA-Connect Agent can report completion of the command.

Add the following expression here: workflow()

Should the SOAP interface be enabled on the next-hop Director?

Should the REST interface be enabled on the next-hop Director?

Should the web server (for hosting the IA-Connect Inspector) be enabled on the next-hop Director?

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.

If the SOAP interface were enabled, what TCP port should it run on (defaults to 8002)?

If the REST interface were enabled, what TCP port should it run on (defaults to 8002)?

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.

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.

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.

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.

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.

Should the first-hop Agent use named pipes to communicate with the first-hop Director? This is the default communication method.

Add the following expression here: workflow()

The left pixel edge of the rectangle to convert. Can be in virtual or physical pixels depending on the conversion type.

The top pixel edge of the rectangle to convert. Can be in virtual or physical pixels depending on the conversion type.

The right pixel edge of the rectangle to convert. Can be in virtual or physical pixels depending on the conversion type.

The bottom pixel edge of the rectangle to convert. Can be in virtual or physical pixels depending on the conversion type.

The type of conversion: From physical to virtual (PhysicalToVirtual or P2V) or virtual to physical (VirtualToPhysical or V2P).

Add the following expression here: workflow()

The full path to the source file. This must be accessible from the session where the IA-Connect Agent is running.

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.

Add the following expression here: workflow()

The file path to copy the file from (on the local computer running the IA-Connect Director).

The file path to copy the file into (on the computer running the IA-Connect Agent).

Should the file be compressed when copying?

Add the following expression here: workflow()

The file path to the local file to be copied to the clipboard.

If set to true then the file will be cut instead of copied.

Add the following expression here: workflow()

The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.

Should IA-Connect raise an error if the directory (folder) already exists?

Add the following expression here: workflow()

The address of the remote system to connect to. This could be an IP address, hostname or Fully Qualified Domain Name (FQDN).

The folder in which to save the RDP file.

The name of the RDP file which will be created in the output folder path.

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.

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.

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.

If storing a credential to hold the Remote Desktop authentication details, this allows you to specify the username to store in the credential.

If storing a credential to hold the Remote Desktop authentication details, this allows you to specify the password to store in the credential.

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.

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

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.

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.

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.

Should the remote desktop session be fullscreen.

The width of the remote desktop session in pixels if the remote desktop session is not fullscreen.

The height of the remote desktop session in pixels if the remote desktop session is not fullscreen.

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

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.

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.

Add the following expression here: workflow()

The Id of the existing Orchestrator automation task to defer (or defer again).

How many minutes should the automation task be delayed for.

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.

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

Set the priority level of this task (1 being highest level).

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.

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.

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.

Add the following expression here: workflow()

The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.

Should subdirectories (subfolders) and files in the directory also be deleted?

Add the following expression here: workflow()

The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.

Add the following expression here: workflow()

The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.

A pattern to match against files to be deleted, for example . for all files or *.txt for files with a .txt extension.

Add the following expression here: workflow()

The Id of the Orchestrator automation task to delete.

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.

A unique identifier for the password to delete. For example: SAPGUILogon.

Add the following expression here: workflow()

The name / address of the credential.

The credential type: Windows or Generic.

Add the following expression here: workflow()

Add the following expression here: workflow()

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

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.

Add the following expression here: workflow()

The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.

Add the following expression here: workflow()

The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.

Add the following expression here: workflow()

The name of the IA-Connect session to check.

Add the following expression here: workflow()

The delay between each click, in milliseconds.

Add the following expression here: workflow()

The X coordinate value (in pixels).

The Y coordinate value (in pixels).

The delay between each click, in milliseconds.

Add the following expression here: workflow()

The HTTP or HTTPS download URL.

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.

If a file already exists with the name specified in the 'Save file path' input, should it be overwritten?

Should the user's credentials be passed on to the web server? This would typically only be used for internal Intranet sites.

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.

This parameter specifies which content types are supported. This should only be changed if the content you are downloading requires a different content type.

Set to True to support TLS 1.0 encryption protocol.

Set to True to support TLS 1.1 encryption protocol.

Set to True to support TLS 1.2 encryption protocol.

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.

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.

Should the file contents be returned as a 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.

Add the following expression here: workflow()

The left pixel edge of the rectangle to display. Can be in virtual or physical pixels depending on the input 'Coordinates are physical'.

The right pixel edge of the rectangle to display. Can be in virtual or physical pixels depending on the input 'Coordinates are physical'.

The top pixel edge of the rectangle to display. Can be in virtual or physical pixels depending on the input 'Coordinates are physical'.

The bottom pixel edge of the rectangle to display. Can be in virtual or physical pixels depending on the input 'Coordinates are physical'.

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.

The thickness (in pixels) of the highlight rectangle border.

The number of seconds to display the rectangle.

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.

Add the following expression here: workflow()

The full path to the folder. This must be accessible from the session where the IA-Connect Agent is running.

Add the following expression here: workflow()

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.

The TCP port that the next hop Director is listening on (the Director on the computer that the Agent is running on).

Set to True if the next hop Director is using HTTPS, or false if not.

The next hop director address (relative to the Agent) is 'localhost'.

The next hop director address is the hostname of the computer running the Agent (i.e. the one running the Agent and the Director).

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

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.

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.

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.

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.

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.

Add the following expression here: workflow()

The input string containing environment variables.

Add the following expression here: workflow()

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.

Add the following expression here: workflow()

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!

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.

Set to true to return the password as plain text.

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.

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: !$()*.

Set to true (the default) for the Agent to avoid duplicating random number sequences and hence ensure that generated passwords are unique where possible within a particular Agent session. This doesn't guarantee unique passwords between separate Agents, or if the Agent is closed or restarted, so you should always ensure your passwords are highly random by using complex passwords (for example: wnnws is more random than wnw).

Add the following expression here: workflow()

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

Add the following expression here: workflow()

Add the following expression here: workflow()

Leave blank to return Orchestrator automation tasks with any name. Enter a value to only retrieve tasks with this automation name.

Filter the automation by the specified automation task status. Leave the field blank to return all automation task statuses.

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.

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.

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.

Add the following expression here: workflow()

Add the following expression here: workflow()

Add the following expression here: workflow()

The full path to the CSV file. This must be accessible from the session where the IA-Connect Agent is running.

Is the first line in the CSV file a header row?

Should the headers be trimmed to remove any leading or trailing whitespace?

If set to true (the default), completely blank rows in the CSV data are permitted and will be returned as an empty row. If set to false, completely blank rows will be removed in the returned data (the file will be left untouched).

If set to true, and if there are cells in the data without a matching column header (i.e. a row with more cells than the header row), a column header will be automatically created with the name Column_N (where N is the column index). If set to false (the default), there will be an exception if a row contains data without a matching column.

Add the following expression here: workflow()

Add the following expression here: workflow()

Add the following expression here: workflow()

Add the following expression here: workflow()

The drive letter of the disk to check.

Add the following expression here: workflow()

Add the following expression here: workflow()

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.

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

The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.

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.

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.

Add the following expression here: workflow()

The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.

Add the following expression here: workflow()

The full path to the file. This must be accessible from the session where the IA-Connect Agent is running.

Add the following expression here: workflow()

The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.

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.

Add the following expression here: workflow()

Filter results to retrieve only those started within the last specified number of days. Set to 0 to not filter.

Filter results to retrieve only those with the specified Flow name. Set to blank to not filter by flow name.

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.

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.

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.

The full path to the folder. This must be accessible from the session where the IA-Connect Agent is running.

Add the following expression here: workflow()

The full path to the directory (folder). This must be accessible from the session where the IA-Connect Agent is running.

Add the following expression here: workflow()

Friendly name of the credential stored in the Orchestrator.

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.

Add the following expression here: workflow()

Add the following expression here: workflow()

Add the following expression here: workflow()

Should the alternative IA-Connect Agent executable be compressed during the upload?

Should the IA-Connect Agent log be restricted to the result of the last command rather than the entire log?

Should the IA-Connect Agent log be saved as a file?

Should the contents of the log be returned in an output variable?

The filepath to the folder to save the IA-Connect Agent log into.

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.

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.

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.

Add the following expression here: workflow()

Add the following expression here: workflow()

Add the following expression here: workflow()

Add the following expression here: workflow()

Add the following expression here: workflow()

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.

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.

Add the following expression here: workflow()

Add the following expression here: workflow()

Add the following expression here: workflow()

Add the following expression here: workflow()

Should local printers be returned?

Should network printers be returned?

Should detailed information such as location, port name, driver name and status of each printer be returned?

Add the following expression here: workflow()

Filter results to retrieve only Orchestrator logins within the specified number of days. Set to 0 to not filter.

Filter results to retrieve only Orchestrator logins with the specified email address. Set to blank to not filter by email address.

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.

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.

Add the following expression here: workflow()

Add the following expression here: workflow()

Add the following expression here: workflow()

Add the following expression here: workflow()

Leave blank to return Orchestrator automation tasks with any name. Enter a value to only retrieve tasks with this automation name.

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.

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.

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.

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.

The Id of the Orchestrator task you want to retrieve.

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.

The process ID of the child process.

Add the following expression here: workflow()

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

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

Set to true to automatically hide the Agent (if visible) to ensure it doesn't obscure the pixel being read.

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.

Add the following expression here: workflow()

The process ID of the process to get.

Add the following expression here: workflow()

The process name.

Add the following expression here: workflow()

The process ID of the process to retrieve the command line properties from.

Add the following expression here: workflow()

An optional filter for the process name.

If set to true, the process command-line details will be returned.

Add the following expression here: workflow()

Add the following expression here: workflow()

The identifier of the stored password. These passwords are only stored in memory and are lost when the Agent is closed. For example: MyExchangePassword.

Add the following expression here: workflow()

Filter results to retrieve only those started within the last specified number of days. Set to 0 to not filter.

Filter results to retrieve only those with the specified Flow name. Set to blank to not filter by flow name.

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.