Exchange - Create object

Declaration

<AMEXCHANGE PROTOCOLTYPE="text (options)" EMAILADDRESS="text" 
AUTODISCOVERURL="YES/NO" IGNOREINVALIDCERTIFICATE="YES/NO" 
IMPERSONATE="YES/NO" AUTHTYPE="text (options)" 
TIMEOUT="number" PROXYTYPE="text (options)" 
EXCHANGEOBJECTTYPE="text (options)" RESULTVARIABLE="text"><PROPERTY 
NAME="Text" VALUE="text" /></AMEXCHANGE>

Description: Creates a new Microsoft Exchange object, such as an appointment, task or contact along with object properties.

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"	The name of an existing session to link this activity with. This parameter is active only if the Connection parameter is set to Session. The default session name is 'Exchangesession1'.
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, Exchange Impersonation is enabled. Impersonation enables 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	Appointment	EXCHANGEOBJECTTYPE="Appointment" EXCHANGEOBJECTTYPE="Task" EXCHANGEOBJECTTYPE="Contact"	The type of Exchange object to create. Specific properties may become available depending on the object type selected. The available options are: Appointment (default) - An appointment will be created. Task - A task will be created. Contact - A contact will be created.
Populate variable with object ID	Text	No	(Empty)	RESULTVARIABLE="theID"	The name of an existing variable to populate with the unique ID of the newly created object.
Object properties	---	---	---	---	The Object properties table is used to indicate property name(s) and associated value(s) to set for the newly created Exchange object. Click the Load required properties button to load all required property names for the Exchange object to be created and enter the desired value for each name. Properties vary depending on the type of object selected under the Object type parameter. For example, creating an Appointment object populates required properties such as StartTime, EndTime and Location, whereas, creating a Contact object populates required properties such as Organization, Street , City and Postal Code. To specify individual property name/value pairs, click the Add button. To edit a specific name/value pair, select it from the table and click the Edit button. To delete a specific name/value pair, select it from the table and click the Delete button. More on property name/value specifications can be found below under Additional Notes.
Name	Text	Yes	(Empty)	Name="Subject"	The property name associated to the Exchange object to create. More on property name/value specifications can be found below under Additional Notes.
Value	Text	Yes	(Empty)	Value="BPA"	The value corresponding to the property name. More on property name/value specifications can be found below under Additional Notes.

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

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 Parameters

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 Parameters

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 Parameters

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 Parameters

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

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Sample 1

Create Contact

<AMEXCHANGE EXCHANGEOBJECTTYPE="Contact" 
RESULTVARIABLE="theVar" 
EMAILADDRESS="test.exchange@netauto.com" 
SERVER="servername.netauto.com" 
DOMAINNAME="netauto" 
USERNAME="test.exchange" 
PASSWORD="AM1/M9fgpoQkU1a9P85M3OojA==aME">
<Property 
Name="First" Value="Peter" /><Property 
Name="Last" Value="Parker" /><Property 
Name="Company" Value="Network Automation" />
<Property Name="JobTitle" 
Value="Sales" /><Property Name="Email" Value="pp@netauto.com" />
<Property Name="BusinessPhone" Value="323-555-1234" />
<Property Name="Street" Value="1234 West St." />
<Property Name="City" Value="Los Angeles" />
<Property Name="ZIPOrPostalCode" Value="90005" />
<Property Name="CountryOrRegion" 
]Value="USA" /></AMEXCHANGE>

Sample 2

Meeting Request

<AMEXCHANGE EXCHANGEOBJECTTYPE="Appointment" 
RESULTVARIABLE="a" EMAILADDRESS="test.exchange@netauto.com" 
SERVER="indra.netauto.com" DOMAINNAME="netauto" 
USERNAME="test.exchange" PASSWORD="AM1/M9fgpoQkU1a9P85M3OojA==aME">
<Property Name="Subject" Value="BPA" />
<Property Name="StartTime" Value="12/8/2008 1:26:41 PM" />
<Property Name="EndTime" Value="12/9/2008 2:26:43 PM" />
<Property Name="Body" Value="All the new Features" />
<Property Name="Location" Value="Scott's Office" />
<Property Name="AllDayEvent" Value="true" />
<Property Name="Body" Value="Meeting" />
<Property Name="RequiredAttendees" 
Value="mm@netauto.com" /></AMEXCHANGE>

Sample 3

Create Task

<AMEXCHANGE EXCHANGEOBJECTTYPE="Task" RESULTVARIABLE="theVar" 
EMAILADDRESS="test.exchange@netauto.com" 
SERVER="indra.netauto.com" DOMAINNAME="netauto" 
USERNAME="test.exchange" 
PASSWORD="AM1/M9fgpoQkU1a9P85M3OojA==aME"><Property 
Name="Subject" Value="Complete Monthly Report" />
<Property Name="StartDate" Value="12/8/2008 
4:00:00 PM" /><Property Name="DueDate" Value="12/8/2008 
5:00:00 PM" /><Property Name="Body" Value="Complete 
Monthly Sales Report " /></AMEXCHANGE>

Sample 4

This sample task creates an Exchange session. Within the session, a few Create object steps are used to create a meeting and task. The task ends with an End session step.

<!-- Create Variables -->
<AMVARIABLE NAME="meetingObjectID" />
<AMVARIABLE NAME="taskObjectID" />
<!-- Create Exchange Session -->
<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" />
<!-- Create Meeting Request -->
<AMEXCHANGE SESSION="NetAutoExchange" RESULTVARIABLE="meetingObjectID"><PROPERTY NAME="Subject" 
VALUE="Phone System Demo" /><PROPERTY NAME="StartDate" 
VALUE="12/8/2008 3:26:41 PM" /><PROPERTY NAME="EndDate" 
VALUE="12/8/2008 4:26:43 PM" /><PROPERTY NAME="Body" 
VALUE="All the new Features" /><PROPERTY NAME="Location" 
VALUE="Batman's Office" /><PROPERTY NAME="MeetingStatus" 
VALUE="Meeting" /><PROPERTY NAME="To" 
VALUE="nl@netauto.com" /></AMEXCHANGE>
<!-- Create Task -->
<AMEXCHANGE SESSION="NetAutoExchange" 
EXCHANGEOBJECTTYPE="task" RESULTVARIABLE="taskObjectID"><PROPERTY 
NAME="Subject" VALUE="Kill all in BF2" /><PROPERTY 
NAME="CommonStart" VALUE="12/8/2008 4:00:00 PM" />
<PROPERTY NAME="CommonEnd" VALUE="12/8/2008 5:00:00 PM" /><PROPERTY NAME="Body" VALUE="With Knife" />
</AMEXCHANGE>
<!-- End Exchange Session -->
<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.