IA-Connect Microsoft Office

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 Microsoft Office automation.

This connector is available in the following products and regions:

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

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

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

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

Prerequisites

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

The IA-Connect software consists of two main components:

• The IA-Connect Orchestrator, which is an Azure WebApp which you would host in your own Azure tenant. This handles the routing and security of RPA Flows to one or more on-premises or cloud-based virtual machines.

• The IA-Connect Agent and Director, which is installed onto the virtual machines where the software you wish to automate is accessible. Additionally, the IA-Connect Agent can run inside a Citrix or Microsoft Remote Desktop Services (RDS) session, where the RPA commands are passed down a virtual channel into the remote session for execution. The IA-Connect Agent can be run from a network share and does not require installation.

Available IA-Connect Connectors

The available IA-Connect Connectors are:

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

How to get credentials

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

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

Get started with your connector

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

Support

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

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

Known issues, common errors and FAQs

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

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

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

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

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Activate MS Excel worksheet	Activates a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Add macro to MS Excel workbook	Adds a macro to a workbook in an instance of Microsoft Excel (referenced by the handle).
Add table column to MS Word document	Adds a column to a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).
Add table row to MS Word document	Adds a row to a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).
Add table to MS Word document	Adds a table with the specified number of rows and columns to a named document in an instance of Microsoft Word (referenced by the handle).
Attach to existing MS Excel instance	Attaches to an instance Microsoft Excel that has already been started.
Attach to existing MS Outlook instance	Attaches to a running Outlook instance to allow Outlook to be automated using the actions in this IA-Connect module.
Attach to existing MS Word instance	Attaches to an instance Microsoft Word that has already been started.
Check OLE object in MS Excel worksheet	Check or uncheck an OLE checkbox or radio button (ActiveX control) in the active workbook in an instance of Microsoft Excel (referenced by the handle).
Clear clipboard	Clears the contents of the clipboard in the IA-Connect Agent user session.
Clear MS Excel clipboard	Clears the current Excel clipboard (the dotted area) in a workbook in an instance of Microsoft Excel (referenced by the handle).
Close current MS Excel workbook	Closes the current Excel workbook in an instance of Microsoft Excel (referenced by the handle).
Close MS Excel instance	Closes an instance Microsoft Excel that was started using a Visual Basic Object (or attached to later). The instance of Excel to close is defined by the handle.
Close MS Excel workbook	Closes an open Excel workbook in an instance of Microsoft Excel (referenced by the handle).
Close MS Outlook instance	Closes an instance of Microsoft Outlook that was started using the 'Create instance' action (or attached to later), without waiting for any active requests to complete. This action can sometimes cause issues when Outlook cached mode is enabled and should be used after calling 'Wait for mails to send' to ensure that Outlook has successfully completed any ongoing tasks such as sending emails.
Close MS Outlook instance using Window	Closes an instance of Microsoft Outlook that was started using the 'Create instance' action (or attached to later), by making Outlook visible and then closing the Outlook window (as a user would close Outlook). This can be more reliable when Outlook cached mode is enabled.
Close MS Word document	Closes an open Word document in an instance of Microsoft Word (referenced by the handle).
Close MS Word instance	Closes an instance of Microsoft Word that was started using a Visual Basic Object (or attached to later). The instance of Word to close is defined by the handle.
Copy between cells in MS Excel workbook	Copy and paste between cells in a workbook in an instance of Microsoft Excel (referenced by the handle).
Copy MS Word selection to clipboard	Copies the selected contents of a document in an instance of Microsoft Word (referenced by the handle).
Copy selection in MS Excel workbook	Copies the current selection or a specified selection (by making use of the Excel clipboard) in a workbook in an instance of Microsoft Excel (referenced by the handle).
Create mail folder in MS Outlook	Creates a mail folder within the current Outlook profile. This action can be used to create top-level folders if no parent folder path is provided, or child folders by providing a parent folder path.
Create MS Excel instance	Starts Microsoft Excel using a Visual Basic Object to allow Excel to be automated using the actions in this IA-Connect module. Microsoft Excel starts hidden, unless you enable ShowExcel, because it doesn't need to be visible for automation, unless you are also using UIA to control Excel.
Create MS Excel workbook	Creates a new Excel workbook in an instance of Microsoft Excel (referenced by the handle).
Create MS Excel worksheet	Creates a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Create MS Outlook instance	Starts Microsoft Outlook using a Visual Basic Object to allow Outlook to be automated using the actions in this IA-Connect module. Microsoft Outlook starts hidden, unless you enable ShowOutlook, because it doesn't need to be visible for automation, unless you are also using UIA to control Outlook. Only one instance of Outlook can be running at any one time.
Create MS Word document	Creates a new Word document in an instance of Microsoft Word (referenced by the handle).
Create MS Word instance	Starts Microsoft Word using a Visual Basic Object to allow Word to be automated using the actions in this IA-Connect module. Microsoft Word starts hidden, unless you enable ShowWord, because it doesn't need to be visible for automation, unless you are also using UIA to control Word.
Cut between cells in MS Excel workbook	Cut and paste between cells in a workbook in an instance of Microsoft Excel (referenced by the handle).
Cut selection in MS Excel workbook	Cuts the current selection or a specified selection (by making use of the Excel clipboard) in a workbook in an instance of Microsoft Excel (referenced by the handle).
Delete email in MS Outlook	Deletes an email in Outlook.
Delete MS Excel worksheet	Deletes a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Delete selection in MS Excel workbook	Deletes the current selection in a workbook in an instance of Microsoft Excel (referenced by the handle).
Detach from MS Word instance	Detaches from a running instance of Microsoft Word that was started using a Visual Basic Object (or attached to later). The instance of Word to detach from is defined by the handle.
Does OLE object exist in MS Excel worksheet	Determines whether an OLE object exists in the active workbook in an instance of Microsoft Excel (referenced by the handle).
Evaluate MS Excel expression	Returns the result of evaluating an expression in an instance of Microsoft Excel (referenced by the handle).
Execute MS Excel command bar object	Executes any command bar object in an instance of Microsoft Excel (referenced by the handle) given the Control Name. These are documented by Microsoft as 'Office Fluent UI Command Identifiers'. Some command-bar objects will work without additional interaction, while some might need to be used in conjunction with some UIA actions.
Execute MS Outlook command bar object	Executes any command bar object in a Microsoft Outlook window or dialog, given the Control Name. These are documented by Microsoft as 'Office Fluent UI Command Identifiers'. The action is performed on the currently active Outlook window so Outlook must be visible (use the action 'Show MS Outlook'). Some command-bar objects will work without additional interaction, while some might need to be used in conjunction with some UIA actions.
Execute MS Word command bar object	Executes any command bar object in an instance of Microsoft Word (referenced by the handle) given the Control Name. These are documented by Microsoft as 'Office Fluent UI Command Identifiers'. Some command-bar objects will work without additional interaction, while some might need to be used in conjunction with some UIA actions.
Export MS Word document as PDF	Saves a named document as a PDF in an instance of Microsoft Word (referenced by the handle).
Find next cell with value in MS Excel worksheet	Finds the next cell with a specified value in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Find next empty cell in MS Excel worksheet	Finds the next empty cell in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Format cell in active MS Excel worksheet	Formats a cell in the active worksheet in an instance of Microsoft Excel (referenced by the handle).
Format current cell in active MS Excel worksheet	Formats the active cell in the active worksheet in an instance of Microsoft Excel (referenced by the handle).
Forward email in MS Outlook	Forwards an email in Outlook.
Get active cell in active MS Excel worksheet	Returns the cell reference of the active cell in an instance of Microsoft Excel (referenced by the handle).
Get active MS Excel worksheet name	Returns the name of the worksheet at a specified index (starting at 1) in a workbook in an instance of Microsoft Excel (referenced by the handle).
Get and set cell text in active MS Excel worksheet	Read a single cell text value and store into a different cell in the active workbook in an instance of Microsoft Excel (referenced by the handle).
Get and set cell value 2 in active MS Excel worksheet	Read a single raw cell value and store into a different cell in the active workbook in an instance of Microsoft Excel (referenced by the handle). Gets and sets the underlying value of the cell without any formatting applied.
Get and set cell value in active MS Excel worksheet	Read a single cell value and store into a different cell in the active workbook in an instance of Microsoft Excel (referenced by the handle).
Get cell background colour in MS Excel worksheet	Gets the background colour of the specified cell in an instance of Microsoft Excel (referenced by the handle).
Get cell text in active MS Excel worksheet	Get text in a cell in the active workbook in an instance of Microsoft Excel (referenced by the handle).
Get cell value 2 in active MS Excel worksheet	Gets the raw value in a cell in the active workbook in an instance of Microsoft Excel (referenced by the handle). This returns the underlying value of the cell without any formatting applied.
Get cell value in active MS Excel worksheet	Get the string value in a cell in the active workbook in an instance of Microsoft Excel (referenced by the handle).
Get email attachment filenames in MS Outlook	Retrieves details about the attachments on an email in Outlook.
Get email body in MS Outlook	Retrieves the body of an email in Outlook.
Get emails in MS Outlook	Retrieves emails from a specified folder in Outlook.
Get first email in MS Outlook	Retrieves the first email from a specified folder in Outlook. As the emails are not ordered in any particular way, if you require the emails to be in a specific order (e.g. the first email by date received) then you should instead use the 'Get emails' action and then sort the output.
Get highlighted text in MS Word document	Returns all highlighted text in a document in an instance of Microsoft Word (referenced by the handle).
Get mail folders in MS Outlook	Retrieves all mail folders in Outlook by providing a folder path and optionally a flag to indicate whether subfolders should also be returned.
Get MS Excel country setting	Returns the Country setting for an instance of Microsoft Excel (referenced by the handle).
Get MS Excel worksheet as collection enhanced	Retrieves the contents of a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Get MS Excel worksheet names	Returns the names of worksheets in a workbook in an instance of Microsoft Excel (referenced by the handle).
Get MS Excel worksheet used range	Returns the used range in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Get MS Outlook MAPI profiles	Retrieves all the configured MAPI profiles which can be used with Outlook.
Get MS Outlook namespace information	Retrieves information about the current Outlook instance running and the Exchange server that it is connected to.
Get MS Outlook process Id	Returns the dynamic Process ID (PID) of the running Outlook process which could be used for performing UIA actions.
Get MS Word document body text	Reads the content from a specified character range in the body of a named document in an instance of Microsoft Word (referenced by the handle).
Get MS Word document table bounds	Returns the number of rows and columns in a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).
Get MS Word document table cell text value trimmed	Gets the text value of a cell with any leading or trailing whitespace characters (e.g. spaces) removed in a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).
Get number of MS Outlook mails	Returns the number of emails from a specified folder in Outlook that match the provided search criteria.
Get number of rows in MS Excel worksheet	Returns the number of data rows in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Get number of tables in MS Word document	Returns the number of tables in a named document in an instance of Microsoft Word (referenced by the handle).
Get OLE object value in MS Excel worksheet	Retrieve the text value of an OLE object in the active workbook in an instance of Microsoft Excel (referenced by the handle). If the OLE object is a checkbox, the value 'True' or 'False' will be returned.
Get table cell text value in MS Word document	Gets the text value of a cell in a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).
Go to cell in active MS Excel worksheet	Goes to (selects) a cell in the active workbook in an instance of Microsoft Excel (referenced by the handle).
Go to next empty cell down in MS Excel worksheet	Go to next empty cell down in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Go to next empty cell left in MS Excel worksheet	Go to next empty cell to the left in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Go to next empty cell right in MS Excel worksheet	Go to next empty cell to the right in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Go to next empty cell up in MS Excel worksheet	Go to next empty cell up in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Hide MS Excel	Hides an instance of Microsoft Excel (referenced by the handle). This would typically only be used during development because Excel doesn't need to be visible for automation.
Hide MS Word	Hides an instance of Microsoft Word (referenced by the handle). This would typically only be used during development because Word doesn't need to be visible for automation.
Input text into OLE object in MS Excel worksheet	Input text into an OLE object in the active workbook in an instance of Microsoft Excel (referenced by the handle).
Insert on selection in MS Excel workbook	Inserts on the current selection in a workbook in an instance of Microsoft Excel (referenced by the handle).
Is MS Outlook connected	Checks to see if IA-Connect is connected to an instance of Outlook.
Mark email as read in MS Outlook	Marks a specific email in Outlook as read or unread, depending on the input flag set.
Maximise MS Excel window	Maximise the active instance of Microsoft Excel (referenced by the handle).
Minimise MS Excel window	Minimise the active instance of Microsoft Excel (referenced by the handle).
Move email in MS Outlook	Moves a specific email from a specified folder in Outlook to another folder.
Normalise MS Excel window	Normalise the active instance of Microsoft Excel (referenced by the handle).
Open MS Excel workbook	Opens a specified Excel workbook in an instance of Microsoft Excel (referenced by the handle).
Open MS Word document	Opens a specified Word document in an instance of Microsoft Word (referenced by the handle).
Paste into MS Word from clipboard	Pastes the content of the clipboard into a document at the currently selected point in an instance of Microsoft Word (referenced by the handle).
Paste into selection in MS Excel workbook	Pastes into the current selection or a specified selection (by making use of the Excel clipboard) in a workbook in an instance of Microsoft Excel (referenced by the handle).
Press OLE object in MS Excel worksheet	Presses an OLE button object (ActiveX control) in the active workbook in an instance of Microsoft Excel (referenced by the handle).
Put MS Excel workbook in edit mode	Puts a Microsoft Excel workbook into edit mode. This is useful if a workbook opened in read-only mode and there is an 'Enable editing' button which you must press to edit the workbook.
Reply to email in MS Outlook	Replies to an email in Outlook.
Run MS Excel macro	Runs a macro in a workbook in an instance of Microsoft Excel (referenced by the handle).
Save As MS Word document	Saves a specified open document in an instance of Microsoft Word (referenced by the handle) as a specified filename.
Save current MS Excel workbook	Saves the current workbook in an instance of Microsoft Excel (referenced by the handle).
Save current MS Excel workbook as	Saves the current workbook in an instance of Microsoft Excel (referenced by the handle) as a specified filename.
Save current MS Excel workbook as CSV	Saves the current workbook as CSV in an instance of Microsoft Excel (referenced by the handle) as a specified filename.
Save email attachments as file in MS Outlook	Saves the attachments from a specific email in Outlook.
Save MS Excel workbook	Saves a specified open workbook in an instance of Microsoft Excel (referenced by the handle).
Save MS Excel workbook as	Saves a specified open workbook in an instance of Microsoft Excel (referenced by the handle) as a specified filename.
Save MS Excel workbook as CSV	Saves a specified open workbook as CSV in an instance of Microsoft Excel (referenced by the handle) as a specified filename.
Save MS Excel workbook as with password	Saves a specified open workbook in an instance of Microsoft Excel (referenced by the handle) as a specified filename with a password.
Save MS Word document	Saves a specified open document in an instance of Microsoft Word (referenced by the handle).
Select all in MS Word document	Selects all of the content in an open document in an instance of Microsoft Word (referenced by the handle).
Select cell range in MS Excel worksheet	Selects a range in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Select range in MS Word document	Selects a character range in a named document in an instance of Microsoft Word (referenced by the handle).
Select table cell in MS Word document	Selects a cell in a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).
Select table in MS Word document	Selects a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).
Send email in MS Outlook	Sends a new email in Outlook.
Set cell background colour in MS Excel worksheet	Sets the background colour of the specified cell or cells in an instance of Microsoft Excel (referenced by the handle).
Set cell value in active MS Excel worksheet	Set the string value of a cell in the active workbook in an instance of Microsoft Excel (referenced by the handle).
Set MS Excel calculation mode	Sets the calculation mode (0 = manual, 1 = automatic, 2 = semi automatic) in an instance of Microsoft Excel (referenced by the handle).
Set MS Outlook Allow popup details	Overrides the default Outlook 'Allow' popup element search details used by IA-Connect Agent to locate the 'Allow' button. Button names may change with the language settings, if so use this before calling 'Background monitor for Allow popup'.
Set MS Word document table cell text value	Sets the text value of a cell in a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).
Show MS Excel	Makes an instance of Microsoft Excel visible (referenced by the handle). This would typically only be used during development because Excel doesn't need to be visible for automation, unless you are also using UIA to control Excel.
Show MS Outlook	Shows the current Outlook instance that is being automated. This would typically only be used during development because Outlook doesn't need to be visible for automation, unless you are also using UIA to control Outlook.
Show MS Word	Makes an instance of Microsoft Word visible (referenced by the handle). This would typically only be used during development because Word doesn't need to be visible for automation, unless you are also using UIA to control Word.
Start background monitor for MS Outlook Allow popup	Creates a background thread that monitors the remote session for a specified number of seconds, searching for an 'Allow' popup, which can be triggered by a number of Outlook actions such as 'Send email'. Once the element is located, the action will then click the 'Allow' button to permit the triggering action to complete successfully.
Trust MS Excel VB object model in registry	Sets the registry value for Excel to trust VB object model (needed to create macros). Excel must not be running and only works if not overridden by GPO. This is the same as enabling the 'Trust access to the VBA project object model' option in the 'Developer Macro Settings' section of Trust Center.
Type text in MS Word document	Types the specified text into a document from the currently selected point in an instance of Microsoft Word (referenced by the handle).
Update MS Word bookmark	Updates a bookmark in a named document in an instance of Microsoft Word (referenced by the handle).
Write collection to MS Excel worksheet	Writes a collection (array) into a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).
Write collection to MS Excel worksheet with dates	Writes a collection (array) with date fields into a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Activate MS Excel worksheet

