Software Requirements

Specification

ROCS – REFORMED OPEN COMMUNITY

SCHOOLS
Release: R1 – Draft

Prepared by: HybridLogics (Pvt.) Ltd.

12 December, 2017
S/W Technical Reference Manual

© 2017
No part of this document shall be manually or digitally copied without written consent of FFP
Pakistan. For further information, please contact HybridLogics (Pvt.) Ltd

II
S/W Technical Reference Manual

Revision History

Date Version Description Author

12-12-2017 1.0 First Draft BA/Team

III
S/W Technical Reference Manual

Table of Contents
Revision History ................................................................................................................................ III
1. Introduction ................................................................................................................................... 6
1.1 Intended Audience & Reading Suggestions.......................................................................... 6
1.2 Purpose................................................................................................................................... 6
1.3 Scope ...................................................................................................................................... 6
1.4 Definition, acronyms and abbreviations ............................................................................... 8
2. Overall Description ........................................................................................................................ 9
2.1 Product perspective ............................................................................................................... 9
2.2 User Characteristics ............................................................................................................... 9
2.3 Assumptions and dependencies .........................................................................................11
3. Specific requirements .................................................................................................................12
3.1 User interface.......................................................................................................................12
3.2 Hardware interface ..............................................................................................................12
3.3 Product requirements .........................................................................................................13
3.3.1 System requirements ...................................................................................................13
3.3.2 Functional requirements .............................................................................................13
3.3.2.1 User Management ................................................................................................13
3.3.2.2 Traffic ....................................................................................................................14
3.3.2.3 Notifications ..........................................................................................................14
3.3.2.4 Tablet Tracking .....................................................................................................14
3.3.2.5 Charts / Reports ....................................................................................................14
3.3.2.6 Monitoring & Accessibility ...................................................................................14
3.3.2.7 CRUD .....................................................................................................................15
3.3.2.8 System access .......................................................................................................15
3.3.3 Non-functional requirements ......................................................................................16
3.3.3.1 Size and performance...........................................................................................16
3.3.3.2 Quality ...................................................................................................................16
4. Process Overview ........................................................................................................................17
4.1 Processes Details .................................................................................................................17
4.1.1 Configuration ................................................................................................................17
4.1.2 Tablet Registration .......................................................................................................17

4
S/W Technical Reference Manual

4.1.3 User Registration ..........................................................................................................17

4.1.4 ROCS Dashboards .........................................................................................................17
4.2 User Management ...............................................................................................................18
4.2.1 Administrator ...............................................................................................................18
4.2.2 Coordinator ..................................................................................................................19
4.2.3 Traffic ............................................................................................................................20
4.2.4 Notifications .................................................................................................................21
4.2.5 Tablet ............................................................................................................................22
4.2.6 Reporting / Charts ........................................................................................................23
4.3 General Activity ....................................................................................................................25

5
S/W Technical Reference Manual

1. Introduction
ROCS, Reformed Open Community Schools works

1.1 Intended Audience & Reading Suggestions

This document is intended mainly for developers, development partners so that they can
easily get important information from the system features. This document can also benefit
program staff for understanding of features.

1.2 Purpose

This document describes the software requirements and specifications for ROCS software.
The document is intended for the administrator, client and the developer (designers,
testers, maintainers). This document is intended mainly for developers and development
partners TEKENIKO so that they can easily get important information from system features.

1.3 Scope

A “field monitoring” segment (ROCS), with data entered by Teachers, which will have four
parts:
I. Weekly Tests
II. School Visit Reports
III. Sample Test
IV. Pre-course self-assessment
V. Post-course self-assessment

The scope of this software is limited to the following features:

a) Register all Users with their NRC numbers and also with their tablet number.
b) Weekly Test i.e. captures data from SMS against Registered Followers
(Submitted by: Course participants).
c) Sample Test i.e. captures data from SMS against Registered Followers
(Submitted by: Course participants).
d) Pre-course self-assessment i.e. captures data from SMS against Registered
Followers (Submitted by: Course participants).

6
S/W Technical Reference Manual

e) Post-course self-assessment i.e. captures data from SMS against Registered

Followers (Submitted by: Course participants).
f) School Visit Report i.e. captures data from SMS (Submitted by: Zonal
Supervisor).

7
S/W Technical Reference Manual

1.4 Definition, acronyms and abbreviations

Terms Definitions
ROCS Reformed Open Community Schools works

SMS Short Messaging Services

8
ROCS - S/W Technical Reference Manual

2. Overall Description

2.1 Product perspective

ROCS-WEB is a web based system that can capture high quality programme data
and generate accurate reports as soon as Tests begins and also includes Tablet Records that
is being provided to the field staff. ROCS-WEB collect data of four parts and will reflect that
data in reports up to National level. First, ROCS-WEB will register all users/Followers then it
will get input of data from Followers by collecting Assessment Test progress data on the basis
of designed indicators. Third, ROCS-WEB will get input of Schools Visit Report from Zonal
Followers, this will help in identifying the progress of the Followers. Fourth, Followers will
also submit their test data via sms, and results will be entered in ROCS-WEB. All data would
be entered through SMS API’s designed for the purpose.

