Difference between revisions of "IS480 Team wiki: 2014T1 Chocolicious Documentation"
(37 intermediate revisions by the same user not shown) | |||
Line 18: | Line 18: | ||
|} | |} | ||
==Documents== | ==Documents== | ||
+ | |||
{|class="wikitable" width="80%" | {|class="wikitable" width="80%" | ||
|- | |- | ||
Line 24: | Line 25: | ||
|- | |- | ||
! Proposal | ! Proposal | ||
− | | <center>[[Media:ProposalTeamChocolicious.pdf|Proposal]]</center> | + | | <center>[[Media:ProposalTeamChocolicious.pdf|[Proposal]]]</center> |
|- | |- | ||
! Meeting Minutes | ! Meeting Minutes | ||
Line 35: | Line 36: | ||
[[Media:ChocoMinutes6_25Jul2014.pdf|[6]]], | [[Media:ChocoMinutes6_25Jul2014.pdf|[6]]], | ||
[[Media:ChocoMinutes7_19Aug2014.pdf|[7]]], | [[Media:ChocoMinutes7_19Aug2014.pdf|[7]]], | ||
+ | [[Media:ChocoMinutes8_5Sep2014.pdf|[8]]], | ||
+ | [[Media:ChocoMinutes9_12Sep2014.pdf|[9]]], | ||
+ | [[Media:ChocoMinutes10_9Oct2014.pdf|[10]]] | ||
+ | [[Media:ChocoMinutes11_17Oct2014.pdf|[11]]], | ||
+ | [[Media:ChocoMinutes12_5Nov2014.pdf|[12]]], | ||
+ | [[Media:ChocoMinutes13_18Nov2014.pdf|[13]]] | ||
+ | |||
</center> | </center> | ||
|- | |- | ||
! Supervisor Meeting Minutes | ! Supervisor Meeting Minutes | ||
− | | <center>[[Media:ChocoSupervisorMinutes1_13Jul2014.pdf|[1]]], | + | | <center> |
− | + | [[Media:ChocoSupervisorMinutes1_13Jul2014.pdf|[1]]], | |
− | |- | + | [[Media:ChocoSupervisorMinutes2_26Jul2014.pdf|[2]]], |
+ | [[Media:ChocoSupervisorMinutes3_14Aug2014.pdf|[3-Acceptance]]], | ||
+ | [[Media:ChocoSupervisorMinutes4_29Aug2014.pdf|[4]]], | ||
+ | [[Media:ChocoSupervisorMinutes5_5Sep2014.pdf|[5]]], | ||
+ | [[Media:ChocoSupervisorMinutes6_12Sep2014.pdf|[6]]], | ||
+ | [[Media:ChocoSupervisorMinutes7_19Sep2014.pdf|[7]]], | ||
+ | [[Media:ChocoSupervisorMinutes8_26Sep2014.pdf|[7]]], | ||
+ | [[Media:ChocoSupervisorMinutes7_3Oct2014.pdf|[9]]], | ||
+ | [[Media:ChocoSupervisorMinutes10_17Oct2014.pdf|[10]]], | ||
+ | [[Media:ChocoSupervisorMinutes11_7Nov2014.pdf|[11]]], | ||
+ | [[Media:ChocoSupervisorMinutes12_18Nov2014.pdf|[12]]] | ||
+ | </center> | ||
+ | |- | ||
! Client Meeting Minutes | ! Client Meeting Minutes | ||
− | | <center>[[Media:ChocoClientMinutes1_24May2014.pdf|[1]]], [[Media:ChocoClientMinutes2_23Jul2014.pdf|[2]]], [[Media:ChocoClientMinutes3_26July2014.pdf|[3]]], [[Media:ChocoClientMinutes4_04Aug2014.pdf|[4]]]</center> | + | | <center> |
− | |- | + | [[Media:ChocoClientMinutes1_24May2014.pdf|[1]]], |
− | ! Acceptance Presentation | + | [[Media:ChocoClientMinutes2_23Jul2014.pdf|[2]]], |
− | | <center>[[Media:ChocoliciousAcceptancePresentation.pptx|[Presentation]]], [[Media:AcceptanceMinutes_14Aug2014.pdf|[Feedback]]]</center> | + | [[Media:ChocoClientMinutes3_26July2014.pdf|[3]]], |
+ | [[Media:ChocoClientMinutes4_04Aug2014.pdf|[4]]], | ||
+ | [[Media:ChocoClientMinutes5_22Sep2014.pdf|[5]]], | ||
+ | [[Media:ChocoClientMinutes6_28Oct2014.pdf|[6]]] | ||
+ | </center> | ||
+ | |- | ||
+ | ! Acceptance Presentation | ||
+ | | <center> | ||
+ | [[Media:ChocoliciousAcceptancePresentation.pptx|[Presentation]]], | ||
+ | [[Media:AcceptanceMinutes_14Aug2014.pdf|[Feedback]]] | ||
+ | </center> | ||
+ | |- | ||
+ | ! UAT 1 | ||
+ | | <center>Test Documents for: | ||
+ | [[Media:ChocoSMUSAFinanceSecretary.pdf|[SMUSA Finance Secretary]]], | ||
+ | [[Media:ChocoSMUSASecretary.pdf|[SMUSA Secretary]]], | ||
+ | [[Media:ChocoSMUSAPresident.pdf|[SMUSA President]]] | ||
+ | |||
+ | </center> | ||
+ | |- | ||
+ | ! UAT 2 | ||
+ | | <center>Test Documents for: | ||
+ | [[Media:ChocoSMUSAFinanceSecretary2.pdf|[SMUSA Finance Secretary]]], | ||
+ | [[Media:ChocoSMUSASecretary2.pdf|[SMUSA Secretary]]], | ||
+ | [[Media:ChocoSMUSAPresident2.pdf|[SMUSA President]]]<br/> | ||
+ | [[Media:ChocoCBDFinanceSecretary.pdf|[CBd Finance Secretary]]], | ||
+ | [[Media:ChocoCBDMC.pdf|[CBd MC]]], | ||
+ | [[Media:ChocoCBDPresident.pdf|[CBd President]]]<br/> | ||
+ | [[Media:ChocoClubFinanceSecretary.pdf|[Club Finance Secretary]]], | ||
+ | [[Media:ChocoNormal.pdf|[Normal]]], | ||
+ | [[Media:ChocoClubPresident.pdf|[Club President]]]<br/> | ||
+ | Briefing Slides with Process Flow Charts:<br/> | ||
+ | [[Media:ChocoUAT2brief.pdf|[Briefing]]] | ||
+ | </center> | ||
+ | |- | ||
+ | ! UAT 3 | ||
+ | | <center> | ||
+ | [[Media:ChocoUAT3.pdf|[Questionnaire]]] | ||
+ | </center> | ||
+ | |- | ||
+ | ! Midterm Presentation | ||
+ | | <center> | ||
+ | [[Media:ChocoMidtermPresentatio.pdf|[Midterm Presentation]]],[[Media:ChocoMidtermMinutes_07Oct2014.pdf|[Feedbacks]]] | ||
+ | </center> | ||
+ | |- | ||
+ | ! Finals Presentation | ||
+ | | <center>[[Media:ChocoliciousPosterSmall.pdf|[Poster]]], [[Media:ChocoFinalsPresentation.pdf|[Finals Presentation]]]</center> | ||
|} | |} | ||
==Database== | ==Database== | ||
− | [[File:ChocoDiagram.jpg|center| | + | [[File:ChocoDiagram.jpg|center|600px]] |
+ | |||
==Use Cases== | ==Use Cases== | ||
− | [[File:Use_Case_Diagram_(Color_code).jpg|center| | + | [[File:Use_Case_Diagram_(Color_code).jpg|center|820px]] |
<center> | <center> | ||
{| class="wikitable mw-collapsible mw-collapsed" style="width:80%" | {| class="wikitable mw-collapsible mw-collapsed" style="width:80%" | ||
Line 63: | Line 130: | ||
| Depending on user privileges, users will be able to create, edit, submit, approve, reject and endorse claims from their expenditure accounts. <br> | | Depending on user privileges, users will be able to create, edit, submit, approve, reject and endorse claims from their expenditure accounts. <br> | ||
Finance secretaries will be able to claim outside their budget if clubs have revenue. <br> | Finance secretaries will be able to claim outside their budget if clubs have revenue. <br> | ||
− | All users will be able to track the statuses of their claims. | + | All users will be able to track the statuses of their claims. The SMUSA Finance Secretary will be able to track all the claims. |
|- | |- | ||
! Funds management | ! Funds management | ||
Line 75: | Line 142: | ||
| The finance secretary of SMUSA will be able to allocate funds into the expenditure accounts of all student clubs at the start of budgeting terms. At the end of budgeting terms, they can initiate the pullback of unutilized budget into the reserve accounts. The formula for pullback can be modified by the finance secretary of SMUSA. | | The finance secretary of SMUSA will be able to allocate funds into the expenditure accounts of all student clubs at the start of budgeting terms. At the end of budgeting terms, they can initiate the pullback of unutilized budget into the reserve accounts. The formula for pullback can be modified by the finance secretary of SMUSA. | ||
|- | |- | ||
− | ! | + | ! Vendor Recommendation |
− | | Users | + | | Users will build AIS's Vendor Database when they make payment claims to vendors. Ratings will be used to help users find vendors for events in the future. Constant updating of the reviews by different users ensure that the vendors are continuously re-rated and that the database will be able to recommend the most trustworthy vendors when called upon. |
+ | |- | ||
+ | ! Additional features | ||
+ | | Sensitive financial data will be encrypted. | ||
|- | |- | ||
! Additional features | ! Additional features | ||
− | | | + | | e-Receipt as a part of AIS allows users to give receipts to students/buyers when organizing events. Paperless and easy to store, distribute and submit, these e-Receipts aims to help improve efficiency. |
|} | |} | ||
</center> | </center> | ||
− | ==Priority Rankings== | + | |
+ | ==Architecture Diagram== | ||
+ | <center> | ||
+ | [[File:ChocoArchiDiagram.png|650px]] | ||
+ | <p> | ||
+ | <b><big>Architecture Diagram for AIS:</big></b><br/> | ||
+ | 3 Main Tiers - Client, Server and Data<br/> | ||
+ | <br/> | ||
+ | <b><big>Client:</big></b><br/> | ||
+ | 1 Layer<br/> | ||
+ | Client Layer accessible through Browsers<br/> | ||
+ | <br/> | ||
+ | <b><big>Server:</big></b><br/> | ||
+ | 2 Layers, 1 Cross-Cutting Layer<br/> | ||
+ | Presentation Layer has the UI components and the Client Side Logic/Validations.<br/> | ||
+ | Business Layer has the Business Logics, we used Ruby on Rails for our programming. This layer also communicates with the email server to perform some of the functions.<br/> | ||
+ | We also applied the MVC Framework: Model & Controllers are in the Business Layer while View is in the Presentation Layer.<br/> | ||
+ | The Application is hosted on AWS EC2.<br/> | ||
+ | <br/> | ||
+ | <b><big>Data:</big></b><br/> | ||
+ | MySQL Database with InnoDB engine on AWS RDS | ||
+ | </p> | ||
+ | </center> | ||
+ | |||
+ | <!--==Priority Rankings== | ||
[[File:ChocoPriority.png|center|800px]] | [[File:ChocoPriority.png|center|800px]] | ||
The diagram above depicts the priorities of our functions with those listed under <b>Primary</b> as the most important and the rest as <b>Secondary</b> priority. | The diagram above depicts the priorities of our functions with those listed under <b>Primary</b> as the most important and the rest as <b>Secondary</b> priority. | ||
+ | --> | ||
==System Diagram== | ==System Diagram== | ||
Line 202: | Line 297: | ||
Image:AIS_Form_page.jpg|Claims application form page | Image:AIS_Form_page.jpg|Claims application form page | ||
Image:AIS_Form_status.jpg|Form fields-verification | Image:AIS_Form_status.jpg|Form fields-verification | ||
− | </gallery></center> | + | </gallery></center><br/> |
+ | |||
+ | <p> Below are the wireframes for pages in general and sign in, sign up, resend confirmation pages.</p> | ||
+ | <center>[[File:Chocowireframe.jpg|800px]]</center> | ||
+ | <br/> | ||
===Work-flow=== | ===Work-flow=== | ||
Line 221: | Line 320: | ||
<b>Budgeting</b> | <b>Budgeting</b> | ||
− | <center><!--[[File:BudgetWorkflow.jpg|600px]]--></center> | + | {| |
+ | |<center><!--[[File:BudgetWorkflow.jpg|600px]]--></center> | ||
[[File:CHOCOBUDGET.gif|left|700px]] | [[File:CHOCOBUDGET.gif|left|700px]] | ||
− | <p>Budgeting is done twice in every academic year. There are 4 main actors involved, the SMUSA Finance Secretary, the SMUSA Secretaries, the CBd Finance Secretaries and lastly the Club Finance Secretaries. Before the start of the term, student organisations will need to propose the events that they would be organising and justify the amount of money that they would require from SMUSA. To start the Budgeting Process, the SMUSA Finance Secretary will open up the budget editing period and set a deadline. SMUSA Secretaries will propose for their respective departments while the rest of the Finance Secretaries will propose for their respective organisation. When the deadline is due, the SMUSA Finance Secretary locks the editing function to prepare for discussion with the CBd Finance Secretaries. As budget is limited, intense discussion and careful allocation is essential in ensuring each club gets a deserving portion of the budget for their clubs. | + | |<p>Budgeting is done twice in every academic year. There are 4 main actors involved, the SMUSA Finance Secretary, the SMUSA Secretaries, the CBd Finance Secretaries and lastly the Club Finance Secretaries.</p><p>Before the start of the term, student organisations will need to propose the events that they would be organising and justify the amount of money that they would require from SMUSA. To start the Budgeting Process, the SMUSA Finance Secretary will open up the budget editing period and set a deadline. SMUSA Secretaries will propose for their respective departments while the rest of the Finance Secretaries will propose for their respective organisation. When the deadline is due, the SMUSA Finance Secretary locks the editing function to prepare for discussion with the CBd Finance Secretaries.</p><p>As budget is limited, intense discussion and careful allocation is essential in ensuring each club gets a deserving portion of the budget for their clubs.</p> |
− | <br/> | + | |}<br/> |
<b>Payment to Club</b> | <b>Payment to Club</b> |
Latest revision as of 09:42, 25 November 2014
|
Contents
Documents
Document | Link (Click to download) |
---|---|
Proposal | |
Meeting Minutes | [1], [2], [3], [4], [5], [6], [7], [8], [9], [10] [11], [12], [13] |
Supervisor Meeting Minutes | [1], [2], [3-Acceptance], [4], [5], [6], [7], [7], [9], [10], [11], [12] |
Client Meeting Minutes | |
Acceptance Presentation | |
UAT 1 | [SMUSA Finance Secretary], [SMUSA Secretary], [SMUSA President] |
UAT 2 | [SMUSA Finance Secretary],
[SMUSA Secretary],
[SMUSA President] |
UAT 3 | |
Midterm Presentation | |
Finals Presentation |
Database
Use Cases
Scope | |
---|---|
Electronic bookkeeping | Users will be able to track all transactions on their expenditure accounts and reserve accounts. |
Claims management | Depending on user privileges, users will be able to create, edit, submit, approve, reject and endorse claims from their expenditure accounts. Finance secretaries will be able to claim outside their budget if clubs have revenue. |
Funds management | Finance secretaries will be able to transfer funds from one account to another and will be able to request for withdrawal of funds from the reserves account. They can also deposit funds into their accounts. |
Budgeting tool | Club finance secretaries will be able to propose and submit budgets during the budgeting cycle. CBd finance secretaries and the SMUSA finance secretary will be able to review, edit and approve the budgets. |
Allocation & pullback of funds | The finance secretary of SMUSA will be able to allocate funds into the expenditure accounts of all student clubs at the start of budgeting terms. At the end of budgeting terms, they can initiate the pullback of unutilized budget into the reserve accounts. The formula for pullback can be modified by the finance secretary of SMUSA. |
Vendor Recommendation | Users will build AIS's Vendor Database when they make payment claims to vendors. Ratings will be used to help users find vendors for events in the future. Constant updating of the reviews by different users ensure that the vendors are continuously re-rated and that the database will be able to recommend the most trustworthy vendors when called upon. |
Additional features | Sensitive financial data will be encrypted. |
Additional features | e-Receipt as a part of AIS allows users to give receipts to students/buyers when organizing events. Paperless and easy to store, distribute and submit, these e-Receipts aims to help improve efficiency. |
Architecture Diagram
Architecture Diagram for AIS:
3 Main Tiers - Client, Server and Data
Client:
1 Layer
Client Layer accessible through Browsers
Server:
2 Layers, 1 Cross-Cutting Layer
Presentation Layer has the UI components and the Client Side Logic/Validations.
Business Layer has the Business Logics, we used Ruby on Rails for our programming. This layer also communicates with the email server to perform some of the functions.
We also applied the MVC Framework: Model & Controllers are in the Business Layer while View is in the Presentation Layer.
The Application is hosted on AWS EC2.
Data:
MySQL Database with InnoDB engine on AWS RDS
System Diagram
User Rights Table
Functions \ User Type | Normal student | Normal student with club | CBd Management Committee Member | Club finance secretary | CBD Finance Secretary | SMUSA Secretary | Club/CBD President | SMUSA Finance secretary |
---|
Registrations | ||||||||
---|---|---|---|---|---|---|---|---|
Register for club | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ |
Accept/decline user requests to join club | ✔ | ✔ | ||||||
Add/delete club members | ✔ | ✔ | ✔ | |||||
Add/delete club finance secretaries | ✔ | |||||||
Add/delete CBD finance secretaries | ✔ | |||||||
Add/delete SMUSA secretaries | ✔ | |||||||
Add/delete CBD MC members | ✔ | |||||||
Register a club | ✔ | |||||||
Delete a club | ✔ |
Claims | ||||||||
---|---|---|---|---|---|---|---|---|
Create new claim | ✔ | ✔ | ✔ | |||||
Edit claims | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ||
Submit claims | ✔ | ✔ | ✔ | ✔ | ✔ | ✔ | ||
Reject claims | ✔ | ✔ | ||||||
Endorse claims | ✔ | ✔ | ||||||
Change claim status | ✔ | ✔ |
Accounts | ||||||||
---|---|---|---|---|---|---|---|---|
View expenditure account | ✔ | ✔ | ✔ | ✔ | ✔ | |||
View reserve account | ✔ | ✔ | ✔ | ✔ | ||||
Edit account balance | ✔ | ✔ | ||||||
Allocate funds to accounts | ✔ | |||||||
Pullback funds from accounts | ✔ | |||||||
Change reserves limit | ✔ | |||||||
Inject funds into SAC reserves | ✔ | |||||||
Change formulas for transaction calculations | ✔ | |||||||
Transfer funds | ✔ | |||||||
Deposit revenue | ✔ | ✔ |
Budget | ||||||||
---|---|---|---|---|---|---|---|---|
Propose/submit budget | ✔ | ✔ | ✔ | |||||
View/edit budget | ✔ | ✔ | ✔ | ✔ |
Proto-type
Below are the screenshots of our UI Mock up. Clockwise from left: Home screen layout, Claims application form page, Form fields-verification.
Below are the wireframes for pages in general and sign in, sign up, resend confirmation pages.
Work-flow
Below are the workflow diagrams of our processes for the Normal Club Claim Process, the CBd MC Claim and the SMUSA Secretary Claim Processes.
Normal Club Claim
CBd MC Claim
SMUSA Secretary Claim
Budgeting
Budgeting is done twice in every academic year. There are 4 main actors involved, the SMUSA Finance Secretary, the SMUSA Secretaries, the CBd Finance Secretaries and lastly the Club Finance Secretaries. Before the start of the term, student organisations will need to propose the events that they would be organising and justify the amount of money that they would require from SMUSA. To start the Budgeting Process, the SMUSA Finance Secretary will open up the budget editing period and set a deadline. SMUSA Secretaries will propose for their respective departments while the rest of the Finance Secretaries will propose for their respective organisation. When the deadline is due, the SMUSA Finance Secretary locks the editing function to prepare for discussion with the CBd Finance Secretaries. As budget is limited, intense discussion and careful allocation is essential in ensuring each club gets a deserving portion of the budget for their clubs. |
Payment to Club
Deposit
Accounting Information System: Functions comparison
SN | Features | uClaim | Dj Jay | Chocolicious |
---|---|---|---|---|
1. | User Process |
|
|
|
2. | CCA Process |
|
| |
3. | Budget Process |
|
|
|
4. | Claims Process |
|
|
|
5. | Reporting Process |
|
|
|
6. | Asset Process |
|
|
|
7. | Events Process |
|
||
8. | Accounts Process |
| ||
9. | Funds Process |
|