FinHub User Guide

FinHub is a desktop app for insurance agents to manage clients. It helps them to better organise all information related to each client, optimised for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, FinHub can get your client management tasks done faster than traditional GUI apps.

---

Target User and Assumptions Made

Our target users are insurance agents who:

• manage many existing and potential clients.
• may need to find contacts of particular clients.
• have to keep track of many meetings with clients.
• need to keep track of a huge amount of client information.
• have client of different priorities.
• can type fast and prefer typing commands to interacting with UI.
• are equipped with basic CLI knowledge.
• have Singaporean clients with English names.

---

Table of Contents

• 1. Quick Start
• 2. Features
  • 2.1 General Commands
    • 2.1.1 Viewing Help : help
    • 2.1.2 Listing all Clients : list
    • 2.1.3 Listing all active Clients : activelist
    • 2.1.4 Listing all archived Clients : archivelist
    • 2.1.5 Clear all Entries : clear
    • 2.1.6 Exiting the Program : exit
  • 2.2 Managing Clients
    • 2.2.1 Adding a Client : add
    • 2.2.2 Deleting a Client : delete
    • 2.2.3 Editing a Client : edit
    • 2.2.4 Locating a Client : find
    • 2.2.5 Staring a Client : star
    • 2.2.6 Removing Star of a Client : unstar
    • 2.2.7 Archiving a Client : archive
    • 2.2.8 Unarchiving a Client : unarchive
  • 2.3 Reminders
    • 2.3.1 Adding a Reminder : reminder
    • 2.3.2 Deleting a Reminder : rDelete
    • 2.3.3 Editing a Reminder : rEdit
  • 2.4 Meeting Notes
    • 2.4.1 Adding a Meeting Note : note
    • 2.4.2 Deleting a Meeting Note : nDelete
• 3. Data and Storage
  • 3.1 Saving the Data
  • 3.2 Editing the Data File
  • 3.3 Transferring Data to another Computer
• 4. FAQ
• 5. Known Issues
• 6. Command Summary
• 7. Glossary

---

1. Quick Start

1. Make sure you have Java 17 or above installed in your computer.
   Mac users: Make sure you have the precise JDK version listed here.

2. Download the latest .jar file from here.

3. Copy the file to the folder you want to use as the home folder for FinHub.

4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar FinHub.jar command to run the application.
   A window like the one below will appear after a few seconds. Note how the app contains some sample data.
   

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.
   Some example commands you can try:

   • list : Lists all contacts.

   • add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 ip/AIB Premium Plan : Adds a contact named John Doe to FinHub.

   • delete 3 : Deletes the 3rd contact shown in the current list.

   • clear : Deletes all contacts.

   • exit : Exits the app.

   • reminder 2 h/Meeting on Friday d/2026-04-24 16:00 : Adds a reminder with header Meeting on Friday to client index 2.

6. Refer to the Features below for details of each command.

---

2. Features

2.1 General Commands

2.1.1 Viewing help : help

Displays a message explaining how to access the help page.

Format: help

---

2.1.2 Listing all clients : list

Displays a complete list of all clients in the FinHub system, including both active and archived clients.

Format: list

Below is an image showing what you should expect to see after running the list command with sample data.

---

2.1.3 Listing active clients : activelist

Displays only the active clients currently in the FinHub system.

Format: activelist

---

2.1.4 Listing archived clients : archivelist

Displays all clients who have been archived in the FinHub system, meaning they are no longer active.

Format: archivelist

---

2.1.5 Clearing all entries : clear

Clears all entries in FinHub, including client data, records, and any stored information.

Format: clear

---

2.1.6 Exiting the program : exit

Exits FinHub.

Format: exit

---

2.2 Managing Clients

2.2.1 Adding a client : add

Adds a client to FinHub.

Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS ip/INSURANCE_POLICY [t/TAG]…​

Examples:

• add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 ip/AIB Premium Plan

• add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Palace street, block 456, #03-03 p/1234567 t/classmate ip/AIB LifePlan

---

2.2.2 Deleting a client : delete

Deletes a specified client from FinHub.

Format: delete CLIENT_INDEX

• Deletes the client at the specified CLIENT_INDEX.
• CLIENT_INDEX refers to the index number of the client shown in the currently displayed clients list.

Examples:

• activelist followed by delete 2 deletes the 2nd client in the currently displayed clients list.

• find alex followed by delete 1 deletes the 1st client in the results of the find command.

---

2.2.3 Editing a client : edit

Edits an existing client in FinHub.

Format: edit CLIENT_INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​ [ip/INSURANCE_POLICY]

• Edits the client at the specified CLIENT_INDEX.
• CLIENT_INDEX refers to the index number of the client shown in the displayed clients list.
• 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 client will be removed i.e adding of tags is not cumulative.
• You can remove all the client’s tags by typing t/ without specifying any tags after it.

Examples:

