System Design Specification · Web viewSystem Design Specification for MyEd mobile solution (Timetabling) Version: 1.0 Page 9 of 17 Template Revised April 2013

System Design Specification

for

Mobile Information Solution with MyEd(Timetabling)

Project Code: WEB005

Version: 1.0

Date: 28/04/14

Template Revised April 2013

Template Revised April 2013

System Design Specification for MyEd mobile solution (Timetabling)Error:Reference source not found

Version: 1.0

Contents

1 DOCUMENT MANAGEMENT..................................................................31.1 Contributors................................................................................................31.2 Version Control............................................................................................3

2 OVERVIEW...............................................................................................4

3 DEVELOPMENT TOOLS AND STANDARDS.........................................53.1 Development Tools......................................................................................5

3.1.1 Maven archetype..........................................................................................53.1.2 Portlet development specification................................................................5

3.2 Development Standards..............................................................................5

4 SYSTEM PROCESSES............................................................................64.1 Portlet general settings and configuration...................................................64.2 Java project.................................................................................................6

4.2.1 Configuration file..........................................................................................64.2.2 Message file..................................................................................................64.2.3 Logging file....................................................................................................64.2.4 jQuery Mobile...............................................................................................6

5 USER INTERFACE...................................................................................85.1 Transactional Interface................................................................................85.2 MyEd Interface............................................................................................8

5.2.1 Day view (BRD 2.5.1 Requirement 1)............................................................85.2.2 Error handling...............................................................................................95.2.3 Map integration (BRD Section 2.5.1 Requirement 2)....................................95.2.4 Link to Scientia Timetable (BRD Section 2.5.1 Requirement 3)...................10

5.3 Reporting Interface....................................................................................11

6 APPLICATION SECURITY.....................................................................126.1 Authentication...........................................................................................126.2 Authorisation.............................................................................................126.3 Business Objects........................................................................................12

7 DATABASE DESIGN..............................................................................137.1 V_ACTIVITY................................................................................................137.2 V_ACTIVITY_LOCATION..............................................................................13

Page 1 of 17


Version: 1.0

7.3 V_ACTIVITY_STUDENTSET..........................................................................137.4 V_LOCATION..............................................................................................137.5 V_STUDENT_SET........................................................................................147.6 V_ACTIVITY_DATETIME_FLAT....................................................................14

8 APPLICATION INTERFACES................................................................15

9 DATA......................................................................................................169.1 Data Migration..........................................................................................169.2 Archiving Policy.........................................................................................16

10 IMPLEMENTATION............................................................................17

Page 2 of 17


Version: 1.0

1 Document ManagementWhen completing this document, please mark any section that is not required as ‘N/A’. A brief description of why the section is not required should also be included.

1.1 Contributors

Role Unit NameSystems Analyst Designer (Owner)

IS Applications Richard GoodRoss NicollNeil Hanlon

Business Analyst

IS Applications Maurice Franceschi

Project Manager IS Applications Maurice FranceschiProject Sponsor IS Applications Martin MorreyBusiness Area Manager

IS Applications Maurice Franceschi

Other document contributors

1.2 Version ControlPlease document all changes made to this document since initial distribution.

Date Version Author Section Amendment11/04/14 0.1 RN All Initial document28/04/14 1.0 RG All Add further detail, amendments

Page 3 of 17


Version: 1.0

2 OVERVIEW

The WEB005 project concentrates on delivery of MyEd to mobile devices.

This design specification details the business requirement detailed in Section 2.5 of the BRD, a portlet which will display a view of the logged in students personal timetable. This will be initially constrained to a view of the current day’s timetable, and extended into a week view if time permits. The other potential features to be added later are a link to the Scientia provided personalised timetable, and a deep link to the map location of the timetable event.

The university uses a timetabling solution provided by Scientia, which as a feature provides a read only database of timetabling information. This database will be used to retrieve the student personalised timetable for display in MyEd.

The portlet is to be delivered to both desktop and mobile devices, and as such should be display formatted appropriate to the device it is being viewed on.

Page 4 of 17


Version: 1.0

3 DEVELOPMENT TOOLS AND STANDARDS

3.1 Development Tools

Java SQL Server

