Architectural Design Document

Nexcel

Version	Date	Author	Reason of change
0.0.0	3-7-2014	Askerali Maruthullathil	Initial version
1.0.0	12-9-2014	Askerali Maruthullathil, Lamana Mulaffer	First version
1.3.0	18-1-2015	not applicable	Beta version

Document Change Records

Chapter 1

Nowadays, data are more easily accessible than ever, yet support for correlating base data into interesting consequences is often unavailable, or too expensive, or too technical for many users. We have designed NEXCEL, a possible solution to this problem which revolves around extending the spreadsheet paradigm to enable users to define useful forms of correlation among their data. Spreadsheets are widely available to users, already allow them to routinely define complex custom calculations on numerical data, and are easy to use productively with little or no training. However they are unable to deal with the kind of recursive relational calculations needed for many common types of data correlation problems. NEXCEL's design exploits techniques from logic programming and database theory to solve these issues.

Figure 2.1: The environment of Nexcel

This chapter describes the connections that Nexcel has with database and the authentication systems.

This chapter describes the technical aspects of the design of Nexcel.

Query
Workbook

Sheet
Group Expressions/Formulas
User
Cell data and Formulas
Update
GUI
UI Layout

Event Handlers

Mouse Listener

Key Listener

JavaScript modules structure

External libraries

Nexcel

Controller

Formula

Model

Rules

UI

Server PHP Scripts

Database

Explanation

Dependency Calculation;

Formula Parser

Rule Engine

Negative Explanation

In this chapter we will describe every component of chapter 4 in detail. We will, however, start by giving a description model.

1. 
   Create User
   
2. 
   Add User folder
   
3. 
   Update folder name
   
4. 
   Change Password
   

This module mainly meant to handle all the data handling associated with the workbook.

1. 
   Add workbook
   
2. 
   Duplicate Workbook
   
3. 
   Rename Workbook
   
4. 
   Load Workbook
   
5. 
   Load Workbook/Sheets
   
6. 
   Rename Sheet on Workbook
   
7. 
   Delete Sheet
   
8. 
   Add Sheet
   
9. 
   Update Sheet Order
   
10. 
    Load Sheet Cells
    
11. 
    Update Row Size
    
12. 
    Update Column Size
    
13. 
    Add Row
    
14. 
    Add Column
    
15. 
    Add Cell
    
16. 
    Update Cells
    

This module mainly meant to handle all the data handling associated with the groups and data.

1. 
   Create Group
   
2. 
   Rename Group
   
3. 
   Pin group
   
4. 
   Delete Group
   
5. 
   Sort Group
   
6. 
   Update Group Formula
   
7. 
   Update Group Size
   
8. 
   Update Group Sorting
   

DESC: Given that a user has registered, then the user should be able to retrieve his/her password by email.

DESC: All the user will have the option to login as demo user and can view some specific sheets, so that he can have a view of the application.

DESC: The nexcel Application is going to rich interface application associated with toomany dependency file need to be downloaded, There should not have too much delay in the initial loading of the application.

Initially it can give a glimpse of the view and the background it can load required files and data using some background processes.
ID: FR 4: Default WorkBook.

DESC: By Default the user will not be opened with any of the workbook, If the user doesn’t provided the workbook id, It should open a popup showing all his workbook in the Nexcel Cloud. Something thing like the windows file browser.

DESC: The user will be provided an option to add a new workbook, by giving a Modal window which prompts for the workbook name.

Process:

1. 
   User Enter the New WorkBook name
   
2. 
   If clicks OK, it sends Ajax request to server to Service WorkBook.addWorkBook and comes back with new WorkBook Id.
   
3. 
   Reload the page with the new workbook it.
   
4. 
   If the user clicks Cancel/Close, the window will be closed.
   

Requires: FR3, WorkBookService.addWorkBook

DESC: The user will be provided an option to duplicate a workbook, by giving a Modal window which prompts to confirm the duplicate or not.

Requires: WorkBookService.duplicateWorkBook

ID: FR 7:Add Sheet

1. 
   On user clicking the + button a new sheet will be added.
   