Operation ID:

MSExcelActivateWorksheet

Activates a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Create if missing	CreateIfMissing		boolean	If a Worksheet with the specified name does not exist, should it be created?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Add macro to MS Excel workbook

Operation ID:

MSExcelAddMacroToWorkbook

Adds a macro to a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Macro code	MacroCode	True	string	The code that will be executed when the macro runs.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Add table column to MS Word document

Operation ID:

MSWordAddTableColumn

Adds a column to a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Table index	TableIndex	True	integer	The table number, starting at 1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Add table row to MS Word document

Operation ID:

MSWordAddTableRow

Adds a row to a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Table index	TableIndex	True	integer	The table number, starting at 1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Add table to MS Word document

Operation ID:

MSWordAddTable

Adds a table with the specified number of rows and columns to a named document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Number of rows	NumberOfRows	True	integer	The number of rows in the table to be added.
Number of columns	NumberOfColumns	True	integer	The number of columns in the table to be added.
Auto fit behaviour	AutoFitBehaviour		integer	The AutoFit behaviour of the table (0 for fixed table size, 1 for fit to content and 2 for fit to window).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Attach to existing MS Excel instance

Operation ID:

MSExcelAttachToExistingInstance

Attaches to an instance Microsoft Excel that has already been started.

Parameters

Name	Key	Required	Type	Description
File Name	Filename		string	The filename of an open spreadsheet in Excel to attach to. If it is an empty worksheet then enter the name of the sheet (e.g. 'Book1').
Toggle window	ToggleWindow		boolean	Should the Excel window be toggled before attempting to attach? This helps to ensure that recently opened Excel windows are visible to the Windows operating system.
Toggle uses global left mouse click agent	ToggleUsesGlobalLeftMouseClickAgent		boolean	If choosing to toggle the Excel window, this specifies whether to use global mouse clicks to focus the IA-Connect Agent first.
Toggle delay in seconds	ToggleDelay		double	If choosing to toggle the Excel window, this specifies the pause after toggling.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Excel handle	Handle	integer	A handle for this instance of Excel to be used by other Excel actions to distinguish between different instance of Excel if more than one instance is running.

Attach to existing MS Outlook instance

Operation ID:

MSOutlookAttachToExistingInstance

Attaches to a running Outlook instance to allow Outlook to be automated using the actions in this IA-Connect module.

Parameters

Name	Key	Required	Type	Description
Toggle window	ToggleWindow		boolean	Should the Outlook window be toggled before attempting to attach? This helps to ensure that recently opened Outlook windows are visible to the Windows operating system.
Toggle uses global left mouse click agent	ToggleUsesGlobalLeftMouseClickAgent		boolean	If choosing to toggle the Outlook window, this specifies whether to use global mouse clicks to focus the IA-Connect Agent first.
Toggle delay in seconds	ToggleDelay		double	If choosing to toggle the Outlook window, this specifies the pause after toggling.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Current profile name	CurrentProfileName	string	The name of the Outlook mail profile that is in use.

Attach to existing MS Word instance

Operation ID:

MSWordAttachToExistingInstance

Attaches to an instance Microsoft Word that has already been started.

Parameters

Name	Key	Required	Type	Description
File name	Filename		string	The filename of an open document in Word to attach to. If it is an empty document then enter the name of the document (e.g. 'Document1').
Toggle window	ToggleWindow		boolean	Should the Word window be toggled before attempting to attach? This helps to ensure that recently opened Word windows are visible to the Windows operating system.
Toggle uses global left mouse click agent	ToggleUsesGlobalLeftMouseClickAgent		boolean	If choosing to toggle the Word window, this specifies whether to use global mouse clicks to focus the IA-Connect Agent first.
Toggle delay in seconds	ToggleDelay		double	If choosing to toggle the Word window, this specifies the pause after toggling.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Word handle	Handle	integer	A handle for this instance of Word to be used by other Word actions to distinguish between different instance of Word if more than one instance is running.

Check OLE object in MS Excel worksheet

Operation ID:

MSExcelCheckOLEObject

Check or uncheck an OLE checkbox or radio button (ActiveX control) in the active workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
OLE object name	OLEObjectName	True	string	The name of the OLE object.
Check	Checked		boolean	Set to true to check the OLE object or false to uncheck.
Run in background	RunInBackground		boolean	Should the IA-Connect Agent await a response or should this be run as a background task? Set to true if changing the object state would show a message box, dialog or prompt.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

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

Clear clipboard

Operation ID:

MSWordClearClipboard

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

Clear MS Excel clipboard

