2. Table of Contents
1 The Purpose of the Document .................................................................................1
1.1 The Business................................................................................................................ 1
1.2 Goal of the Project ....................................................................................................... 1
2 The Stakeholders ....................................................................................................... 2
2.1 Stakeholders................................................................................................................. 2
2.2 The Hands on users of the app.....................................................................................3
2.3 User Participation......................................................................................................... 4
3 Mandated Constraints .............................................................................................. 5
3.1 Solution Constraints..................................................................................................... 5
3.2 Schedule Constraints.................................................................................................... 5
4 Naming Conventions and Definitions.....................................................................6
4.1 Stakeholders................................................................................................................. 6
5 Relevant Facts and Assumptions.............................................................................7
5.1 Relevant Facts.............................................................................................................. 7
5.2 Business Rules ............................................................................................................. 7
5.3 Assumptions................................................................................................................. 7
6 The Scope of the Work ............................................................................................. 8
6.1 The Current situation................................................................................................... 8
6.2 The Context of the Work ............................................................................................. 8
6.3 Work Partitioning ........................................................................................................ 8
6.4 Business Use Cases...................................................................................................... 8
7 The Scope of the Product ......................................................................................... 9
7.1 Product Boundary........................................................................................................ 9
7.2 Product Use Case List................................................................................................10
7.3 Individual Product Use Case .....................................................................................11
7.3.1 Use-Case Specification for UC001: Interface to myCIT portal................................11
7.3.2 Use-Case Specification for UC002: Download student handbook ...........................11
7.3.3 Use-Case Specification for UC003: View student handbook ...................................12
7.3.4 Use-Case Specification for UC005: View Timetable................................................13
7.3.5 Use-Case Specification for UC006: View College Tour ..........................................13
7.3.6 Use-Case Specification for UC007: View Indoor Map.............................................14
7.3.7 Use-Case Specification for UC008: View Society Activities....................................14
7.3.8 Use-Case Specification for UC009: Add Content.....................................................15
7.3.9 Use-Case Specification for UC010: Update Content ................................................15
7.3.10 Use-Case Specification for UC011: Delete Content .................................................16
8 Functional and Data Requirements ......................................................................17
8.1 Functional Requirements...........................................................................................17
9 Non-Functional Requirements ..............................................................................19
9.1 Non-Functional Requirements...................................................................................19
10 Diagrams...................................................................................................................21
10.1 Class Diagram............................................................................................................21
4. 13.2 Main Screen ...............................................................................................................50
13.3 Student Services.........................................................................................................51
13.4 Student Services Web Page .......................................................................................52
13.5 Student Handbooks....................................................................................................53
13.6 Student Handbooks – Online.....................................................................................54
13.7 View Timetable..........................................................................................................55
13.8 View Timetable Day..................................................................................................56
13.9 College Tour ..............................................................................................................57
13.10 College Tour ..............................................................................................................58
13.11 Society........................................................................................................................59
13.12 Society Activity Details.............................................................................................60
13.13 Facebook....................................................................................................................61
13.14 Twitter........................................................................................................................62
14 Localization..............................................................................................................63
14.1 Polish Main................................................................................................................63
14.2 Polish Student Services..............................................................................................64
14.3 German Main.............................................................................................................65
5. Page 1
1 The Purpose of the Document
1.1 The Business
Cork Institute of Technology is a third year level academic institution, which has
approximately 12,000 students, 6000 full time and 6000 part time. Approximately 2000
news students join CIT each year as well as Erasmus student. Currently students rely on the
student handbook to provide information about the college such as services available,
building location and contact numbers. The Handbook is not fully utilized.
1.2 Goal of the Project
We want new students joining CIT to have better access to currently available information
and provide a more interactive interface to the myCIT portal. Students will also get a better
idea of the layout of the college using the use of the app.
6. Page 2
2 The Stakeholders
2.1 Stakeholders
S01 Cork Institute of Technology
• Have Knowledge
• Have knowledge about the requirements and specifications
• Will be our number one contact when gathering requirements
• Have influence on all parts of the system
S02 IT Department
• Will be using the system directly for maintenance and addition of new content
S04 Other CIT Departments
• Provide input and information about upcoming events and activities within the
college
S04: Students of Virtual CIT App
• Interact with parts of the system
• Are affected by system performance
• Can be involved in a survey on customer service and efficiency
S05: Our Group
• Are responsible for development of the Virtual CIT app
• Are required to gather information from other stakeholders
7. Page 3
2.2 The Hands on users of the app
S01: The current and potential students of CIT (Primary Users)
• Role: Retrieve information from the students portal
• Subject Matter Experience: Novice
• Technological Experience: Novice
• Linguistic skills: Foreign Erasmus students may have difficulty reading English –
app localised
• Will be the primary users of the system
S02: IT Department (App Administrators)
• Role: maintain, update and add additional content
• Subject Matter Experience: Journeyman to Master
• Technological Experience: Master
8. Page 4
2.3 User Participation
U01: The representatives of CIT
• Have a vast knowledge of their business
• Will be our primary Key User Contact and have the most influence on the product
specifications.
• User Requirements:
o We will conduct interviews with these users and base the development
around their personal and professional needs.
o They need to be open to changes and invest time in gathering the
requirements (approx. 20hrs total).
o They will be involved in testing and evaluating prototypes.
U02: The IT Department
• Will use the system frequently and have knowledge about the requirements.
• User Requirements:
o They will have very limited influence on the product specifications.
o They will be involved in testing and evaluating prototypes.
9. Page 5
3 Mandated Constraints
3.1 Solution Constraints
Constraint 01 (C01)
• Description:
o The system has to be designed for a mobile interface. This affects the layout
and design of the interactive components.
• Rationale:
o The user will use the app with expectation that it is developed for mobile
devices.
• Fit Criterion:
o We will do prototyping on different types of mobile devices.
3.2 Schedule Constraints
Constraint 03 (C03)
• Description:
o The product shall be available on the Google Play App Store by the end of
March 2015.
• Rationale:
o Our third year assignment requires us to have it delivered by the end of
March.
None of the other constraints applies to the Virtual CIT app.
10. Page 6
4 Naming Conventions and Definitions
4.1 Stakeholders
Term Description
Administrator A member of IT department who is apply to modify the applications
content
Indoor Maps Viewing interior map of building using Google Play services
Location Feature Provides GPS currently location and direction to chosen to chosen
location
Portal Feature of the myCIT website that will be available to students
Student A person currently attends or will attend CIT
Student Services A list of services available to students and information about each one
Social Media Twitter/Facebook embedded content
Society Group of college students who participate in an activity
Virtual Tour A map highlighting locations within the college.
11. Page 7
5 Relevant Facts and Assumptions
5.1 Relevant Facts
• The app will be free and available to all students
5.2 Business Rules
• No specific CIT business rules apply to the application.
5.3 Assumptions
• Assumption the user will have access to the internet.
• Website content in place and will be made available.
12. Page 8
6 The Scope of the Work
6.1 The Current situation
Currently new students use either the student handbook or the myCIT website to find out
about information related to students.
When a student views the myCIT website on their mobile device, they will view a desktop
webpage. This is not user friendly and actively discourages students who use mobile devices
to use the myCIT website.
6.2 The Context of the Work
Non Applicable
6.3 Work Partitioning
Non Applicable
6.4 Business Use Cases
Non Applicable
13. Page 9
7 The Scope of the Product
7.1 Product Boundary
Currently new students use either the student handbook or the myCIT website to find out
about information related to students.
When a student views the myCIT website on their mobile device, they will view a desktop
webpage. This is not user friendly and actively discourages students who use mobile devices
to use the myCIT website
14. Page 10
7.2 Product Use Case List
Use
Case
ID:
Use Case Name: Description:
UC001 Interface to myCIT portal Display selected myCIT websites features to the user.
UC002 Download student
handbooks
Launch a download of the selected handbook to the
user’s device.
UC003 View student handbook Display the handbook to the user in a web browser
UC004 View social media Display select social media news feeds to the user
UC005 View timetable User selects course and semester, timetable is displayed
UC006 View college tour Display map with building images to students
UC007 View indoor map Display 2D floor plan with users location
UC008 View society activities Display all the current days activities to the student
UC009 Add content Site administrator adds new content to the app
UC010 Update content Site administrator updates content on the app
UC011 Delete content Site administrator delete content no longer needed
15. Page 11
7.3 Individual Product Use Case
7.3.1 Use-Case Specification for UC001: Interface to myCIT portal
1. Brief Description
The use case describes how to access the myCIT portal on a mobile device.
2.1 Basic Flow of Events
The use case starts when a student clicks on an icon to launch the app.
1. The app presents the student with options from the myCIT portal to choose.
3. Alternative Flows
3.1 No internet connectivity will not display any content to the user.
3.2 Poor internet connectivity would result in content being displayed to the user longer than
expected.
4. Preconditions:
Have internet connectivity.
5. Post conditions:
5.1 Content is available to the user.
Extension Points
None.
Special Requirements
None.
7.3.2 Use-Case Specification for UC002: Download student handbook
1. Brief Description
The use case describes how to download student handbook.
2.1 Basic Flow of Events
The use case starts when a student clicks an option to view student handbooks.
The app presents the users with two options one of which is to download a pdf of the handbook.
The student clicks a button to initiate the download.
The app initiates a download of the student handbooks to the student’s device.
3. Alternative Flows
3.1 Not enough storage space.
The student will be informed there is not enough space on their device to download the content.
4. Preconditions
4.1 Space on their device
4. 2 Have internet connectivity.
They will have to create space before continuing downloading.
5. Post conditions
5.1 PDF of the handbook is downloaded to student’s device.
6. Extension Points
None.
7. Special Requirements
None
16. Page 12
7.3.3 Use-Case Specification for UC003: View student handbook
Brief Description
Display the handbook to the user in a web browser.
2.1 Basic Flow of Events
1. The app presents the users with two options one of which is to view a pdf of the
handbook.
2. The student clicks a button to view a handbook.
3. The browser displays the app to the student.
3. Alternative Flows
3.1 No internet connectivity will prevent the app from being viewed.
3.2 Poor internet connectivity may significantly reduce the speed of displaying the app to
the student.
4. Preconditions
4.1 Internet connectivity.
5. Post conditions
5.1 PDF viewer displays handbook to student.
Extension Points
None.
Special Requirements
None.
Use-Case Specification for UC004: View social media
1. Brief Description
The use case describes how students can access the college’s social media.
2.1 Basic Flow of Events
The use case starts when a student selects an option for social media.
1. The user is presented with a bar across the top of the screen displaying the college
social media options (Facebook and Twitter for CIT).
2. Twitter social media will be displayed by default.
3. A (yet to be determined) number of social media entries will be displayed to the
user
4. The student can switch between listed social media feeds.
3. Alternative Flows
3.1 No internet connectivity will prevent the app from being viewed.
3.2 Poor internet connectivity may significantly reduce the speed of displaying the app to
the
4. Preconditions
4.1 Internet connectivity.
5. Post conditions
5.1 Social media feed is displayed to the user
6. Extension Points
None.
7. Special Requirements
None.
17. Page 13
7.3.4 Use-Case Specification for UC005: View Timetable
1. Brief Description
The use case describes how students can access their timetable in a mobile friendly format.
2.1 Basic Flow of Events
The use case starts when a student selects an option for viewing their timetable.
1. The student is presented with an option to select their department.
2. The student then is presented an option to select their class group.
3. The student then selects and option for semester 1 or semester 2.
4. The student is then displayed their timetable in a mobile friendly format.
3. Alternative Flows
3.1 No internet connectivity will prevent the app from being viewed.
3.2 Poor internet connectivity may significantly reduce the speed of displaying the app to
the
4. Preconditions
4.1 Internet connectivity.
5. Post conditions
5.1 The student is then displayed their timetable in a mobile friendly format.
6. Extension Points
None.
7. Special Requirements
None.
7.3.5 Use-Case Specification for UC006: View College Tour
1. Brief Description
The use case describes how students can view the college campus with images .
The use case starts when a student selects an option to view a virtual tour of the college.
1. The app display an image of the college map along with image markers showing
specific building to the user.
2. Tap on a market to show building image associated with it.
3. Alternative Flows
3.1 No internet connectivity will prevent the app from being viewed.
3.2 Poor internet connectivity may significantly reduce the speed of displaying the app to
the
4. Preconditions
4.1 Internet connectivity.
5. Post conditions
5.1 The student will see images of the different parts of the college.
6. Extension Points
None.
7. Special Requirements
None.
18. Page 14
7.3.6 Use-Case Specification for UC007: View Indoor Map
1. Brief Description
The use case describes how students can view the floor plans of the college.
2.1 Basic Flow of Events
The use case starts when a student selects an option for viewing the indoor plan of the college.
1. . Indoor maps plan to be determined
3. Alternative Flows
3.1 Indoor maps plan to be determined 4. Preconditions
4.1 Indoor maps plan to be determined
5. Post conditions
5.1 Indoor maps plan to be determined 6. Extension Points
None.
7. Special Requirements
None.
7.3.7 Use-Case Specification for UC008: View Society Activities
1. Brief Description
The use case describes how students can view the society activities for the current day.
The use case starts when a student selects an option to view society activities.
1. The app displays a timetable to the student for that particular day for activities
happening each hour and the location they will happen.
3. Alternative Flows
3.1 No society activities for that particular day for example on Sundays.
4. Preconditions
4.1 None.
5. Post conditions
5.1 The student will be displayed the society activities for that particular day.
6. Extension Points
None.
7. Special Requirements
None.
19. Page 15
7.3.8 Use-Case Specification for UC009: Add Content
1. Brief Description
The use case describes how administrators can add content to the app.
2.1 Basic Flow of Events
The use case starts when an administrator adds content to the application sources code.
1. The administrator adds a news list feature and related content.
2. When the student accesses the application, it will update the application.
3. The newly added feature will be available to the student.
3. Alternative Flows
3.1 The administrator adds new content to the webserver.
4. Preconditions
4.1 The administrator has access to the source code.
5. Post conditions
5.1 Student will see newly added content
6. Extension Points
None.
7. Special Requirements
None.
7.3.9 Use-Case Specification for UC010: Update Content
1. Brief Description
The use case describes how administrators can update content on the app.
2.1 Basic Flow of Events
The use case starts when an administrator update a feature in application sources code.
1. The administrator updates and related content.
2. When the student accesses the application, it will update the application.
3. The newly added feature will be available to the student.
3. Alternative Flows
3.1 The administrator updates current content on the webserver.
3.2 The student will see the newly added content when using the app.
4. Preconditions
4.1 The administrator has access to the source code.
5. Post conditions
5.1 Students will see newly updated content
6. Extension Points
None.
7. Special Requirements
None.
20. Page 16
7.3.10 Use-Case Specification for UC011: Delete Content
1. Brief Description
The use case describes how administrators can delete app content.
2.1 Basic Flow of Events
The use case starts when an administrator deletes content from the application sources code.
1. The administrator deletes a feature on the application.
2. When the student accesses the application, it will update.
3. The newly deleted feature will be no longer be available to the student.
3. Alternative Flows
3.1 The administrator deletes current content from the web server.
3.2 The student will see the newly added content when using the app.
4. Preconditions
4.1 The administrator has access to the source code.
5. Post conditions
5.1 Student will not see the previously available content
6. Extension Points
None.
7. Special Requirements
None.
21. Page 17
8 Functional and Data Requirements
8.1 Functional Requirements
Requirement
No.
Reqt Type Description Rationale Fit Criterion Related
UCs
R001 Functional The system shall
provide an
interface to
selected features of
the myCIT portal.
Provide a
more user
friendly
interface for
mobile users
of the myCIT
website.
The user will
be presented
with selected
features from
the myCIT
portal.
UC001
R002 Functional The system shall
be able to
download student
handbooks.
Students may
wish to
download their
own copy of
the handbooks.
The user will
receive a
downloaded
PDF of the
handbooks.
UC002
R003 Functional The system shall
allow students to
view the
handbooks online
Students may
not wish to
download the
app to their
devices but
view it within
the app.
The user will
be presented
with the
handbook in
the web
browser.
UC003
R004 Functional The system shall
allow students to
view the colleges’
social media.
Provide
students with
different
means to
access college
news and
information.
The user will
be presented
the latest news
feeds from their
social media.
UC004
R005 Functional The system shall
allow students to
view their
timetable in a
mobile friendly
format.
Make viewing
timetables
easier.
The student
will be
presented the
timetable in a
mobile friendly
format.
UC005
R006 Functional The system shall
allow students to
view a college
tour..
Allow students
view external
areas of CIT.
Users will be h UC006
R007 Functional The system shall
allow display a 2D
floor plan of CIT
Helps students
locate lecture
rooms and
2D map will be
presented to the
student
UC007
22. Page 18
buildings. labs. marking his
GPS location
and guides
them to
destination.
R008 Functional The system shall
allow students to
view society
activities for the
current day.
Daily society
activities time
and location
will be
displayed.
Students will
have daily
society
activities
available to
them.
UC008
R009 Functional The system shall
allow an
administrator to
add a new feature.
New features
will be added
frequently.
Students will
be presented
with the newly
added feature.
UC009
R010 Functional The system shall
allow an
administrator to
update features.
New features
will be
updated
regularly.
Students will
be presented
with the newly
deleted feature.
UC010
R011 Functional The system shall
allow an
administrator to
delete features.
Some feature
will no longer
be relevant to
students at
different times.
Students will
no longer be
able to access
the removed
feature.
UC011
23. Page 19
9 Non-Functional Requirements
9.1 Non-Functional Requirements
Requirement
No.
Reqt Type Description Rationale Fit Criterion Related
UCs
R010 Localisation The app shall
list options to
students in
their own
language.
Make the
view more
appealing to
foreign
students.
When the app is
launched, it will
detect the
operating
system language
and display text
accordingly.
R011 Localisation /
Ease of use
The design
shall mainly
use lists to
display
options to the
user.
Some
languages
require more
space than
others do;
using lists
makes this
more flexible.
When the user
launches the app
they will be
display the
options via a
list.
R012 Scalability The design
shall mainly
use lists to
display
options to the
user.
New items
can be added
easily to the
list and
removed.
Site
administrators
add and remove
items as needed.
R014 Connectivity Sufficient
network
bandwidth.
App relies on
sufficient
internet
connectivity
to be
functional.
N/A. UC001 –
UC008
R015 Storage Enough
device storage
space.
Some devices
might not
have enough
storage to
download the
handbooks.
Notify users of
size of file on
the download
link.
UC003
R016 Accessibility The system
shall use
easily
readable fonts
and styles.
The student
with impaired
eyesight
should be able
to easily use
the app.
A user with
slightly
impaired vision.
24. Page 20
R017 Understandability Use simple
easy to
understand
language.
Make
language easy
for foreign
non-native
speakers to
understand.
Students with
basic English
will be able to
understand the
options
available.
48. Page 44
12 Testing
12.1 Student Services Test
Test 1
Use Case 1
Purpose View Student Services web page
Run Number 1 Date 27/03/2015
Action Taken Expected Output Pass/Fail
Select Web
Page option
Display web page Pass
12.2 Download Student Handbook
Test 2
Use Case 2
Purpose Download student handbook to device
Run Number 1 Date 27/03/2015
Action Taken Expected Output Pass/Fail
Press down
button under
specific button
Student handbook(s) downloaded to
devices download folder
Pass
49. Page 45
12.3 Download Student Handbook
Test 3
Use Case 3
Purpose View student handbook online
Run Number 1 Date 27/03/2015
Action Taken Expected Output Pass/Fail
Select image
button to view
student
handbook
online
Web browser launched, displays pdf
online
Pass
12.4 View Social Media - Facebook
Test 3
Use Case 4
Purpose View Facebook Posts
Run Number 1 Date 27/03/2015
Action Taken Expected Output Pass/Fail
Select
Facebook
option
Downloaded Facebook posts displayed
to the user
Pass
50. Page 46
12.5 View Social Media - Twitter
Test 4
Use Case 4
Purpose View Twitter Feed
Run Number 1 Date 27/03/2015
Action Taken Expected Output Pass/Fail
Select Twitter
option
Downloaded Twitter feed displayed to
the user
Pass
12.6 View Timetable
Test 5
Use Case 5
Purpose View timetable data
Run Number 1 Date 27/03/2015
Action Taken Expected Output Pass/Fail
Select
timetable
option
Timetable days displayed to user Pass
51. Page 47
12.7 View College Tour
Test 6
Use Case 6
Purpose View college tour
Run Number 1 Date 27/03/2015
Action Taken Expected Output Pass/Fail
Select college
tour option
Display map of college with markets
showing images of the college
buildings
Pass
12.8 View Indoor Map
Test 7
Use Case 7
Purpose View map
Run Number 1 Date 27/03/2015
Action Taken Expected Output Pass/Fail
Select indoor
maps option
Google Indoor Map displayed on the
users advices
Pass
52. Page 48
12.9 View Indoor Map
Test 8
Use Case 8
Purpose View map
Run Number 1 Date 27/03/2015
Action Taken Expected Output Pass/Fail
Select indoor
maps option
Google Indoor Map displayed on the
users advices
Pass
