Latest revision as of 14:05, 12 February 2018

1 Overview

This document forms part of the bxp Release 10 Service Enhancement Release 1 suite of changes found here Bxp_Release_10_SER_1_prerelease_notes

1.1 Appointment Manager

1.1.1 Interface

bxp has two different interfaces for dealing with the Appointment Manager engine. Appointment_Management_-_Interface

• The first is a pure HTML backwards compliant engine.
• The second is the open source fullcaldendar.io engine https://fullcalendar.io/

FullCalendar.io has a more limited support base. https://fullcalendar.io/support/

The bxp engine is going to embrace further the fullcalendar.io engine but provide a selectable option to allow clients revert to the pure HTML version if their browsers are incompatible.

This option will be selectable on the Diary Add / Edit screens

The calendar version has been upgraded from the previous 2.3.1 to 3.4.0

• https://fullcalendar.io/blog/2016/09/feature-packed-releases/
• https://fullcalendar.io/blog/2017/03/fullcalendar-33-and-scheduler-16/

The scheduler engine is not included in the release but is under review.

1.1.2 Linking facility

A facility to add a form record, eCourse reference and a Meeting Manager reference will be included in the data structures.

The linking options will be enabled at a Diary Add / Edit level using the Features field. Appointment_Management_-_Features

1.1.3 Filtering

The interfaces will be provided with a filtering engine which will allow filtering by

• Person (pending attendee expansion)
• Category (pending attendee expansion)
• Date From
• Date To
• Subject keyword
• Body keyword
• Form link (pending attendee expansion)
• eCourse link (pending attendee expansion)
• Meeting Manager link (pending attendee expansion)

The filtering bar will be an option configured at the Diary Add / Edit level.

1.1.4 Appointment API

A dedicated API will be developed to facilitate add, edit, delete and listing of events.

Responses will be provide in XML and / or JSON depending on FullCalendar.io’s compatibility requirements.

API Fields:

• apptype - the type of calendar option i.e. listing, addorupdate, delete
• dteTime_Event_Start - event start date UTC format
• dteTime_Event_End - event end date UTC format
• period - the period to report on, start and end date will be ignored if used i.e. ThisWeek, ThisMonth etc.
• appid - the appointment diary id
• dataformat - the format to return the data i.e. XML, JSON
• appliedfilters - strDateFilterFrom (UTC format date), strDateFilterTo (UTC format date), strTime_Event_Name (event title), strTime_Event_Body (event body). More fields will be available soon.
• attendee - The name of the attendee to search for (still in beta)
• system - AppointmentManagement

1.1.5 Data listing method

The current approach for the diary system using FullCalendar.io is a listing for a 6 month historical and 6 month advance listing of events. Outside this window the data doesn’t list.

With the addition of the API, this will allow event data to be loaded in real time, making the window of reportable events universal.

1.1.6 “Drag to drop” facility

FullCalendar.io supports drag and drop editing. This will allow for the drag and drop of an appointment to a different day. Expansions to be made to allow for increase/decrease duration of the appointment.

1.1.7 “Email on edit” facility

This change will allow an email to be sent automatically those associated with the event. This facility will be based on Category.