3.1.1 Maven archetype

The portlet will use the following maven archetype to bootstrap the structure and dependencies:

Group: org.jasig.portlet.archetypeArtefact ID: jsr286-archetype

3.1.2 Portlet development specification

The Portlet is a JSR286 portlet, which is compatible with uPortal 4.x.

3.2 Development Standards

Tick the appropriate box to indicate the standards being followed for this application:

Standard √ indicates complianceDatabase DesignCold FusionJava √Uportal Development √Accessibility √Web Style Standards √Supported Web Browsers √

Page 5 of 17


Version: 1.0

4 SYSTEM PROCESSES

4.1 Portlet general settings and configuration

(For portlet deployment settings refer to the channel publishing template in Section 5.2)

4.2 Java project

The Java Portlet structure will be defined by the Maven JASIG Portlet Archetype.

The package root for the Archetype will be:

uk.ac.ed.uportal.portlets.mytimetable

The portlet should also incorporate the current Syllabus plus libraries of code (ideally as a pom dependency if time permits). These are held under:

uk.ac.ed.splus

4.2.1 Configuration file

The file for configuration (database connectivity mainly) will be held under:

src/main/resources/configuration.properties

4.2.2 Message file

The language message file will be held under:

src/main/resources/messages.properties

4.2.3 Logging file

