Skip to content

Latest commit

 

History

History
450 lines (332 loc) · 14.8 KB

UserGuide.adoc

File metadata and controls

450 lines (332 loc) · 14.8 KB
Raw

reInsurance - User Guide

By: T11-B3 Since: Jan 2018 Licence: MIT

1. Introduction

reInsurance is for those who prefer to use a desktop app for managing contacts. More importantly, reInsurance is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, reInsurance can get your contact management tasks done faster than traditional GUI apps. Interested? Jump to the Section 2, “Quick Start” to get started. Enjoy!

2. Quick Start

  1. Ensure you have Java version 1.8.0_60 or later installed in your Computer.

    ℹ️
    		 Having any Java 8 version is not enough.
    This app will not work with earlier versions of Java 8.

  2. Download the latest reInsurance.jar here.

  3. Copy the file to the folder you want to use as the home folder for your reInsurance application.

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

    Ui

  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:

    • list : lists all contacts

    • addn/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01 b/09-09-1995 : adds a contact named John Doe to the reInsurance.

    • delete3 : deletes the 3rd contact shown in the current list

    • exit : exits the app

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

3. Features

Command Format

  • Words in UPPER_CASE are the parameters to be supplied by the user e.g. in add n/NAME, NAME is a parameter which can be used as add n/John Doe.

  • Items in square brackets are optional e.g n/NAME [t/TAG] can be used as n/John Doe t/friend or as n/John Doe.

  • Items with …​ after them can be used multiple times including zero times e.g. [t/TAG]…​ can be used as   (i.e. 0 times), t/friend, t/friend t/family etc.

  • Parameters can be in any order e.g. if the command specifies n/NAME p/PHONE_NUMBER, p/PHONE_NUMBER n/NAME is also acceptable.

3.1. Viewing help : help

Format: help, Alias: h

💡
 The help page can be accessed by moving the mouse over Help section of the navigation bar then clicking Help. The help page can also be accessed by pressing F1 on the keyboard.

3.2. Alias of commands [Since V1.2]

  • Most of the common commands that are often used is tagged with an "Alias: " note.

  • If the features do not display any alias, it can be assumed to have none.

💡
 Alias feature can be easily used by replacing current command word with the alias

Examples:

  • a n/Jeremy p/82286918 e/[email protected] a/427, Yishun Ave 11 b/09-07-1995

  • e 1 i/General[200]

3.3. Adding a person: add

Adds a person to reInsurance
Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS b/BIRTHDAY [d/APPOINTMENT] [t/TAG] [i/INSURANCE[COMMISSION]] [g/GROUP] …​ Alias: a

💡
 A person can have any number of tags, appointment and insurance plans (including 0) but only one group Dates are in the format dd-mm-yyyy

Examples:

  • add n/John Doe p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 b/09-12-1994 d/05-05-2018 g/PRIORITY t/friends i/Health[30]

  • add n/Betsy Crowe t/friend e/[email protected] a/Newgate Prison p/1234567 b/29-10-1992 g/friends t/criminal i/General

3.3.1. Adding an insurance: Prefix: "i/"

Add one or more insurance to a person
Format: i/INSURANCE[COMMISSION]

💡
 A person can have any number of insurances, to add in the commission of a particular insurance simply put the amount immediately after the insurance name and inside a '[]' or a '{}' bracket.
ℹ️
 Insurance only accept alpha numeric characters and Commission needs to be non-negative

Examples: add n/Jeremy Lee p/82286918 e/[email protected] a/311, Clementi Ave 2, #02-25 b/09-12-1994 i/Health[10] i/General{20}

3.4. Colour Tag [Since V1.2]

Common tags in reInsurances are colour highlighted. Tags input type is non restrictive and up to the user’s imagination.

3.5. Listing all persons : list

Shows a list of all persons in reInsurance.
Format: list Alias: l

3.6. View number of persons : count