2.2 User Characteristics

There are following types of users that interact with the system: ROCS Administrator (Admin),
Coordinator, National Follower, Provincial Follower, District Follower and Zonal Followers.

ROCS Administrator will create all Users. ROCS Administrator will have all the access over the
ROCS within the system. Add/Edit/Delete options of the system will be accessible by ROCS
administrator role. ROCS User management module will be only managed by ROCS
Administrator. All the listing would be managed by the administrator which would be further
populating in dropdowns for selection. Coordinator can extract reports and access the full
visualized picture of the system within his permissions. Coordinator can also manage Users
but that management is limited to his/her area staff. Coordinator will generate Reports and
access the dashboard and that will also be limited to his/her lower level. Follower (Provincial,
District or Zonal) have the rights to view reports within their permissions or they can view
data of the followers at lower level. Followers can export and download reports up to their
level.

9
ROCS - S/W Technical Reference Manual

Designation/Team Major Roles to be performed

ROCS Administrator (Admin) ROCS Admin will have all the access over the System CRUD
operations.

Create/update/delete the Followers/Admin/Coordinator

Users.

All the basic configuration of the System would be done

only by the ROCS administrator.

Coordinator Coordinator will have all the access over the system
reports within District.

Can monitor from the District level till the ground data
entry level within the ROCS.

Exporting and download options of reports.

Provincial Follower Generate and view Reports and access dashboard of

his/her own Province.

Exporting and download options of reports will be

available for Province Follower.

District Follower Generate and view Reports and access dashboard of

his/her own District.

Exporting and download options of reports will be

available for District Follower.

Zonal Follower Zonal Follower is a user who will be learning from ROCS
and entering progress against the Test and
activities/actions for a specific period of time.

10
ROCS - S/W Technical Reference Manual

2.3 Assumptions and dependencies

An assumption about the product is that it will always be used on web and user must have
enough internet performance. If the user computer does not have nice working internet
available for the application, the application will work slow or improper.

11
ROCS - S/W Technical Reference Manual

3. Specific requirements
3.1 User interface

A first-time Administrator of the system should see the log-in page when he/she opens the
application. Similarly Data entry could be done through SMS sent by teachers and then
encoded data sent by teachers id decode to text, number, files etc.

3.2 Hardware interface

Since this web system does not have any designated hardware, it does not have any direct
hardware interfaces. The hardware connection to the database server is managed by the
underlying operating system the web server. Hardware must have the ability to connect to
internet.

12
ROCS - S/W Technical Reference Manual

3.3 Product requirements

3.3.1 System requirements

•Windows 7 and above

Operating System

•Google Chrome(Latest Version)

Browser
•FireFox (Latest Version)

•min. 100KB
Network Speed

•Linux & Windows

Platform

• Javascript, Css, MVC Framework

Scripting Tools

•PostgresSQL
Database Configurations

3.3.2 Functional requirements

3.3.2.1 User Management

There are users at four Levels:

1. National
2. Provincial
3. District
4. Zone

Above are the four level of users that will interact with the system with different set of
permissions and roles. Every level has its own role in the system.
Above all these users there is Admin user, who has accessibility to overall the system. Admin
has full access to system. Now, we will elaborate permissions set of each level user.
a) District level, at district level we have coordinators who has permissions to do user
management of the user in his/her own district. District coordinator can create Zone-
level followers, and can also do some data corrections of the data submitted by the
teachers from his/her district.
b) Follower, follower is three different level of user, only district level follower has
different permissions as described above. Provincial/zonal follower has only read
rights, means they can only view data of their own provinces/zones.
13
ROCS - S/W Technical Reference Manual

3.3.2.2 Traffic

Traffic is the data that is being sent by teachers toward the system through sms. Webapp will
receive this data in Encoded form and will decode to user readable format, so that users can
view the data. Admin can view and manage not only decoded but also endode traffic

3.3.2.3 Notifications

Notifications are being generated by District level user to notify the lower level followers or
teachers to notify them if they had missed any event/activity. Notifications are managed by
the coordinators or admin of the system

3.3.2.4 Tablet Tracking

Tablets are provided to zonal followers, to track the tablets that is being distributed we have
to register tablets against user NRC number mapped with tablet number. So that system
knows which data is being submitted by which user and from which Tablet? Tablets record is
maintained to know how many tablets are being distributed and how many tablets are
functional and data is being sent by tablet.

3.3.2.5 Charts / Reports

Charts / Reports, generated from the data submitted by the teachers will be displayed on
dashboard. Dashboard is a page which is the landing page for any user with numbers shown
according to their permission set. Dashboard has different type of filters to filter data to see
specified results against specific indicator.

3.3.2.6 Monitoring & Accessibility

a) ROCS access.
 ROCS Admin will have access of the whole system.