Logging is via logback (http://logback.qos.ch), the configuration file is held under:

src/main/resources/logback.xml

4.2.4 jQuery Mobile

Page 6 of 17

http://logback.qos.ch/


Version: 1.0

It is not anticipated that the portlet will require a specific version of jQuery mobile, as such it will use the version provided via the uPortal framework.

Page 7 of 17


Version: 1.0

5 USER INTERFACE

5.1 Transactional Interface

Not applicable, the design is for a read-only portlet as described in the following section.

5.2 MyEd Interface

Unless stated otherwise, all functionality will be available to both the desktop and mobile views on the portlet.

5.2.1 Day view (BRD 2.5.1 Requirement 1)

Figure 1. Basic day view timetable

The default view is for the current day’s timetable. Entries are to be presented as a sequence of items, ordered chronologically. The top of the portlet should display the current date.

Page 8 of 17


Version: 1.0

For each item, title, time and course code will be displayed.

5.2.2 Error handling

There will be no explicit handling of errors in terms of feedback to the user. All errors will be handled by the standard portal error handling, and the errors logged in the portlet log file.

For example, if an error occurred connecting to the database, the user would receive the standard portlet error screen, an admin user would receive the connectivity error stack trace, and the log file would contain the full error stack trace.

5.2.3 Map integration (BRD Section 2.5.1 Requirement 2)

Figure 2. Timetable with map link

The Map link is an optional enhancement (Could) which will be done if time permits. Essentially each activity displayed should also show a map button (see figure above).

Clicking the map button would pass the building ID from the timetabling data to the Map portlet, which would display the pin related to the passed in ID (see the figure below). For example, if the link was to the main library, the following figure shows the display in the map portlet when the map button is pressed.

Page 9 of 17


Version: 1.0

Figure 3. Map link caption

5.2.4 Link to Scientia Timetable (BRD Section 2.5.1 Requirement 3)

This is a minor (Could) enhancement to be done if time permits. Essentially this will add a link to the portlet so that a user can open up the Scientia provided website containing a personalised timetable. The link will be added to the foot of the portlet, as per the image below.

Page 10 of 17


Version: 1.0

Figure 4. Open timetable link

5.3 Reporting Interface

Not applicable.

Page 11 of 17


Version: 1.0

6 APPLICATION SECURITYThis section relates to application rather than physical security which is covered in the Technical Architecture Document (TAD).

6.1 Authentication

Authentication is via EASE, and is configured by the uPortal framework.

6.2 Authorisation

Only students will be authorised to view the timetable, so this channel will be constrained to the Student PAGS group.

6.3 Business Objects

Not applicable

Page 12 of 17


Version: 1.0

7 DATABASE DESIGN

The Scientia Reporting Database (or RDB) contains a number of views which make querying activity information easy. On top of this, the University of Edinburgh has added generic interface views which any application querying data from the RDB should use. This should protect connected applications to some extent from changes when the Scientia software is upgraded.

For convenience, the required views are provided below.

7.1 V_ACTIVITYField name Data type Exampleactivity_id char(32) 00BAAA47ABC22B25D668282623985F90

name nvarchar(255) Film Revisions: Adaptation and Migration and the Moving Image

description nvarchar(255)

type_id char(32) 3AA6365B5329D5689704974C5B100840

week_pattern

nvarchar(65) 00000000000000000000000111110111111000000000000000000000000000000

module_id char(32) 1D090DC287FC50F50238298D0ED34A6D

template_id char(32) 63488FFE09514B8992274F239E669A55

planned_size int 50

last_changed datetime 2014-01-10 07:59:50.133

7.2 V_ACTIVITY_LOCATIONField name Data type Exampleactivity_id char(32) 004632E437100A9D3695211921E2A3F8

location_id char(32) 3AA6365B5329D5689704974C5B100ADC

last_changed

datetime2014-01-10 07:59:50.133

7.3 V_ACTIVITY_STUDENTSETField name Data type Exampleactivity_id char(32) 004632E437100A9D3695211921E2A3F8

student_set_id

char(32)18DA24E630F0F147C9D4590A0016D04B


7.4 V_LOCATIONField name Data type Examplelocation_id char(32) 3AA6365B5329D5689704974C5B100876

host_key nvarchar(255) 0109_00_G.15

name nvarchar(255) Lecture Theatre 4

Page 13 of 17


Version: 1.0

description nvarchar(255) Classroom Style: Tables & chairs

capacity int 44

zone_id char(32) 3AA6365B5329D5689704974C5B100C35

booking_link nvarchar(256) <a target="_blank" href="http://www.ed.ac.uk/schools-departments/registry/timetabling/bookable-rooms/bookable-rooms?rid=G.15&fid=00&bid=109&cw_xml=Room_info.cfm"><abbr title="Photo"><img src="Images/blue/camera.gif" border="0" /></abbr></a>

7.5 V_STUDENT_SETField name Data type Examplestudent_set_id

char(32)18DA24E630F0F147C9D4590A0016C220

uun nvarchar(255) s0801413

full_name nvarchar(255) WOODWARD Christopher (S0801413)

name nvarchar(255) Mr Christopher Peter Woodward

department_id

char(32)3AA6365B5329D5689704974C5B1007DA


7.6 V_ACTIVITY_DATETIME_FLATField name Data

typeExample

activity_id char(32) 004632E437100A9D3695211921E2A492

week_no int 29

day_number int 2

start_date_time datetime 2014-02-26 11:10:00.000

raw_start_date_time

datetime 2014-02-26 11:00:00.000

end_date_time datetime 2014-02-26 12:00:00.000

raw_end_date_time datetime 2014-02-26 12:00:00.000

occurrence bigint 6


Note that this view includes the variation data (i.e. once-off changes to activities which take place at a regular time & location)

Page 14 of 17


Version: 1.0

8 APPLICATION INTERFACES

The portlet uses the uun provided via the portal framework in order to query the particular logged in student’s timetable.

This portlet then queries the Scientia Reporting Database to access timetabling information. For details see Section 7.

Page 15 of 17


Version: 1.0

9 DATA

9.1 Data Migration

The Scientia Reporting Database only contains a single academic year. The portlet will have to be added to the list of software which requires rollover between academic years. This involves repointing the database connection to the new academic year reporting database.

It is therefore anticipated that the portlet will be encompassed under the annual timetabling rollover project/support activities, and therefore will need to be raised with the timetabling unit and Student portfolio programme manager.

9.2 Archiving Policy

Not applicable, any archival of timetabling data is handled by the Scientia system.

Page 16 of 17


Version: 1.0

10 IMPLEMENTATION

The portlet should be added to the uPortal portlet overlay so that it is automatically deployed with the uPortal build.

The portlet should also make use of the new departmental Maven server in order to avoid any manual dependency management at build time.

Page 17 of 17

Documents

System Design Specification · Web viewSystem Design Specification for MyEd mobile solution (Timetabling) Version: 1.0 Page 9 of 17 Template Revised April 2013