AstrolabeCAE/astronote
AstrolabeCAE/astronote
2
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Update SpecificationAstronotes.md (edit some markdown layout)

Browse Source
This commit is contained in:
Emeline 2020-07-10 18:19:11 +02:00
parent 3b6468360b
commit faf32909d5
1 changed files with 67 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

128
SpecificationAstronotes.md
View File

@ -13,14 +13,14 @@
##### Work packages: ##### Work packages:
- **Step 1**: - **Step 1**:
Prototype allowing input of expense date, type and charge (incl. and excl. taxes) | Prototype allowing input of expense date, type and charge (incl. and excl. taxes)
Using local data (typed objects and binaries) | Using local data (typed objects and binaries)
Secured data upload to enDI EAS (enDI itself might need some work to ensure compatibility) Secured data upload to enDI EAS (enDI itself might need some work to ensure compatibility)
- **Step 2**: - **Step 2**:
File attachment system and overhauled user interface | File attachment system and overhauled user interface
Using uploaded snapshot of expense document as supporting document | Using uploaded snapshot of expense document as supporting document
OCR-based data input autocompletion based on said snapshot | OCR-based data input autocompletion based on said snapshot
Using OCR software components from open-source repository or Android standard API Using OCR software components from open-source repository or Android standard API
- **Environment**: Android / Lineage operating systems, F-Droid / Play Store app stores, free software, EAS - **Environment**: Android / Lineage operating systems, F-Droid / Play Store app stores, free software, EAS
--- ---
@ -32,13 +32,16 @@ Baseline scenario:
2. User inputs username (i.e. e-mail address) and password in login form then submits 2. User inputs username (i.e. e-mail address) and password in login form then submits
3. If necessary, user can visit enDI official website using URL 3. If necessary, user can visit enDI official website using URL
4. If necessary, user can visit Astrolabe official website using URL 4. If necessary, user can visit Astrolabe official website using URL
Connection to enDI is automated with REST API. Sessions are cookie-based. Connection to enDI is automated with REST API
Sessions are cookie-based
[ ] ==**DASHBOARD**== [ ] ==**DASHBOARD**==
Dashboard ensures draft and unvalidated expense reports management, sorted by year and company. Within each year sorted in decending order, expense reports are sorted by month in ascending order. Every expense report in the dashboard features the following parameters: Dashboard ensures draft and unvalidated expense reports management, sorted by year and company
Within each year sorted in decending order, expense reports are sorted by month in ascending order
Every expense report in the dashboard features the following parameters:
- Expense status (validated, unvalidated or draft) - Expense status (validated, unvalidated or draft)
- Expense data (date, charge incl. and excl. taxes, VAT, distance) - Expense data (date, charge incl. and excl. taxes, VAT, distance)
- Sum data (total incl. and excl. taxes, total VAT, total distance) - Sum data (total incl. and excl. taxes, total VAT, total distance)
@ -60,7 +63,7 @@ Expense report dashboard allows user to keep track of:
- Saved comments (including writer name, writing date and comment content) - Saved comments (including writer name, writing date and comment content)
- Business expenses - Business expenses
Expenses are divided into two sections : costs related to a company (Costs) and the costs related to a customer (Purchases). Expenses are divided into two sections : costs related to a company (Costs) and the costs related to a customer (Purchases)
Expenses include : Expenses include :
- date, type, description, charge incl. and excl. taxes, VAT - date, type, description, charge incl. and excl. taxes, VAT
- for mileage expense : date, type, provision, origin, destination, distance - for mileage expense : date, type, provision, origin, destination, distance
@ -77,7 +80,9 @@ Baseline scenario:
2. User inputs date (month and year), with current date as default 2. User inputs date (month and year), with current date as default
3. User confirms or cancels operation 3. User confirms or cancels operation
Expense reports ("Expense") are associated with expense sheets ("ExpenseSheet") which themselves are associated with user account ("User") and company ("Company"). Expense reports are created as parts of an expense sheet, which need to be created first. Newly created expense reports are automatically saved as drafts. Expense reports ("Expense") are associated with expense sheets ("ExpenseSheet") which themselves are associated with user account ("User") and company ("Company")
Expense reports are created as parts of an expense sheet, which need to be created first
Newly created expense reports are automatically saved as drafts
[ ] ==**ADD BUSINESS-RELATED EXPENSE (company)**== [ ] ==**ADD BUSINESS-RELATED EXPENSE (company)**==
@ -88,14 +93,14 @@ Baseline scenario:
3. User can complete line charge form with appropriate data 3. User can complete line charge form with appropriate data
4. User confirms or cancels expense addition 4. User confirms or cancels expense addition
Overhead form data to be completed: date, group, type*, description, charge incl. and excl. taxes* - Overhead form data to be completed: date, group, type*, description, charge incl. and excl. taxes*
- Line charge form data to be completed: date*, type*, charge incl. and excl. taxes*
Line charge form data to be completed: date*, type*, charge incl. and excl. taxes* (* = required data for form validation)
(* = required data for form validation) If multiple VAT rates need to be provided, total sum should be input
If VAT is not deductible, charge incl. taxes should be input in "charge excl. taxes" field and 0 should be input in "VAT" field
If multiple VAT rates need to be provided, total sum should be input. If VAT is not deductible, charge incl. taxes should be input in "charge excl. taxes" field and 0 should be input in "VAT" field. Expense can only be added if expense report is already saved as draft
Expense can only be added if expense report is already saved as draft.
[ ] ==**EDIT BUSINESS-RELATED EXPENSE (company)**== [ ] ==**EDIT BUSINESS-RELATED EXPENSE (company)**==
@ -106,15 +111,14 @@ Baseline scenario:
3. User can complete line charge form with appropriate data (fields have current values as default values) 3. User can complete line charge form with appropriate data (fields have current values as default values)
4. User confirms or cancels expense edition 4. User confirms or cancels expense edition
Overhead form data to be completed: date, category, type*, description, charge incl. and excl. taxes* - Overhead form data to be completed: date, category, type*, description, charge incl. and excl. taxes*
- Line charge form data to be completed: date*, type*, charge incl. and excl. taxes*
Line charge form data to be completed: date*, type*, charge incl. and excl. taxes* (* = required data for form validation)
(* = required data for form validation) If multiple VAT rates need to be provided, total sum should be input
If VAT is not deductible, charge incl. taxes should be input in "charge excl. taxes" field and 0 should be input in "VAT" field
If multiple VAT rates need to be provided, total sum should be input. Expense can only be added if expense report is already saved as draft
If VAT is not deductible, charge incl. taxes should be input in "charge excl. taxes" field and 0 should be input in "VAT" field.
Expense can only be added if expense report is already saved as draft.
[ ] ==**ADD BUSINESS-RELATED TRAVEL EXPENSE (company)**== [ ] ==**ADD BUSINESS-RELATED TRAVEL EXPENSE (company)**==
@ -124,9 +128,9 @@ Baseline scenario:
2. User completes form with appropriate data 2. User completes form with appropriate data
3. User confirms or cancels expense addition 3. User confirms or cancels expense addition
Form data to be completed: date*, type*, provision, origin*, destination*, distance* - Form data to be completed: date*, type*, provision, origin*, destination*, distance*
(* = required data for form validation) (* = required data for form validation)
Expense can only be added if expense report is already saved as draft. Expense can only be added if expense report is already saved as draft.
@ -138,9 +142,9 @@ Baseline scenario:
2. User completes form with appropriate data (fields have current values as default values) 2. User completes form with appropriate data (fields have current values as default values)
3. User confirms or cancels expense addition 3. User confirms or cancels expense addition
Form data to be completed: date*, type*, provision, origin*, destination*, distance* - Form data to be completed: date*, type*, provision, origin*, destination*, distance*
(* = required data for form validation) (* = required data for form validation)
Expense can only be added if expense report is already saved as draft. Expense can only be added if expense report is already saved as draft.
@ -162,8 +166,8 @@ Baseline scenario:
2. User completes form with appropriate data (comments that are optional) 2. User completes form with appropriate data (comments that are optional)
3. User confirms or cancels 3. User confirms or cancels
Only draft expense reports can be saved. Only draft expense reports can be saved
Comments will be displayed in dashboard HCI from then on. Comments will be displayed in dashboard HCI from then on
[ ] ==**DELETE EXPENSE REPORT**== [ ] ==**DELETE EXPENSE REPORT**==
@ -173,7 +177,8 @@ Baseline scenario:
2. User is prompted for deletion confirmation as safety measure 2. User is prompted for deletion confirmation as safety measure
3. User confirms or cancels 3. User confirms or cancels
Only draft expense reports can be deleted. If deleted expense report was awaiting validation, it is returned to draft status and the validation process is automatically cancelled. Only draft expense reports can be deleted
If deleted expense report was awaiting validation, it is returned to draft status and the validation process is automatically cancelled
[ ] ==**SUBMIT EXPENSE REPORT FOR VALIDATION**== [ ] ==**SUBMIT EXPENSE REPORT FOR VALIDATION**==
@ -183,7 +188,8 @@ Baseline scenario:
2. User completes form with appropriate data (comment that is optional) 2. User completes form with appropriate data (comment that is optional)
3. User confirms or cancels 3. User confirms or cancels
User cannot (un)validate their own expense report; only the admin can. Expense reports might have another status but those are not accessible on the user's end. User cannot (un)validate their own expense report; only the admin can
Expense reports might have another status but those are not accessible on the user's end
---------- ----------
@ -195,12 +201,12 @@ Baseline scenario:
2. User completes form with appropriate data 2. User completes form with appropriate data
3. User confirms or cancels attachment 3. User confirms or cancels attachment
Form data to be completed: document type*, local image file*, description* - Form data to be completed: document type*, local image file*, description*
(* = required data for form validation) (* = required data for form validation)
Default description is image file name. Default description is image file name
Supporting documents can be joined regardless of expense report status. Supporting documents can be joined regardless of expense report status
[ ] ==**DELETE SUPPORTING DOCUMENT FROM EXPENSE**== [ ] ==**DELETE SUPPORTING DOCUMENT FROM EXPENSE**==
@ -212,7 +218,7 @@ Baseline scenario:
4. User is prompted for deletion confirmation as safety measure 4. User is prompted for deletion confirmation as safety measure
5. User confirms or cancels deletion 5. User confirms or cancels deletion
Supporting documents can be deleted regardless of expense report status. Supporting documents can be deleted regardless of expense report status
[ ] ==**EDIT SUPPORTING DOCUMENT FROM EXPENSE**== [ ] ==**EDIT SUPPORTING DOCUMENT FROM EXPENSE**==
@ -224,12 +230,12 @@ Baseline scenario:
4. User completes form with appropriate data (fields have current values as default values, including file) 4. User completes form with appropriate data (fields have current values as default values, including file)
5. User confirms or cancels edition 5. User confirms or cancels edition
Form data to be completed: document type*, local image file*, description* - Form data to be completed: document type*, local image file*, description*
(* = required data for form validation) (* = required data for form validation)
Default description is image file name. Default description is image file name
Supporting documents can be edited regardless of expense report status. Supporting documents can be edited regardless of expense report status
[ ] ==**GENERATE EXPENSE WITH OCR**== [ ] ==**GENERATE EXPENSE WITH OCR**==
@ -250,15 +256,14 @@ Baseline scenario:
3. User can complete line charge form with appropriate data 3. User can complete line charge form with appropriate data
4. User confirms or cancels expense addition 4. User confirms or cancels expense addition
Overhead form data to be completed: date, category, type*, description, charge incl. and excl. taxes* - Overhead form data to be completed: date, category, type*, description, charge incl. and excl. taxes*
- Line charge form data to be completed: date*, type*, charge incl. and excl. taxes*
Line charge form data to be completed: date*, type*, charge incl. and excl. taxes* (* = required data for form validation)
(* = required data for form validation) If multiple VAT rates need to be provided, total sum should be input
If VAT is not deductible, charge incl. taxes should be input in "charge excl. taxes" field and 0 should be input in "VAT" field
If multiple VAT rates need to be provided, total sum should be input. Expense can only be added if expense report is already saved as draft
If VAT is not deductible, charge incl. taxes should be input in "charge excl. taxes" field and 0 should be input in "VAT" field.
Expense can only be added if expense report is already saved as draft.
[ ] ==**EDIT CUSTOMER INTERACTION-RELATED EXPENSE**== [ ] ==**EDIT CUSTOMER INTERACTION-RELATED EXPENSE**==
@ -269,15 +274,14 @@ Baseline scenario:
3. User can complete line charge form with appropriate data (fields have current values as default values) 3. User can complete line charge form with appropriate data (fields have current values as default values)
4. User confirms or cancels expense edition 4. User confirms or cancels expense edition
Overhead form data to be completed: date, category, type*, description, charge incl. and excl. taxes* - Overhead form data to be completed: date, category, type*, description, charge incl. and excl. taxes*
- Line charge form data to be completed: date*, type*, charge incl. and excl. taxes*
Line charge form data to be completed: date*, type*, charge incl. and excl. taxes* (* = required data for form validation)
(* = required data for form validation) If multiple VAT rates need to be provided, total sum should be input
If VAT is not deductible, charge incl. taxes should be input in "charge excl. taxes" field and 0 should be input in "VAT" field
If multiple VAT rates need to be provided, total sum should be input. Expense can only be added if expense report is already saved as draft
If VAT is not deductible, charge incl. taxes should be input in "charge excl. taxes" field and 0 should be input in "VAT" field.
Expense can only be added if expense report is already saved as draft.
[ ] ==**ADD CUSTOMER INTERACTION-RELATED TRAVEL EXPENSE**== [ ] ==**ADD CUSTOMER INTERACTION-RELATED TRAVEL EXPENSE**==
@ -287,8 +291,10 @@ Baseline scenario:
2. User completes form with appropriate data 2. User completes form with appropriate data
3. User confirms or cancels expense addition 3. User confirms or cancels expense addition
Form data to be completed: date*, type*, provision, origin*, destination*, distance*, customer - Form data to be completed: date*, type*, provision, origin*, destination*, distance*, customer
(* = required data for form validation)
(* = required data for form validation)
Expense can only be added if expense report is already saved as draft Expense can only be added if expense report is already saved as draft
@ -299,11 +305,11 @@ Baseline scenario:
2. User completes form with appropriate data (fields have current values as default values) 2. User completes form with appropriate data (fields have current values as default values)
3. User confirms or cancels expense edition 3. User confirms or cancels expense edition
Form data to be completed: date*, type*, provision, origin*, destination*, distance*, customer - Form data to be completed: date*, type*, provision, origin*, destination*, distance*, customer
(* = required data for form validation) (* = required data for form validation)
Expense can only be added if expense report is already saved as draft. Expense can only be added if expense report is already saved as draft
[ ] ==**COPY EXPENSE**== [ ] ==**COPY EXPENSE**==
@ -313,7 +319,7 @@ Baseline scenario:
2. User specifies to which expense report the expense needs to be copied. Only expense reports already saved as drafts can be selected. Default value is current expense report 2. User specifies to which expense report the expense needs to be copied. Only expense reports already saved as drafts can be selected. Default value is current expense report
3. User confirms or cancels copy 3. User confirms or cancels copy
When user specifies in which expense report the expense needs to be copied, charge incl. and excl. VAT are displayed for clarity. When user specifies in which expense report the expense needs to be copied, charge incl. and excl. VAT are displayed for clarity
An expense can only be copied if expense report is already saved as draft An expense can only be copied if expense report is already saved as draft
@ -324,4 +330,4 @@ Baseline scenario:
2. User specifies month and year 2. User specifies month and year
3. User confirms or cancels 3. User confirms or cancels
Expense reports can be copied regardless of status, and copies will automatically be saved as drafts. Expense reports can be copied regardless of status, and copies will automatically be saved as drafts