Operation ID:

MSExcelClearExcelClipboard

Clears the current Excel clipboard (the dotted area) in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Close current MS Excel workbook

Operation ID:

MSExcelCloseCurrentWorkbook

Closes the current Excel workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Close MS Excel instance

Operation ID:

MSExcelCloseInstance

Closes an instance Microsoft Excel that was started using a Visual Basic Object (or attached to later). The instance of Excel to close is defined by the handle.

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Close MS Excel workbook

Operation ID:

MSExcelCloseWorkbook

Closes an open Excel workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook Name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Save Data	SaveData		boolean	Should the Excel workbook be saved before closing?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Close MS Outlook instance

Operation ID:

MSOutlookCloseInstance

Closes an instance of Microsoft Outlook that was started using the 'Create instance' action (or attached to later), without waiting for any active requests to complete. This action can sometimes cause issues when Outlook cached mode is enabled and should be used after calling 'Wait for mails to send' to ensure that Outlook has successfully completed any ongoing tasks such as sending emails.

Parameters

Name	Key	Required	Type	Description
Seconds to wait for process to close	SecondsToWaitForProcessToClose		integer	The number of seconds to wait for the Outlook instance to close down.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Close MS Outlook instance using Window

Operation ID:

MSOutlookCloseInstanceUsingWindow

Closes an instance of Microsoft Outlook that was started using the 'Create instance' action (or attached to later), by making Outlook visible and then closing the Outlook window (as a user would close Outlook). This can be more reliable when Outlook cached mode is enabled.

Parameters

Name	Key	Required	Type	Description
Use native windows	UseNativeWindow		boolean	Should Outlook be closed using the native Outlook window handle? If both 'Use native windows' and 'Use UIA' are set to true, this method will be attempted first.
Use UIA	UseUIA		boolean	Should Outlook be closed using UIA methods?
Seconds to wait for process to close	SecondsToWaitForProcessToClose		integer	The number of seconds to wait for the Outlook instance to close down.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Close MS Word document

Operation ID:

MSWordCloseDocument

Closes an open Word document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Close MS Word instance

Operation ID:

MSWordCloseInstance

Closes an instance of Microsoft Word that was started using a Visual Basic Object (or attached to later). The instance of Word to close is defined by the handle.

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Copy between cells in MS Excel workbook

Operation ID:

MSExcelCopyBetweenCells

Copy and paste between cells in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Source Excel handle	SourceHandle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance'), or 0 for the currently active instance of Excel, from which to read from.
Source Workbook name	SourceWorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook, from which to read from.
Source Worksheet name	SourceWorksheetName		string	The name of the worksheet (tab) within the workbook, or blank for the currently active worksheet, from which to read from.
Source cell reference	SourceCellReference	True	string	The cell or cell range reference to copy the data from, for example: A1 or B2:C5.
Source entire row	SourceEntireRow		boolean	Should the entire row that contains the reference cell(s) be selected?
Source entire column	SourceEntireColumn		boolean	Should the entire column that contains the reference cell(s) be selected?
Target Excel handle	TargetHandle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance'), or 0 for the currently active instance of Excel, to write the copied data into.
Target Workbook name	TargetWorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook, to write the copied data into.
Target Worksheet name	TargetWorksheetName		string	The name of the worksheet (tab) within the workbook, or blank for the currently active worksheet, to write the copied data into.
Target cell reference	TargetCellReference	True	string	The cell or cell range reference to paste the data to, for example: A1 or B2:C5.
Target entire row	TargetEntireRow		boolean	Should the entire row that contains the target reference cell(s) be selected?
Target entire column	TargetEntireColumn		boolean	Should the entire column that contains the target reference cell(s) be selected?
Values Only	ValuesOnly		boolean	Should only values be pasted or should formatting be preserved?
Simple paste only	SimplePasteOnly		boolean	Simple paste or paste special?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSExcelCopyBetweenCellsResult	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.

Copy MS Word selection to clipboard

Operation ID:

MSWordCopyToClipboard

Copies the selected contents of a document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Copy selection in MS Excel workbook

Operation ID:

MSExcelCopySelection

Copies the current selection or a specified selection (by making use of the Excel clipboard) in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference		string	The cell or cell range reference, for example: A1 or B2:C5. Leave blank to read the current selection.
Entire row	EntireRow		boolean	Should the entire row that contains the reference cell(s) be selected and copied?
Entire column	EntireColumn		boolean	Should the entire column that contains the reference cell(s) be selected and copied?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Create mail folder in MS Outlook

Operation ID:

MSOutlookCreateMailFolder

Creates a mail folder within the current Outlook profile. This action can be used to create top-level folders if no parent folder path is provided, or child folders by providing a parent folder path.

Parameters

Name	Key	Required	Type	Description
Parent folder path	ParentFolderPath		string	The path to the parent folder to create the folder within, e.g. Inbox.
New folder name	NewFolderName		string	The name of the new folder to be created, e.g. Processed Items.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Create MS Excel instance

Operation ID:

MSExcelCreateInstance

Starts Microsoft Excel using a Visual Basic Object to allow Excel to be automated using the actions in this IA-Connect module. Microsoft Excel starts hidden, unless you enable ShowExcel, because it doesn't need to be visible for automation, unless you are also using UIA to control Excel.

Parameters

Name	Key	Required	Type	Description
Enable Events	EnableEvents		boolean	Enables VBA events such as BeforeSave, Open etc.
Show MS Excel	ShowExcel		boolean	Show MS Excel after the instance has been created. This could be useful when developing the MS Excel automation, or if you are also using UIA to control Excel.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Excel handle	Handle	integer	A handle for this instance of Excel to be used by other Excel actions to distinguish between different instance of Excel if more than one instance is running.

Create MS Excel workbook

Operation ID:

MSExcelCreateWorkbook

Creates a new Excel workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Workbook name	WorkbookName	string	The name of this Excel workbook to be used by other Excel actions to distinguish between different Excel workbooks if more than one is open.

Create MS Excel worksheet

Operation ID:

MSExcelCreateWorksheet

Creates a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) to be created within the workbook.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Create MS Outlook instance

Operation ID:

MSOutlookCreateInstance

Starts Microsoft Outlook using a Visual Basic Object to allow Outlook to be automated using the actions in this IA-Connect module. Microsoft Outlook starts hidden, unless you enable ShowOutlook, because it doesn't need to be visible for automation, unless you are also using UIA to control Outlook. Only one instance of Outlook can be running at any one time.

Parameters

Name	Key	Required	Type	Description
Mail profile name	ProfileName		string	The Outlook mail profile to use. If no mail profile name is provided, then the default profile will be used.
Show MS Outlook	ShowOutlook		boolean	Show MS Outlook after the instance has been created. This could be useful when developing the MS Outlook automation, or if you are also using UIA to control Outlook.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Current profile name	CurrentProfileName	string	The name of the Outlook mail profile that is in use.

Create MS Word document

Operation ID:

MSWordCreateDocument

Creates a new Word document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Document name	DocumentName	string	The name of this Word document to be used by other Word actions to distinguish between different Word documents if more than one is open.

Create MS Word instance

Operation ID:

MSWordCreateInstance

Starts Microsoft Word using a Visual Basic Object to allow Word to be automated using the actions in this IA-Connect module. Microsoft Word starts hidden, unless you enable ShowWord, because it doesn't need to be visible for automation, unless you are also using UIA to control Word.

Parameters

Name	Key	Required	Type	Description
Show MS Word	ShowWord		boolean	Show MS Word after the instance has been created. This could be useful when developing the MS Word automation, or if you are also using UIA to control Word.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Word handle	Handle	integer	A handle for this instance of Word to be used by other Word actions to distinguish between different instance of Word if more than one instance is running.

Cut between cells in MS Excel workbook

Operation ID:

MSExcelCutBetweenCells

Cut and paste between cells in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Source Excel handle	SourceHandle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance'), or 0 for the currently active instance of Excel, from which to read from.
Source Workbook name	SourceWorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks), or blank for the currently active workbook, from which to read from.
Source Worksheet name	SourceWorksheetName		string	The name of the worksheet (tab) within the workbook, or blank for the currently active worksheet, from which to read from.
Source cell reference	SourceCellReference	True	string	The cell or cell range reference to cut the data from, for example: A1 or B2:C5.
Source entire row	SourceEntireRow		boolean	Should the entire row that contains the reference cell(s) be selected?
Source entire column	SourceEntireColumn		boolean	Should the entire column that contains the reference cell(s) be selected?
Target Excel handle	TargetHandle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance'), or 0 for the currently active instance of Excel, to write the cut data into.
Target Workbook name	TargetWorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook, to write the cut data into.
Target Worksheet name	TargetWorksheetName		string	The name of the worksheet (tab) within the workbook, or blank for the currently active worksheet, to write the cut data into.
Target cell reference	TargetCellReference	True	string	The cell or cell range reference to paste the cut data to, for example: A1 or B2:C5.
Target entire row	TargetEntireRow		boolean	Should the entire row that contains the target reference cell(s) be selected?
Target entire column	TargetEntireColumn		boolean	Should the entire column that contains the target reference cell(s) be selected?
Values Only	ValuesOnly		boolean	Should only values be pasted or should formatting be preserved?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSExcelCutBetweenCellsResult	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.

Cut selection in MS Excel workbook

Operation ID:

MSExcelCutSelection

Cuts the current selection or a specified selection (by making use of the Excel clipboard) in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference		string	The cell or cell range reference, for example: A1 or B2:C5. Leave blank to read the current selection.
Entire row	EntireRow		boolean	Should the entire row that contains the reference cell(s) be selected and cut?
Entire column	EntireColumn		boolean	Should the entire column that contains the reference cell(s) be selected and cut?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Delete email in MS Outlook

Operation ID:

MSOutlookDeleteEmail

Deletes an email in Outlook.

Parameters

Name	Key	Required	Type	Description
Email entry ID	EntryID	True	string	The email entry ID of the email to be actioned. This can be retrieved from the output of the action 'Get emails'.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Delete MS Excel worksheet

Operation ID:

MSExcelDeleteWorksheet

Deletes a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Delete selection in MS Excel workbook

Operation ID:

MSExcelDeleteSelection

Deletes the current selection in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference		string	The cell or cell range reference to paste into, for example: A1 or B2:C5. Leave blank to paste into the current selection.
Entire row	EntireRow		boolean	Should the entire row that contains the reference cell(s) be pasted into?
Entire column	EntireColumn		boolean	Should the entire column that contains the reference cell(s) be pasted into?
Shift	Shift		string	Which direction should the rest of the worksheet data be shifted, L (Left) or U (Up)?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Detach from MS Word instance

Operation ID:

MSWordDetachFromInstance

Detaches from a running instance of Microsoft Word that was started using a Visual Basic Object (or attached to later). The instance of Word to detach from is defined by the handle.

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Does OLE object exist in MS Excel worksheet

Operation ID:

MSExcelDoesOLEObjectExist

Determines whether an OLE object exists in the active workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
OLE object name	OLEObjectName	True	string	The name of the OLE object.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
OLE object exists	OLEObjectExists	boolean	True if the OLE object exists. False if the OLE object does not exist.

