Feature Wiki

Information about planned and released features

Tabs

Detailed Appointment as Round-Trip Modal

Page Overview

[Hide]

This feature request is a part of the Calendar Revision.

1 Initial Problem

In ILIAS 5.2 there are two different detailed views to Appointments:

  1. A form-type view of all details of an appointment in the main column
  2. An overlay view of all details of an appointment layered over grid calendars (incl. Milestones)
The overlays do not present well on mobiles.

2 Conceptual Summary

The two differing views are replaced by one single unified view that works on mobiles: All detailed views of Appointments become Round-Trip-Modals.

The following table shows all appointment types (status ILIAS 5.2):

Object

Appointments automatically derived from Settings of Object

Manual creation of Appointments

Course

Creates “Start Date” and  “End Date” automatically.
Appointments are displayed in the Course Calendar and on the PD of Course Members

Private, Course Calendar or Public Calendar Appointments can be created manually

Group

Creates no Appointments automatically

Private, Course Calendar or Public Calendar Appointments can be created manually

Exercise Assignment

Creates “Deadline Appointments” and  “Feedback Deadline Appointments” automatically. Appointments are displayed on PD and any course / Group Calendar the exercise is enclosed in.

No option to manually create Appointments

Session

Creates “Start Date / End Date Appointment”  automatically. Appointments are displayed on PD and any course / Group Calendar the exercise is enclosed in.

No option to manually create Appointments

Booking Pool

Creates "Start Date / End Date Appointment" automatically after a personal booking of a booking appointment. There is one Calendar “Personal Bookings” comprising all reservations a user made. Reservations show up in the Calendar on the Personal Desktop but not in any Group or Course Calendar.

No option to manually create Appointments

Personal Calendar

Creates no Appointments automatically

Private or Public Calendar Appointments can be created manually

Public Calendar

Creates no Appointments automatically

Private or Public Calendar Appointments can be created manually

Milestones

Creates no Appointments automatically

Milestones can be created manually

The following table provides an overview of what is contained in the Detailed Appointment in a general fashion (irrespective of the specific object) .

Empty Fields are not supposed to be shown. 

Modal Headline: DD. Mon YYYY, HH:MM - HH:MM 

Toolbar [Download All Files] [Actions of Object] [Open Object]

DISPLAY HEADLINE: APPOINTMENT TITLE

Description

Description of Appointment, may be a bit morr text (do not show if not applicable)

[Object Type i.e Course]

Title of Object, followed by respective description after a comma

Origin

Linked title of appointment-generating object OR appointment-generating global OR public calendar

Object-Specific Information

Text and more text, some stuff (do not display if not applicable)

  1. Modal Headline will give point in time or time span
  2. Toolbar with Actions as Buttons:
    • Download All Files: All files which associated with this appointment are be downloaded as file or as a ZIP-file.
    • Action of Object: Important actions, depends on appointment type.
    • Open Object: Open object which generated this appointment in "Content" tab or edit the appointment.
  3. Display Headline will give Appointment title
  4. Description of Appointment is only displayed if  the Appointment have a description
  5. [Object Type] presents the type of object as identifier and the linked title  of the object as option label does this have to be linked or is [Open Object] good enough
  6. Origin  is shown if the appointment comes from a Calendar and thus not [Object Type] can be shown OR if the object is enclosed in an other container 

3 User Interface Modifications

3.1 List of Affected Views

  • After clicking an Appointment Title in the Marginal List Calendar in Course or Group
  • After clicking an Appointment Title in Main Column List View (Upcoming Events) on Personal Desktop
  • After clicking an Appointment Box in the Grid View in the Main Column

After finishing the Modal workflow the user is returned to the tab that person was before.

3.2 User Interface Details

3.2.1 Specific Automatically Derived Appointments

Data of automatically derived Course Appointment

Modal Headline: DD. Mon YYYY

Toolbar [Download All Files] [Open Course]

HEADLINE DISPLAY: START OF: TITLE OF COURSE

Description

Description of Appointment, may be a bit more text (do not show if not applicable)

Course

Title of Object, followed by respective description after a comma

HEADLINE OF DISPLAY: COURSE INFORMATION

Important Information

Text from Important Information from Settings > Course Information  (do not display if not applicable)

Syllabus

Text from Syllabus from Settings > Course Information  (do not display if not applicable)

File

Linked File from Settings > Course Information  (do not display if not applicable)

Tutorial Support

Linked Profile of Tutorial Support (do not display if not applicable)

Contact

Text from Contact of Setting > Course Information  (do not display if not applicable)

