Exchange Online Service Type

The Exchange Online service type allows you to work with an Exchange server using SmartObjects. This service type uses Exchange's REST-based API. The SmartObjects provide methods for the following Exchange items:

  • Appointment
  • Attachment
  • Attendee
  • Automatic Reply
  • Category
  • Email
  • Email Recipient
  • Folder
  • Lookup List
  • Room
  • Task
  • Time Zone
You must activate the Exchange Online feature to create an instance of this service type. See Exchange Online Feature Activation. The Exchange Online feature activation allows you to integrate with Microsoft Exchange Online or a Microsoft Exchange on-premises server.
See the following resources for more information:

Service Authentication

You can configure the following Authentication Modes for this service type:

  • With Nintex K2 Five:
    • OAuth - when connecting to a Microsoft Exchange Online environment
    • Impersonate - when connecting to a Microsoft Exchange on-premises environment
    • Static - when connecting to a Microsoft Exchange on-premises environment

Service Keys (Service Instance Configuration Settings)

Key Can be modified Data Type Sample Value Notes
EwsUrl Yes (required) Text http://dlx.denallix.com/EWS/Exchange.asmx The URL of the Exchange Web Services.
PageSize Yes (required) Text 100 The page size is the number of results returned from the Exchange server. Given the sample value of 100, if you have 150 emails and execute the List method on the Email SmartObject you will get 100 returned in the list.
On Behalf of Email No Text CommonMailbox@denallix.com To add an Email Address that is used in workflows by the K2 Server account go to the Exchange Online Feature activation page and add or update the Email Address field.

Service Objects

When you create an instance of the Exchange Online feature, the service instance gets created in the Exchange Online folder with the name you give it. You can find the Exchange SmartObjects in this category.

SmartObjects

The following SmartObjects are created when you create a new instance of the Exchange feature. You can use these SmartObjects in SmartForms and workflows.

Using the OAuth authentication mode and executing the Exchange Online SmartObjects from a workflow uses the K2 Service account and the mailbox defined in the Email Address field on the feature activation page. You must use the OnBehalfOf property to specify the account to use to create the appointment or task .

See Exchange SmartObject Reference for more information.

Considerations

Please keep in mind the following considerations:

  • Integration with Microsoft Exchange requires either Active Directory (AD) or Azure Active Directory (AAD).
  • The Exchange instance created by this feature is not linked to any K2 wizards. You can use the Exchange SmartObject methods of the service in workflows you design in the K2 Designer. All Exchange wizards use the Exchange Online service brokers configured at time of installation.
  • If you send invalid data to the Sensitivity property of the Task SmartObject list method, the method returns every entry in the SmartObject.

  • Any folder created to contain Task items cannot be renamed. In Outlook go to the Tasks tab. Expand My Tasks and then Tasks. These folders can’t be renamed using the Exchange REST API.
  • Always use the Exchange feature activation page to register new instances and edit existing service instances.
  • Your workflow will go into an error state if you reach any of the Microsoft Exchange limits, the error thrown by the Exchange Server will be displayed in the workflow's error message.
  • Using the OAuth authentication mode and executing the Exchange Online SmartObjects from a workflow uses the K2 Service account and the mailbox defined in the Email Address field on the feature activation page. You must use the OnBehalfOf property to create the appointment or task in the mailbox of the specified account.
  • When using OAuth, Impersonate, or Static authentication modes and executing the Exchange Online SmartObjects from a SmartForm, the form uses the logged on person's mailbox.