From 3b6468360b728197ca02c68eb2ca8d12c2b79a89 Mon Sep 17 00:00:00 2001 From: Emeline Date: Fri, 10 Jul 2020 18:06:59 +0200 Subject: [PATCH] Update SpecificationAstronotes.md (edit some markdown layout) --- SpecificationAstronotes.md | 86 +++++++++++++++++++++++++------------- 1 file changed, 56 insertions(+), 30 deletions(-) diff --git a/SpecificationAstronotes.md b/SpecificationAstronotes.md index 8e392a7..76f4e0c 100644 --- a/SpecificationAstronotes.md +++ b/SpecificationAstronotes.md @@ -12,18 +12,21 @@ ##### Work packages: - **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) - **Step 2**: -File attachment system and overhauled user interface -Using uploaded snapshot of expense document as supporting document -OCR-based data input autocompletion based on said snapshot + +File attachment system and overhauled user interface | +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 - **Environment**: Android / Lineage operating systems, F-Droid / Play Store app stores, free software, EAS --- ## STEP 1 [ ] ==**CONNECTION**== + Baseline scenario: 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 @@ -56,8 +59,9 @@ Expense report dashboard allows user to keep track of: - Supporting document (or lack thereof) - Saved comments (including writer name, writing date and comment content) - Business expenses + 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 - for mileage expense : date, type, provision, origin, destination, distance @@ -85,10 +89,13 @@ Baseline scenario: 4. User confirms or cancels expense addition 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* + (* = 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. -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)**== @@ -100,11 +107,14 @@ Baseline scenario: 4. User confirms or cancels expense edition 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* + (* = 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 -Expense can only be added if expense report is already saved as draft + +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. [ ] ==**ADD BUSINESS-RELATED TRAVEL EXPENSE (company)**== @@ -115,8 +125,10 @@ Baseline scenario: 3. User confirms or cancels expense addition Form data to be completed: date*, type*, provision, origin*, destination*, distance* + (* = 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)**== @@ -127,8 +139,10 @@ Baseline scenario: 3. User confirms or cancels expense addition Form data to be completed: date*, type*, provision, origin*, destination*, distance* + (* = 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**== @@ -138,7 +152,7 @@ Baseline scenario: 2. User is prompted for deletion confirmation as safety measure 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**== @@ -148,8 +162,8 @@ Baseline scenario: 2. User completes form with appropriate data (comments that are optional) 3. User confirms or cancels -Only draft expense reports can be saved -Comments will be displayed in dashboard HCI from then on +Only draft expense reports can be saved. +Comments will be displayed in dashboard HCI from then on. [ ] ==**DELETE EXPENSE REPORT**== @@ -159,7 +173,7 @@ Baseline scenario: 2. User is prompted for deletion confirmation as safety measure 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**== @@ -182,9 +196,11 @@ Baseline scenario: 3. User confirms or cancels attachment Form data to be completed: document type*, local image file*, description* + (* = 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**== @@ -196,7 +212,7 @@ Baseline scenario: 4. User is prompted for deletion confirmation as safety measure 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**== @@ -209,9 +225,11 @@ Baseline scenario: 5. User confirms or cancels edition Form data to be completed: document type*, local image file*, description* + (* = 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**== @@ -233,11 +251,14 @@ Baseline scenario: 4. User confirms or cancels expense addition 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* + (* = 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 -Expense can only be added if expense report is already saved as draft + +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. [ ] ==**EDIT CUSTOMER INTERACTION-RELATED EXPENSE**== @@ -249,11 +270,14 @@ Baseline scenario: 4. User confirms or cancels expense edition 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* + (* = 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 -Expense can only be added if expense report is already saved as draft + +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. [ ] ==**ADD CUSTOMER INTERACTION-RELATED TRAVEL EXPENSE**== @@ -276,8 +300,10 @@ Baseline scenario: 3. User confirms or cancels expense edition Form data to be completed: date*, type*, provision, origin*, destination*, distance*, customer + (* = 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**== @@ -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 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 @@ -298,4 +324,4 @@ Baseline scenario: 2. User specifies month and year 3. User confirms or cancels -Expense reports can be copied regardless of status, and copies will automatically be saved as drafts \ No newline at end of file +Expense reports can be copied regardless of status, and copies will automatically be saved as drafts. \ No newline at end of file