Exchange - Create session

Declaration

<AMEXCHANGE EXCHANGEOBJECTTYPE="text (options)" RESULTVARIABLE="text (variable name)" EMAILADDRESS="text" SERVER="text" DOMAINNAME="text" USERNAME="text" PASSWORD="text (encrypted)"><Property Name="text" Value="text" /><Property Name="text" Value="text" /><Property Name="text" Value="text" /><Property Name="text" Value="text" /><Property Name="text" Value="text" /><Property Name="text" Value="text" /><Property Name="text" Value="text" /><Property Name="text" Value="mm@text" /><Property Name="text" Value="text" /></AMEXCHANGE>

Related Topics   

Description

Creates a unique session which can be used to associate subsequent Exchange steps. This provides a single task the ability to execute numerous Exchange related operations simultaneously.

Practical Usage

Ideally used to create a session to correlate subsequent Exchange activities to. Numerous sessions can be created for a single task.   

Parameters

Server

Property

Type

Required

Default

Markup

Description

Protocol

Text (options)

Yes if Connection set to Host

WEBDAV

  1. PROTOCOLTYPE="ews2007"

  2. PROTOCOLTYPE="webdav"

The Exchange server protocol to communicate with. 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.

Session

Text

Yes

ExchangeSession1

SESSION="ExchangeSess21"

The name Exchange session to create. Several activities can be linked to a single session, eliminating redundant data entry and making tasks more organized. Numerous sessions can exist in a single task and run parallel with one another, increasing overall efficiency. The default session name is 'ExchangeSession1'.

Email address

Text

Yes

(Empty)

EMAILADDRESS="test@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

(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

(Empty)

PASSWORD="encrypted"

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)

  1. DOMAINNAME="server.domain.com"

  2. DOMAINNAME="232.145.351.124"

The domain name (i.e. domain.exchangeServer.com) or IP address (i.e. 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

  1. AUTHTYPE="Basic"

  2. AUTHTYPE="Default"

  3. AUTHTYPE="Form"

The Exchange server authentication type. This parameter is available only if the 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

(Empty)

SERVER="server.domain.com"

The Exchange server to connect to.

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 Outlook 2007 or newer as well as some mobile phones by using a user's e-mail address and password to automatically configure 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 this activity should point to at runtime.

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.

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

Advanced

Property

Type

Required

Default

Markup

Description

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.

Impersonate

Yes/No

No

No

IMPERSONATE="YES"

If set to YES, Exchange Impersonation is enabled (set to NO by default). Impersonation enables a caller to impersonate a given account so that the operations can be performed with the rights of the impersonated account, instead of the rights 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).

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

  1. PROXYTYPE="none"

  2. PROXYTYPE="http"

Specifies the proxy type AutoMate should use when attempting any network communications through a proxy server. If you are unsure of the value to use in this parameter, contact your network administrator. 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 is HTTP.

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

 

Description

Error Causes

On Error

Example

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

Description

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" />