User Guide

Table of Contents

• About FINDvisor
• Quick start
• Interacting with FINDvisor
  • On Command Success
  • On Command Failure
• Features
  • Adding a person: add
  • Listing all persons: list
  • Editing a person: edit
  • Searching persons by person’s information: find
  • Deleting a person: delete
  • Scheduling a meeting: schedule
  • Unscheduling a meeting: unschedule
  • Rescheduling a meeting: reschedule
  • Update remark of a person: remark
  • Adding tags to a person: addtag
  • Deleting tags from a person: deletetag
  • Clearing all entries: clear
  • Exiting the program: exit
  • Viewing help: help
  • Saving the data
  • Saving workspace preferences
• FAQ
• Known issues
• Command summary

About FINDvisor

FINDvisor is a desktop app for Singapore-based financial advisors who are comfortable using CLI applications and have to manage contacts with Singapore-based mobile phone numbers. If you frequently schedule meetings and require quick access to your contacts’ details, then FINDvisor is the tool for you. It is optimized for typists, enabling individuals who type fast to perform contact management and meeting scheduling tasks efficiently.

FINDvisor enables financial advisors to quickly save and retrieve their contacts’ information such as name, phone number, email, and physical address. It also allows financial advisors to add a remark and tags to specific contacts where needed, while offering the capability to manage their meeting details with their contacts.

Quick start

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

2. Download the latest findvisor.jar from here.

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

4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar findvisor.jar command to run the application. A GUI similar to the image below should appear in 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 : Adds a contact named John Doe to FINDvisor.

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

   • clear : Deletes all contacts.

   • exit : Exits the app.

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

Interacting with FINDvisor

The components of FINDvisor’s user interface are shown below:

1. Command Box: Commands are entered in this box and executed when the user presses the Enter key. The command entered will be cleared when a command is executed successfully.
2. Command Result Box: The feedback for commands will be displayed, indicating if a command was executed successfully. An error message will be displayed if a command is unsuccessful.
3. Person List: The list of persons stored in FINDvisor. Note that this list will display the latest list when a command to update the list is executed successfully.
4. Today’s Meeting List: The list of persons who have a meeting on the current date of your computer when running the application (if any). This list is updated accordingly to match the latest persons’ information in the Person List.

On Command Success

Below is a sample command that is executed successfully. Note that the feedback is displayed in the Command Result Box and the Person List displays the newly added person.

On Command Failure

Below is a sample unsuccessful command executed. Note that the command is highlighted in red in the Command Box and the Command Result Box displays the relevant error message.

Features

Adding a person: add

Adds a person to the contact list in FINDvisor.

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

• p/PHONE_NUMBER has to be unique from the other contacts in FINDvisor.

Tip: A person can have any number of tags (including 0).

Examples:

• add n/Bobby Tay p/9678 5432 e/BobbyTay@gmail.com a/Blk 123 Foo Street 45, #07-89 t/PRUactiveCash
• add n/Betsy Crowe t/PRUactiveCash e/betsycrowe@example.com a/Block 82 Marine Parade Central #01-600 p/9876 5432 t/PRUTravellerProtect

Listing all persons: list

Shows a list of all persons in the contact list of FINDvisor.

Format: list

Editing a person: edit

Edits an existing person’s contact information (name, phone number, email, and address) and tags in FINDvisor.

Format: edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​

• Edits the person at the specified INDEX.
• The index refers to the index number shown in the currently displayed person list.
• The index must be a positive integer 1, 2, 3, …​
• At least one of the optional fields must be provided.
• Input values will overwrite all existing values that were assigned to the specified field.
• When editing tags, existing tags will be overwritten with the new tags given.
• You can remove all the person’s tags by typing t/ without specifying any tags after it.
• This command will check for duplicate mobile phone numbers before the edit command is executed. If the new mobile phone number is used by another person, the command will not be executed.

Examples:

• edit 3 n/Bobby Tay e/bobbytay@u.nus.edu edits contact displayed at index 3 and changes the name of the contact to Bobby Tay and email to bobbytay@u.nus.edu respectively.
• edit 1 t/PRUActiveSaverIII t/PRUActiveCash edits contact displayed at index 1 to change its tags to only PRUActiveSaverIII and PRUActiveCash. It will remove all other tags that were previously associated with the contact.

Searching persons by person’s information: find

Finds persons that contain specified keywords based on a specified category of a person’s information.