b) Master data access
 ROCS Admin will have access over Master data.
c) Monitor/accessing information
 ROCS Administrator (Admin), Coordinator have all the access to the
information under their supervision.
d) Access Indicators
 ROCS Admin CRUD access to indicators
e) Access reports
 ROCS Administrator (Admin), Coordinator, Provincial/District/Zonal
Coordinator can access the reports

14
ROCS - S/W Technical Reference Manual

f) Access visual data

 ROCS Administrator (Admin), Coordinator, Provincial/District/Zonal Follower
can access of visualize data under their supervision.
g) Generate reports and data visualizations
 ROCS Administrator (Admin), Coordinator, Provincial/District/ Zonal Follower
can generates the reports and has visual access.

3.3.2.7 CRUD

a) Create ROCS administrator Users.

 ROCS Admin can create administrations users.
b) Edit ROCS administrator Users
 ROCS Admin can modify administrations users.
c) Delete ROCS administrator Users
 ROCS Admin can delete administrations users.
d) ROCS User management
 ROCS admin manages ROCS users
 Coordinator can also manage user, but only users under his/her supervision.

3.3.2.8 System access

a) Access over the System.

 ROCS Admin has access over the systems CRUD operations
b) User Management
 ROCS Admin, administrator can manage user of all levels
 Coordinator can only manage user under his permissions

15
ROCS - S/W Technical Reference Manual

3.3.3 Non-functional requirements

3.3.3.1 Size and performance

The chosen software architecture supports the key sizing and timing requirements:
1. The system shall support up to reasonable amount of simultaneous users
against the central database at any given time and up to 300 simultaneous
users against the server at any one time.
2. The system shall provide access to the legacy M&E database not more than 10
second latency.
3. The system must be able to complete 80% of all transactions within minimum
possible time.
4. The client shall require less than 20 MB disk space and 32 MB RAM.

The selected architecture supports the sizing and timing requirements through the
implementation of architecture. The components have been designed to ensure that minimal
disk and memory requirements are needed on the PC.

3.3.3.2 Quality

The software architecture of ROCS supports the quality requirement:

1. The desktop user-interface shall be Microsoft Windows XP and above.

2. The user interface of the ROCS System shall be designed user friendly and shall
be appropriate for a computer-literate user community with no additional or
little bit training on the System.
3. ROCS System shall have built-in online help manual for the clients.
4. The ROCS System shall be available 24 hours a day, 7 days a week.

16
ROCS - S/W Technical Reference Manual

4. Process Overview
A description of the process view of the architecture describes the tasks (processes and
threads) involved in the system's execution, their interactions and configurations. Also
describes the allocation of objects and classes to tasks.
The Process Model illustrates the MIS-FMS classes organized as executable processes.
Processes exist to support FFP National Manager, FFP MNE, and FFP Provincial Manager; in
addition Administrator will have the full access over the processes within the system.

4.1 Processes Details

4.1.1 Configuration

Configuration allows MIS-FMS Administrator User to Add, Edit and Delete users and other
system related metadata options at different levels.

4.1.2 Tablet Registration

Tablets are registered against each user using Tablet number which will be provided/entered
by zonal supervisor.

4.1.3 User Registration

Administrator can Create user of any level while coordinator can also Create User but only
lower level user and within his/her area.

4.1.4 ROCS Dashboards

Dashboards for different User Roles/Types will facilitates the users for viewing visualized
Data.

17
ROCS - S/W Technical Reference Manual

4.2 User Management

4.2.1 Administrator

Administrator User Management, Administrator can create fellow admin and all lower level
users. Administrator can update/delete users under his permissions.

Figure 1

18
ROCS - S/W Technical Reference Manual

4.2.2 Coordinator

Coordinator can create all lower level users but would not be able to create user of the same
level. Coordinator can update/delete users under his permissions

19
ROCS - S/W Technical Reference Manual

4.2.3 Traffic

Administrator has access all traffic, admin has the right to change the data sent by the
teachers or even delete the received data.

20
ROCS - S/W Technical Reference Manual

4.2.4 Notifications

Administrator has the right to create new notifications which is being sent to all users in the
system. Admin can also view and manage notifications managed by lower level user.

21
ROCS - S/W Technical Reference Manual

4.2.5 Tablet

Administrator has the right to register new Tablet which is registered against a user. Admin
can also view and manage tablets managed by lower level user.

22
ROCS - S/W Technical Reference Manual

4.2.6 Reporting / Charts

All users have access to the Dashboard with all limitations that their account has. District
Level user can only view all data of his/her own district only. Similarly, Provincial and Zonal
users can also only view data of their provinces or zones. While Followers of ROCS only have
read access, means followers can only view data of their province, district or zone.
All users have same kind of filters available, so they can see customized charts and reports.

23
ROCS - S/W Technical Reference Manual

As described above follower has right to view data up to his level or under his supervision.
Following is the Use Case to show accessibility of Follower.

24
ROCS - S/W Technical Reference Manual

4.3 General Activity

25