The Course have Start and End Dates that do not specify HH:MM. This should be kept as it is.
The Contact from Course Information should be swapped for Tutorial Support.

Data of automatically derived Group Appointment

Modal Headline: DD. Mon YYYY

Toolbar [Download All Files] [Open Group]

HEADLINE DISPLAY: START OF: TITLE OF GROUP

Description

Description of Appointment, may be a bit more text (do not show if not applicable)

Group

Title of Object, followed by respective description after a comma

HEADLINE OF DISPLAY: GROUP INFORMATION

Important Information

Text from Important Information from Settings > Group Information  (do not display if not applicable)

The Start and End Date for Groups is not implemented yet but was suggested for 5.3. This Mock-Up is only relevant if that feature is implemented.

  • There is not Tutorial Support or Contact Information for Groups.
  • Groups do not Support Custom Metadata.

Data of automatically derived Booking Pool Appointment

Modal Headline: DD. Mon YYYY, HH:MM - HH:MM

Toolbar [Download All Files] [Cancel Reservation] [Open Reservation]

HEADLINE DISPLAY: BOOKING OF: TITLE OF BOOKING OBJECT

Description

Description of Appointment, may be a mit mor text (do not show if not applicable)

Booking Pool

Title of Object, followed by respective description after a comma

Origin

Personal Bookings

HEADLINE OF DISPLAY: BOOKING INFORMATION

Additional Information

Files from Additional Description in Settings of Booking Object

Post Booking Information

Text of Post Booking Information
File of Post Booking Information in Settings of Booking Object

Actions:

  • "Download All Files" will download all files which are dedicated to this appointment.
  • “Cancel Reservation” will take user to Reservations-tab
  • “Open Reservation” will carry user to Booking Objects-tab

Data of automatically derived Session Appointment

Modal Headline: DD. Mon YYYY, HH:MM - HH:MM

Toolbar [Download All Files] [Attend Session] [Open Session]

HEADLINE DISPLAY: DD. Mon YYYY, HH:MM - HH:MM (instead of title of session) OR TITLE OF SESSION

Description

Description of Appointment, may be a mit mor text (do not show if not applicable)

Contained in

Title of enclosing Course or Group

HEADLINE OF DISPLAY: SESION INFORMATION

Location

Text about Location

Details / Workflow

Text about Session

Information about lecturer

Name, E-Mail, Phone

Files

Files assigned from Settings-Tab

Actions:

  • "Download All Files" will download all files which are dedicated to this appointment.
  • "Attend Session" or "Unregister Session" will take user to the Info-tab of session.
  • "Open Session" will take user to the Info-tab of Session.

There is no Tutorial Support for Sessions and thus no Profile to link to in the Appointment.
Sessions do not Support Custom Metadata.

Data of automatically derived Exercise-Assignment Appointment

Modal Headline: DD. Mon YYYY, HH:MM

Toolbar [Download All Files] [Hand In] [Create Team] [Open Assignment]

HEADLINE DISPLAY: TITLE OF ASSIGNMENT

Origin

Exercise Title

Contained in

Title of enclosing Course or Group

HEADLINE OF DISPLAY: ASSIGNMENT INFORMATION

Work Instruction

Rather long text with Work Instructions from Settings-Tabs of the Assignment Work Instructions specify the kind of task that should be solved

Instruction Files

Title of Files from Insruction Files-Tab

Pass Mode

Mandatory Assignment

Actions:

  • "Download All Files" will download all files which are dedicated to this appointment.
  • "Hand in" will take user to the view page of this assignment.
  • "Create Team" will take user to the view page of this assignment.
  • "Open Assignment" will take user to the view page of this assignment.

Exercise Assignment create three different kinds of appointments:

  1. Deadline for Submission
  2. Deadline for Peer Feedback
  3. Individual Deadline  

Data of automatically derived Consultation Hour Appointment

Modal Headline: DD. Mon YYYY, HH:MM

HEADLINE DISPLAY: TITLE OF CONSULTATION HOURS SEQUENCE

Consltation Hour Manager

Login of User entered in Settings-tab

Location 

Where is the Appointment taking place? 

Latest Registration  

x Day, 4 Hours (do not show if not applicable)

Repository Objects

Linked Container Titles

No Actions.

3.2.2 Manually created Appointments

Data of manually created Personal Appointment

Modal Headline: DD. Mon YYYY, HH:MM - HH:MM 

Toolbar [Edit Appointment] [Delete Appoinment]

DISPLAY HEADLINE: APPOINTMENT TITLE

Description