Format:find n/NAME|e/EMAIL|p/PHONE_NUMBER|a/ADDRESS|r/REMARK|m/MEETING_DATE
|mr/MEETING_REMARK|t/TAG…

• Only one category can be specified and searched for any instance of the find command.
• Specified keywords must not be blank.
• User input will be validated only for find m/MEETING_DATE based on the DATE format.
  • For other categories, user input does not have to conform to the corresponding parameter format, e.g. find p/John, however, no persons will be matched.
• The search checks if a person’s information contains the keyword specified, e.g. find n/Ali will match Alice and Alicia Tay.
• The search is case-insensitive. e.g. find n/hans will match Hans.
• The order of keywords matters. e.g. find n/Doe John will not match John Doe.
• Multiple keywords can be specified for tags only.
  • Persons matching at least one of the specified tag keywords will be returned. e.g. find t/PRUActiveCash t/friends returns all persons with tags containing PRUActiveCash or friends.

Examples:

• find n/Alice returns all persons with the name containing Alice.
• find p/91234567 returns person with phone number 91234567.
• find mr/online meeting returns all persons with meeting remark containing online meeting.
• find m/23-10-2024 returns all persons with meetings on the date 23-10-2024.

Deleting a person: delete

Deletes the specified person from the contact list of FINDvisor.

Format: delete INDEX

• Deletes the person 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, …​
• The delete command only supports the deletion of one person at a time.

Examples:

• list followed by delete 2 deletes the 2nd person in the contact list of FINDvisor.
• find Betsy followed by delete 1 deletes the 1st person in the results of the find command.

Scheduling a meeting: schedule

Schedules a meeting with the specified person.

Format: schedule INDEX s/START_DATETIME e/END_DATETIME [mr/MEETING_REMARK]

• The index refers to the index number shown in the displayed person list.
• The index must be a positive integer 1, 2, 3, …​
• START_DATETIME must be after the system’s current datetime.
• END_DATETIME must be after START_DATETIME
• There can be at most one scheduled meeting with a person.
• If MEETING_REMARK is empty or consists entirely of whitespace characters, no meeting remark will be added.

Examples:

• schedule 1 s/23-06-2024T16:00 e/23-06-2024T17:00 mr/online meeting schedules a meeting with the person at index 1 from 23-06-2024 16:00 to 23-06-2024 17:00 with the remark online meeting.
• schedule 1 s/23-06-2024T16:00 e/23-06-2024T17:00 schedules a meeting with the person at index 1 from 23-06-2024 16:00 to 23-06-2024 17:00.

Unscheduling a meeting: unschedule

Unschedules a meeting with the specified person.

Format: unschedule INDEX

• The index refers to the index number shown in the displayed person list.
• The index must be a positive integer 1, 2, 3, …​
• The specified person must have a meeting scheduled.

Examples:

• unschedule 1 unschedules the meeting with the person at index 1.

Rescheduling a meeting: reschedule

Allows the currently scheduled meeting details to be edited.

Format: reschedule INDEX [s/START_DATETIME] [e/END_DATETIME] [mr/MEETING_REMARK]

• The index refers to the index number shown in the displayed person list.
• The index must be a positive integer 1, 2, 3, …​
• The specified person must have a meeting scheduled.
• At least one of the optional fields must be provided.
• Input values will overwrite existing values that were assigned to the specified field.
• START_DATETIME must be after the system’s current datetime.
• END_DATETIME must be after START_DATETIME
• If MEETING_REMARK is empty or consists entirely of whitespace characters, the command will remove the existing meeting remark.

Examples:

• reschedule 1 s/23-06-2024T16:00 e/23-06-2024T17:00 reschedules the meeting with the person at index 1 to start at 23-06-2024 16:00 and end at 23-06-2024 17:00.
• reschedule 1 mr/online meeting changes the meeting remark of the meeting with the person at index 1 to online meeting.

Update remark of a person: remark

Updates the remark of a specified person.

This command is useful for adding additional information about a person, such as their birthday or financial goals, that is not covered by a person’s contact information.

Format: remark INDEX r/[REMARK]

• Updates the remark of a person 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, …​
• If there is an existing remark, it will be overwritten with the new REMARK.
• If REMARK is empty or consists entirely of whitespace characters, the command will remove the existing remark.

Examples:

• remark 1 r/Plans to own a house by age 35 updates the remark of the person at index 1 to Plans to own a house by age 35.
• remark 2 r/ updates the remark of the person at index 2 to be empty.

Adding tags to a person: addtag

Adds 1 or more tags to a specified person from the contact list of FINDvisor.

