Activity variables

When you design a workflow, you specify variable names as input and outputs for activities. These variables are created and assigned values at run-time. The workflow name will be used as its Scope and it will be available only in that workflow/scope.

The following types of variables are created by activities at run-time and can not be created manually.

Types of variables

SecureString

Represents text that should be kept confidential such as passwords.

A variable of type SecureString can not be displayed using Show Message or Write Log.

Accessible properties

Property	Description
Length	Gets the number of characters

ExcelHandle

A structure that encompasses all the information that is needed to handle an excel file such as path of the file, format, version, open, and edit passwords.

Accessible properties

Property	Description
Filename	Gets the name of the excel file.
Extension	Gets the excel filename extension. .xls .xlsm .xlsx .xlsb

Bitmap

Bitmap is a structure that represents an image, for example, the output of Take Screenshot.

Accessible properties

Property	Description
Height float	Gets the height of the Bitmap in pixels.
Width float	Gets the width of the Bitmap in pixels.

Rectangle

Rectangle is a structure that contains four values x, y, width, height. A variable of this type is normally used to represent image clipping regions and used with activities that handles Bitmap.

Accessible properties

Property	Description
Height float	Gets the height of the Rectangle in pixels.
Width float	Gets the width of the Rectangle in pixels.

MimeMessage

A MimeMessage consists of header fields and, optionally, a body.

The body of the message can either be plain text or it can be a tree of MIME entities such as a text/plain MIME part and a collection of file attachments.

Property	Description
Attachments List	Gets the attachments.
Bcc String	Gets the list of addresses in the Bcc header.
BodyString	Gets the body of the message. The body of the message can either be plain text or it can be a tree of MIME entities such as a text/plain MIME part.
BodyParts	Gets the body parts of the message.
CcString	Gets the list of addresses in the Cc header.
Date DateTime	Gets or set the date of the message.
From	Gets the list of addresses in the From header.
Headers	Gets the list of headers.
HtmlBodyString	Gets the html body of the message if it exists.
InReplyToString	Gets the Message-Id that this message is replying to.
MessageIdString	Gets the message identifier.
PriorityString	Gets the value of the Priority header.
ReplyTo	Gets the list of addresses in the Reply-To header.
ResentBcc	Gets the list of addresses in the Resent-Bcc header.
ResentCc	Gets the list of addresses in the Resent-Cc header.
ResentDateDateTime	Gets the Resent-Date of the message.
ResentFrom	Gets the list of addresses in the Resent-From header.
ResentMessageId	Gets the Resent-Message-Id header.
ResentReplyTo	Gets the list of addresses in the Resent-Reply-To header.
ResentSender	Gets or set the address in the Resent-Sender header.
ResentTo	Gets the list of addresses in the Resent-To header.
SenderString	Gets the address in the Sender header.
SubjectString	Gets the subject of the message.
TextBody String	Gets the text body of the message if it exists.
To	Gets the list of addresses in the To header.
SenderName	Gets the name of the Sender.
SenderAddress	Gets the address of the Sender.
ReceiverDetails	Gets the list of ImapReceiver that contains the names and addresses of the receivers.

List

Represents a list of objects that can be accessed by index and used in Loop activities.

Accessible properties

Property	Description
Count int	Gets the number of elements contained in the List.

Array

Represents an array of objects that can be accessed by index and used in Loop activities.

Accessible properties

Property	Description
Length int	Gets the total number of elements in all the dimensions of the Array.

IEnumerable

Represents a list of objects that can be accessed by index and used in Loop activities.

Accessible properties

None

DataTable

Represents the data as table with rows and columns.

You can use index to access rows, columns and data.

Eg. table[0] or table.Rows[0] : First row of the table table[][0] or table.Columns[0] : First column of the table table[0][0] : Cell at first row and first column\

Accessible properties

Property	Description
Columns List	Gets the collection of columns that belong to this table.
Rows List	Gets the collection of rows that belong to this table.
TableName String	Gets the name of the DataTable.

IList

Alias of List.

Accessible properties

None

Color

Color is a structure that represents an ARGB (alpha, red, green, blue) color.