• activelist followed by edit 1 p/91234567 ip/Health policy changes the 1st client’s PHONE to 91234567 and INSURANCE_POLICY to Health policy respectively in the currently displayed client list.

• find alex yeoh followed by edit 1 n/Alex Tan t/ changes the name of the first client in the results of the find command to Alex Tan and clears all his existing tags.

---

2.2.4 Locating clients by name : find

Finds clients whose names contain any of the given keywords.

Format: find KEYWORD [MORE_KEYWORDS]

• The search is case-insensitive.
• The order of the keywords does not matter.
• Only the name is searched.
• Clients matching at least one keyword will be returned (i.e. OR search).

Examples:

• find ale returns Alex Yeoh.

• find Yu Ber returns Bernice Yu.
• find Alex David returns Alex Yeoh, David Li.
  

---

2.2.5 Starring a client : star

Stars the specified client in FinHub. Starred clients will have a star displayed next to their name, and will be bumped to the top of the displayed clients lists along with other starred clients.

Format: star CLIENT_INDEX

• Stars the client at the specified CLIENT_INDEX.
• CLIENT_INDEX refers to the index number of the client shown in the currently displayed clients list.
• You can only star one client at a time.

Examples:

• activelist followed by star 1 stars the 1st client in the currently displayed clients list.
• activelist followed by star 2 stars the 2nd client in the currently displayed clients list.
• find Alex followed by star 1 stars the 1st client in the results of the find command.

---

2.2.6 Removing star status of a client : unstar

Removes the starred status of a specified client in FinHub.

Format: unstar CLIENT_INDEX

• Removes the starred status of the client at the specified CLIENT_INDEX.
• CLIENT_INDEX refers to the index number of the client shown in the currently displayed clients list.
• You can only remove the star status from one client at a time.

Examples:

• activelist followed by unstar 1 removes star status from the 1st client in the currently displayed clients list.
• activelist followed by unstar 2 removes star status from the 2nd client in the currently displayed clients list.
• find Alex followed by unstar 1 removes star status from the 1st client in the results of the find command.

---

2.2.7 Archiving a client : archive

Archives the specified client in FinHub.

Format: archive CLIENT_INDEX

• Archives the client at the specified CLIENT_INDEX.
• CLIENT_INDEX refers to the index number of the client shown in the displayed clients list.
• You can only archive one client at a time.

Examples:

• activelist followed by archive 1 archives the 1st client in the displayed clients list.
• find Alex followed by archive 1 archives the 1st client in the results of the find command if he is not archived.

---

2.2.8 Unarchiving a client : unarchive

Unarchives the specified client in FinHub.

Format: unarchive CLIENT_INDEX

• Unarchives the client at the specified CLIENT_INDEX
• CLIENT_INDEX refers to the index number of the client shown in the archived clients list.
• You can only unarchive one client at a time.

Examples:

• archivelist followed by unarchive 1 unarchives the 1st client in the displayed clients list
• find Alex followed by unarchive 1 unarchives the 1st client in the results of the find command if he is archived.

---

2.3 Reminders

2.3.1 Adding a reminder : reminder

Adds a reminder to a specified client in FinHub.

Format: reminder CLIENT_INDEX h/HEADER d/DEADLINE

• Adds a reminder to the client at the specified CLIENT_INDEX.
• A reminder consists of a HEADER which describes the task or event, and a DEADLINE which indicates when it's due.
• HEADER cannot be empty.
• DEADLINE should be in the format: yyyy-MM-dd HH:mm
• CLIENT_INDEX refers to the index number of the client shown in the currently displayed clients list.
• Both HEADER and DEADLINE must be provided.
• You can only add one reminder at a time.
• You can add more than one reminder to each client.

Examples:

• activelist followed by reminder 2 h/Meeting on Friday d/2026-04-24 16:00 adds the reminder "Meeting on Friday, due by 2026-04-24 16:00" to the 2nd client in the currently displayed clients list.

• find alex followed by reminder 1 h/Meeting on Saturday d/2026-06-24 18:00 adds the reminder "Meeting on Saturday, due by 2026-06-24 18:00" to the 1st client in the results of the find command.

---

2.3.2 Deleting a reminder : rDelete

Deletes a reminder from a specified client in FinHub.

Format: rDelete CLIENT_INDEX REMINDER_INDEX

• Deletes the reminder at the specified REMINDER_INDEX of the specified client at CLIENT_INDEX.
• CLIENT_INDEX refers to the index number of the client shown in the currently displayed clients list.
• REMINDER_INDEX refers to the index number of the reminder shown in the specified client's currently displayed reminders list.
• Both CLIENT_INDEX and REMINDER_INDEX must be provided.
• You can only delete one reminder at a time.

Examples:

• activelist followed by rDelete 2 1 deletes the 1st reminder in the currently displayed reminders list of the 2nd client in the currently displayed clients list.

• find alex followed by rDelete 1 1 deletes the 1st reminder in the currently displayed reminders list of the 1st client in the results of the find command.

---

2.3.3 Editing a reminder : rEdit

