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)

This commit is contained in:
Emeline 2020-07-10 18:06:59 +02:00
parent 9b53456105
commit 3b6468360b
1 changed files with 56 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
SpecificationAstronotes.md
View File

@ -12,18 +12,21 @@
##### Work packages: ##### Work packages:
- **Step 1**: - **Step 1**:
Prototype allowing input of expense date, type and charge (incl. and excl. taxes)
Using local data (typed objects and binaries) Prototype allowing input of expense date, type and charge (incl. and excl. taxes) |
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
Using uploaded snapshot of expense document as supporting document File attachment system and overhauled user interface |
OCR-based data input autocompletion based on said snapshot Using uploaded snapshot of expense document as supporting document |
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
--- ---
## STEP 1 ## STEP 1
[ ] ==**CONNECTION**== [ ] ==**CONNECTION**==
Baseline scenario: Baseline scenario:
1. Passive user logs in using custom URL and logs sent by admin or support team 1. Passive user logs in using custom URL and logs sent by admin or support team
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
@ -56,8 +59,9 @@ Expense report dashboard allows user to keep track of:
- Supporting document (or lack thereof) - Supporting document (or lack thereof)
- 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).
Expense 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
@ -85,10 +89,13 @@ Baseline scenario:
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)**==
@ -100,11 +107,14 @@ Baseline scenario:
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)**==
@ -115,8 +125,10 @@ Baseline scenario:
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.
[ ] ==**EDIT BUSINESS-RELATED TRAVEL EXPENSE (company)**== [ ] ==**EDIT BUSINESS-RELATED TRAVEL EXPENSE (company)**==
@ -127,8 +139,10 @@ Baseline scenario:
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.
[ ] ==**DELETE EXPENSE**== [ ] ==**DELETE EXPENSE**==
@ -138,7 +152,7 @@ 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 deletion 3. User confirms or cancels deletion
An expense can only be delete if expense report is already saved as draft An expense can only be delete if expense report is already saved as draft.
[ ] ==**SAVE EXPENSE REPORT**== [ ] ==**SAVE EXPENSE REPORT**==
@ -148,8 +162,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**==
@ -159,7 +173,7 @@ 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**==
@ -182,9 +196,11 @@ Baseline scenario:
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
Supporting documents can be joined regardless of expense report status Default description is image file name.
Supporting documents can be joined regardless of expense report status.
[ ] ==**DELETE SUPPORTING DOCUMENT FROM EXPENSE**== [ ] ==**DELETE SUPPORTING DOCUMENT FROM EXPENSE**==
@ -196,7 +212,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**==
@ -209,9 +225,11 @@ Baseline scenario:
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
Supporting documents can be edited regardless of expense report status Default description is image file name.
Supporting documents can be edited regardless of expense report status.
[ ] ==**GENERATE EXPENSE WITH OCR**== [ ] ==**GENERATE EXPENSE WITH OCR**==
@ -233,11 +251,14 @@ Baseline scenario:
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**==
@ -249,11 +270,14 @@ Baseline scenario:
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**==
@ -276,8 +300,10 @@ Baseline scenario:
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**==
@ -287,7 +313,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
@ -298,4 +324,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.