Accessible properties

None

WordHandle

A structure that encompasses all the information that is needed to handle a word file.

Accessible properties

None

IFtpSession

A variable of this type stores an opened FTP session.

Accessible properties

None

FtpObjectInfo

A variable of this type stores a list of items in the FTP server.

Accessible properties

Property	Description
FullName string	Gets the full name or full path of the file or folder item.
Name string	Gets the name of the file or folder item.
Size long	Gets the size of the file or folder item.
Created DateTime	Gets the created date time of the file or folder item.
Modified DateTime	Gets the modified date time of the file or folder item.
Type FtpObjectType	Gets the Type of the file or folder item
GroupPermissions FtpPermissions	Gets the Group permission of the file or folder item.
OtherPermissions FtpPermissions	Gets the Other permission of the file or folder item.
OwnerPermissions FtpPermissions	Gets the Owner permission of the file or folder item

None

ISshSession

A variable of this type stores an opened SSH session.

Accessible properties

None

Process

Provides access to local and remote processes and enables you to start and stop local system processes.

Accessible properties

Property	Description
SessionIdint	Gets the Terminal Services session identifier for the associated process.

DataRow

Represent a row of data in a DataTable.

Accessible properties

None

DateTime

Represents an instant in time, typically expressed as a date and time of day.\

Accessible properties

Property	Description
Dayint	Gets the day of the month represented by this instance.
Monthint	Gets the month component of the date represented by this instance.
Yearint	Gets the year component of the date represented by this instance.
Hourint	Gets the hour component of the date represented by this instance.
Minuteint	Gets the minute component of the date represented by this instance.
Secondint	Gets the seconds component of the date represented by this instance.
Millisecondint	Gets the milliseconds component of the date represented by this instance.

DbHandle

A structure that encompasses all the information that is needed to handle a database.

Accessible properties

None

IWebDriver

An interface through which the user controls the browser.

Accessible properties

Property	Description
CurrentWindowHandler String	Gets the current window handle, which is an opaque handle to this window that uniquely identifies it within this driver instance.
PageSource String	Gets the source of the page last loaded by the browser.
Title String	Gets the title of the current browser window.
Url String	Gets or sets the URL the browser is currently displaying.
WindowHandles	Gets the window handles of open browser windows.

IWebElement

An interface through which the user controls elements on the page.

Accessible properties

Property	Description
Displayed	Gets a value indicating whether or not this element is displayed.
Enabled	Gets a value indicating whether or not this element is enabled.
Location	Gets a Point object containing the coordinates of the upper-left corner of this element relative to the upper-left corner of the page.
Selected	Gets a value indicating whether or not this element is selected.
Size	Gets a Size object containing the height and width of this element.
TagName	Gets the tag name of this element.
Text	Gets the innerText of this element, without any leading or trailing whitespace, and with other whitespace collapsed.

FileMetadata

A variable that stores the information about any type of file.

Accessible properties

Property	Description
SessionIdint	Gets the Terminal Services session identifier for the associated process.
Length long	Gets the size in bytes of the current file.
DirectoryName string	Gets a string representing the directory's full path.
CreationTime DateTime	Gets or sets the creation time of the current file or directory.
LastAccessTimeDateTime	Gets or sets the time the current file or directory was last accessed.
LastWriteTime DateTime	Gets or sets the time when the current file or directory was last written to.
Name string	Gets the name of the file.
IsReadOnly bool	Gets or sets a value that determines if the current file is read only.

MailMessage

Represents an email message that can be sent using the SmtpClient class.

Accessible properties