Returns the number of clients stored in the reInsurance application.
Format: count

3.7. Editing a person : edit

Edits an existing person in the reInsurance.
Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [b/BIRTHDAY] [d/APPOINTMENT] [t/TAG] [i/INSURANCE]…​ Alias: e

  • Edits the person at the specified INDEX. The index refers to the index number shown in the last person listing. 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.

  • When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.

  • You can remove all the person’s tags or insurance by typing t/ for tags and 'i/' for insurances without specifying any tags after it.

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.

💡
 Clearing the application can also be done by moving the mouse over File section of the navigation bar then clicking Clear.

3.8. Locating persons by name: find

Finds persons whose names contain any of the given keywords.
Format: find KEYWORD [MORE_KEYWORDS] Alias: f

  • The search is case insensitive. e.g hans will match Hans

  • The order of the keywords does not matter. e.g. Hans Bo will match Bo Hans

  • Only the name is searched.

  • Only full words will be matched e.g. Han will not match Hans

  • Persons matching at least one keyword will be returned (i.e. OR search). e.g. Hans Bo will return Hans Gruber, Bo Yang

Examples:

  • find John
    Returns john and John Doe

  • find Betsy Tim John
    Returns any person having names Betsy, Tim, or John

3.9. Locating persons by tag: findtag

Finds persons whose names contain any of the given tags.
Format: findtag KEYWORD [MORE_KEYWORDS]

  • The search is case insensitive. e.g friends will match Friends

  • The order of the tags does not matter. e.g. Friends Colleagues will match Colleagues Friends

  • Only the tag is searched.

  • Only full words will be matched e.g. Friend will not match Friends

  • Persons matching at least one tag will be returned (i.e. OR search).

Examples:

  • find Friends
    Returns any person having tag Friends

  • find Friends Colleagues Neighbours
    Returns any person having tags Friends, Colleagues, or Neighbours

3.10. Deleting a person : delete

Deletes the specified person from reInsurance.
Format: delete INDEX Alias: d

  • Deletes the person at the specified INDEX.

  • The index refers to the index number shown in the most recent listing.

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

Examples:

  • list
    delete 2
    Deletes the 2nd person in the reInsurance.

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

3.11. Selecting a person : select

Selects the person identified by the index number used in the last person listing.
Format: select INDEX Alias: s

  • Selects the person and loads the Google search page the person at the specified INDEX.

  • The index refers to the index number shown in the most recent listing.

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

Examples:

  • list
    select 2
    Selects the 2nd person in reInsurance.

  • find Betsy
    select 1
    Selects the 1st person in the results of the find command.

3.12. Listing entered commands : history

Lists all the commands that you have entered in reverse chronological order.
Format: history

ℹ️

Pressing the ↑ and ↓ arrows will display the previous and next input respectively in the command box.

3.13. Undoing previous command : undo

Restores reInsurance to the state before the previous undoable command was executed.
Format: undo Alias: u

ℹ️

Undoable commands: those commands that modify reInsurance’s content (add, delete, edit and clear).

Examples:

  • delete 1
    list
    undo (reverses the delete 1 command)

  • select 1
    list
    undo
    The undo command fails as there are no undoable commands executed previously.

  • delete 1
    clear
    undo (reverses the clear command)
    undo (reverses the delete 1 command)

3.14. Redoing the previously undone command : redo

Reverses the most recent undo command.
Format: redo Alias: r

Examples:

  • delete 1
    undo (reverses the delete 1 command)
    redo (reapplies the delete 1 command)

  • delete 1
    redo
    The redo command fails as there are no undo commands executed previously.

  • delete 1
    clear
    undo (reverses the clear command)
    undo (reverses the delete 1 command)
    redo (reapplies the delete 1 command)
    redo (reapplies the clear command)

3.15. Sorting all entries : sort

Sort all entries from reInsurance by given condition in lexicographical order.
Format: sort

