InsureBook User Guide

InsureBook is an address book desktop application built to help insurance agents manage and organize their client information more effectively. Its primary purpose is to streamline the day-to-day workflow of agents, allowing them to store, access, update and keep track of client data with ease.

By combining the speed of a Command Line Interface (CLI) with the familiarity of a Graphical User Interface (GUI), InsureBook is optimized for fast, efficient use. If you're a quick typist, you'll find that InsureBook lets you perform contact management tasks faster than traditional point-and-click apps — all while maintaining clarity and control over your client base.

As a result, with InsureBook, we're not just insuring policies—we're insuring smiles!

How to Use This Guide

This User Guide is designed to help you get the most out of InsureBook. Here's how to navigate it effectively:

1. Quick Start (For New Users)

   • If you're new to InsureBook, start with the Quick Start section
   • This section provides step-by-step instructions to get you up and running quickly

2. Commands (For All Users)

   • The Commands section contains detailed information about all available commands
   • Commands are organized into categories:
     • Client Management (add, edit, delete)
     • Policy Management (renew, viewrenewals, filter)
     • Search and List (find, list)
     • General Commands (help, clear, exit)

3. Command Summary (For Quick Reference)

   • The Command Summary section provides a quick overview of all commands
   • Use this section as a quick reference when you're familiar with the commands

4. Additional Resources

   • FAQ: Answers to common questions
   • Known Issues: Solutions to common issues

---

Understanding Callout Boxes

Throughout this guide, you'll encounter different types of callout boxes that provide important information:

---

Table of Contents

1. How to Use This Guide
2. Understanding Callout Boxes
3. Quick Start
4. Commands
   • Client Management Commands
     • Adding a person
     • Editing a person
     • Deleting a person
   • Policy Management Commands
     • Updating a policy renewal date
     • Viewing upcoming policy renewals
     • View policy renewals in date range
   • Search Commands
     • Listing all persons
     • Locating persons by keyword
   • General Commands
     • Viewing help
     • Clearing all entries
     • Exiting the program
5. FAQ
6. Known Issues
7. Command Summary

---

Quick start

1. Ensure you have Java 17 or above installed in your Computer.
   Mac users: Ensure you have the precise JDK version prescribed 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 your InsureBook.

4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar InsureBook.jar command to run the application.
   A GUI similar to the 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 pol/1234567 : Adds a contact named John Doe to the Address Book.

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

   • clear : Deletes all contacts.

   • exit : Exits the app.

Refer to the Commands below for details of each command.

---

Commands

InsureBook provides you with several types of commands to manage your client information effectively:

Client Management Commands

• Adding a person - add
• Editing a person - edit
• Deleting a person - delete

Policy Management Commands

• Updating a policy renewal date - renew
• Viewing upcoming policy renewals - viewrenewals
• View policy renewals in date range - filter

Search Commands

• Listing all persons - list
• Locating persons by keyword - find

General Commands

• Viewing help - help
• Clearing all entries - clear
• Exiting the program - exit

A command consists of a command word and zero or more parameters.

Example: add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 pol/123456

Client Management Commands

Adding a person : add

Adds a person to the address book.

Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS pol/POLICY_NUMBER [pt/POLICY_TYPE] [r/RENEWAL_DATE] [note/NOTE] [t/TAG]…​

• NAME: Names must only include alphanumeric characters and spaces.
• PHONE_NUMBER: Phone numbers must follow the E.164 standard.
• EMAIL: The email must be in the localpart@domainname format. The localpart should only contain alphanumeric characters and these special characters, excluding the parentheses, (+_.-). The local-part may not start or end with any special characters. The domain name must: end with a domain label at least 2 characters long, have each domain label start and end with alphanumeric characters, and have each domain label consist of alphanumeric characters, separated only by hyphens, if any.
• ADDRESS: The address can be any string value, but it must not be blank.
• POLICY_NUMBER: The policy number must consist only of digits, ensuring that it is numeric and non‑blank.
• POLICY_TYPE: Only the following case‑insensitive policy types are allowed: Life, Health, Property, Vehicle, Travel.
• RENEWAL_DATE: The date must follow the DD-MM-YYYY format.
• NOTE: There are no specific restrictions for notes; any string is accepted as a valid note.
• TAG: A valid tag name must be entirely alphanumeric.

