OCRotaICalendarSNC- Global

The OCRotaICalendarSNC script include provides iCal formatted events for the a specific user's rotation.

Parent Topic:Server API reference

OCRotaICalendarSNC - cleanExpiredCache ()

Records in the cmn_rota_resp_cache table that have a From date prior to today.

OCRotaICalendarSNC - createCalendarEvents (String groupId, String rotaId, String userId, Object dateRangeObj)

Returns list of AJAXScheduleItems for the user's on-call.

OCRotaICalendarSNC - createCustomEvent (String groupName, Object scheduleItemSpan, String calendarLink)

Creates a VEVENT based on the scheduleItemSpan provided.

OCRotaICalendarSNC - createPlaceholderCalendar (GlideRecord rotaGR, Object dateRangeObj, String calendarLink)

Creates a formatted iCalendar if the user has no upcoming on-call.

OCRotaICalendarSNC - getCalendarEvents (String groupId , String rotaId, String userId , Object dateRangeObj, Boolean useCache)

Returns the formatted iCalendar for the user's rotation.

OCRotaICalendarSNC - getEventsFromTable (String groupId, String rotaId, String userId, Object dateRangeObj)

Returns the formatted iCalendar for the user's rotation if found in the cmn_rota_resp_cache table.

OCRotaICalendarSNC - getIntersectRotaSpanItem (ScheduleTimeSpan timeSpan, Array rotaSpanItems)

Checks whether the provided timeSpan intersects with one of the rota span items.

OCRotaICalendarSNC - getMemberCalendarURL (String groupId, Object rotaId, String userId)

Creates the subscribable URL for the user's iCalendar.

OCRotaICalendarSNC - getOnCallCalendarURL (GlideRecord rotaGR)

Returns a URL to the on-call calendar based on the rota record.

OCRotaICalendarSNC - handleOverrideMember (AJAXScheduleItem scheduleItem)

Returns an array of the user's overrides (extra coverage).

OCRotaICalendarSNC - handleRotaMember (AjaxSchedueItem scheduleItem , Object rotaSpanItems, Object definitionItems, Array repeatRotaSpanIdArr)

Returns an object containing the user's override (extra coverage) and excluded spans.

OCRotaICalendarSNC - invalidateRotaRespCache (GlideRecord rotaRespCacheGR)

Used by business rules on the cmn_rota_member, cmn_schedule_span, and roster_schedule_span tables to update the cmn_rota_resp_cache table.

OCRotaICalendarSNC - matchRotaSpanRule(ScheduleTimeSpan timeSpan, Array rotaSpanItems, Array repeatRotaSpanIdArr, Object seriesStartTimes)

Checks whether the provided timeSpan matches one of the rotaSpanItems.

OCRotaICalendarSNC - populateCalendarSubscriptionSettings ()

Used by fixed job to populate the calendar subscription fields on the cmn_rota form

OCRotaICalendarSNC - processSeriesEvent (List scheduleItems, Array repeatRotaSpanIdArr , String userId)

Returns an object containing the user's rotations.

OCRotaICalendarSNC - saveCalendarEvents (String groupId, String rotaId, String userId, Object dateRangeObj, String result)

Inserts the user's iCalendar into the cmn_rota_resp_cache table.

OCRotaICalendarSNC - sendCalendarURL (GlideRecord rotaGR)

Queues events to send an email to all members of the rotation.

OCRotaICalendarSNC - updateExceptionList (AJAXScheduleItem scheduleItem, ScheduleTimeSpan timeSpan, Array rotaSpanItems)

Returns an object that contains all of the timeSpans that need to be excluded from the user's iCalendar.