Evaluate MS Excel expression

Operation ID:

MSExcelEvaluateExpression

Returns the result of evaluating an expression in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Expression	Expression	True	string	The expression to be evaluated, for example A1+A2 or SUM(A1:A6).
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Expression result	ExpressionResult	string	The result of evaluating the expression.

Execute MS Excel command bar object

Operation ID:

MSExcelExecuteCommandBarObject

Executes any command bar object in an instance of Microsoft Excel (referenced by the handle) given the Control Name. These are documented by Microsoft as 'Office Fluent UI Command Identifiers'. Some command-bar objects will work without additional interaction, while some might need to be used in conjunction with some UIA actions.

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Object Id	ObjectId	True	string	The Object Id (or Control Name) of the command bar object. These are documented by Microsoft as 'Office Fluent UI Command Identifiers'. Example actions which operate on the sheet: Copy, Undo, Bold, BorderNone, BordersAll, SortAscendingExcel, SortDecendingExcel. Example actions which open controls (set run in background to true): FileSaveACopy, FormatCellsDialog, FindDialogExcel.
Run in background	RunInBackground		boolean	If set to false, the IA-Connect Agent will wait for the action to complete. This is suitable for simple actions (for example: Copy, Undo, Bold). If set to true, the IA-Connect Agent will run the action in a background thread and return for more instructions. This should be used when an action results in a dialog being displayed or causes Excel to wait for additional input.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Execute MS Outlook command bar object

Operation ID:

MSOutlookExecuteCommandBarObject

Executes any command bar object in a Microsoft Outlook window or dialog, given the Control Name. These are documented by Microsoft as 'Office Fluent UI Command Identifiers'. The action is performed on the currently active Outlook window so Outlook must be visible (use the action 'Show MS Outlook'). Some command-bar objects will work without additional interaction, while some might need to be used in conjunction with some UIA actions.

Parameters

Name	Key	Required	Type	Description
Object Id	ObjectId	True	string	The Object Id (or Control Name) of the command bar object. These are documented by Microsoft as 'Office Fluent UI Command Identifiers'. Example actions which operate on a compose email window: Copy, Undo, Bold, IndentIncreaseWord, IndentDecreaseWord, AlignLeft, AlignCenter, AlignRight. Example actions which operate on a compose email window and open controls (set run in background to true): FontDialog, ParagraphDialog. Example actions which operate on the main Outlook email view: Forward, AddressBook, FilePrintQuick, NewItem.
Run in background	RunInBackground		boolean	If set to false, the IA-Connect Agent will wait for the action to complete. This is suitable for simple actions (for example: Copy, Undo, Bold). If set to true, the IA-Connect Agent will run the action in a background thread and return for more instructions. This should be used when an action results in a dialog being displayed or causes Outlook to wait for additional input.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSOutlookExecuteCommandBarObjectResult	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.

Execute MS Word command bar object

Operation ID:

MSWordExecuteCommandBarObject

Executes any command bar object in an instance of Microsoft Word (referenced by the handle) given the Control Name. These are documented by Microsoft as 'Office Fluent UI Command Identifiers'. Some command-bar objects will work without additional interaction, while some might need to be used in conjunction with some UIA actions.

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Object Id	ObjectId	True	string	The Object Id (or Control Name) of the command bar object. These are documented by Microsoft as 'Office Fluent UI Command Identifiers'. Example actions which operate on the document: Copy, Undo, Bold, IndentIncreaseWord, IndentDecreaseWord, AlignLeft, AlignCenter, AlignRight. Example actions which open controls (set run in background to true): FileSaveACopy, SymbolsDialog, FontDialog.
Run in background	RunInBackground		boolean	If set to false, the IA-Connect Agent will wait for the action to complete. This is suitable for simple actions (for example: Copy, Undo, Bold). If set to true, the IA-Connect Agent will run the action in a background thread and return for more instructions. This should be used when an action results in a dialog being displayed or causes Word to wait for additional input.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSWordExecuteCommandBarObjectResult	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.

Export MS Word document as PDF

Operation ID:

MSWordExportDocumentAsPDF

Saves a named document as a PDF in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Save filename	SaveFileName	True	string	The filename to save the PDF as.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Find next cell with value in MS Excel worksheet

Operation ID:

MSExcelFindNextCellWithValue

Finds the next cell with a specified value in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Direction	Direction	True	string	Provide a direction (U, D, L, R).
Search value	SearchValue	True	string	The cell value to search for.
Case sensitive	CaseSensitive		boolean	Should the search be case sensitive?
Comparison type	ComparisonType		string	The comparison type (equals, contains, startswith or endswith).
Max cells to search	MaxCellsToSearch		integer	The maximum number of cells to search.
Activate cell	ActivateCell		boolean	Should the matching cell be activated?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Cell reference	CellReference	string	The cell reference of the matching cell.
Row index	RowIndex	integer	The row index of the matching cell.
Column index	ColumnIndex	integer	The column index of the matching cell.

Find next empty cell in MS Excel worksheet

Operation ID:

MSExcelFindNextEmptyCell

Finds the next empty cell in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Direction	Direction	True	string	Provide a direction (U, D, L, R).
Activate cell	ActivateCell		boolean	Should the matching cell be activated?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Cell reference	CellReference	string	The cell reference of the matching cell.
Row index	RowIndex	integer	The row index of the matching cell.
Column index	ColumnIndex	integer	The column index of the matching cell.

Format cell in active MS Excel worksheet

Operation ID:

MSExcelFormatCell

Formats a cell in the active worksheet in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference	True	string	The cell reference, for example: A1.
Cell Format	CellFormat	True	string	The cell format to be set, e.g. dd/mm/yyyy or #,##0.000 - refer to MS Excel format code guidelines for further examples.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Format current cell in active MS Excel worksheet

Operation ID:

MSExcelFormatCurrentCell

Formats the active cell in the active worksheet in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Cell Format	CellFormat	True	string	The cell format to be set, e.g. dd/mm/yyyy or #,##0.000 - refer to MS Excel format code guidelines for further examples.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Forward email in MS Outlook

Operation ID:

MSOutlookForwardEmail

Forwards an email in Outlook.

Parameters

Name	Key	Required	Type	Description
Email entry ID	EntryID	True	string	The email entry ID of the email to be actioned. This can be retrieved from the output of the action 'Get emails'.
Email to	To		string	The email address(es) of the primary recipient(s).
Email CC	CC		string	The email address(es) of any recipient(s) who should be included on CC.
Email BCC	BCC		string	The email address(es) of any recipient(s) who should be included on BCC.
Override subject	OverrideSubject		boolean	Should the default forward subject be overridden? If set to true, alternative subject text should be provided in the 'Email subject' parameter.
Email subject	Subject		string	The email subject text to be used if the default is overridden. This should be left blank if the default subject is being used.
Override body	OverrideBody		boolean	Should the body of the forwarded email be overridden? If set to true, alternative email body text should be provided in the 'Email body' parameter.
Email body format	BodyFormat		string	Provide a body type (HTML, Plain or RTF).
Email body	Body		string	The alternative email body to be used if the email body format has been provided as 'Plain'.
Email HTML body	HTMLBody		string	The alternative email body to be used if the email body format has been provided as 'HTML'.
Email RTF body	RTFBody		string	The alternative email body to be used if the email body format has been provided as 'RTF'.
Click allow button if required	ClickAllowButtonIfRequired		boolean	Should IA-Connect attempt to click the 'Allow' button if prompted?
Voting options	VotingOptions		string	A semicolon separated list of voting options.
Send as SMTP address	SendAsSMTPAddress		string	The 'Send as' email address. This option can be used if the profile has permissions to send on behalf of another person or group.
Include existing hidden attachments	IncludeExistingHiddenAttachments		boolean	Should existing hidden attachments be included in the forwarded email?
Include existing visible attachments	IncludeExistingVisibleAttachments		boolean	Should existing visible attachments be included in the forwarded email?
Attachment filenames JSON	AttachmentFilenamesJSON		string	A list of full filepaths to the files that should be attached to the email, in JSON format.
Dont send if attachment filename missing	DontSendIfAttachmentFilenameMissing		boolean	Should the email not be sent if one of the provided attachments cannot be found?
Body contains stored password	BodyContainsStoredPassword		boolean	Set to true if the email body contains an IA-Connect stored password identifier, in the format {IAConnectPassword:StoredPasswordIdentifier} or an IA-Connect Orchestrator generic credential, in the format {OrchestratorCredential:FriendlyName}. This stored password could have been generated by the 'Generate password' action. For example: 'Welcome new starter, your new account password is {IAConnectPassword:GeneratedPassword}'.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Get active cell in active MS Excel worksheet

Operation ID:

MSExcelGetActiveCell

Returns the cell reference of the active cell in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Cell reference	CellReference	string	The cell reference of the matching cell.
Row index	RowIndex	integer	The row index of the matching cell.
Column index	ColumnIndex	integer	The column index of the matching cell.

Get active MS Excel worksheet name

Operation ID:

MSExcelGetWorksheetName

Returns the name of the worksheet at a specified index (starting at 1) in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet position	Position		integer	The position (index) of the desired Worksheet, starting from 1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Worksheet name	WorksheetName	string	The name of the worksheet in the workbook.

Get and set cell text in active MS Excel worksheet

Operation ID:

MSExcelGetAndSetCellText

Read a single cell text value and store into a different cell in the active workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Source Excel handle	SourceHandle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Source Workbook name	SourceWorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks), or blank for the currently active workbook, from which to read from.
Source Worksheet name	SourceWorksheetName		string	The name of the worksheet (tab) within the workbook, or blank for the currently active worksheet, from which to read from.
Source cell reference	SourceCellReference	True	string	The cell which contains the text value to read, for example: A1.
Target Excel handle	TargetHandle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance'), or 0 for the currently active instance of Excel, to write the copied data into.
Target Workbook name	TargetWorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook, to write the copied data into.
Target Worksheet name	TargetWorksheetName		string	The name of the worksheet (tab) within the workbook, or blank for the currently active worksheet, to write the copied data into.
Target cell reference	TargetCellReference	True	string	The cell in which to set the retrieved text value, for example: B2.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSExcelGetAndSetCellTextResult	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.

Get and set cell value 2 in active MS Excel worksheet

Operation ID:

MSExcelGetAndSetCellValue2

Read a single raw cell value and store into a different cell in the active workbook in an instance of Microsoft Excel (referenced by the handle). Gets and sets the underlying value of the cell without any formatting applied.

Parameters

Name	Key	Required	Type	Description
Source Excel handle	SourceHandle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Source Workbook name	SourceWorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks), or blank for the currently active workbook, from which to read from.
Source Worksheet name	SourceWorksheetName		string	The name of the worksheet (tab) within the workbook, or blank for the currently active worksheet, from which to read from.
Source cell reference	SourceCellReference	True	string	The cell which contains the value to read, for example: A1.
Target Excel handle	TargetHandle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance'), or 0 for the currently active instance of Excel, to write the copied data into.
Target Workbook name	TargetWorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook, to write the copied data into.
Target Worksheet name	TargetWorksheetName		string	The name of the worksheet (tab) within the workbook, or blank for the currently active worksheet, to write the copied data into.
Target cell reference	TargetCellReference	True	string	The cell in which to set the retrieved value, for example: B2.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSExcelGetAndSetCellValue2Result	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.

