Skip to main content
Kinetic Community

Microsoft Exchange Appointment Create Recurring

Overview

This handler creates a recurring appointment in Microsoft Exchange.

Downloads

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

exchange_appointment_create_recurring_v1.zip

exchange_appointment_create_recurring_v2.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 a recurring 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 output is returned.

Many combinations of events can be created, as defined by the recurrent type field.  Based on the recurrence type, various other fields are required.  If the required parameters are not included for the recurrence type, an exception will be raised.  Options and a description are below:

  • RelativeYear = First Monday in January each year [Requires 'Days of Week', 'Day of Week Index', 'Month']
  • AbsoluteYear = January 4 each year [Requires 'Day of Month', 'Month']
  • RelativeMonth = Second Wednesday every 3rd month [Requires 'Days of Week', 'Day of Week Index', 'Interval']
  • AbsoluteMonth =  22nd of every 3rd month [Requires 'Day of Month', 'Interval']
  • Weekly = Tuesdays and Thursdays every other week [Requires 'Days of Week', 'Interval']
  • Daily = Every 7th day [Requires 'Interval']

Each parameter has its own requirements / allowable options.  The details are listed in each parameter below (and are also in the help-text / hover-text for each parameter within the handler).

Duration Type if also required, and determines if either the recurring end-date or number of occurrences parameters are required. 

The V2 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

V2 Handler

Name Description
Recurrence Type Defines the type of recurring event. Options are 'RelativeYear', 'AbsoluteYear', 'RelativeMonth', 'AbsoluteMonth', 'Weekly', 'Daily'. Each option requires specific inputs. Examples: 'RelativeYear' = First Monday in January each year [Requires 'Days of Week', 'Day of Week Index', 'Month']; 'AbsoluteYear' = January 4 each year [Requires 'Day of Month', 'Month']; 'RelativeMonth' = Second Wednesday every 3rd month [Requires 'Days of Week', 'Day of Week Index', 'Interval']; 'AbsoluteMonth' = 22nd of every 3rd month [Requires 'Day of Month', 'Interval']; 'Weekly' = Tuesdays and Thursdays every other week [Requires 'Days of Week', 'Interval']; 'Daily' = Every 7th day [Requires 'Interval']
Duration Type Defines the length of the recurrence. Options are 'No End Date', 'Has End Date', 'Number of Occurrences'.  If 'No End Date' or 'Number of Occurrences' is used, the end date is not required.
Days of Week Describes which day of the week is used in the relative recurrence pattern. Options are 'Sunday', 'Monday', 'Tuesday', 'Wednesday', Thursday', 'Friday', 'Saturday', 'Day', 'Weekday', 'Weekend Day'.  Required for 'RelativeYear', 'RelativeMonth', 'Weekly'.  When used with weekly, multiple values can be used separated by a space (example 'Tuesday Thursday'), and the 'Day', 'Weekday', and 'Weekend Day' options are not allowed.
Day of Week Index Describes which week is used in a relative recurrence pattern. Options are 'First', 'Second', 'Third', 'Fourth', 'Last'. Required for 'RelativeYear', 'RelativeMonth'.
Month Identifies the month in which a recurring item occurs. Options are 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'. Required for 'RelativeYear' and 'AbsoluteYear'.
Day of Month Identifies the day in a month on which a recurring item occurs. The range of values for this property is 1 to 31. If for a particular month this value is larger than the number of days in the month, the last day of the month is assumed. Required for 'AbsoluteYear' and 'AbsoluteMonth'.
Interval Defines the interval between two consecutive recurring events. The range of options is from 1 to 99 for 'RelativeMonth', 'AbsoluteMonth', and 'Weekly'.  The range of options is from 1 to 999 for 'Daily'.  Required for 'Relativemonth', 'AbsoluteMonth', 'Weekly', and 'Daily'.
Start Date of Recurrence (UTC) The start date of the recurrence in UTC with the format 'YYYY-MM-DD' or 'YYYY-MM-DD-HH:mm'.
End Date of Recurrence (UTC) The ending date of the recurrence in UTC with the format 'YYYY-MM-DD' or YYYY-MM-DD-HH:mm'. Required for Duration Type of 'HasEndDate'
Number of Occurrences Describes the number of occurrences of a recurring item.
Subject The subject of the appointment.
Location The location of the appointment.
Body The body of the appointment.
Start The start of the appointment with the format 'YYYY-MM-DDTHH:mm:ss' in 24hr time (13:00 == 1:00PM)
End The end of the 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'

 

