Skip to main content
Kinetic Community

Microsoft Exchange Appointment Create

Overview

This handler creates a new appointment in Microsoft Exchange.

Downloads

By downloading this file, you acknowledge that you agree to our Terms of Service

exchange_appointment_create_v1.zip

exchange_appointment_create_v2.zip

exchange_appointment_create_v3.zip

This handler requires that you are running at least Kinetic Task 2.0.

Detailed Description

This handler uses the Exchange Web Services (EWS) to create an appointment in Exchange using the Viewpoint Ruby Gem. After checking for various input errors, the handler passes the data to the Viewpoint Gem which formats the input to XML and communicates with the Exchange server.  If the exchange appointment is successfully updated, no out is returned.  Exceptions in input values will raise an exception.

The V3 handler, allows dates/times to be input in UTC or a specific time zone, with UTC being the default.  Time zones are entered by selecting one of the menu options, which look similar to this: "(UTC-05:00) Eastern Time (US & Canada)".  US-based time zones appear at the top of the list for convenience.  Be sure to choose the proper timezone based on daylight saving time as appropriate (i.e., "(UTC-07:00) Arizona" instead of "(UTC-07:00) Mountain Time (US & Canada)".    

Parameters

V3 Handler

Name Description
Subject The subject of the new appointment.
Location The location of the new appointment.
Body The body of the new appointment.
Start The start of the new appointment with the format 'YYYY-MM-DDTHH:mm:ss' in 24hr time (13:00 == 1:00PM)
End The end of the new appointment with the format 'YYYY-MM-DDTHH:mm:ss' in 24hr time (13:00 == 1:00PM)
Manually Enter Time Zone? Yes if you want to manually specify a time zone. No if you want to pass times in UTC.
Time Zone Name

**This parameter only appears if 'Manually Enter Time Zone?' is set to Yes.

**This is flagged as a required field so when it does appear the proper required field flag is shown. If the field is not used, the handler will look like it is incorrectly configured because a required field is not populated.

If using this field, choose a time zone from the menu that matches the dates/times that will be provided.

Required Attendees A comma separated list of email addresses that should be required to attend the appointment.
Optional Attendees A comma separated list of email addresses that can optionally attend the appointment.
Send Invitations How meeting requests are handled. Must be one of 'SendToNone','SendOnlyToAll','SendToAllAndSaveCopy'.  Default is 'SendToAllAndSaveCopy'

 

V2 Handler

Name Description
Subject The subject of the new appointment.
Location The location of the new appointment.
Body The body of the new appointment.
Start (UTC) The start of the new appointment in UTC time with the format 'YYYY-MM-DDTHH:mm:ss' in 24hr time (13:00 == 1:00PM)
End (UTC) The end of the new appointment in UTC time with the format 'YYYY-MM-DDTHH:mm:ss' in 24hr time (13:00 == 1:00PM)
Required Attendees A comma separated list of email addresses that should be required to attend the appointment.
Optional Attendees A comma separated list of email addresses that can optionally attend the appointment.
Send Invitations How meeting requests are handled. Must be one of 'SendToNone','SendOnlyToAll','SendToAllAndSaveCopy'.  Default is 'SendToAllAndSaveCopy'

 

Sample Configuration

v3 Handler

Parameter Example Configuration
Subject
Client Meeting
Location East Conference Room
Body We will be meeting with the client to discuss their latest project.
Start 2016-07-14T15:00:00
End 2016-07-14T16:30:00
Manually Enter Time Zone? No (Enter times in UTC)
Time Zone Name  
Required Attendees joe.user@acme.com,john.smith@acme.com
Optional Attendees test.user@acme.com
Send Invitations SendToAllAndSaveCopy

Results

Name Description
Appointment ID The Exchange GUID for the appointment (~150+ characters)  

Change Log

Version Date Description
1 2013-12-19

Initial Version

Hard code XML formatting to interact directly with EWS; requires user to manually identify the timezone in Olson format (e.g., "America/New_York"); includes complex date/time logic within the handler)

2 2016-07-26 Uses the Viewpoint Ruby Gem; only allows UTC dates/times as input
3 2016-07-26 Uses the Viewpoint Ruby Gem; allows time zone selection for date/time values