3.16. Clearing all entries : clear

Clears all entries from reInsurance.
Alias: c
Format: clear Alias: c

💡
 Clearing all entries from reInsurance can also be done by moving the mouse over File section of the navigation bar then clicking Clear.

3.17. Export data : export

Exports the data from the specified export type: calendar or portfolio (case insensitive).
Format: export EXPORT_TYPE

Exports the portfolio to a specified export location.
Format export portfolio FILENAME.

ℹ️

  • Coming in v2.0, there will be more options on the types of data to export.

  • As of v1.5, the application handles the command for the portfolio and calendar.

  • Default destination file is at portfolio.csv for the export portfolio command.

  • The default calendar created in Google Calendars is titled reInsurance Events, which contains birthdays and appointments.

  • Coming in v2.0, the user will be able to specify what the created calendar is called.

Examples:

  • export calendar
    Exports the birthday and appointment data to Google Calendar

    • When running this command, you will be prompted to enter your credentials to your Google Account. DO NOT EXIT THE BROWSER. This will stall the application.

    • After entering credentials, you will be asked if reInsurance can access your account at a page as pictured in Figure 1.

    • Hit ALLOW to proceed the export or CANCEL to deny reInsurance access.

calendar access
Figure 1. Authorization Window

  • export portfolio
    Exports the data in the portfolio to a portfolio.csv file.

  • export portfolio my_data
    Exports the data in the portfolio to a my_data.csv file.

3.18. Group entries : group

Group all entries under the same group from reInsurance.
Format: group Alias: g

Examples:

  • group friends
    All entries under the group friends will be returned to the user as a list.

3.19. Password : password

Set a password for reInsurance as desired. No password required to access the program when using for the first time.
Format: password

Examples:

  • password set/yourpassword
    Password will be set as yourpassword.

  • password change/yournewpassword
    Password will be changed to yournewpassword.

  • password remove/yourexistingpassword
    Password will be removed.

ℹ️

  • Currently, there are no password recovery mechanism in place.

  • If users forget their password, please delete the password.txt file in the data folder to remove the password.

  • Coming in v2.0, there will be an option to retrieve your lost password via email.

  • Default destination file is at the data folder.

3.20. Exiting the program : exit

Exits the program.
Format: exit

💡
 Exiting the application can also be done by moving the mouse over File section of the navigation bar then clicking Exit.

3.21. Saving the data

reInsurance data are saved in the hard disk automatically after any command that changes the data.
There is no need to save manually. Data will be encrypted.

ℹ️
 The standard version of the JRE/JDK are under export restrictions. That also includes that some cryptographic algorithms are not allowed to be shipped in the standard version. Replace files in library with Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files 8. Download the files Here.

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 reInsurance folder.

Q: How do I delete an insurance tagged to a Client?
A: Use the edit command, e.g edit 1 i/ It is possible to edit current insurance plan with the same function too.

Q: Are there any restriction for the type of Insurance plan?
A: No, as the current market have countless type of insurance plan, and a the same time our product aim to be rigid against future addition of insurance plan, insurance type is thus not restricted as long as it is alpha numeric.

5. Command Summary

  • Add add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​
    e.g. add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 b/09-09-1995 t/friend t/colleague i/Health[30]

  • Clear : clear

  • Delete : delete INDEX
    e.g. delete 3

  • Edit : edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​
    e.g. edit 2 n/James Lee e/[email protected]

  • Find : find KEYWORD [MORE_KEYWORDS]
    e.g. find James Jake

  • Findtag : findtag TAG
    e.g. findtag friends

  • List : list

  • Help : help

  • Select : select INDEX
    e.g.select 2

  • History : history

  • Undo : undo

  • Redo : redo

  • Count : count

  • Export : export
    e.g. export portfolio

  • Sort : sort

  • Group : group
    e.g. group priority

  • Password : password
    e.g. password set/123