V1 Handler

Name Description
Recurrence Type Defines the type of recurring event. Options are 'RelativeYear', 'AbsoluteYear', 'RelativeMonth', 'AbsoluteMonth', 'Weekly', 'Daily'. Each option requires specific inputs. Examples: 'RelativeYear' = First Monday in January each year [Requires 'Days of Week', 'Day of Week Index', 'Month']; 'AbsoluteYear' = January 4 each year [Requires 'Day of Month', 'Month']; 'RelativeMonth' = Second Wednesday every 3rd month [Requires 'Days of Week', 'Day of Week Index', 'Interval']; 'AbsoluteMonth' = 22nd of every 3rd month [Requires 'Day of Month', 'Interval']; 'Weekly' = Tuesdays and Thursdays every other week [Requires 'Days of Week', 'Interval']; 'Daily' = Every 7th day [Requires 'Interval']
Duration Type Defines the length of the recurrence. Options are 'No End Date', 'Has End Date', 'Number of Occurrences'.  If 'No End Date' or 'Number of Occurrences' is used, the end date is not required.
Days of Week Describes which day of the week is used in the relative recurrence pattern. Options are 'Sunday', 'Monday', 'Tuesday', 'Wednesday', Thursday', 'Friday', 'Saturday', 'Day', 'Weekday', 'Weekend Day'.  Required for 'RelativeYear', 'RelativeMonth', 'Weekly'.  When used with weekly, multiple values can be used separated by a space (example 'Tuesday Thursday'), and the 'Day', 'Weekday', and 'Weekend Day' options are not allowed.
Day of Week Index Describes which week is used in a relative recurrence pattern. Options are 'First', 'Second', 'Third', 'Fourth', 'Last'. Required for 'RelativeYear', 'RelativeMonth'.
Month Identifies the month in which a recurring item occurs. Options are 'January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'. Required for 'RelativeYear' and 'AbsoluteYear'.
Day of Month Identifies the day in a month on which a recurring item occurs. The range of values for this property is 1 to 31. If for a particular month this value is larger than the number of days in the month, the last day of the month is assumed. Required for 'AbsoluteYear' and 'AbsoluteMonth'.
Interval Defines the interval between two consecutive recurring events. The range of options is from 1 to 99 for 'RelativeMonth', 'AbsoluteMonth', and 'Weekly'.  The range of options is from 1 to 999 for 'Daily'.  Required for 'Relativemonth', 'AbsoluteMonth', 'Weekly', and 'Daily'.
Start Date of Recurrence (UTC) The start date of the recurrence in UTC with the format 'YYYY-MM-DD' or 'YYYY-MM-DD-HH:mm'.
End Date of Recurrence (UTC) The ending date of the recurrence in UTC with the format 'YYYY-MM-DD' or YYYY-MM-DD-HH:mm'. Required for Duration Type of 'HasEndDate'
Number of Occurrences Describes the number of occurrences of a recurring item.
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

v2 Handler

Parameter Example Configuration
Appointment ID AAMkADVjNDJY2rEhHPAAId5ubLAAA=   (Note:  The appointment ID has been shortened here for readability.)
Recurrence Type Weekly
Duration Type Number of Occurrences
Days of Week Friday
Day of Week Index  
Month  
Day of Month  
Interval 1
Start Date of Recurrence (UTC) 2016-08-22
End Date of Recurrence (UTC)  
Number of Occurrences 3
Subject
Client Meeting
Location East Conference Room
Body Meeting with clients
Start 2016-08-22T15:00:00
End 2016-08-22T16:00:00
Manually Enter Time Zone? No (Enter times in UTC)
Time Zone Name  
Required Attendees john.smith@acme.com,jane.smyth@acme.com
Optional Attendees  
Send Invitations SendToAllAndSaveCopy

Results

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

 

Change Log

Version Date Description
1 2016-07-26

Initial Version; only allows UTC dates/times as input

 

2 2016-07-26 Uses the Viewpoint Ruby Gem; allows time zone selection for date/time values