Exchange - Get object(s)

Exchange - Get Object(s)

Declaration

<AMEXCHANGE ACTIVITY="get" EXCHANGEOBJECTTYPE="text (options)" 
RESULTDATASET="text" ATTACHMENTDEST="text" 
SAVEMODE="text (options)" EMAILADDRESS="text" 
SERVER="text" DOMAINNAME="text" USERNAME="text" 
PASSWORD="text (encrypted)" />

Description: Retrieves information regarding one or more Exchange objects and places the results in a dataset.

Practical Usage

Can be used to gather Exchange object data to input in subsequent steps for further processing.

Connection Parameters

Property	Type	Required	Default	Markup	Description
Connection	---	---	---	---	Indicates where user credentials, server settings and other preferences required to establish a connection to the Exchange server should originate from. This is a design mode parameter used only during task construction and configuration, thus, comprises no markup. The available options are: Host (default) - Specifies that user credentials, server settings and advanced preferences are configured individually for this activity. This option is normally chosen if only a single activity is required to complete an operation. Session - Specifies that user credentials, server settings and advanced preferences are obtained from a pre-configured session created in an earlier step with the use of the Create session activity. This option is normally chosen if a combination of related activities are required to complete an operation. Linking several activities to a single session eliminates redundancy. Additionally, a single task supports construction and simultaneous execution of multiple sessions, improving efficiency.
Session	Text	Yes if Connection set to Session	ExchangeSession1	SESSION="ExchangeSess21"
Protocol	Text (options)	Yes if Connection set to Host	WEBDAV	PROTOCOLTYPE="ews2007" PROTOCOLTYPE="webdav"	The Exchange server protocol to communicate with. This parameter is active only if the Connection parameter is set to Host. Different parameters become available depending on the protocol selected. The available options are: WEBDAV (Exchange 2003, 2007) - Use older WEBDAV protocol EWS (Exchange 2007 & newer, Online) - Use newer EWS protocol or Exchange online.
Email address	Text	Yes if Connection set to Host	(Empty)	EMAILADDRESS="theMan@netauto.com"	A valid email address to authenticate Exchange connection. This parameter is active only if the Connection parameter is set to Host.
Username	Text	Yes if Connection set to Host	(Empty)	USERNAME="theUser"	A valid username used to authenticate Exchange connection. This value may or may not be identical to the value set in the Email address field. This parameter is active only if the Connection parameter is set to Host.
Password	Text	Yes if Connection set to Host	(Empty)	PASSWORD="encrypted text"	A valid password used to authenticate Exchange connection. This parameter is active only if the Connection parameter is set to Host.
Domain name (optional)	Text	No	(Empty)	DOMAINNAME="server.domain.com" DOMAINNAME="232.145.351.124"	The domain name (e.g., domain.exchangeServer.com) or IP address (e.g., xxx.xxx.xxx.xxx) used to connect to the Exchange server. This parameter is active only if the Connection parameter is set to Host.
Authentication type	Text (options)	No	Basic	AUTHTYPE="Basic" AUTHTYPE="Default" AUTHTYPE="Form"	The Exchange server authentication type. This parameter is available only if Protocol parameter is set to WEBDAV (Exchange 2003, 2007). The available options are: Basic - Processes basic authentication credentials presented in HTTP headers. Default - The default authentication type set via Options -> Default Settings -> Email will be used. Form - Forms-based authentication lets you use an HTML form to obtain credentials from users who are attempting to access the Exchange server. NOTE: If you are unsure of the value to use in this parameter, contact your network administrator.
HTTPS/HTTP	Yes/No	No	HTTPS	USEHTTP="yes"	Indicates whether to use HTTP (normal HTTP) or HTTPS (secure HTTP) as the Exchange server protocol type.
Exchange server	Text	Yes if Protocol set to EWS	(Empty)	SERVER="server.domain.com"	The Exchange server to perform this activity. Click Discover to auto-discover the server based on the email address and password entered. This parameter is available only if the Protocol parameter is set to EWS (Exchange 2007 & newer, Online).
Authenticate as current windows user	---	---	---	---	If enabled, authentication will be performed via the credentials of the current Windows user, thus, disabling the Username, Password and Domain name parameters (disabled by default). This parameter is available only if the Protocol parameter is set to EWS (Exchange 2007 & newer, Online). This is a visual parameter only used interactively during design-time, therefore, contains no parameters or markups.
Rediscover server at runtime	Yes/No	No	No	AUTODISCOVERURL="YES"	If set to YES, Autodiscover service will be automatically performed at runtime (set to NO by default). The Autodiscover service makes it easier to configure email clients by using a user's email address and password to automatically set a user's profile. Setting this parameter to YES automatically disables the Exchange server parameter. This parameter is available only if the Protocol parameter is set to EWS (Exchange 2007 & newer, Online).
Current folder	Text	Yes	Calendar	CURRENTFOLDER="Contact"	The Exchange folder in which to perform this activity.
Timeout (seconds)	Number	No	100	TIMEOUT="120"	The total amount of time in seconds that this activity should be allowed to execute before a time out error occurs. The default value is 100 seconds.
Impersonate	Yes/No	No	No	IMPERSONATE="YES"	If set to YES, Impersonation is enabled. Impersonation allows an account on an Exchange server to perform actions by using the permissions that are associated with another account, instead of the permissions that are associated with the caller's account. This parameter is set to NO by default and only available if the Protocol parameter is set to EWS (Exchange 2007 & newer, Online). NOTE: With Exchange Impersonation, one account is acting as another account. When an account is impersonated, the system logs the access as if the account that is specified in the header were acting on the system. The calling account must have the appropriate permissions to perform impersonation.
Ignore invalid server certificate	Yes/No	No	No	IGNOREINVALIDCERTIFICATE="YES"	If set to YES, invalid server certificates are ignored. In some cases the SSL certificate may be expired or invalid and an exception is thrown due to its validity status. You may avoid such SSL certificate errors by choosing to ignore invalid server certificates. This parameter is set to NO by default and only available if the Protocol parameter is set to EWS (Exchange 2007 & newer, Online).
Proxy type	Text (options)	No	System default	PROXYTYPE="none" PROXYTYPE="http"	Specifies the proxy type this activity should use when attempting network communications through a proxy server. The available options are: System default - The default proxy configuration set via Options -> Default Settings -> Proxy will be used. None - No proxy is required. HTTP - The proxy type to use is HTTP. NOTE: If you are unsure of the value to use in this parameter, contact your network administrator.
Proxy host	Text	No	(Empty)	PROXYSERVER="proxy.host.com"	The hostname (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server.
Proxy username	Text	No	(Empty)	PROXYUSERNAME="username"	The username that should be used to authenticate when connecting through the proxy server. This option is only valid if the Use authentication parameter is enabled.
Proxy password	Text	No	(Empty)	PROXYPASSWORD="encrypted"	The password that should be used to authenticate when connecting through the proxy server. This option is only valid if the Use authentication parameter is enabled.
Proxy port	Number	No	1028	PROXYPORT="3000"	The port that should be used to connect to the proxy server. Most proxy servers operate on port 1028 (the default) however the proxy server can be customized to operate on other ports.

Object Parameters

Property	Type	Required	Default	Markup	Description
Object type	Text (options)	Yes	Contact	EXCHANGEOBJECTTYPE="appointment" EXCHANGEOBJECTTYPE="contact" EXCHANGEOBJECTTYPE="email" EXCHANGEOBJECTTYPE="Task"	The type of Exchange object to retrieve information about. The available options are: Appointment - The object(s) in which to retrieve data will be of type appointment. Contact - The object(s) in which to retrieve data will be of type contact. Email - The object(s) in which to retrieve data will be of type email. Task - The object(s) in which to retrieve data will be of type task.
Create and populate dataset	Text	Yes	(Empty)	RESULTDATASET="theContacts"	The name of the dataset to create and populate with information regarding the Exchange object(s) to retrieve.
Filter type	---	---	---	---	The filtering method to use. Different parameters appear depending on which option is selected. This is a design time parameter, therefore, contains no markups. The available options are: Custom (default) - A custom filter will be configured. Click the Add button to display the Property Editor where specific Name, Operator and Value properties can be entered, forming a unique filter. Query - Filtering will be performed via the query specified.
Name	Text	Yes if Filter Type set to Custom	(Empty)	Name="Subject"	The property name to use as a filter. This parameter along with the Operator and Value parameters act as a filtering device to filter specific property/value combinations. For example, if the Exchange object type from which to retrieve information is Email and the custom filter is set to the following: Name=Subject Operator=Contains Value=Meeting this activity will retrieve only email messages with a subject field containing the value Meeting. This parameter is available only if the Filter type parameter is set to Custom. More on Property Name/Value Specifications can be found below under AdditionalNotes.
Operator	Text (options)	Yes if Filter Type set to Custom	(Empty)	Operator="Contains" Operator="Not_Contains" Operator="Equals" Operator="Less_Than" Operator="Greater_Than"	Allows insertion of built in operators that allow you to precisely filter data. Click the drop down arrow to display the list of available operators to select from. This parameter is available only if the Filter type parameter is set to Custom. Available operators are as follows: Contains - The property entered contains any word or phrase matching the data entered as the value. Not contains - The property entered does not contain any word or phrase matching text entered as the value. Equals - The property entered is equivalent to the value entered. Less than - The property entered is less than that of the value entered. Greater than - The property entered is greater than that of the value entered. Less than or equal to - The property is less than or equal to that of the value. Greater than or equal to - The property is greater than or equal to that of the value.
Value	Text	Yes if Filter Type set to Custom	(Empty)	Value="AutoMate"	The value corresponding to the property name specified in the Name field. Use this parameter along with the Name and Operator parameters to form a custom filter. This parameter is available only if the Filter type parameter is set to Custom. More on Property Name/Value Specifications can be found below under Additional Notes.
Query	Text	Yes if Filter Type set to Query	(Empty)	QUERY="theQuery"	The query to perform. This parameter is available only if the Filter type parameter is set to Query.
Re-occurrences	---	---	---	---	If enabled, defines a window of time that this activity will react to a recurring appointment (disabled by default). This parameter is available only if the Object Type parameter is set to Appointment.
Start date	Number	Yes if Re-occurrences parameter is enabled	Current Date/Time	STARTDATE="%DateSerial(2016,02,17) +TimeSerial(11,00,00)%"	The start date/time that this activity will react to the recurring appointment. Click Custom to select a pre-defined start date. Enable Expression to enter a date/time value in the format of a regular expression.
End date	Number	Yes if Re-occurrences parameter is enabled	Current Date/Time	ENDDATE="%DateSerial(2016,02,25) +TimeSerial(11,00,00)%"	The end date/time that this activity will react to the recurring appointment. Click Custom to select a pre-defined end date. Enable Expression to enter a date/time value in the format of a regular expression.
Save attachment(s) in folder	Text	No	(Empty)	ATTACHMENTDEST="C:\Temp\"	If enabled, specifies the folder in which to save any attachments. This parameter is disabled by default.
If filename already exists	Text	No	Do not save	SAVEMODE="overwrite"	Indicates what this activity should do if an attachment file with the same name already exists in the speci fied folder. This parameter is available only if the Save attachment(s) in folder parameter is enabled. The available options are: Do not save (Default) - The new attachment file will not be saved. Save with unique file name - The new attachment file will be saved with a unique name (unique character will append original name). Overwrite existing file - The new attachment file will overwrite the existing one.

Description

Error Causes

On Error

Property Name/Value Specifications

The available property names and dataset fields that are populated vary depending on the Exchange object type specified. The following tables supply available property names for each object type.

Appointments

If the Exchange object type parameter is set to Appointment, the following property names and/or dataset fields are populated. The bold items are the required properties needed to create a new appointment.

Property/Dataset	Type	Description
AllDayEvent	True/False	Specifies whether the appointment or meeting is scheduled for an entire day. Return values are True or False
AllowNewTimeProposals	True/False	Indicates whether a new meeting time can be proposed for a meeting by an attendee. Return values are True or False.
AppointmentType	Text (options)	Specifies the type of an appointment. The available options are: Single Occurrence Exception Recurring Master
Attachments	Text	Specifies the collection of attachments for this message. This property is read-only.
Body	Text	Indicates the text body.
BusyStatus	Text (options)	The busy status of this messaging user for this appointment. The available options are: Free - The messaging user has no conflicting commitments during the time span of this appointment. Tentative - The messaging user has at least one tentative commitment during the time span of this appointment. Busy - The messaging user has at least one confirmed commitment during the time span of this appointment. OOF (Out of Office) - The messaging user is to be considered out-of-office (OOF). No Data - Left Blank
Categorize	Text	The list of categories that are associated with this item.
EndTime	Date/Time	Contains the time an appointment ends. Either a Duration Property or an EndTime is required.
EndTimeZone	Text	The time zone related to the end time.
HasAttachments	True/False	Indicates whether the item has attachments. True if the item has attachments; otherwise, false.
Id (Dataset only)	Number	The ID of this item. Only populated in a dataset.
Importance	Text (options)	An Importance enumeration value indicating the importance of the item. The available options are: Low Normal High
Location	Text	The location of this appointment.
IsMeeting	True/False	Indicates whether the appointment is a meeting. True if the appointment is a meeting; otherwise, false.
OptionalAttendees	Text	A list of optional attendees for the meeting.
Reminder	Date/Time	The date and time when the reminder is due for this item.
RequestResponses	True/False	Whether a response is requested. True or False
RequiredAttendees	Text	A list of required attendees for the meeting.
Resources	Text	A list of resources for the meeting.
Sensitivity	Text (options)	The sensitivity of this item. The available options are: Normal Personal Private Confidential
StartTime	Date/Time	The start time of the appointment.
StartTimeZone	Text	The time zone related to the start time.
Subject	Text	The subject of this item.

Contacts

If the Exchange object type parameter is set to Contact, the following property names and/or dataset fields are populated. The bold items are the required properties needed to create a new contact.

Property /Dataset	Type	Description
AddressType	Text	The type of address.
Anniversary	Date	The contact's anniversary date.
AssistantName	Text	The name of the contact's assistant.
Birthday	Date	The birthday of the contact.
Body	Text	The body of this item.
BusinessFax	Number	The recipient's business fax number.
BusinessPhone	Number	The recipient's business phone number.
Categorize	Text	The list of categories that are associated with this item.
City	Text	The city where the contact resides.
Company	Text	The company for which the recipient works.
Country	Text	The country where the contact resides.
CountryOrRegion	Text	The country or region where the contact resides.
DateTimeCreated	Date/Time	The date/time when the contact was created.
Department	Text	The department in which the recipient works.
Email	Text	The recipient's e-mail address.
FileAs	Text	The name under which this contact is filed.
First	Text	The recipient's first name.
FullName	Text	The recipient's full name.
HasAttachments	True/False	Indicates whether the item has attachments. True if the item has attachments; otherwise, false.
HomePhone	Number	The recipient's home phone number.
Id	Text	The unique ID of this item.
ImAddress	Text	The list of instant messaging (IM) addresses for the contact.
JobTitle	Text	The job title of the contact.
Last	Text	The last name of the contact.
ManagerName	Text	The name of the contact's manager.
Middle	Text	The contact's middle initial.
MobilePhone	Number	The contact's cell phone number.
NickName	Text	The contact's nick name
Office	Text	The office location for the recipient.
Profession	Text	The contact's profession.
Spouse	Text	The name of the contact's spouse.
State	Text	The state where the contact resides.
Street	Text	The contact's street.
ZIPOrPostalCode	Number	The ZIP code or the postal code where the contact is located.

Tasks

If the Exchange object type parameter is set to Contact, the following property names and/or dataset fields are populated. The bold items are the required properties needed to create a new task.

Property/Dataset	Type	Description
ActualWork	Number	The actual work in hours.
Attachments	Text	Specifies the collection of attachments for this message. This property is read-only.
BillingInformation	Text	The billing information set for the item.
Body	Text	The body of this item.
Company	Text	The company name the task is referencing.
DateCompleted	Text	The completion date of the task
DueDate	Text	The due date of the task.
HasAttachments	True/False	Indicates whether the item has attachments. True if the item has attachments; otherwise, false.
Id	Text	The unique ID of this item.
Importance	Text (options)	An Importance enumeration value indicating the importance of the item. The available options are: Low Normal High
IsComplete	True/False	Indicates whether the task is complete. True if completed; otherwise, false.
Mileage	Number	The number of miles used to for the task.
Mode	Text	The modes of a Task.
Owner	Text	The owner of the task.
PercentComplete	Text	The completion percentage of the task.
Reminder	Text	Reminders entered for the task.
Sensitivity	Text (options)	The sensitivity of this item. The available options are: Normal Personal Private Confidential
StartDate	Date/Time	Start date of the task.
Status	Text	Defines the status of a task.
Subject	Text	The subject of the task.
To	Text	The primary recipients of the task.
TotalWork	Number	The total number of hours for the task.

E-mail Paramters

If the Exchange object type parameter is set to E-mail, the following property names and/or dataset fields are populated.

Property/Dataset	Type	Description
Attachments	Text	Specifies the collection of attachments for this message. This property is read-only.
Bcc	Text	The hidden recipients of the message.
Body	Text	The primary content of an e-mail message.
Cc	Text	The secondary recipients of the message.
DateReceived	Date	The date and time that the message was received.
From	Text	The author(s) of the message.
HasAttachments	True/False	Indicates whether the item has attachments. True if the item has attachments; otherwise, false.
HasBeenRead	True/False	Indicates whether the message has been read. True if the item has attachments; otherwise, false.
Headers	Text	Returns the panel that contains the form header.
ID (Dataset only)	Text	The unique ID of the message.
Importance	Text (options)	An Importance enumeration value indicating the importance of the item. The available options are: Low Normal High
MessageID	Text	The identifier string for the message. This is Read Only
ReplyTo	Text	Represents the recipients to whom the message is addressed.
RequestDeliveryReceipt	True/False	Indicates whether a delivery receipt is requested. True or False.
RequestReadReceipt	True/False	Indicates whether a read receipt is requested. True or False.
Sensitivity	Text (options)	Represents the sensitivity of the message. The available options are: Normal Personal Private Confidential
Subject	Text	The subject of the message.
To	Text	The primary recipients of the message.

Example

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)

Description: This sample task retrieves Exchange appointment objects and populates the a dataset named "test" with results. A loop is then performed. Within each iteration, a message box displays the Exchange address of the current object.

<AMEXCHANGE ACTIVITY="create_session" SESSION="NetAutoExchange" 
PROTOCOLTYPE="webdav" 
EMAILADDRESS="exchange@netauto.com" 
SERVER="indra.netauto.com" 
USERNAME="netauto.exchange" 
PASSWORD="AM4IaUpiBW8p0jdVSjFibrJx0ilJ97MCLAjaME" 
DOMAINNAME="netauto" CURRENTFOLDER="Calendar" />
<AMEXCHANGE ACTIVITY="get" SESSION="NetAutoExchange" 
RESULTDATASET="test" />
<AMLOOP ACTIVITY="dataset" DATASET="test">
<AMSHOWDIALOG>%test.Address%
</AMSHOWDIALOG>
</AMLOOP>
<AMEXCHANGE ACTIVITY="end_session" SESSION="NetAutoExchange" />

v10 | 202208121109

Copyright Help/Systems LLC and its group of companies.
All trademarks and registered trademarks are the property of their respective owners.