Skip to content

Latest commit

 

History

History
194 lines (133 loc) · 5.81 KB

UserGuide.adoc

File metadata and controls

194 lines (133 loc) · 5.81 KB
Raw

Deliveria - User Guide

Group Name: CS2103-F14-4

By: Chee You, Rushagrid Kunthamas, Sam Yong Jek, Song Tianyi, Tan Jun Bang

Since: Jun 2016 Licence: MIT

1. Introduction

Deliveria is a desktop application that allows a delivery manager to manage and assign delivery tasks efficiently. While it consists of a Graphical User Interface (GUI) that is user-friendly, Deliveria is optimized for those who prefer to work with a Command Line Interface (CLI) which allows fast management of the delivery tasks in an organisation.

2. Getting Started

Ui
Figure 1. Draft UI mockup

  1. Ensure you have Java 11 or above installed in your Computer.

  2. Download the latest release deliveria.jar here.

  3. Copy the file to the folder you want to use as the home folder for your Address Book.

  4. Double-click the file to start the app. The GUI should appear in a few seconds.

  5. Type the command in the command box and press Enter to execute it. e.g. typing help and pressing Enter will open the help window.

  6. Some example commands you can try

    • Lists all contacts: list

    • Adds a contact named John Doe to the Address Book: Add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01

    • Deletes the 3rd contact shown in the current list: Delete 3

    • Exits the app: exit

  7. Refer to Section 3, “Features” for details of each command.

3. Features

Command Format

  • [action] [parameter 1] [parameter 2] [parameter 3]

  • Parameter consists of a delimiter and a word. For example, to tag a person on index 1: edit 1 t/ College

  • Commands are case sensitive

  • Order of parameter is can be reordered freely.

3.1. Viewing help : help

List all available commands Format: help

3.2. View delivery tasks: view

Lists all delivery tasks Format: list delivery

3.3. Get delivery details: read

Retrieves the details of 3rd task shown in the current list Format: list delivery

3.4. Listing all persons : list

Shows a list of all persons in the address book.
Format: list

3.5. Delete delivery tasks: delete

Deletes an existing task shown in the current list
Format: delete delivery INDEX

  • Deletes the task at the specified INDEX. The index refers to the index number shown in the displayed task list. The index must be a positive integer 1,2,3,…​

3.6. Update driver field for a delivery task: update

Attach an existing task shown in the current list to Driver: DriverName
Format: update delivery INDEX n/DriverName

  • Attaches the task at the specified INDEX to Driver: DriverName. The index refers to the index number shown in the displayed task list. The index must be a positive integer 1,2,3,…​

Examples:
* update delivery 3 n/John Doe

3.7. View list of drivers: list

List all drivers
Format: list drivers

3.8. Get driver details: read

Retrieves the details of an existing driver shown in current list
Format: read driver INDEX

  • Retrives the details of driver at specified INDEX. The index refers to the index number shown in the displayed driver list. The index must be a positive integer 1,2,3,…​

3.9. Delete a driver : delete driver

Deletes the specified driver from the driver list.
Format: delete driver INDEX

  • Deletes the driver at the specified INDEX.

  • The driver cannot be deleted if it’s already assigned to a task.

  • The index refers to the index numbers shown in the displayed driver’s list.

  • The index must be a positive integer 1, 2, 3, ..

Examples:

  • list
    delete driver 2
    Deletes the 2nd driver in the address book.

  • find Betsy
    delete 1
    Deletes the 1st person in the results of the find command.

3.10. Editing a driver : update driver

Edits an existing driver in the address book.
Format: update driver INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​

  • Edits the driver at the specified INDEX. The index refers to the index number shown in the displayed person list. The index must be a positive integer 1, 2, 3, …​

  • At least one of the optional fields must be provided.

  • Existing values will be updated to the input values.

Examples:

  • edit 1 p/91234567 e/[email protected]
    Edits the phone number and email address of the 1st person to be 91234567 and [email protected] respectively.

  • edit 2 n/Betsy Crower t/
    Edits the name of the 2nd person to be Betsy Crower and clears all existing tags.

3.11. Assign a task to a driver: assign

Assign an existing task a driver.
Format: assign TASK_INDEX DRIVER_INDEX

  • If the driver is not available for that task, an error message will be shown.

  • The indices refer to the numbers shown in the displayed lists.

Examples:

  • assign 1 3
    Assigns the task at index 1 to the driver at index 3.

3.12. Exiting the program : exit

Exits the program.
Format: exit

3.13. Saving the data

Address book data are saved in the hard disk automatically after any command that changes the data.
There is no need to save manually.

4. FAQ

Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Address Book folder.

Q: Where is the saved file at?
A: It is located in the same folder where the .jar file is. There will be a folder called data.

Q: How do I know the list of commands?
A: The help command will give a list of available commands.