Description of Appointment, may be a bit more text (do not show if not applicable)

Origin

Linked Private Calendar

Owner

Linked Profile of Owner

HEADLINE OF DISPLAY:  APPOINTMENT INFORMATION

Location

Where is the Appointment taking place? (do not show if not applicalble) 

User Notification 

Name of User who receives mail about appoinment, next name (do not show if not applicalble)

Actions:

  • "Edit Appointment" will take users to the edit form of this appointment.
  • "Delete Appointment" will take user to the delete dialogue.

Data of manually created Public Appointment

Modal Headline: DD. Mon YYYY, HH:MM - HH:MM 

Toolbar [Edit Appointment] [Delete Appoinment]

DISPLAY HEADLINE: APPOINTMENT TITLE

Description

Description of Appointment, may be a bit more text (do not show if not applicable)

Origin

Linked Public Calendar

Owner

Linked Profile of Owner

HEADLINE OF DISPLAY:  APPOINTMENT INFORMATION

Location

Where is the Appointment taking place? (do not show if not applicalble)

User Notification 

Name of User who receives mail about appoinment, next name (do not show if not applicalble)

Actions:

  • "Edit Appointment" will take users to the edit form of this appointment. (only with edit-permission)
  • "Delete Appointment" will take user to the delete dialogue.

Data of manually created Milestone

Modal Headline: DD. Mon YYYY

Toolbar [Edit Milestone] [Delete Milestone]

DISPLAY HEADLINE: DEADLINE MILESTONE TITLE

Description

Description of Milestone, may be a bit more text (do not show if not applicable)

Origin

Linked Public Calendar

Owner

Linked Profile of Owner

HEADLINE OF DISPLAY:  APPOINTMENT INFORMATION

Task Completion 

x %

Actions:

  • "Edit Milestone" will take users to the edit form of this milestone. (only with edit-permission)
  • "Delete Milestone" will take user to the delete dialogue.

3.3 New User Interface Concepts

This is no new Interface Concept but it does make use of the Round-Trip-Modal

4 Technical Information

{The maintainer has to provide necessary technical information, e.g. dependencies on other ILIAS components, necessary modifications in general services/architecture, potential security or performance issues.}

5 Contact

6 Funding

If you are interest in funding this feature, please add your name and institution to this list.

  • ...

7 Discussion

Workshop 2016-11-28: 

Feedback on Course Appointment Mock-Up 

  • In general: Modal with information and actions is a acceptable change.
  • Remove "Join" Action from Course 
  • Modal has no title: Title should be the Date of Appointment.
  • Syllabus / Important Information  might be rather long texts: In this case a a "Show more" control should be 
  • How are the fields to mapped to i-cal, there is a field "location" and so forth. The mapping has to be made sure with all further plans. 
There is no Mock-Up for manually created Course-Appoinments
  • If the campus management does not automatically create Sessions out of appointments but merely creates Course / Group Appoinments. 
Several scenarios needs different informations first. A reasonable default should be defined to get a common denominator:
  • Which informations are more important for which appointment types?
Metadata
  • Are the displayed Metadata those of the Course or the Appointment? Not all Metadata are relevant, are all shown, how can this be handled without adding enormous complexity?
  • Global setting to set in each metadata categorie if it will be visible in calendar appointment view, f.e. setting "Show in Calendar Grid View". 

JourFixe, ILIAS [jourfixe]: Jan 09, 2017: Feature suggestion is highly appreciated and scheduled for 5.3.

AT: We figured that offering the object-specific actions in the detailed appointment view is not sensible: A vast number of classes and methods need to be instantiated to determine what action to offer i.e with assignments. 
Together with the University of Berne we have agreed to offer in the Toolbar: [Download Files] if applicable, [Open Object] and whatever Action pre-existed in 5.1 

8 Implementation

Test Cases

Test cases completed on 2017-08-25 by Tödt, Alexandra [atoedt]

  • 18733: Detailansicht eines Kursstarttermins
  • 18723: Detailansicht eines Gruppenstarttermins
  • 18734: Detailansicht eines Buchungstermins 
  • 18735: Detailansicht eines Übungsabgabetermins
  • 18736: Detailansicht eines Sprechstundentermins
  • 18738: Detailansicht eines Persönlichen Termins
  • 18739: Detailansicht eines öffentlichen Termins
  • 540: Details eines Meilensteins einsehen

Approval

Approved at 11. August 2017 by Amstutz, Timon [amstutz].

Last edited: 25. Aug 2017, 10:11, Tödt, Alexandra [atoedt]