MakersInstitute Open edx Extension

Transcription

1 Software Requirements Specification for MakersInstitute Open edx Extension Version 0.1 Prepared by Nurul Arif Setiawan Makers Institute July 31, 2015

2 Table of Contents Introduction Purpose Document Conventions Intended Audience and Reading Suggestions Product Scope References Overall Description Product Perspective Product Functions User Classes and Characteristics Operating Environment Design and Implementation Constraints User Documentation Assumptions and Dependencies External Interface Requirements User Interfaces Hardware Interfaces Software Interfaces Communications Interfaces System Features [Open edx] Checkout with Veritrans as credit card processor [Open edx] Checkout with bank debit using Veritrans [Open edx] Checkout with manual bank transfer [Open edx] Redeem voucher [Open edx] Helpdesk SSO [Open edx] Purchase history [Admin Dashboard] Admin sign in [Admin Dashboard] Admin menus and ACL (Access Control List) [Admin Dashboard] Admin user management [Admin Dashboard] Makers Institute Statistics dashboard [Admin Dashboard] Manage users [Admin Dashboard] Manage staffs [Admin Dashboard] Manage courses [Admin Dashboard] Manage payment [Admin Dashboard] Manage voucher [Admin Dashboard] Audit trail [Admin Dashboard] Update admin profile Other Nonfunctional Requirements Performance Requirements Safety Requirements Security Requirements Software Quality Attributes

3 Business Rules Other Requirements

4 Revision History Name Date Reason For Changes Version Nurul Arif Setiawan August 9, 2015 Initial version 0.1

5 1. Introduction 1.1 Purpose Makers Institute is a online courses provider aim to provide a selective, intensive and highest quality of computer science education both online and in the classroom. Our platform will be based on Open edx ( ) which power edx ( ) and many others online learning course. Makers Institute would like to customize and extend Open edx platform for Indonesia market. This document will specify functional and nonfunctional requirements for Open edx extension. 1.2 Document Conventions 1.3 Intended Audience and Reading Suggestions This document is intended for developers, project managers, testers, and documentation writers. 1.4 Product Scope Makers Institute is a online courses provider aim to provide a selective, intensive and highest quality of computer science education both online and in the classroom. 1.5 References

6 2. Overall Description 2.1 Product Perspective Below is latest Open edx architecture Makers Institute Open edx extension is shown below

7 Open edx extension that are part of this documents are: 1. More payment options 2. Admin dashboard 3. Open edx as SAML provider for Happyfox SSO (Single Sign on) Makers Institute website is based on Open edx. The extension should use the same underlying technology as Open edx and follow Open edx convention and standard. This include the User Interface and User Experience. 2.2 Product Functions This section outlined high level detail of Open edx extension for Makers Institute. details of each functions will be given in Section 4 (System Features) More payment options Currently Open edx support Credit Card via cybersource ( ) and Paypal ( ). We will add another method of payments:

8 1. Use Veritrans ( as Credit card processor. 2. Use Veritrans to process payment using Bank Debit from major banks in Indonesia (Bank Mandiri, Bank BCA and Bank BRI). 3. Manual bank transfer. This is where customer transfer money to a provided bank account number and then ask Helpdesk to verify the transfer. If verified, helpdesk will enable the course for them. We will use third party helpdesk service Happyfox ( We will add redeem voucher feature to allow customer which have discount voucher to use it. The voucher might reduce price by percent or by nominal value. voucher will be used for promotional purpose Admin dashboard Open edx provide admin site from Django framework. However it is intended for super admin users. We need admin dashboard with more limited functionality (for Helpdesk) or more visual (with charts) for management. The admin dashboard will be a separate application from Open edx but have access to Open edx databases. Some admin dashboard functions: 1. Manage admin users CRUD, list and detail. 2. Summary dashboard: Total course, total user, total paid user, average online user, total hour of video, total hours of course, total issued certificates and other data (TBD To be defined). 3. See users data CRUD, list and detail, courses attended, payment history, certificates issued. 4. See staff data CRUD, list and detail, courses created. 5. See courses data CRUD, list and detail, attendees, paid attendees. 6. See payment data CRUD, list and detail, user, course, status. 7. voucher CRUD, list and detail. 8. Admin dashboard audit trail user, sign in/sign out, IP, location, update data, time Happyfox SSO User should be able to use the same Open edx account to use Happyfox system. 2.3 User Classes and Characteristics Users of Makers Institute: User Site visitor Characteristics Visitor (not logged in) who access Makers Institute open edx

9 Course Student Course Staff Helpdesk Marketing Admin Management Also referred as user or customer in this document. Makers Institute staff who create course Provide customer service support. Log in to Admin Dashboard. Makers Institute marketing staff. Log in to Admin Dashboard. Makers Institute site admin. Log in to Admin Dashboard. Makers Institute management. Log in to Admin Dashboard. 2.4 Operating Environment Follow Open edx standard. Server will run on Linux while the website should run on all latest major browsers 2.5 Design and Implementation Constraints The extension specified in this document should use the same underlying technology as Open edx. Some of the notes are: 1. Admin dashboard should be built with Django, and use the same database as Open edx LMS and CMS. 2. Features that adding features to current open source Open edx should adhere to Open edx standard. This is including code conventions, app layers (model, controller and UI). Open edx use Backbone in UI layer, so it must be used. 3. Open edx theme can be customized. This standard should be followed and new applied theme should also update any web pages added as part of extension. 4. Use English as main language and follow internationalization standard used in Open edx. All text displayed in UI should be translatable. 5. Use configuration convention as in Open edx. 6. Use deployment convention as in Open edx. Open edx use Ansible and the extension should follow that standard. For example, additional configuration options should be available in the Ansible playbook and Admin dashboard deployment should also use Ansible. 7. Open edx use Celery workers. When applicable, the extension also should use the same approach. 2.6 User Documentation Expected documentation as part of thie requirements are: 1. Finding and notes on Open edx (code, deployment, etc)

10 2. How to extend Open edx (Intended for developers) a. How to add more payment options (New credit card processor, update checkout page, add manual bank transfer payment flow) b. How to deploy admin dashboard with Ansible 3. Admin dashboard software design documents 2.7 Assumptions and Dependencies Third party services that we will use: 1. Veritrans ( ) as credit card processor 2. Happyfox ( ) as helpdesk The systems might inherit assumptions and dependencies from Open edx. 3. External Interface Requirements 3.1 User Interfaces Following Open edx standard For additional payment methods and redeem vouchers, the checkout UI is shown below:

11 For admin dashboard, we will use commercial theme available from Themeforest ( ). Which theme to use is TBD. 3.2 Hardware Interfaces Following Open edx standard 3.3 Software Interfaces Following Open edx standard 3.4 Communications Interfaces Following Open edx standard 4. System Features This section will explain in detail extension features. There are two system specified on this section: 1. Extension to Open edx core is marked with [Open edx] 2. New admin dashboard is marked as [Admin Dashboard] Note that Some of the functions described in the detailed sequence below should be readily available in Open edx source or will be added as third party service. For example: purchase flow with credit card is already exists and helpdesk will use third party service (Happyfox). 4.1 [Open edx] Checkout with Veritrans as credit card processor Description and Priority Currently, Open edx support CyberSource and Paypal as credit card processor. For Indonesia market we want to use Indonesian credit card processor, Veritrans. The checkout flow will be same as existing processor: customer is redirected to processor payment page where they enter their credit card information Stimulus/Response Sequence Customer select a paid course or free course but choose for paid certificate Customer select to checkout with credit card Customer redirected to Veritrans page to enter their credit card information and proceed with purchase Veritrans will redirect to Open edx site with success or error status

12 Customer redirected to success or error page based on purchase status from Veritrans Customer will get should the purchase success with receipt attachment In case of paid course, customer is redirected to the course page, displaying that he/she has access to the course In case of paid certificate, customer is redirected to the course page, displaying that he/she has paid for certificate Functional Requirements EDX 1.1: Replace Cybersource with Veritrans as credit card processor 4.2 [Open edx] Checkout with bank debit using Veritrans Description and Priority Bank debit also popular payment method in Indonesia. By using Veritrans service, the flow will be similar to credit card processing (Customers is redirected to Veritrans page to process payment) Stimulus/Response Sequence Customer select a paid course or free course but choose for paid certificate Customer select to checkout with bank debit Customer redirected to Veritrans page to continue with bank debit processing Veritrans will redirect to Open edx site with success or error status Customer redirected to success or error page based on purchase status from Veritrans Customer will get should the purchase success with receipt attachment In case of paid course, customer is redirected to the course page, displaying that he/she has access to the course In case of paid certificate, customer is redirected to the course page, displaying that he/she has paid for certificate Functional Requirements EDX 2.1: Customer can pay courses or verified certificate using Veritrans as bank debit processor. EDX 2.2: Bank debit should support three major banks in Indonesia (Bank Mandiri, Bank BCA and Bank BRI). 4.3 [Open edx] Checkout with manual bank transfer Description and Priority Customer should be able to transfer money to specified bank account number (either directly to bank, using ATM, online banking or other methods), then request for verification by contacting Helpdesk. Helpdesk will check if money is received then update customer purchase status using Admin Dashboard.

13 4.3.2 Stimulus/Response Sequence Customer select a paid course or free course but choose for paid certificate Customer select to checkout with manual transfer Customer redirected to a page contains list of bank account for transfer. This page also contains invoice which customer can download a pdf version Customer make payment by transfer to specified bank account. How the transfer made is up to the customer Customer can check his payment status from payment menu Customer can ask for payment confirmation to Helpdesk using a form or directly chat with Helpdesk officer Helpdesk verify user data, check that transfer is received and then update customer purchase status Customer get notification via of his purchase status verified and system update his payment status Functional Requirements EDX 3.1: Customers can get information of specified bank account for manual transfer. EDX 3.2: Customer can see the purchase invoice and can download it in pdf format EDX 3.3: Customer can see his payment status. EDX 3.4: Customer can request for payment verification using a form. This form will be sent to Helpdesk. Use Happyfox API to create ticket. EDX 3.5: Helpdesk can see and update Customer data using Admin Dashboard. EDX 3.6: Helpdesk can see and update Payment data using Admin Dashboard. EDX 3.7: Admin can update bank account using admin site Mockups TODO: Add payment verification request form mockup

14 4.4 [Open edx] Redeem voucher Description and Priority Before proceed with checkout on paid course or verified certificate, user can redeem a voucher that will discount the final price if still valid. Voucher might discount by percent (discount %20) or by nominal value (discount IDR ) Stimulus/Response Sequence Customer select a paid course or free course but choose for paid certificate Customer then redeem a voucher using redeem voucher button Customer enter voucher code then submit Server will check if voucher still valid or not. Failed reason might be its already used or has expired If success, price will be discounted Functional Requirements EDX 4.1: Customer can redeem a voucher before checkout EDX 4.2: Voucher might discount by percent (discount %20) or by nominal value (discount IDR ) Mockups

15

16 4.5 [Open edx] Helpdesk SSO Description and Priority We use third party service for helpdesk: Happyfox. Customer should be able to sign in to Happyfox support using his/her Open edx (SSO Single Sign On) account to see his ticket status. Integration is using SAML. Prority: High Stimulus/Response Sequence User want to create a ticket or chat to helpdesk for support User can create a ticket using help button available on the Makers Institute pages When user sign in to Makers Institute Open edx, it will automatically signed him in to Happyfox. So when user want to create a ticket using widget or chat to helpdesk, user information is readily available User can see his ticket status on Makers Institute Happyfox site If user access Happyfox site but not signed in to Makers Institute Open edx, he/she can sign in using Open edx account Functional Requirements EDX 5.1: Open edx can act as SAML provider for Happyfox. EDX 5.2: When user sign in to Makers Institute Open edx, it will automatically signed him in to Happyfox using his Makers Institute Open edx account. EDX 5.3: When user create a ticket or chat, user information is readily available for helpdesk since it use the same Open edx account. EDX 5.4: User can sign in to Happyfox site using Open edx account.

17 4.6 [Open edx] Purchase history Description and Priority User can see his purchase history: Which courses, amount, date, success/failure/pending status, payment method, purchase invoice and others data (TBD) Stimulus/Response Sequence User want to see his purchase history User go to purchase menu then see his purchase history list User can check purchase details and download invoice in pdf format Functional Requirements EDX 6.1: User can get his purchase history list. EDX 6.2: User can check purchase details and download invoice in pdf format Mockups TODO: Purchase history mockups 4.7 [Admin Dashboard] Admin sign in Description and Priority Admin user can sign in to admin dashboard. Admin user also can reset password Stimulus/Response Sequence Admin go to admin dashboard site Admin then sign in or reset password if he forget Functional Requirements AD 7.1: Admin dashboard sign in using name or and password. AD 7.2: Admin dashboard forget password Mockups

18 4.8 [Admin Dashboard] Admin menus and ACL (Access Control List) Description and Priority There are several menus available on Admin dashboard and there are several user types. How user can access each menu is TBD Stimulus/Response Sequence When a user sign in to Admin dashboard, he can see menus that are allowed for him to access Functional Requirements AD 8.1: Admin dashboard ACL TODO: Admin dashboard ACL table 4.9 [Admin Dashboard] Admin user management Description and Priority CRUD for admin dashboard user. Set admin privilege. Admin user field: user name, full name, , password, role, create time, updated time, profile picture Stimulus/Response Sequence Show admin list Create new admin, edit and update admin data, delete existing admin Functional Requirements AD 9.1: Admin user CRUD Mockups TODO: Admin user management mockups 4.10 [Admin Dashboard] Makers Institute Statistics dashboard Description and Priority Show statistical summary of Makers Institute. Shows data that might be relevant for management purposes (see potential market, estimate growth, etc). Some data is shown as summary: Total course, total user, total paid user, total revenue, average online user, total hour of video, total hours of course, total issued certificates and other data (TBD) Some data is shown as chart: User growth (showing both monthly and cumulative), Paid user growth, revenue growth, user percentage (gender, education, location ), and other data (TBD) Some data is shown as total or current running month Stimulus/Response Sequence Show statistics in number (total and this month) and growth chart.

19 Functional Requirements AD 10.1: Show summary of statistics in current month and total: Total course, total user, total paid user, total revenue, average online user, total hour of video, total hours of course, total issued certificates and other data (TBD) AD 10.2: Show data in chart: User growth (showing both monthly and cumulative), Paid user growth, revenue growth, user percentage (gender, education, location ), and other data (TBD) TODO: More detailed and defined what statistical data is shown in Admin dashboard Mockups TODO: Statistics dashboard mockups 4.11 [Admin Dashboard] Manage users Description and Priority Provide CRUD function for Open edx users. Show user related data: Course attended, purchase list, certificate issued, activity profile Stimulus/Response Sequence Show user list Create new user, edit and update user data, delete existing user Show user related data Functional Requirements AD 11.1: Open edx user CRUD AD 11.2: Only allow update on some fields for Helpdesk (not allow create or delete) AD 11.3: Show user related data: Course attended, purchase list, certificate issued, activity profile Mockups TODO: Manage users mockups 4.12 [Admin Dashboard] Manage staffs Description and Priority Provide CRUD function for Open edx staff. Show staff related data: Course created (linked to course details) Stimulus/Response Sequence Show staff list Create new staff, edit and update staff data, delete existing staff Show staff related data Functional Requirements AD 12.1: Open edx staff CRUD AD 12.2: Show created course by staff (linked to course details. See section 4.13) Mockups

20 TODO: Manage staffs mockups 4.13 [Admin Dashboard] Manage courses Description and Priority Provide CRUD function for Open edx staff. Show course related data: Attendees, purchase, contents Stimulus/Response Sequence Show courses list Create new courses, edit and update courses data, delete existing courses Show course related data Functional Requirements AD 13.1: Open edx courses CRUD AD 13.2: Show course related data: Attendees, purchase, contents Mockups TODO: Manage courses mockups 4.14 [Admin Dashboard] Manage payment Description and Priority Provide CRUD function for payment made for purchase courses or verified certificates. Provide link to relevant entities: user who made payment, course to pay Stimulus/Response Sequence Show payment list Create new payment, edit and update courses data, delete existing payment Show link to relevant entities: user who made payment, course to pay Functional Requirements AD 14.1: Open edx payment CRUD AD 14.2: Provide link to relevant entities: user who made payment, course to pay Mockups TODO: Manage payment mockups 4.15 [Admin Dashboard] Manage voucher Description and Priority Provide CRUD function for Voucher. Voucher might be: valid only for a course, valid only for specific time span, valid only for single use or multiple use Stimulus/Response Sequence

21 Show voucher list Create new voucher, edit and update voucher data, delete existing voucher Functional Requirements AD 15.1: Voucher CRUD AD 15.2: Support for several voucher valid scenario: valid only for a course or multiple course or all courses, valid only for specific time span or indefinitely, valid only for single use or multiple use Mockups TODO: Manage voucher mockups 4.16 [Admin Dashboard] Audit trail Description and Priority Access log. Record any changes to any data from admin dashboard users Stimulus/Response Sequence Show access and change log Functional Requirements AD 16.1: Audit trail for Admin dashboard usage Mockups TODO: Audit trail mockups 4.17 [Admin Dashboard] Update admin profile Description and Priority Admin user can update username, full name, password profile picture Stimulus/Response Sequence Admin go to admin profile page Admin update username, full name, password profile picture Functional Requirements AD 17.1: Admin user can update username, full name, password profile picture Mockups TODO: Update admin profile mockups 5. Other Nonfunctional Requirements 5.1 Performance Requirements For extension that added to Open edx code, following Open edx standard. For admin dashboard, loading time should be fast. Minimize database query time to load the data before rendering. Use cache when necessary to fasten up loading time.

22 5.2 Safety Requirements Following Open edx standard. 5.3 Security Requirements For extension that added to Open edx code, following Open edx standard. 5.4 Software Quality Attributes Following Open edx standard. 5.5 Business Rules For extension that added to Open edx code, following Open edx standard. 6. Other Requirements Appendix A: Glossary Appendix B: Analysis Models Appendix C: To Be Determined List