2. 
   It calls the server service WorkBook.addSheet and comes back with new SheetId.
   
3. 
   The screen will activate with new Sheet with 100 rows & 26 columns default
   
4. 
   The default name will be Sheet + the number  total sheets found.
   

Requires: FR1, WorkBookService.addSheet

ID: FR 8: Delete Sheet

1. 
   On user clicking the delete menu in the Sheet TAB, It will prompt “Do you want to delete or not”.
   
2. 
   It calls the server service WorkBook.deleteSheet
   
3. 
   The screen will activate with next available sheet
   
4. 
   If there is any group dependency is available a Warning will be shown that, you cannot delete this sheet, first you should delete all the dependencies.
   

Requires: FR1, WorkBookService.deleteSheet

ID: FR 9: Rename Sheet

Process:

1. 
   On user clicking the rename menu in the Sheet TAB, It will prompt a Modal with old name populated, asking for new Name.
   
2. 
   It calls the server service WorkBook.renameSheet
   
3. 
   It will check whether the same is already existing or not, If yes, a warning message will be shown.
   

Requires: FR1, WorkBookService. renameSheet

ID: FR 10: Select single cell

Process:

1. 
   On user clicking any cell the cell border will be colored to highlight.
   
2. 
   Must maintain the current selection of the cell.
   
3. 
   On cell selected the Row and column bar should be highlighted
   
4. 
   The header should change to the current cell name.
   

ID: FR 11: Select cell area

Process:

1. 
   On user clicking any cell the cell border will be colored to highlight.
   
2. 
   Must maintain the current selection of the cell area.
   

ID: FR 12: Context menu

As follows.

Row Number

1. 
   Insert Row Above
   
2. 
   Insert Row Below
   
3. 
   Delete Row
   
4. 
   Clear Row
   

1. 
   Insert Column Above
   
2. 
   Insert Column Below
   
3. 
   Delete Column
   
4. 
   Clear Column
   

1. 
   Cut
   
2. 
   Copy
   

1. 
   Cut
   
2. 
   Copy
   
3. 
   Create Group
   

1. 
   Copy
   
2. 
   Copy Group values
   
3. 
   Edit Group
   
4. 
   Delete Group
   
5. 
   Insert Group Formula
   

1. 
   Copy
   
2. 
   Copy Group values
   
3. 
   Edit Group
   
4. 
   Explain
   
5. 
   Delete Group
   
6. 
   Remove Group Formula
   
7. 
   View Evaluation Graph
   

ID: FR 13: Mouse Left Click

Click on Cell

1. 
   The cell should be activated – FR:10
   
2. 
   If cell has formula the formula bar should be updated.
   
3. 
   The cell name should be updated in near the formula bar.
   

Requires: FR1, FR11, FR12

ID: FR 13: Mouse Right Click

Click on Cell

1. 
   The context menu should be poped up.– FR:10
   
2. 
   If cell has formula the formula bar should be updated.
   
3. 
   The cell name should be updated in near the formula bar.
   

Requires: FR1, FR10,FR11

1. 
   The context menu should be poped up.– FR:11
   
2. 
   If cell has formula the formula bar should be updated.
   
3. 
   The context menu should have an option to create a Group.
   

ID: FR 14: Create Group

Requires: FR13

Column 4tion

Column 3tion

Column 2tion

Column 1tion

With Selection

With Rangetion

Process

1. 
   The user must provide the Group name, It should be distinct
   
2. 
   The group name should not be existing.
   
3. 
   If select column name, the name of the column should be provided.
   

ID: FR 13: Insert group formula – Formula Editor

The formula will be parsed and evaluated.

1. 
   On the editor user will have option auto suggested to enter the formula – Will do later
   
2. 
   The formula must follow similar to the prolog implementation
   
3. 
   Auto suggestion should be implemented
   

ID: FR 13: Explanation

This chapter gives an estimation of the computer resources which are needed to develop and operate Nexcel.

Chapter 7

Tracing software requirements to components is vital in the software production process. It allows developers to relate specific parts of the software to the user requirements. In this way, each developer should know what a component’s purpose is.