Get and set cell value in active MS Excel worksheet

Operation ID:

MSExcelGetAndSetCellValue

Read a single cell value and store into a different cell in the active workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Source Excel handle	SourceHandle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Source Workbook name	SourceWorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks), or blank for the currently active workbook, from which to read from.
Source Worksheet name	SourceWorksheetName		string	The name of the worksheet (tab) within the workbook, or blank for the currently active worksheet, from which to read from.
Source cell reference	SourceCellReference	True	string	The cell which contains the value to read, for example: A1.
Target Excel handle	TargetHandle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance'), or 0 for the currently active instance of Excel, to write the copied data into.
Target Workbook name	TargetWorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook, to write the copied data into.
Target Worksheet name	TargetWorksheetName		string	The name of the worksheet (tab) within the workbook, or blank for the currently active worksheet, to write the copied data into.
Target cell reference	TargetCellReference	True	string	The cell in which to set the retrieved value, for example: B2.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSExcelGetAndSetCellValueResult	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.

Get cell background colour in MS Excel worksheet

Operation ID:

MSExcelGetCellBackgroundColour

Gets the background colour of the specified cell in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference	True	string	The cell to retrieve the background colour from, for example: A1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Colour index	ColourIndex	integer	The MS Excel colour index number, for example: Black = 1, White = 2, Red = 3, Green = 4, Blue = 5. The index -4142 will be returned for cells with no fill. For a full colour index see our KB article.

Get cell text in active MS Excel worksheet

Operation ID:

MSExcelGetCellText

Get text in a cell in the active workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference	True	string	The cell reference, for example: A1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Cell value	CellValue	string	The text value of the referenced cell.

Get cell value 2 in active MS Excel worksheet

Operation ID:

MSExcelGetCellValue2

Gets the raw value in a cell in the active workbook in an instance of Microsoft Excel (referenced by the handle). This returns the underlying value of the cell without any formatting applied.

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference	True	string	The cell reference, for example: A1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Cell value	CellValue	string	The raw value of the referenced cell.

Get cell value in active MS Excel worksheet

Operation ID:

MSExcelGetCellValue

Get the string value in a cell in the active workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference	True	string	The cell reference, for example: A1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Cell value	CellValue	string	The string value of the referenced cell.

Get email attachment filenames in MS Outlook

Operation ID:

MSOutlookGetEmailAttachmentFilenames

Retrieves details about the attachments on an email in Outlook.

Parameters

Name	Key	Required	Type	Description
Email entry ID	EntryID	True	string	The email entry ID of the email to be actioned. This can be retrieved from the output of the action 'Get emails'.
Click allow button if required	ClickAllowButtonIfRequired		boolean	Should IA-Connect attempt to click the 'Allow' button if prompted?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of attachments	NumberOfAttachments	integer	The number of attachments on the specified email.
Email attachment filenames JSON	EmailAttachmentFilenamesJSON	string	The email attachment filenames, in JSON format.

Get email body in MS Outlook

Operation ID:

MSOutlookGetEmailBody

Retrieves the body of an email in Outlook.

Parameters

Name	Key	Required	Type	Description
Email entry ID	EntryID	True	string	The email entry ID of the email to be actioned. This can be retrieved from the output of the action 'Get emails'.
Click allow button if required	ClickAllowButtonIfRequired		boolean	Should IA-Connect attempt to click the 'Allow' button if prompted?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Body format	BodyFormat	string	The format of the email body.
Plain body	PlainBody	string	The plain text content of the email body.
Formatted body	FormattedBody	string	The formatted content of the email body.

Get emails in MS Outlook

Operation ID:

MSOutlookGetEmails

Retrieves emails from a specified folder in Outlook.

Parameters

Name	Key	Required	Type	Description
Folder path	FolderPath		string	The path to the specified folder to get emails from, e.g. Inbox.
Search read	SearchRead		boolean	Should read emails be returned?
Search unread	SearchUnread		boolean	Should unread emails be returned?
Search subject	SearchSubject		string	A search subject or keyword to match emails on, for example 'Invoice'.
Search from SMTP	SearchFromSMTP		string	A sender email address to match emails from.
Search from name	SearchFromName		string	A sender name to match emails from.
Search query	SearchQuery		string	A search query to match emails on. Example 1: [Importance] = 2. Example 2: [Categories] = 'Personal'. See the documentation for more examples.
Search max age in days	SearchMaxAgeInDays		integer	A maximum age of emails to return, in days.
Search start date time	SearchStartDateTimeAsString		date-time	A start search datetime string. For example: '2020-01-21T00:00:00' which would return all emails received after midnight on the 21st of January 2020. Please note, all datetimes are in UTC so you may wish to use the Convert DateTime action to convert your local time to UTC. If you do not provide a value, this will default to '1901-01-01T00:00:00'
Search end date time	SearchEndDateTimeAsString		date-time	An end search datetime string. For example: '2020-01-28T00:00:00' which would return all emails received before midnight on the 28th of January 2020. Please note, all datetimes are in UTC so you may wish to use the Convert DateTime action to convert your local time to UTC. If you do not provide a value, this will default to '2999-01-01T00:00:00'
Max results to return	MaxResultsToReturn		integer	The maximum number of emails to return. Used to limit the search results.
Click allow button if required	ClickAllowButtonIfRequired		boolean	Should IA-Connect attempt to click the 'Allow' button if prompted?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of emails match filter	NumberOfEmailsMatchFilter	integer	The number of emails in the specified folder that match the provided search criteria.
Number of emails returned	NumberOfEmailsReturned	integer	The number of emails returned. This may be lower than 'Number of emails match filter' if a 'Max results to return' value is provided in the input parameters.
Emails JSON	EmailsJSON	string	The emails retrieved, in JSON format.

Get first email in MS Outlook

Operation ID:

MSOutlookGetFirstEmail

Retrieves the first email from a specified folder in Outlook. As the emails are not ordered in any particular way, if you require the emails to be in a specific order (e.g. the first email by date received) then you should instead use the 'Get emails' action and then sort the output.

Parameters

Name	Key	Required	Type	Description
Folder path	FolderPath		string	The path to the specified folder to get emails from, e.g. Inbox.
Search read	SearchRead		boolean	Should read emails be returned?
Search unread	SearchUnread		boolean	Should unread emails be returned?
Search subject	SearchSubject		string	A search subject or keyword to match emails on, for example 'Invoice'.
Search from SMTP	SearchFromSMTP		string	A sender email address to match emails from.
Search from name	SearchFromName		string	A sender name to match emails from.
Search query	SearchQuery		string	A search query to match emails on. Example 1: [Importance] = 2. Example 2: [Categories] = 'Personal'. See the documentation for more examples.
Search max age in days	SearchMaxAgeInDays		integer	A maximum age of emails to return, in days.
Search start date time	SearchStartDateTimeAsString		date-time	A start search datetime string. For example: '2020-01-21T00:00:00' which would return all emails received after midnight on the 21st of January 2020. Please note, all datetimes are in UTC so you may wish to use the Convert DateTime action to convert your local time to UTC. If you do not provide a value, this will default to '1901-01-01T00:00:00'
Search end date time	SearchEndDateTimeAsString		date-time	An end search datetime string. For example: '2020-01-28T00:00:00' which would return all emails received before midnight on the 28th of January 2020. Please note, all datetimes are in UTC so you may wish to use the Convert DateTime action to convert your local time to UTC. If you do not provide a value, this will default to '2999-01-01T00:00:00'
Click allow button if required	ClickAllowButtonIfRequired		boolean	Should IA-Connect attempt to click the 'Allow' button if prompted?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of emails match filter	NumberOfEmailsMatchFilter	integer	The number of emails in the specified folder that match the provided search criteria.
Email entry ID	EmailEntryID	string	The unique email entry ID of the email.
Sender email type	SenderEmailType	string	The senders email address type (SMTP or Exchange).
Sender email address	SenderEmailAddress	string	The senders email address.
Received by name	ReceivedByName	string	The recipient name.
Email to	To	string	The names of all email recipients.
Email subject	EmailSubject	string	The email subject line.
Email read	EmailRead	boolean	Returns true if the email has been read or false if not.
Email sent on	SentOnAsString	date-time	The DateTime when the email was sent
Number of attachments	NumberOfAttachments	integer	The number of attachments included in the email

Get highlighted text in MS Word document

Operation ID:

MSWordGetHighlightedText

Returns all highlighted text in a document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Highlighted text JSON	HighlightedTextJSON	string	All of the highlighted pieces of text in the document, in JSON format.

Get mail folders in MS Outlook

Operation ID:

MSOutlookGetMailFolders

Retrieves all mail folders in Outlook by providing a folder path and optionally a flag to indicate whether subfolders should also be returned.

Parameters

Name	Key	Required	Type	Description
Folder path	FolderPath		string	The path to the parent folder to get folders from, e.g. Inbox.
Subfolders	SubFolders		boolean	Should any subfolders also be returned?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Mail folders JSON	MailFoldersJSON	string	The mail folders, in JSON format.

Get MS Excel country setting

Operation ID:

MSExcelGetCountrySetting

Returns the Country setting for an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Country setting	CountrySetting	integer	The country setting value, for instance 44 for UK English.

Get MS Excel worksheet as collection enhanced

Operation ID:

MSExcelGetWorksheetAsCollectionEnhanced

Retrieves the contents of a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Use Header	UseHeader		boolean	Should the first row of the worksheet be used as headers?
Start Cell	StartCell		string	The cell reference to start reading from, for example A1.
Maximum column number	MaximumColumnNumber		integer	The maximum number of columns to return.
Skip Blank Rows	SkipBlankRows		boolean	Should blank rows in the worksheet be skipped?
Skip columns with no header	SkipColumnsWithNoHeader		boolean	Should columns with no headers be skipped?
Key column	KeyColumn		string	The name of the key column, if one exists. If you are using a 'Minimum number of populated cells' value, the key column will not count as a populated cell.
Get raw data	GetRawData		boolean	Should the raw, unformatted data be returned?
Minimum number of populated cells	IgnoreRowsWithLowCellCount		integer	The minimum number of cells that must be populated in each row. If the row contains less than this number, it will be skipped.
Max concurrent blank rows	MaxConcurrentBlankRows		integer	The maximum number of concurrent blank rows that are allowed in the Worksheet data.
First data row to return	FirstDataRowToReturn		integer	The index of the first row to return, or 0 for all rows.
Max number of data rows to return	MaxNumberOfDataRowsToReturn		integer	The maximum number of rows to return, or 0 for all rows.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Sheet exists	SheetExists	boolean	Returns true if the sheet exists or false if not.
Any more rows to return	AnyMoreRowsToReturn	boolean	Contains either true or false depending on if there were more rows in the worksheet that were omitted due to the max number of data rows to return input.
First data row in returned collection	FirstDataRowInReturnedCollection	integer	The worksheet index of the first row returned.
Last data row in returned collection	LastDataRowInReturnedCollection	integer	The worksheet index of the last row returned.
Total number of rows in worksheet	TotalNumberOfRowsInWorksheet	integer	The total number of rows in the worksheet.
Worksheet collection JSON	WorksheetCollectionJSON	string	The contents of the Worksheet, in JSON format.