This command makes it easier to add tags to a person without having to re-type all existing tags using the edit command.

Format: addtag INDEX t/TAG...

• Adds 1 or more tags to the person 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 1 TAG must be provided.

Examples:

• list followed by addtag 1 t/PRUSafe365 adds PRUSafe365 to the 1st person in the contact list of FINDvisor.
• find n/Holly followed by addtag 1 t/PRUSafe365 t/PRUGrowth adds both PRUSafe365 and PRUGrowth to the 1st person in the results of the find command.

Deleting tags from a person: deletetag

Deletes 1 or more tags from a specified person from the contact list of FINDvisor.

This command makes it easier to remove tags from a person without having to re-type all tags that should be kept using the edit command.

Format: deletetag INDEX t/TAG...

• Deletes 1 or more tags from the person 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 1 TAG must be provided.
• The specified person must have all the specified TAG.

Examples:

• deletetag 1 t/friends t/family deletes the tags friends and family of the person at index 1 in the contact list of FINDvisor.
• find n/Alex followed by deletetag 1 t/PRUSafe365 t/PRUGrowth deletes both PRUSafe365 and PRUGrowth to the 1st person in the results of the find command.

Clearing all entries: clear

Clears all entries from the contact list of FINDvisor.

Warning:
FINDvisor will not prompt for confirmation and will result in permanent deletion of all contacts in FINDvisor. This action is irreversible and there will be no way to retrieve the data unless there is a backup copy of the JSON data file.

Format: clear

Exiting the program: exit

Exits the program.

Format: exit

Viewing help: help

Shows a message explaining how to access the help page.

Format: help

Saving the data

FINDvisor data are saved in the hard disk automatically as a JSON file after any command that changes the data, with the corresponding path [JAR file location]/data/addressbook.json. There is no need to save manually.

Saving workspace preferences

FINDvisor automatically saves workspace preferences to a file location specified in the JSON file [JAR file location]/config.json upon closing FINDvisor. By default, workspace preferences are saved to the JSON file [JAR file location]/preferences.json. There is no need to save manually.

The workspace preferences include the following:

• Position of FINDvisor’s main window.
• Width and height of FINDvisor’s main window when it is not maximized.
• State of FINDvisor’s main window, whether it is maximized or not.
• Divider position between Today’s Meeting List and the other components in FINDvisor’s main window.

This allows FINDvisor to restore most of the window settings on the next startup, requiring minimal adjustments for users that have a preferred layout when using FINDvisor.

FAQ

Q: What is the difference between a person and a contact in the user guide?
A: These two terms are used interchangeably, i.e. a contact is a person stored in FINDvisor and vice versa.

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

Q: Can I edit the JSON data file directly?
A: We do not support direct editing of any JSON files.

Warning:
If your changes to the data file make its format invalid, FINDvisor will discard all data and start with an empty data file at the next run. Furthermore, certain edits can cause the FINDvisor to behave in unexpected ways (e.g. if a value entered is outside of the acceptable range).

Q: Can I edit the workspace preferences JSON file directly?
A: We do not support direct editing of any JSON files.

Warning:
Certain edits can cause the FINDvisor to behave in unexpected ways and possibly not start correctly.

Q: How can I generate the sample contacts that are shown when I first launched FINDvisor?
A: Sample contacts are generated when JSON file [JAR file location]/data/addressbook.json is not found upon starting FINDvisor. Delete the corresponding JSON file with FINDvisor is closed. Starting FINDvisor again will generate the sample contacts.

Warning:
Note that deleting the corresponding JSON file will cause all previously saved contact information to be lost. A backup of the JSON file should be made if necessary when regenerating sample contacts for FINDvisor.

Q: Is it possible to restore the default workspace settings to when I first launched FINDvisor?
A: Default workspace settings are generated when the corresponding JSON file (stated in [JAR file location]/config.json) is not found upon starting FINDvisor. Delete the corresponding JSON file with FINDvisor closed. Starting FINDvisor again will generate the default workspace settings.

Warning:
Note that deleting the corresponding JSON file will cause all previously saved workspace preferences to be lost. A backup of the JSON file should be made if necessary when regenerating default workspace settings for FINDvisor.

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. The remedy is to delete the preferences.json file created by the application before running the application again.
2. When adding a tag with many characters, the text for the tag does not wrap and will go off-screen. While FINDvisor does not impose a character length limit, for the optimal experience, it is recommended to use tags of short character lengths.

Command summary