Examples:

• add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 pol/12345678 pt/Life r/31-12-2025 note/Basketball Player
• add n/Betsy Crowe t/friend pol/654321 pt/Health e/betsycrowe@example.com a/Newgate Prison p/1234567 t/criminal

Expected Output:

• Before running the command:

• After running the command:

Editing a person : edit

Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [pol/POLICY_NUMBER] [pt/POLICY_TYPE] [r/RENEWAL_DATE] [note/NOTE] [t/TAG]…​

• Edits 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 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 by typing t/ without specifying any tags after it.

Examples:

• edit 1 p/91234567 e/johndoe@example.com pt/Health r/31-12-2025
• edit 2 n/Betsy Crower t/

Expected Output:

• Before running the command:

• After running the command:

Deleting a person : delete

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, …​

Examples:

• delete 2
• find n/Betsy followed by delete 1

Expected Output:

• Before running the command:

• After running the command:

Policy Management Commands

Updating a policy renewal date : renew

Format: renew pol/POLICY_NUMBER r/RENEWAL_DATE

• The pol/POLICY_NUMBER parameter must be a valid policy number in the system.
• The r/RENEWAL_DATE parameter must be in the format DD-MM-YYYY.

Examples:

• renew pol/123456 r/01-01-2026

Expected Output:

• Before running the renew command:

• After running renew pol/123456 r/01-01-2026:

Viewing upcoming policy renewals : viewrenewals

Format: viewrenewals [n/NEXT_N_DAYS] [s/SORT_ORDER]

• The n/NEXT_N_DAYS parameter must be between 0 and 365.
• The search results can be sorted using s/SORT_ORDER by name or by date only. The default sort order is by date if unspecified.

Examples:

• viewrenewals
• viewrenewals n/60
• viewrenewals n/60 s/name

Expected Output:

• Before running the viewrenewals command:

• After running viewrenewals n/200 s/name:

View policy renewals in date range : filter

Format: filter sd/START_DATE ed/END_DATE [s/SORT_ORDER]

• The sd/START_DATE parameter must be in the format DD-MM-YYYY.
• The ed/END_DATE parameter must be in the format DD-MM-YYYY.
• The search results will include policy renewals between the specified start date and end date.
• The search results can be sorted using s/SORT_ORDER by name or by date only. The default sort order is by date if unspecified. Name sorting follows the same rules as mentioned in the viewrenewals command.

Examples:

• filter sd/01-03-2025 ed/31-03-2025
• filter sd/01-01-2025 ed/30-06-2025 s/name

Expected Output:

• Before running the filter command:

• After running filter sd/01-06-2025 ed/01-01-2026:

Search Commands

Listing all persons : list

Shows a list of all persons in the address book.

Format: list

Each person card in the list displays:

• Name
• Phone number
• Email address
• Physical address
• Policy number
• Policy type (Life, Health, Property, Vehicle, or Travel)
• Renewal date (displayed as "Renewal date: DD-MM-YYYY")
• Tags (if any)

The policy type and renewal date are clearly labeled to help insurance agents quickly identify the types of policies and when they need to be renewed.

Locating persons by keyword : find

Searches given person fields by specific keyword and returns any matching entries Format: find [n/NAME]…​ [p/PHONE]…​ [e/EMAIL]…​ [a/ADDRESS]…​ [pol/POLICY_NUMBER]…​ [pt/POLICY_TYPE]…​ [t/TAG]…​ [s/SORT_ORDER]…​