Get MS Excel worksheet names

Operation ID:

MSExcelGetWorksheetNames

Returns the names of worksheets in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Worksheet names	WorksheetNames	array of object	The names of the worksheets in the workbook.
items	WorksheetNames	object

Get MS Excel worksheet used range

Operation ID:

MSExcelGetWorksheetUsedRange

Returns the used range in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Left	Left	integer	The index of the leftmost column in the used range in the worksheet.
Right	Right	integer	The index of the rightmost column in the used range in the worksheet.
Top	Top	integer	The index of the topmost row in the used range in the worksheet.
Bottom	Bottom	integer	The index of the bottommost row in the used range in the worksheet.

Get MS Outlook MAPI profiles

Operation ID:

MSOutlookGetMAPIProfiles

Retrieves all the configured MAPI profiles which can be used with Outlook.

Parameters

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

Returns

Name	Path	Type	Description
Number of MAPI profiles	NumberOfMAPIProfiles	integer	The number of MAPI profiles which can be used with Outlook.
MAPI profiles JSON	MAPIProfilesJSON	string	A list of MAPI profiles, in JSON format.
Default MAPI profile	DefaultMAPIProfile	string	The name of the default MAPI profile.

Get MS Outlook namespace information

Operation ID:

MSOutlookGetNameSpaceInformation

Retrieves information about the current Outlook instance running and the Exchange server that it is connected to.

Parameters

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

Returns

Name	Path	Type	Description
Current profile name	CurrentProfileName	string	The name of the Outlook mail profile that is in use.
Exchange mailbox server name	ExchangeMailBoxServerName	string	The fully qualified name of the Exchange server that hosts the primary Exchange account mailbox.
Exchange mailbox server version	ExchangeMailBoxServerVersion	string	The full version number of the Exchange server that hosts the primary Exchange account mailbox.
Offline	Offline	boolean	Returns true if Outlook is currently offline (not connected to an Exchange server) or false if not.
Current user address	CurrentUserAddress	string	The email address of the current Outlook user.
Current user name	CurrentUserName	string	The user name of the current Outlook user.
Application name	ApplicationName	string	The name of the Outlook application.
Application version	ApplicationVersion	string	The version of the Outlook application.

Get MS Outlook process Id

Operation ID:

MSOutlookGetOutlookProcessId

Returns the dynamic Process ID (PID) of the running Outlook process which could be used for performing UIA actions.

Parameters

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

Returns

Name	Path	Type	Description
Outlook process Id	ProcessId	integer	The dynamic Process ID (PID) of the running Outlook process.

Get MS Word document body text

Operation ID:

MSWordGetDocumentBodyText

Reads the content from a specified character range in the body of a named document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Start	Start	True	integer	The starting character position, starting at 1.
Finish	Finish	True	integer	The ending character position, starting at 1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Body text	BodyText	string	The text that has been read from the document body.

Get MS Word document table bounds

Operation ID:

MSWordGetTableBounds

Returns the number of rows and columns in a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Table index	TableIndex	True	integer	The table number, starting at 1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of rows	NumberOfRows	integer	The number of rows in the table.
Number of columns	NumberOfColumns	integer	The number of columns in the table.

Get MS Word document table cell text value trimmed

Operation ID:

MSWordGetTableCellTextValueTrimmed

Gets the text value of a cell with any leading or trailing whitespace characters (e.g. spaces) removed in a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Table index	TableIndex	True	integer	The table number, starting at 1.
Row index	RowIndex	True	integer	The row number, starting at 1.
Column index	ColumnIndex	True	integer	The column number, starting at 1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Cell text	CellText	string	The text value of the referenced cell within the table with any leading or trailing whitespace characters (e.g. spaces) removed.

Get number of MS Outlook mails

Operation ID:

MSOutlookGetNumberOfEmails

Returns the number of emails from a specified folder in Outlook that match the provided search criteria.

Parameters

Name	Key	Required	Type	Description
Folder path	FolderPath		string	The path to the specified folder to get emails from, e.g. Inbox.
Search read	SearchRead		boolean	Should read emails be returned?
Search unread	SearchUnread		boolean	Should unread emails be returned?
Search subject	SearchSubject		string	A search subject or keyword to match emails on, for example 'Invoice'.
Search from SMTP	SearchFromSMTP		string	A sender email address to match emails from.
Search from name	SearchFromName		string	A sender name to match emails from.
Search query	SearchQuery		string	A search query to match emails on. Example 1: [Importance] = 2. Example 2: [Categories] = 'Personal'. See the documentation for more examples.
Search max age in days	SearchMaxAgeInDays		integer	A maximum age of emails to return, in days.
Search start date time	SearchStartDateTimeAsString		date-time	A start search datetime string. For example: '2020-01-21T00:00:00' which would return all emails received after midnight on the 21st of January 2020. Please note, all datetimes are in UTC so you may wish to use the Convert DateTime action to convert your local time to UTC. If you do not provide a value, this will default to '1901-01-01T00:00:00'
Search end date time	SearchEndDateTimeAsString		date-time	An end search datetime string. For example: '2020-01-28T00:00:00' which would return all emails received before midnight on the 28th of January 2020. Please note, all datetimes are in UTC so you may wish to use the Convert DateTime action to convert your local time to UTC. If you do not provide a value, this will default to '2999-01-01T00:00:00'
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of emails match filter	NumberOfEmailsMatchFilter	integer	The number of emails in the specified folder that match the provided search criteria.

Get number of rows in MS Excel worksheet

Operation ID:

MSExcelGetNumberOfRows

Returns the number of data rows in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of rows	NumberOfRows	integer	The number of rows in the worksheet.

Get number of tables in MS Word document

Operation ID:

MSWordGetNumberOfTablesInDocument

Returns the number of tables in a named document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of tables	NumberOfTables	integer	The number of tables that were found in the Word document.

Get OLE object value in MS Excel worksheet

Operation ID:

MSExcelGetOLEObjectValue

Retrieve the text value of an OLE object in the active workbook in an instance of Microsoft Excel (referenced by the handle). If the OLE object is a checkbox, the value 'True' or 'False' will be returned.

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
OLE object name	OLEObjectName	True	string	The name of the OLE object.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
OLE object value	OLEObjectValue	string	The value retrieved from the specified OLE object.

Get table cell text value in MS Word document

Operation ID:

MSWordGetTableCellTextValue

Gets the text value of a cell in a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Table index	TableIndex	True	integer	The table number, starting at 1.
Row index	RowIndex	True	integer	The row number, starting at 1.
Column index	ColumnIndex	True	integer	The column number, starting at 1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Cell text	CellText	string	The text value of the referenced cell within the table.

Go to cell in active MS Excel worksheet

Operation ID:

MSExcelGoToCell

Goes to (selects) a cell in the active workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference	True	string	The cell reference, for example: A1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Go to next empty cell down in MS Excel worksheet

Operation ID:

MSExcelGotoNextEmptyCellDown

Go to next empty cell down in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Cell reference	CellReference	string	The cell reference of the matching cell.
Row index	RowIndex	integer	The row index of the matching cell.
Column index	ColumnIndex	integer	The column index of the matching cell.

Go to next empty cell left in MS Excel worksheet

Operation ID:

MSExcelGotoNextEmptyCellLeft

Go to next empty cell to the left in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Cell reference	CellReference	string	The cell reference of the matching cell.
Row index	RowIndex	integer	The row index of the matching cell.
Column index	ColumnIndex	integer	The column index of the matching cell.

Go to next empty cell right in MS Excel worksheet

Operation ID:

MSExcelGotoNextEmptyCellRight

Go to next empty cell to the right in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Cell reference	CellReference	string	The cell reference of the matching cell.
Row index	RowIndex	integer	The row index of the matching cell.
Column index	ColumnIndex	integer	The column index of the matching cell.

Go to next empty cell up in MS Excel worksheet

Operation ID:

MSExcelGotoNextEmptyCellUp

Go to next empty cell up in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Cell reference	CellReference	string	The cell reference of the matching cell.
Row index	RowIndex	integer	The row index of the matching cell.
Column index	ColumnIndex	integer	The column index of the matching cell.

Hide MS Excel

Operation ID:

MSExcelHideExcel

Hides an instance of Microsoft Excel (referenced by the handle). This would typically only be used during development because Excel doesn't need to be visible for automation.

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Hide MS Word

Operation ID:

MSWordHideWord

Hides an instance of Microsoft Word (referenced by the handle). This would typically only be used during development because Word doesn't need to be visible for automation.

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Input text into OLE object in MS Excel worksheet

Operation ID:

MSExcelInputTextIntoOLEObject

Input text into an OLE object in the active workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
OLE object name	OLEObjectName	True	string	The name of the OLE object.
Text to input	TextToInput		string	The text to enter into the OLE object.
Run in background	RunInBackground		boolean	Should the IA-Connect Agent await a response or should this be run as a background task? This should be set to true if changing the object state would show a message box, dialog or prompt.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSExcelInputTextIntoOLEObjectResult	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.

Insert on selection in MS Excel workbook

Operation ID:

MSExcelInsertOnSelection

Inserts on the current selection in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference		string	The cell or cell range reference to paste into, for example: A1 or B2:C5. Leave blank to paste into the current selection.
Entire row	EntireRow		boolean	Should the entire row that contains the reference cell(s) be pasted into?
Entire column	EntireColumn		boolean	Should the entire column that contains the reference cell(s) be pasted into?
Shift	Shift		string	Which direction should the current selection be shifted, R (Right) or D (Down)?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Is MS Outlook connected

Operation ID:

MSOutlookIsConnected

Checks to see if IA-Connect is connected to an instance of Outlook.

Parameters

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

Returns

Name	Path	Type	Description
Is Outlook connected	IsOutlookConnected	boolean	Returns true if IA-Connect is connected to an instance of Outlook or false if not.

Mark email as read in MS Outlook

Operation ID:

MSOutlookMarkEmailAsRead

Marks a specific email in Outlook as read or unread, depending on the input flag set.

Parameters

Name	Key	Required	Type	Description
Email entry ID	EntryID	True	string	The email entry ID of the email to be actioned. This can be retrieved from the output of the action 'Get emails'.
Read	Read		boolean	Should the email be marked as read? This can be set to false to mark the email as unread.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Maximise MS Excel window

Operation ID:

MSExcelMaximiseWindow

Maximise the active instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSExcelMaximiseWindowResult	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.

Minimise MS Excel window

Operation ID:

MSExcelMinimiseWindow

Minimise the active instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSExcelMinimiseWindowResult	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.

Move email in MS Outlook

Operation ID:

MSOutlookMoveEmail

Moves a specific email from a specified folder in Outlook to another folder.

Parameters