Property	Description
AlternateViews	Gets the attachment collection used to store alternate forms of the message body.
Attachments	Gets the attachment collection used to store data attached to this email message.
Bcc	Gets the address collection that contains the blind carbon copy (BCC) recipients for this email message.
Body	Gets or sets the message body.
BodyEncoding	Gets or sets the encoding used to encode the message body.
BodyTransferEncoding	Gets or sets the transfer encoding used to encode the message body.
CC	Gets the address collection that contains the carbon copy (CC) recipients for this email message.
DeliveryNotificationOptions	Gets or sets the delivery notifications for this email message.
From	Gets or sets the from address for this email message.
Headers	Gets the email headers that are transmitted with this email message.
HeadersEncoding	Gets or sets the encoding used for the user-defined custom headers for this email message.
IsBodyHtml	Gets or sets a value indicating whether the mail message body is in HTML.
Priority	Gets or sets the priority of this email message.
ReplyTo	Gets or sets the ReplyTo address for the mail message.
ReplyToList	Gets the list of addresses to reply to for the mail message.
Sender	Gets or sets the sender's address for this email message.
Subject	Gets or sets the subject line for this email message.
SubjectEncoding	Gets or sets the encoding used for the subject content for this email message.
To	Gets the address collection that contains the recipients of this email message.

Office365Message

A variable of this type stores the mail messages retrieved from the Outlook account.

Accessible properties

Property	Description
MessageId	Unique identifier for the message (note that this value may change if a message is moved or altered).
BodyPreview	The first 255 characters of the message body. It is in text format.
Flag	The flag value that indicates the status, start date, due date, or completion date for the message.
Importance	The importance of the message. The possible values are: low, normal, and high.
IsRead	Indicates whether the message has been read.
LastModifiedDateTime	The date and time the message was last changed.
ParentFolderId	The unique identifier for the message's parent mailFolder.
ReceivedDateTime	The date and time the message was received.
SentDateTime	The date and time the message was sent.
WebLink	The URL to open the message in Outlook on the web.
Categories	The categories associated with the message.
InternetMessageId	The message ID in the format specified by RFC2822.
OriginalMessage	Gets the original message.

GraphServiceClient

A variable of this type stores the Access Token received from the Microsoft Azure Account

Accessible properties

None

Event

Represents an event in a user calendar or the default calendar of a Microsoft 365 group.

Accessible properties

Property	Description
allowNewTimeProposals	True if the meeting organizer allows invitees to propose a new time when responding, false otherwise. Optional. Default is true.
attendees	The collection of attendees for the event.
body	The body of the message associated with the event. It can be in HTML or text format.
bodyPreview	The preview of the message associated with the event. It is in text format.
categories	The categories associated with the event.
changeKey	Identifies the version of the event object. Every time the event is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object.
createdDateTime	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
end	The date, time, and time zone that the event ends. By default, the end time is in UTC.
hasAttachments	Set to true if the event has attachments.
hideAttendees	When set to true, each attendee only sees themselves in the meeting request and meeting Tracking list. Default is false.
iCalUId	A unique identifier for an event across calendars. This ID is different for each occurrence in a recurring series. Read-only.
id	Read-only.
importance	The importance of the event. The possible values are: low, normal, high.
isAllDay	Set to true if the event lasts all day.
isCancelled	Set to true if the event has been canceled.
isDraft	Set to true if the user has updated the meeting in Outlook but has not sent the updates to attendees. Set to false if all changes have been sent, or if the event is an appointment without any attendees.
isOrganizer	Set to true if the calendar owner (specified by the owner property of the calendar) is the organizer of the event (specified by the organizer property of the event). This also applies if a delegate organized the event on behalf of the owner.
lastModifiedDateTime	The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z
location	The location of the event.
locations	The locations where the event is held or attended from. The location and locations properties always correspond with each other. If you update the location property, any prior locations in the locations collection would be removed and replaced by the new location value.
organizer	The organizer of the event.
responseRequested	Default is true, which represents the organizer would like an invitee to send a response to the event.
responseStatus	Indicates the type of response sent in response to an event message.
sensitivity	The possible values are: normal, personal, private, confidential.
showAs	The status to show. The possible values are: free, tentative, busy, oof, workingElsewhere, unknown.
start	The date, time, and time zone that the event starts. By default, the start time is in UTC.
subject	The text of the event's subject line.

Calendar

Represents a container for event resources. It can be a calendar for a user or the default calendar of a Microsoft 365 group.

Accessible properties