• At least one of the optional fields must be provided.
• Each field may be provided more than once except SORT_ORDER.
• The fields follow the same rules and constraints as detailed in the add command.
• NAME and ADDRESS field may contain more than one word.
• The search is case-insensitive. e.g hans will match Hans
• The order of the values matter for a field but not for different fields. e.g. n/Hans Bo will not match Bo Hans but n/Hans n/Bo will match Bo Hans
• Partial search for Name, Phone number, Email address, Physical address and Policy number is allowed
• Exact search is required for Policy type and Tags
• Partial words e.g. n/Han will match Hans
• Partial numbers e.g. p/123 will match 91234567
• Partial search for emails must be concatenated with @ followed by at least 2 characters e.g. e/ice@ex will match alice@example.com but alice@e will not match alice@example.com
• Persons matching at least one field will be returned (i.e. OR search). e.g. n/Hans n/Bo will return Hans Gruber, Bo Yang
• Tags are supported. You can add one or more tags using t/TAG. The search for tags is not case-sensitive and must be an exact word.
• Policy types are supported. You can search for specific policy types using pt/POLICY_TYPE. Valid policy types are: Life, Health, Property, Vehicle, and Travel. The search is not case-sensitive.
• The search results can be sorted using s/SORT_ORDER by name or by tag only. The default sort order is by name. Tag sorting sorts by entries with the most number of tags first. Name sorting follows the same rules as mentioned in the viewrenewals command.

Examples:

• find n/olive
• find n/Amy p/999
• find n/alex n/david
• find t/friends t/colleagues s/tag

Expected Output (Partial name searching example):

• Before running the find command:

• After running find n/olive:

Expected Output (Tag searching example):

• Before running the find command:

• After running find t/friends t/colleagues s/tag:

General Commands

Viewing help : help

Shows a message explaining how to access the help page.

Format: help

Expected output after running help :

Clearing all entries : clear

Format: clear

Expected output after running clear:

Exiting the program : exit

Format: exit

Expected output after running exit: InsureBook closes.

FAQ

Q: How do I add a new person to the address book?

A: Use the add command. For example, add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 pol/123456 pt/Life r/31-12-2024 note/Basketball Player.

Q: How do I edit a person's information?

A: Use the edit command. For example, edit 1 p/91234567 e/johndoe@example.com pt/Health r/31-12-2024.

Q: How do I delete a person from the address book?

A: Use the delete command. For example, delete 1.

Q: How do I clear all entries from the address book?

A: Use the clear command. For example, clear.

Q: How do I exit the program?

A: Use the exit command. For example, exit.

Q: How do I update a policy renewal date?

A: Use the renew command. For example, renew pol/123456 r/31-12-2025.

Q: How do I view upcoming policy renewals?

A: Use the viewrenewals command. For example, viewrenewals n/60.

Q: How do I filter policy renewals in a date range?

A: Use the filter command. For example, filter sd/01-03-2025 ed/31-03-2025.

Known Issues

I: I'm unable to add a new person to the address book.

A: Ensure that all fields are filled out correctly and that the phone number, email, and policy number are in the correct format.

I: I'm unable to edit a person's information.

A: Ensure that the index is correct and that all fields are filled out correctly.

I: I'm unable to delete a person from the address book.

A: Ensure that the index is correct and that the index exists in the address book.

I: I'm unable to clear all entries from the address book.

A: Ensure that you have the correct permissions to clear the address book.

I: I'm unable to exit the program.

A: Ensure that you have saved all changes before exiting the program.

I: I'm unable to update a policy renewal date.

A: Ensure that the policy number is correct and that the renewal date is in the correct format.

I: I'm unable to view upcoming policy renewals.

A: Ensure that the program is up to date and that there are no issues with the data file.

I: I'm unable to filter policy renewals in a date range.

A: Ensure that the start and end dates are in the correct format and that the data file is up to date.

Command Summary

Client Management Commands

Policy Management Commands

Search Commands

General Commands

---

Glossary

---