Name	Key	Required	Type	Description
Email entry ID	EntryID	True	string	The email entry ID of the email to be actioned. This can be retrieved from the output of the action 'Get emails'.
Destination mail folder	DestinationFolder		string	The email folder path to move the email to, for example 'Inbox\Processed Items'.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Normalise MS Excel window

Operation ID:

MSExcelNormaliseWindow

Normalise the active instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSExcelNormaliseWindowResult	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.

Open MS Excel workbook

Operation ID:

MSExcelOpenWorkbook

Opens a specified Excel workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
File Name	Filename		string	The filename of the Excel workbook to be opened.
Open read only	ReadOnly		boolean	Should the Excel workbook be opened in read only mode?
Update links	UpdateLinks		boolean	Should any links in the Excel workbook be updated on open?
Open password	Password		password	The password for the Excel workbook, if required.
Enable events	EnableEvents		boolean	Should Excel events be enabled?
Put HTTP workbooks in edit mode	PutHTTPWorkbooksIntoEditMode		boolean	Set to true if you want IA-Connect to automatically put workbooks opened from an HTTP URL (for example: Opened from SharePoint) into edit mode. This will only be performed if the workbook is detected to have opened in read-only mode.
Put file path workbooks in edit mode	PutFilePathWorkbooksIntoEditMode		boolean	Set to true if you want IA-Connect to automatically put workbooks opened from a file path (for example: a drive letter or network share) into edit mode. This will only be performed if the workbook is detected to have opened in read-only mode.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Workbook name	WorkbookName	string	The name of this Excel workbook to be used by other Excel actions to distinguish between different Excel workbooks if more than one is open.

Open MS Word document

Operation ID:

MSWordOpenDocument

Opens a specified Word document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
File name	Filename	True	string	The filename of the Word document to be opened.
Open read only	OpenReadOnly		boolean	Should the Word document be opened in read only mode?
Add to recent files	AddToRecentFiles		boolean	Should the Word document be added to the recently used files list?
Password	Password		password	The password for the Word document, if required.
Open and repair	OpenAndRepair		boolean	Should the document be repaired when it is opened? This can be used to prevent document corruption.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Document name	DocumentName	string	The name of this Word document to be used by other Word actions to distinguish between different Word documents if more than one is open.

Paste into MS Word from clipboard

Operation ID:

MSWordPasteFromClipboard

Pastes the content of the clipboard into a document at the currently selected point in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Paste into selection in MS Excel workbook

Operation ID:

MSExcelPasteIntoSelection

Pastes into the current selection or a specified selection (by making use of the Excel clipboard) in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Values Only	ValuesOnly		boolean	Should only values be pasted or should formatting be preserved?
Simple paste only	SimplePasteOnly		boolean	Simple paste or paste special? If pasting a cut, simple paste must be set to true.
Cell reference	CellReference		string	The cell or cell range reference to paste into, for example: A1 or B2:C5. Leave blank to paste into the current selection.
Entire row	EntireRow		boolean	Should the entire row that contains the reference cell(s) be pasted into?
Entire column	EntireColumn		boolean	Should the entire column that contains the reference cell(s) be pasted into?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Press OLE object in MS Excel worksheet

Operation ID:

MSExcelPressOLEObject

Presses an OLE button object (ActiveX control) in the active workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
OLE object name	OLEObjectName	True	string	The name of the OLE object.
Run in background	RunInBackground		boolean	Should the IA-Connect Agent await a response or should this be run as a background task? Set to true if changing the object state would show a message box, dialog or prompt.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSExcelPressOLEObjectResult	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.

Put MS Excel workbook in edit mode

Operation ID:

MSExcelPutWorkbookInEditMode

Puts a Microsoft Excel workbook into edit mode. This is useful if a workbook opened in read-only mode and there is an 'Enable editing' button which you must press to edit the workbook.

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook Name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Force	Force		boolean	If set to false and IA-Connect determines the workbook is not in read-only mode, no action is performed since the workbook is already in edit mode. If set to true, IA-Connect will attempt to enable editing regardless of workbook read-only state - this might cause an exception if the workbook is not in read-only mode.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSExcelPutWorkbookInEditModeResult	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.

Reply to email in MS Outlook

Operation ID:

MSOutlookReplyToEmail

Replies to an email in Outlook.

Parameters

Name	Key	Required	Type	Description
Email entry ID	EntryID	True	string	The email entry ID of the email to be actioned. This can be retrieved from the output of the action 'Get emails'.
Reply to all	ReplyToAll		boolean	Should this reply be sent to all recipients? If false, the reply will be sent directly to the sender.
Email body format	BodyFormat		string	Provide a body type (HTML, Plain or RTF).
Email body	Body		string	The email body to be used if the email body format has been provided as 'Plain'.
Email HTML body	HTMLBody		string	The email HTML body to be used if the email body format has been provided as 'HTML'.
Email RTF body	RTFBody		string	The email RTF body to be used if the email body format has been provided as 'RTF'.
Attachment filenames JSON	AttachmentFilenamesJSON		string	A list of full filepaths to the files that should be attached to the email, in JSON format.
Dont send if attachment filename missing	DontSendIfAttachmentFilenameMissing		boolean	Should the email not be sent if one of the provided attachments cannot be found?
Click allow button if required	ClickAllowButtonIfRequired		boolean	Should IA-Connect attempt to click the 'Allow' button if prompted?
Voting options	VotingOptions		string	A semicolon separated list of voting options.
Send as SMTP address	SendAsSMTPAddress		string	The 'Send as' email address. This option can be used if the profile has permissions to send on behalf of another person or group.
Body contains stored password	BodyContainsStoredPassword		boolean	Set to true if the email body contains an IA-Connect stored password identifier, in the format {IAConnectPassword:StoredPasswordIdentifier}. This stored password could have been generated by the 'Generate password' action. For example: 'Welcome new starter, your new account password is {IAConnectPassword:GeneratedPassword}'.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Run MS Excel macro

Operation ID:

MSExcelRunMacro

Runs a macro in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Macro name	MacroName	True	string	The name of the macro in the MS Excel workbook.
Number of arguments	NumberOfArguments		integer	The number of arguments that will be passed to the macro.
Argument 1	Argument1		string	The first argument that will be passed to the macro.
Argument 2	Argument2		string	The second argument that will be passed to the macro.
Argument 3	Argument3		string	The third argument that will be passed to the macro.
Argument 4	Argument4		string	The fourth argument that will be passed to the macro.
Argument 5	Argument5		string	The fifth argument that will be passed to the macro.
Argument 6	Argument6		string	The sixth argument that will be passed to the macro.
Argument 7	Argument7		string	The seventh argument that will be passed to the macro.
Argument 8	Argument8		string	The eighth argument that will be passed to the macro.
Argument 9	Argument9		string	The ninth argument that will be passed to the macro.
Argument 10	Argument10		string	The tenth argument that will be passed to the macro.
Run in background	RunInBackground		boolean	If set to false, the IA-Connect Agent will wait for the macro to complete. This is suitable for simple macros which perform a task and exit. If set to true, the IA-Connect Agent will run the macro in a background thread and return for more instructions. This should be used for long running macros, if the macro displays a dialog or causes Excel to wait for additional input.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Result	Result	string	The result of the macro execution.

Save As MS Word document

Operation ID:

MSWordSaveAsDocument

Saves a specified open document in an instance of Microsoft Word (referenced by the handle) as a specified filename.

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Save filename	SaveFilename	True	string	The filename to save the document as.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
New document name	NewDocumentName	string	The new name of the Word document (after it has been saved) to be used by other Word actions to distinguish between different Word documents if more than one is open.

Save current MS Excel workbook

Operation ID:

MSExcelSaveCurrentWorkbook

Saves the current workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
New workbook name	NewWorkbookName	string	The new name of the Excel workbook (after it has been saved) to be used by other Excel actions to distinguish between different Excel workbooks if more than one is open.

Save current MS Excel workbook as

Operation ID:

MSExcelSaveCurrentWorkbookAs

Saves the current workbook in an instance of Microsoft Excel (referenced by the handle) as a specified filename.

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Save filename	SaveFilename		string	The filename to save the Workbook as.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
New workbook name	NewWorkbookName	string	The new name of the Excel workbook (after it has been saved) to be used by other Excel actions to distinguish between different Excel workbooks if more than one is open.

Save current MS Excel workbook as CSV

Operation ID:

MSExcelSaveCurrentWorkbookAsCSV

Saves the current workbook as CSV in an instance of Microsoft Excel (referenced by the handle) as a specified filename.

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Save filename	SaveFilename	True	string	The filename to save the Workbook as.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
New workbook name	NewWorkbookName	string	The new name of the Excel workbook (after it has been saved) to be used by other Excel actions to distinguish between different Excel workbooks if more than one is open.

Save email attachments as file in MS Outlook

Operation ID:

MSOutlookSaveEmailAttachmentsAsFile

Saves the attachments from a specific email in Outlook.

Parameters

Name	Key	Required	Type	Description
Email entry ID	EntryID	True	string	The email entry ID of the email to be actioned. This can be retrieved from the output of the action 'Get emails'.
Save folder path	SaveFolderPath		string	The full folder path to save the attachments to in the IA-Connect Agent session.
Create folder	CreateFolder		boolean	Should the save folder path be created if it does not already exist?
Only save attachments matching wildcard	OnlySaveAttachmentsMatchingWildcard		string	An optional wildcard filter to specify which attachments should be saved, for example '.xlsx' to save all attachments with a '.xlsx' extension or 'Daily Report' to save all attachments with a name starting 'Daily Report'.
Save hidden attachments	SaveHiddenAttachments		boolean	Should hidden attachments be saved from the email?
Click allow button if required	ClickAllowButtonIfRequired		boolean	Should IA-Connect attempt to click the 'Allow' button if prompted?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Number of saved attachments	NumberOfSavedAttachments	integer	The number of attachments saved.
Number of attachments failed to save	NumberOfAttachmentsFailedToSave	integer	The number of attachments that failed to save.
Number of attachments not matching wildcard	NumberOfAttachmentsNotMatchingWildcard	integer	The number of attachments that were skipped as they did not match the wildcard.
Number of attachments skipped	NumberOfAttachmentsSkipped	integer	The number of attachments that were skipped as they were hidden.
Email attachment save as filenames JSON	EmailAttachmentSaveAsFilenamesJSON	string	The full path to each attachment that was saved, in JSON format.

Save MS Excel workbook

Operation ID:

MSExcelSaveWorkbook

Saves a specified open workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
New workbook name	NewWorkbookName	string	The new name of the Excel workbook (after it has been saved) to be used by other Excel actions to distinguish between different Excel workbooks if more than one is open.

Save MS Excel workbook as

Operation ID:

MSExcelSaveWorkbookAs

Saves a specified open workbook in an instance of Microsoft Excel (referenced by the handle) as a specified filename.

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Save filename	SaveFilename	True	string	The filename to save the Workbook as.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
New workbook name	NewWorkbookName	string	The new name of the Excel workbook (after it has been saved) to be used by other Excel actions to distinguish between different Excel workbooks if more than one is open.