Property	Description
allowedOnlineMeetingProviders	Represent the online meeting service providers that can be used to create online meetings in this calendar. Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
canEdit	True if the user can write to the calendar, false otherwise. This property is true for the user who created the calendar. This property is also true for a user who has been shared a calendar and granted write access.
canShare	Gets a collection containing the values in the Dictionary.
canViewPrivateItems	True if the user can read calendar items that have been marked private, false otherwise.
color	Specifies the color theme to distinguish the calendar from other calendars in a UI. The property values are: auto, lightBlue, lightGreen, lightOrange, lightGray, lightYellow, lightTeal, lightPink, lightBrown, lightRed, maxColor.
defaultOnlineMeetingProvider	The default online meeting provider for meetings sent from this calendar. Possible values are: unknown, skypeForBusiness, skypeForConsumer, teamsForBusiness.
id	The calendar's unique identifier. Read-only.
isDefaultCalendar	True if this is the default calendar where new events are created by default, False otherwise.
isRemovable	Indicates whether this user calendar can be deleted from the user mailbox.
name	The calendar name.
owner	If set, this represents the user who created or added the calendar. For a calendar that the user created or added, the owner property is set to the user. For a calendar shared with the user, the owner property is set to the person who shared that calendar with the user.

MeetingTimeSuggestion

Represents a meeting suggestion that includes information like meeting time, attendance likelihood, individual availability, and available meeting locations.

Accessible properties

Property	Description
attendeeAvailability	An array that shows the availability status of each attendee for this meeting suggestion.
confidence	A percentage that represents the likelhood of all the attendees attending.
locations	An array that specifies the name and geographic location of each meeting location for this meeting suggestion.
meetingTimeSlot	A time period suggested for the meeting.
order	Order of meeting time suggestions sorted by their computed confidence value from high to low, then by chronology if there are suggestions with the same confidence.
organizerAvailability	Availability of the meeting organizer for this meeting suggestion. The possible values are: free, tentative, busy, oof, workingElsewhere, unknown.
suggestionReason	Reason for suggesting the meeting time.

DriveItem

Represents a driveItem resource represents a file, folder, or other item stored in a drive.

Accessible properties

Property	Description
audio	Audio metadata, if the item is an audio file. Read-only.
content	The content stream, if the item represents a file.
createdBy	Identity of the user, device, and application which created the item. Read-only.
createdDateTime	Date and time of item creation. Read-only.
deleted	Information about the deleted state of the item. Read-only.
description	Provides a user-visible description of the item. Read-write. Only on OneDrive Personal
file	File metadata, if the item is a file. Read-only.
fileSystemInfo	File system information on client. Read-write.
folder	Folder metadata, if the item is a folder. Read-only.
id	The unique identifier of the item within the Drive. Read-only.
image	Image metadata, if the item is an image. Read-only.
lastModifiedBy	Identity of the user, device, and application which last modified the item. Read-only.
lastModifiedDateTime	Date and time the item was last modified. Read-only.
location	Location metadata, if the item has location data. Read-only.
name	The name of the item (filename and extension). Read-write.
root	If this property is non-null, it indicates that the driveItem is the top-most driveItem in the drive.
searchResult	Search metadata, if the item is from a search result. Read-only.
webUrl	URL that displays the resource in the browser. Read-only.

Contact

Represents a contact in a Contacts folder.