Edits a specified reminder from a specified client in FinHub.

Format: rEdit CLIENT_INDEX REMINDER_INDEX h/HEADER d/DEADLINE

• Edits the reminder at the specified REMINDER_INDEX of the specified client at CLIENT_INDEX.
• h/HEADER refers to the header of the edited reminder.
• d/DEADLINE refers to the deadline of the edited reminder.
• CLIENT_INDEX refers to the index number of the client shown in the currently displayed clients list.
• REMINDER_INDEX refers to the index number of the reminder shown in the specified client's currently displayed reminders list.
• Both CLIENT_INDEX and REMINDER_INDEX must be provided.
• You can only replace one reminder with a new reminder at a time.

Examples:

• activelist followed by rEdit 2 1 h/Meeting on Friday d/2026-04-24 16:00 edits the 1st reminder in the currently displayed reminders list of the 2nd client in the currently displayed clients list to "Meeting on Friday, due by 2026-04-24 16:00".

• find alex followed by rEdit 1 1 h/Meeting on Friday d/2026-04-24 16:00 edits the 1st reminder in the currently displayed reminders list of the 1st client in the results of the find command to "Meeting on Friday, due by 2026-04-24 16:00".

---

2.4 Meeting Notes

2.4.1 Adding a meeting note : note

Adds a meeting note to a specified client in FinHub.

Format: note CLIENT_INDEX TEXT

• Adds a meeting note to the client at the specified CLIENT_INDEX
• When adding a meeting note, FinHub automatically records the date and time the note was added.
• CLIENT_INDEX refers to the index number of the client shown in the currently displayed clients list.
• TEXT refers to the content of the meeting note that you want to add to the specified client.
• TEXT cannot be empty.
• You can only add one meeting note at a time.
• You can add more than one meeting note to each client.

Examples:

• activelist followed by note 2 Client wants to renew policy adds the meeting note "Client wants to renew policy" to the 2nd client in the currently displayed clients list.

• find alex followed by note 1 Client wants to know about policy 2 adds the meeting note "Client wants to know more about policy 2" to the 1st client in the result of the find command.

---

2.4.2 Deleting a meeting note : nDelete

Deletes a meeting note from a specified client in FinHub.

Format: nDelete CLIENT_INDEX MEETING_NOTE_INDEX

• Deletes the meeting note at the specified MEETING_NOTE_INDEX of the specified clients listed at CLIENT_INDEX.
• CLIENT_INDEX refers to the index number of the client shown in the currently displayed clients list.
• MEETING_NOTE_INDEX refers to the index number of the meeting note shown in the specified client's displayed meeting notes list.
• Both CLIENT_INDEX and MEETING_NOTE_INDEX must be provided.
• You can only delete one meeting note at a time.

Examples:

• activelist followed by nDelete 2 1 deletes the 1st meeting note in the displayed meeting notes list of the 2nd client in the currently displayed clients list.

• find alex followed by nDelete 1 1 deletes the 1st meeting note in the displayed meeting notes list of the 1st client in the results of the find command.

---

3. Data and Storage

3.1 Saving the data

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

---

3.2 Editing the data file

FinHub data are saved automatically as a JSON file [JAR file location]/data/finhub.json. Advanced users are welcome to update data directly by editing that data file.

---

3.3 Transferring Data to another Computer

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 FinHub home folder.

---

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 by copying the entire previous data/finhub.json file to the same location

Q: What happens if I make a mistake when entering client information?
A: No worries! You can use edit or rEdit to update the wrong field.

Q: Why are there already random people in my FinHub when I launch the application?
A: These pre-existing clients are sample data. You may simply use clear to remove them.

Q: I mistyped a client’s details. How do I update just one or two fields?
A: Use edit with only the fields you want to change, e.g. edit 2 p/91234567 e/new@example.com. Existing values not mention will be kept.

Q: How do I remove all tags from a client?
A: Type t/ with nothing after it in the edit command, e.g. edit 3 t/. This clears all tags.

Q: Can I search by more than just name?
A: Right now, find searches names only. It’s case-insensitive and matches full words.

Q: FinHub won’t load; did I break the data file?
A: If the data/finhub.json file is edited manually and becomes invalid, FinHub starts empty. Restore a backup of that file or delete it to regenerate sample data. Try to avoid hand-editing it.

Q: Do commands accept parameters in any order?
A: Yes. For example, both of these are valid:

add n/Amy p/9123 e/amy@x.com a/Bishan ip/AIB Premium Plan

add p/9123 a/Bishan ip/AIB Premium Plan e/amy@x.com n/Amy

---

5. Known Issues

1. When using multiple screens, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. To fix this, delete the preferences.json file created by the application, then restart the app.
2. If you minimise the Help Window, then run the help command (or use the Help menu, or the keyboard shortcut F1) again, the original Help Window will remain minimised, and no new Help Window will appear. To fix this, manually restore the minimised Help Window.

---

6. Command Summary

7. Glossary