Save MS Excel workbook as CSV

Operation ID:

MSExcelSaveWorkbookAsCSV

Saves a specified open workbook as CSV in an instance of Microsoft Excel (referenced by the handle) as a specified filename.

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Save filename	SaveFilename	True	string	The filename to save the Workbook as.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
New workbook name	NewWorkbookName	string	The new name of the Excel workbook (after it has been saved) to be used by other Excel actions to distinguish between different Excel workbooks if more than one is open.

Save MS Excel workbook as with password

Operation ID:

MSExcelSaveWorkbookAsWithPassword

Saves a specified open workbook in an instance of Microsoft Excel (referenced by the handle) as a specified filename with a password.

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Save filename	SaveFilename	True	string	The filename to save the Workbook as.
Save password	Password	True	password	The password to be used to access the Workbook after it has been saved.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
New workbook name	NewWorkbookName	string	The new name of the Excel workbook (after it has been saved) to be used by other Excel actions to distinguish between different Excel workbooks if more than one is open.

Save MS Word document

Operation ID:

MSWordSaveDocument

Saves a specified open document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Select all in MS Word document

Operation ID:

MSWordSelectAll

Selects all of the content in an open document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Select cell range in MS Excel worksheet

Operation ID:

MSExcelSelectCellRange

Selects a range in a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference	True	string	The cell or cell range reference, for example: A1 or B2:C5.
Entire row	EntireRow		boolean	Should the entire row that contains the reference cell(s) be selected?
Entire column	EntireColumn		boolean	Should the entire column that contains the reference cell(s) be selected?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Select range in MS Word document

Operation ID:

MSWordSelectRange

Selects a character range in a named document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Start	Start	True	integer	The starting character position, starting at 1.
Finish	Finish	True	integer	The ending character position, starting at 1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Select table cell in MS Word document

Operation ID:

MSWordSelectTableCell

Selects a cell in a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Table index	TableIndex	True	integer	The table number, starting at 1.
Row index	RowIndex	True	integer	The row number, starting at 1.
Column index	ColumnIndex	True	integer	The column number, starting at 1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Select table in MS Word document

Operation ID:

MSWordSelectTable

Selects a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Table index	TableIndex	True	integer	The table number, starting at 1.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Send email in MS Outlook

Operation ID:

MSOutlookSendEmail

Sends a new email in Outlook.

Parameters

Name	Key	Required	Type	Description
Email to	To		string	The email address(es) of the primary recipient(s).
Email CC	CC		string	The email address(es) of any recipient(s) who should be included on CC.
Email BCC	BCC		string	The email address(es) of any recipient(s) who should be included on BCC.
Email subject	Subject		string	The email subject text to be used.
Email body format	BodyFormat		string	Provide a body type (HTML, Plain or RTF).
Email body	Body		string	The email body to be used if the email body format has been provided as 'Plain'.
Email HTML body	HTMLBody		string	The email HTML body to be used if the email body format has been provided as 'HTML'.
Email RTF body	RTFBody		string	The email RTF body to be used if the email body format has been provided as 'RTF'.
Attachment filenames JSON	AttachmentFilenamesJSON		string	A list of full filepaths to the files that should be attached to the email, in JSON format.
Dont send if attachment filename missing	DontSendIfAttachmentFilenameMissing		boolean	Should the email not be sent if one of the provided attachments cannot be found?
Click allow button if required	ClickAllowButtonIfRequired		boolean	Should IA-Connect attempt to click the 'Allow' button if prompted?
Voting options	VotingOptions		string	A semicolon separated list of voting options.
Send as SMTP address	SendAsSMTPAddress		string	The 'Send as' email address. This option can be used if the profile has permissions to send on behalf of another person or group.
Body contains stored password	BodyContainsStoredPassword		boolean	Set to true if the email body contains an IA-Connect stored password identifier, in the format {IAConnectPassword:StoredPasswordIdentifier}. This stored password could have been generated by the 'Generate password' action. For example: 'Welcome new starter, your new account password is {IAConnectPassword:GeneratedPassword}'.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set cell background colour in MS Excel worksheet

Operation ID:

MSExcelSetCellBackgroundColour

Sets the background colour of the specified cell or cells in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference	True	string	The cell or cells where you want to change the background colour, for example: A1.
Colour index	ColourIndex	True	integer	The MS Excel colour index number, for example: No fill = 0, Black = 1, White = 2, Red = 3, Green = 4, Blue = 5. For a full colour index see our KB article.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Name	Path	Type	Description
Command result	MSExcelSetCellBackgroundColourResult	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 cell value in active MS Excel worksheet

Operation ID:

MSExcelSetCellValue

Set the string value of a cell in the active workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference	True	string	The cell reference, for example: A1.
Cell value	CellValue	True	string	The new value to set the cell to.
Cell value is stored password	CellValueContainsStoredPassword		boolean	Set to true if the cell value contains an IA-Connect stored password identifier, in the format {IAConnectPassword:StoredPasswordIdentifier} or an IA-Connect Orchestrator generic credential, in the format {OrchestratorCredential:FriendlyName}. This stored password could have been generated by the 'Generate password' action, for example.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set MS Excel calculation mode

Operation ID:

MSExcelSetCalculationMode

Sets the calculation mode (0 = manual, 1 = automatic, 2 = semi automatic) in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Calculation mode	CalculationMode	True	integer	Provide a calculation mode (0 = Manual, 1 = Automatic, 2 = Semi automatic.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set MS Outlook Allow popup details

Operation ID:

MSOutlookSetAllowPopupDetails

Overrides the default Outlook 'Allow' popup element search details used by IA-Connect Agent to locate the 'Allow' button. Button names may change with the language settings, if so use this before calling 'Background monitor for Allow popup'.

Parameters

Name	Key	Required	Type	Description
Outlook allow button name	OutlookAllowButtonName		string	The element name of the 'Allow' button in the popup. By default, this is 'Allow'.
Outlook allow button automation Id	OutlookAllowButtonAutomationId		string	The automation ID of the 'Allow' button in the popup. By default, this is '4774'.
Outlook allow checkbox automation Id	OutlookAllowCheckboxAutomationId		string	The automation ID of the 'Do not ask me for X minutes' checkbox. By default, this is '4771'.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Set MS Word document table cell text value

Operation ID:

MSWordSetTableCellTextValue

Sets the text value of a cell in a table (specified by index) in a named document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Table index	TableIndex	True	integer	The table number, starting at 1.
Row index	RowIndex	True	integer	The row number, starting at 1.
Column index	ColumnIndex	True	integer	The column number, starting at 1.
New cell text	NewCellText		string	The text value that the specified table cell should be set to.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Show MS Excel

Operation ID:

MSExcelShowExcel

Makes an instance of Microsoft Excel visible (referenced by the handle). This would typically only be used during development because Excel doesn't need to be visible for automation, unless you are also using UIA to control Excel.

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Show MS Outlook

Operation ID:

MSOutlookShow

Shows the current Outlook instance that is being automated. This would typically only be used during development because Outlook doesn't need to be visible for automation, unless you are also using UIA to control Outlook.

Parameters

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

Returns

Show MS Word

Operation ID:

MSWordShowWord

Makes an instance of Microsoft Word visible (referenced by the handle). This would typically only be used during development because Word doesn't need to be visible for automation, unless you are also using UIA to control Word.

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Start background monitor for MS Outlook Allow popup

Operation ID:

MSOutlookBackgroundMonitorForAllowPopup

Creates a background thread that monitors the remote session for a specified number of seconds, searching for an 'Allow' popup, which can be triggered by a number of Outlook actions such as 'Send email'. Once the element is located, the action will then click the 'Allow' button to permit the triggering action to complete successfully.

Parameters

Name	Key	Required	Type	Description
Seconds to wait for dialog	SecondsToWaitForDialog		integer	The number of seconds to wait for the dialog to appear. By default, this is 10 seconds.
Seconds to wait for allow button	SecondsToWaitForAllowButton		integer	The number of seconds to wait for the allow button to appear. By default, this is 10 seconds.
Seconds to wait for allow button to be enabled	SecondsToWaitForAllowButtonToBeEnabled		integer	The number of seconds to wait for the allow button to be enabled. By default, this is 10 seconds.
Outlook allow button name	OutlookAllowButtonName		string	The UIA element name of the 'Allow' button. This is only required if the button element is not named 'Allow'.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Trust MS Excel VB object model in registry

Operation ID:

MSExcelTrustVBOMInRegistry

Sets the registry value for Excel to trust VB object model (needed to create macros). Excel must not be running and only works if not overridden by GPO. This is the same as enabling the 'Trust access to the VBA project object model' option in the 'Developer Macro Settings' section of Trust Center.

Parameters

Name	Key	Required	Type	Description
Excel version	ExcelVersion		integer	The Excel version, e.g. 9 for Excel 2000 or 16 for Excel 2016.
Trust VBOM	TrustVBOM		boolean	Should the VBOM be trusted?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Type text in MS Word document

Operation ID:

MSWordTypeText

Types the specified text into a document from the currently selected point in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Text to type	Text	True	string	The text content to type into the Word document.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Update MS Word bookmark

Operation ID:

MSWordUpdateBookmark

Updates a bookmark in a named document in an instance of Microsoft Word (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Word handle	Handle		integer	The handle of the instance of Word (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Word.
Document name	DocumentName		string	The name of the open Word document (used to distinguish between documents) or blank for the currently active document.
Bookmark name	BookmarkName	True	string	The name of the bookmark to be updated in the Word document.
New value	NewValue		string	The value that the bookmark should be updated to.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Write collection to MS Excel worksheet

Operation ID:

MSExcelWriteCollection

Writes a collection (array) into a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference	True	string	The cell reference, for example: A1.
Collection	CollectionToWriteJSON	True	string	The collection (array) to write, in JSON format.
Include Column Names	IncludeColumnNames		boolean	Should the column names also be written?
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns

Write collection to MS Excel worksheet with dates

Operation ID:

MSExcelWriteCollectionWithDates

Writes a collection (array) with date fields into a named worksheet in a workbook in an instance of Microsoft Excel (referenced by the handle).

Parameters

Name	Key	Required	Type	Description
Excel handle	Handle		integer	The handle of the instance of Excel (as provided by 'Create instance' or 'Attach to existing instance') or 0 for the currently active instance of Excel.
Workbook name	WorkbookName		string	The name of the open Excel workbook (used to distinguish between workbooks) or blank for the currently active workbook.
Worksheet name	WorksheetName		string	The name of the worksheet (tab) within the workbook or blank for the currently active worksheet.
Cell reference	CellReference	True	string	The cell reference, for example: A1.
Collection	CollectionToWriteJSON	True	string	The collection (array) to write, in JSON format.
Include Column Names	IncludeColumnNames		boolean	Should the column names also be written?
Try to convert all fields to date	TryToConvertAllFieldsToDate		boolean	Should all fields be converted to dates if possible?
Columns to convert to date	ColumnsToConvertToDateJSON		string	The column headers of columns that should be converted to dates, in JSON format.
Workflow	Workflow	True	string	Add the following expression here: workflow()

Returns