Property	Description
Account	Returns or sets a String (string in C#) representing the account for the contact. Read/write.
AssistantName	Returns or sets a String (string in C#) representing the name of the person who is the assistant for the contact. Read/write.
AssistantTelephoneNumber	Returns or sets a String (string in C#) representing the telephone number of the person who is the assistant for the contact. Read/write.
Attachments	Returns an Attachments object that represents all the attachments for the specified item. Read-only.
BillingInformation	Returns or sets a String (string in C#) representing the billing information associated with the Outlook item. Read/write.
Birthday	Returns or sets a DateTime indicating the birthday for the contact. Read/write.
Body	Returns or sets a String (string in C#) representing the clear-text body of the Outlook item. Read/write.
Business2TelephoneNumber	Returns or sets a String (string in C#) representing the second business telephone number for the contact. Read/write.
BusinessAddress	Returns or sets a String (string in C#) representing the whole, unparsed business address for the contact. Read/write.
BusinessAddressCity	Returns or sets a String (string in C#) representing the city name portion of the business address for the contact. Read/write.
BusinessAddressCountry	Returns or sets a String (string in C#) representing the country/region code portion of the business address for the contact. Read/write.
BusinessAddressPostalCode	Returns or sets a String (string in C#) representing the postal code (zip code) portion of the business address for the contact. Read/write.
BusinessAddressPostOfficeBox	Returns or sets a String (string in C#) representing the post office box number portion of the business address for the contact. Read/write.
BusinessAddressState	Returns or sets a String (string in C#) representing the state code portion of the business address for the contact. Read/write.
BusinessAddressStreet	Returns or sets a String (string in C#) representing the street address portion of the business address for the contact. Read/write.
BusinessHomePage	Returns or sets a String (string in C#) representing the URL of the business Web page for the contact. Read/write.
BusinessTelephoneNumber	Returns or sets a String (string in C#) representing the first business telephone number for the contact. Read/write.
CallbackTelephoneNumber	Returns or sets a String (string in C#) representing the callback telephone number for the contact. Read/write.
Children	Returns or sets a String (string in C#) representing the names of the children of the contact. Read/write.
Companies	Returns or sets a String (string in C#) representing the names of the companies associated with the Outlook item. Read/write.
CompanyAndFullName	Returns a String (string in C#) representing the concatenated company name and full name for the contact. Read-only.
CompanyName	Returns or sets a String (string in C#) representing the company name for the contact. Read/write.
ComputerNetworkName	Returns or sets a String (string in C#) representing the name of the computer network for the contact. Read/write.
EmailAddress	Returns or sets a String (string in C#) representing the e-mail address of the first e-mail entry for the contact. Read/write.
FirstName	Returns or sets a String (string in C#) representing the first name for the contact. Read/write.
FullName	Returns or sets a String (string in C#) specifying the whole, unparsed full name for the contact. Read/write.
CustomerID	Returns or sets a String (string in C#) representing the customer ID for the contact. Read/write.
HomeAddress	Returns or sets a String (string in C#) representing the full, unparsed text of the home address for the contact. Read/write.
JobTitle	Returns or sets a String (string in C#) representing the job title for the contact. Read/write.
Language	Returns or sets a String (string in C#) that represents the language in which the contact writes messages. Read/write.
LastModificationTime	Returns a DateTime specifying the date and time that the Outlook item was last modified. Read-only.
LastName	Returns or sets a String (string in C#) representing the last name for the contact. Read/write.
OutlookVersion	Returns a String (string in C#) indicating the major and minor version number of the Outlook application for an Outlook item. Read-only.
Profession	Returns or sets a String (string in C#) indicating the profession for the contact. Read/write.
Subject	Returns or sets a String (string in C#) indicating the subject for the Outlook item. Read/write.

Dictionary

Represents a collection of keys and values.

Accessible properties

Property	Description
Count	Gets the number of key/value pairs contained in the Dictionary.
Keys	Gets a collection containing the keys in the Dictionary.
Values	Gets a collection containing the values in the Dictionary.

ProcessedDocument

Variable containing a document with preprocessing applied.

Accessible properties

Property	Description
FilePath	Path of the document.
Hocr	HOCR object created when OCR is applied on the document
OcrPath	Path of the HOCR file saved when OCR is applied.

ClassificationResult

Result of Document Classification.

Accessible properties

Property	Description
Label	String representing the predicted class.
Confidence	Confidence of the class prediction.

ExtractionResult

Result of Document Extraction. It stores the fields and their extracted result in a dictionary.

Data from an Extraction Result can be obtained in the following ways

• ExtractionResult["Total"]- The ExtractionResultItem for the field 'Total'

• ExtractionResult["InvoiceNo"].Value - Value of a field with key 'InvoiceNo'

• ExtractionResult["Date"].Confidence- Confidence of a field with key 'Date'

Accessible properties

Property	Description
Fields	A dictionary where FieldName is key and its ExtractedResultItem is value.
Metadata	Metadata of the extraction
FileInfo	Information about the input document
Keys	List of all field names
Values	List of all ExtractedResultItems

ExtractionResultItem

Result of Document Extraction on a field.

If the extractor was configured to extract tables, then the ExtractionResult includes ExtractionResultItem for each table. The Value, in that case, will be a LineItemsResult.

Accessible properties

Property	Description
Field	Name of the field
Value	Extracted Value
Text	Textual representation of the value
ValueType	Type of the value
Count	No of rows if the Value is a list or table
Label	String representing the field class
Confidence	Confidence of the extraction
PageNumber	The page number of the field

LineItemsResult

Represents an extracted table. LineItemsResult is a list of ExtractionResult objects where each ExtractionResult represents a row. Each cell is an ExtractionResultItem which is accessible using the cell name.

ExtractionResult["Table1"] returns the LineItemsResult for Table1. It can be used as input in For Each Activity. Then the item variable will be an ExtractionResult.

ExtractionResult["Table1"].Value[0]["Amount"].Value or

LineItemsResult[0]["Amount"] - The value of a cell belonging to the column Amount in the first row of the table named Table1 in the Extraction Result.

Accessible properties

Property	Description
Schema	A Dictionary which contains the Name of every column in the Table and the class label for each column
Count	No of rows in the table

Task

Represents a Human Task.

Data from the Task with a single dependency can be accessed in the following ways

• Task.Data - The Task Data

If the Task Category is DocumentDataExtraction then the Task Data is ExtractionResult. Hence following methods are possible

• Task.Data["InvoiceNumber"].Value - value of a field named 'InvoiceNumber' in the Task Data.

For Task with multiple dependencies, user should use either For Each activity or specify the index like Task.Dependencies[1].Data["InvoiceNumber"].Value which would give the value of the field named 'InvoiceNumber' from the second dependency in the Task.

Accessible properties

Property	Description
Id	Id of the Task.
Name	Name of the Task.
Status	Current Status of the Task.
Priority	Priority of the Task.
Category	Category of the Task.
TaskGroupName	Name of the TaskGroup
LastUpdated	DateTime of when the Task was last updated.
Created	DateTime of when the Task was created.
AssignedBy	List of assigned users of the Task.
Remarks	List of Remarks in the Task.
Dependencies	List of all the dependencies in the Task. Each item is a TaskDependency .
Dependency	The first item in the Dependencies. null if the list is empty.
Data	The Task Data. Same as Dependency.Data. Task Data is an ExtractionResult if the Task Category is DocumentDataExtraction.

TaskDependency

Represents the actual data in the Task.

Accessible properties

Property	Description
Type	The type of Task Dependency. Any of PdfFile, TextFile, Textand Form values
Id	Id of the Task Dependency.
Location	Location where the document associated with the Dependency is s
Data	The Task Data object. The Data is an ExtractionResult if the Task Category is DocumentDataExtraction.

MailMessage

A MailMessage represents an email message that can be sent using the SmtpClient class. Instances of the MailMessage class are used to construct email messages that are transmitted to an SMTP server for delivery using the SmtpClient class.

Accessible properties

Property	Description
AlternateViews	Gets the attachment collection used to store alternate forms of the message body.
Attachments	Gets the attachment collection used to store data attached to this email message.
Bcc	Gets the address collection that contains the blind carbon copy (BCC) recipients for this email message.
Body	Gets or sets the message body.
BodyEncoding	Gets or sets the encoding used to encode the message body.
CC	Gets the address collection that contains the carbon copy (CC) recipients for this email message.
DeliveryNotificationOptions	Gets or sets the delivery notifications for this email message.
From	Gets or sets the from address for this email message.
Headers	Gets the email headers that are transmitted with this email message.
IsBodyHtml	Gets or sets a value indicating whether the mail message body is in HTML.
Priority	Gets or sets the priority of this email message.
ReplyToList	Gets the list of addresses to reply to for the mail message.
Sender	Gets or sets the sender's address for this email message.
Subject	Gets or sets the subject line for this email message.
To	Gets the address collection that contains the recipients of this email message.