User Guide for InsuraConnect

Table of contents

Introduction

Welcome to the InsuraConnect User Guide! This guide serves as a complete manual to every aspect of InsuraConnect, your streamlined conduit to peak productivity in the insurance sector. Eschewing the complexity of redundant features, InsuraConnect is forged from in-depth research to deliver a swift, efficient, and user-friendly experience for the modern insurance agent.

Refer to the Table of contents to find your answers as well as step-by-step instructions for all the features to be a master of InsuraConnect.

What it does

InsuraConnect is a desktop application tailored for managing client interactions and insurance policies. It is optimized for speed via a Command Line Interface (CLI), backed by the visual accessibility of a Graphical User Interface (GUI). For agents adept at typing, InsuraConnect enhances task execution, outpacing conventional GUI applications.

With InsuraConnect, you can swiftly access client information, manage policies, track meetings, and stay organized in a competitive landscape. Our goal is to transform your workflow into an efficient model of productivity.

This user guide provides the installation process, clear explanations for each command, step-by-step instructions, insightful examples and troubleshooting recommendations to ensure you harness the full potential of InsuraConnect. In addition, the quick start guide provides an end-to-end setup process to get started.

Target users

InsuraConnect is designed for insurance agents who desire the efficacy of CLI without relinquishing GUI advantages. It is an essential tool for those who manage a broad client base, track multiple insurance policies, organise meetings, and value the efficiency of their time and resources.

---

What can InsuraConnect do for you?

❓ What truly sets InsuraConnect apart? This is only the tip of the iceberg of the things you can do working with InsuraConnect.

Comprehensive Policy Management: Dive into the essence of each policy with InsuraConnect's in-depth tracking system. Visualize expiry dates, premiums, and detailed coverage information, all laid out for clear understanding and quick access.

Dynamic Policy Administration: Add zest to policy handling with agile tools that allow you to add, update, or remove policy details effortlessly. Maintain accurate client portfolios with just a few intuitive commands.

Streamlined Meeting Coordination: Command your schedule with robust scheduling capabilities. Organize, adjust, and cancel meetings with ease, enhanced by our integrated agenda setting and comprehensive note-taking tools.

Client Engagement Tracker: Keep your finger on the pulse of client relations. Monitor interactions and gauge policy engagement levels to ensure high client retention and satisfaction rates.

Proactive Meeting Reminders: Stay ahead of the game with proactive notifications for impending meetings, ensuring you're always prepared to seize every client engagement opportunity.

To explore more, visit the Features section for more advanced tips.

Quick start

1. Ensure you have Java 11 or above installed in your Computer. You can download Java 11 for your system here.

2. Download the latest InsuraConnect.jar from here.

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

4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar InsuraConnect.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 r/client : Adds a contact named John Doe to InsuraConnect.

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

   • schedule 1 md/2024-05-05 mt/09:00 ma/Discuss health policy mdur/60 : Schedules a meeting with the 1st contact in the current list at 5th May 2024 9am to discuss health policy.

   • policy 1 po/Health policy ed/2029-06-06 pm/1000 Adds a policy with the 1st contact in the current list with name of Health policy, expiry date on the 6th of June 2029, with a premium of 1000 SGD.

   • exit : Exits the app.

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

7. Refer to the Command summary for a full list of the available commands

How to use this guide

The InsuraConnect User Guide is structured to help you navigate as easily as possible. You can use the Table of contents to navigate any section you want. Hyperlinks are also included that will take you to relevant sections or features. If you already an experienced user, you can use the Supported prefixes and Command summary sections for a quick overview.

In the Features section, each feature will contain:

• a short preface
• the command format
• details on its use
• guided examples

You can also find visuals that highlight how the features of InsuraConnect will look. They are located below the description of the feature and are labelled for your convenience.

This guide uses the following coloured icons and segments. They represent different information to help you better understand how to use InsuraConnect.

Before you dive into the features, read through the notes regarding InsuraConnect's command format.

Features

Viewing help : help

Shows a message explaining how to access the help page.

Format: help

Adding a person: add

Adds a person to InsuraConnect.

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

Examples:

• add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 r/client adds a client with the respective details to InsuraConnect.
• add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Kent Ridge p/1234567 r/partner t/oweMoney adds a partner with the respective details to InsuraConnect.

The following images show the InsuraConnect UI before and after executing the command add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Kent Ridge p/1234567 r/partner t/oweMoney.

Listing all persons : list

Shows a list of all persons in InsuraConnect.

Format: list

Editing a person : edit

Edits an existing person in InsuraConnect.

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

• Refer to the above add section for constraints for the values.
• 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.
• Editing the relationship is not allowed.
• Editing the policy and meeting fields will be through other commands, policy and reschedule respectively.
• 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/alexyeoh1234@example.com edits the phone number and email address of the 1st person to be 91234567 and johndoe@example.com respectively.
• edit 2 n/Betsy Crower t/ edits the name of the 2nd person to be Betsy Crower and clears all existing tags.

The following images show the InsuraConnect UI before and after executing the command edit 1 p/91234567 e/alexyeoh1234@example.com.

The following images show the InsuraConnect UI before and after executing the command edit 2 n/Betsy Crower t/.

Locating persons by name, relationship, tag, policy: find

Finds persons whose details contain any of the given keywords.

Format: find [n/NAME]... [r/RELATIONSHIP]... [t/TAG]... [po/POLICY]...

• The search is case-insensitive. e.g hans will match Hans.
• Keywords containing white spaces at the beginning or end are allowed. e.g: Hans, client .
• You can search by name, relationship, tags or policy.
• Persons matching at least one keyword in any attribute will be returned (i.e. OR search). e.g. find n/Hans n/Bo r/partner will return Hans Gruber, Bo Yang and all person who have relationship partner.

Examples:

• find n/ John returns john and John Doe
• find r/partner retrieves all the partners listed in the contact list.

The following images show the InsuraConnect UI after executing the command find n/Alex n/David.

Deleting a person : delete

Deletes the specified person from InsuraConnect.

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:

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

Policy

Adding a policy to a client: policy

Format: policy INDEX po/POLICY_NAME [ed/EXPIRY_DATE] [pm/PREMIUM]

• Assigns a policy to the client 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: policy 1 po/Health Policy ed/01-01-2030 pm/500000 adds a new policy to the 1st person.

The following images show the InsuraConnect UI before and after executing the command policy 1 po/Health Policy ed/01-01-2030 pm/500000.

Editing a policy of a client: policy

Format: policy INDEX pi/POLICY_INDEX po/POLICY_NAME [ed/EXPIRY_DATE] [pm/PREMIUM]

• Edits a policy assigned to the client at the specified INDEX with a specified POLICY_INDEX. Policy index refers to the index number shown in the person's displayed policy list. Both indices must be positive integer 1, 2, 3, …​

Examples: policy 1 pi/2 po/Travel Policy ed/01-01-2025 pm/2000 edits the 1st person's 2nd policy.

The following images show the InsuraConnect UI before and after executing the command policy 1 pi/2 po/Travel Policy ed/01-01-2025 pm/2000.

Deleting a policy from a client: policy

Format: policy INDEX pi/POLICY_INDEX po/

• Deletes a policy assigned to the client at the specified INDEX with a specified POLICY_INDEX. Both indices must be positive integer 1, 2, 3, …​
• Leave the POLICY_NAME blank to remove a particular policy from a particular client.
• Note that any information provided after po/ will be ignored and the policy will still be deleted, e.g., policy 1 pi/2 po/ ed/01-01-2025 pm/2000 will still delete the 1st person's 2nd policy.

Examples: policy 1 pi/2 po/ deletes the 1st person's 2nd policy.

The following images show the InsuraConnect UI before and after executing the command policy 1 pi/2 po/.

Meeting

Scheduling a meeting with a person: schedule

Schedules a meeting with a person with an agenda and duration with optional notes

Format: schedule INDEX md/DATE mt/TIME mdur/DURATION ma/AGENDA mn/[NOTES]

• Schedules meeting with a person at the specified INDEX. The index refers to the index number shown in the displayed persons list.
• Meeting notes are optional and can be used to represent any additional information that might be useful for the meeting.
• You can schedule multiple meetings as well, further details are included below

Examples:

1. schedule 1 md/09-09-2024 mt/09:00 mdur/60 ma/discuss health policy mn/urgent
2. schedule 1 md/01-09-2024 mt/13:00 mdur/60 ma/discuss vehicle policy mn/urgent

The following images show the InsuraConnect UI after executing two example commands above consecutively.

Rescheduling a meeting with a person: reschedule

Reschedules a meeting with a person

Format: reschedule INDEX mi/MEETING_INDEX md/DATE mt/TIME

• Reschedules meeting with a person at the specified INDEX. The index is the same as the above for schedule.
• Selects a meeting from the list of meetings using the MEETING_INDEX.

Examples: reschedule 1 mi/2 md/05-09-2024 mt/17:00

The following images show the InsuraConnect UI after executing the example command above from Fig 17.

Cancelling a meeting with a person: cancel

Cancels a meeting with a person

Format: cancel INDEX mi/MEETING_INDEX

• INDEX and MEETING_INDEX is the same as the above for reschedule

Examples: cancel 1 mi/1

The following image shows the InsuraConnect UI after executing the example command above following the commands above in reschedule that resulted in Fig 18.

Managing Meetings

Meeting Scheduling and Rescheduling

Meetings are automatically sorted by their scheduled dates and times. When multiple meetings are scheduled for a client, InsuraConnect will organize them in ascending order, showing the earliest upcoming meeting at the top. This feature allows insurance agents to quickly glance at their schedule and prioritize upcoming meetings.

Automatic Purging of Expired Meetings

To ensure the schedule remains current and manageable, InsuraConnect automatically purges past meetings. Once a meeting's end time has passed, it will be removed from the system during the next refresh cycle. This helps to maintain an up-to-date schedule for users, focusing only on relevant future engagements.

Sorting Clients/Partners by Earliest Meeting

Clients and partners are sorted in the user interface according to the time of their earliest scheduled meeting. This sorting mechanism places those individuals with the most imminent meetings at the top of the list, allowing for efficient time management and planning. Should there be no scheduled meetings for a client or partner, they will be positioned in the list based on the default sorting criteria.

Changing a client's status: status

Changes a client's status by one level to reflect the progress with that client. In increasing order, the possible status levels are Yet to start, In progress, and Completed.

Format: status INDEX s/DIRECTION

• Changes the status of the client 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, …​
• Input DIRECTION as up to increase the status, or down to decrease the status.
• Leave the direction blank to reset the client's status to Yet to start.

Examples:

• status 1 s/up increases the status of the 1st person by one level if it is a client.
• status 1 s/ resets the status of the 1st person if it is a client.

The following images show the InsuraConnect UI before and after executing the command status 1 s/up.

Undoing a command: undo

Undoes a previous command.

Format: undo

• Only undoes commands that made changes to InsuraConnect

Examples:

• add n/Adam Ibnu p/11111111 e/Adam@gmail.com a/Sembawang road blk 509c #02-25 r/client t/friend

The following images show the InsuraConnect UI after executing the command above.

• The previous add command is followed by undo which undoes the previous command, removing the newly added person as shown below.

The following images show the InsuraConnect UI after executing the command undo from Fig 24.

Redoing a command: redo

Redoes a previous undid command

Format: redo

• Requires a successful prior undo command to redo

Examples:

• This example performs redo after the success undo in the above section Undo
• Executing redo reapplies the actions that were previously undone which in this example is adding back Adam in the figure below and a successful redo will show a corresponding successful message as well.

The following images show the InsuraConnect UI after executing the command redo from Fig 25.

Clearing all entries : clear

Clears all entries from InsuraConnect.

Format: clear

Exiting the program : exit

Exits the program.

Format: exit

Saving the data

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

Editing the data file

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

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

Q: Can I access InsuraConnect from multiple devices?
A: Currently, InsuraConnect is designed to be installed and used on a single computer. However, we are exploring options for multi-device access in future updates.

Q: Is InsuraConnect compatible with all operating systems?
A: InsuraConnect is optimized for Windows, macOS, and Linux operating systems. Ensure your device meets the minimum system requirements for seamless performance.

Q: Can I import existing client data into InsuraConnect?
A: Currently, there is no direct import feature within InsuraConnect. However, you can manually input your client data using the add command or directly edit the JSON data file if you have a large dataset. We are considering adding import functionality in future updates.

Q: Is my data secure within InsuraConnect?
A: InsuraConnect prioritizes data security and confidentiality. All client data is stored locally on your computer in a JSON file and is not transmitted over the internet. However, it's advisable to take regular backups of your data to prevent loss in case of unforeseen circumstances.

---

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 scrolling through Meetings and Policy Accordion, if you scroll too quickly, the cells take some time to render and display the required information.
3. After using find command, use list to list all tasks so that all operations are done on the correct index number. The filtered list doesn't revert back when doing next command, so user has to manually enter list to avoid any discrepancies.

---

Glossary

• Meeting: A scheduled interaction between insurance agents and clients or partners to discuss insurance products, coverage options, claims, or other related matters.
• Policy: A formal contract or agreement between an insurance provider and a client specifying the terms, conditions, coverage, and obligations related to an insurance product or service.
• Client: An individual or entity that holds an insurance policy and is entitled to the benefits and coverage outlined in the policy.
• Partner: An individual who is a colleague or another insurance agent that the user is in collaboration with.
• Policy Management: The process of administering insurance policies, including issuing new policies, updating existing policies, processing endorsements, and handling policy renewals and cancellations.
• UI (User Interface): The graphical interface provided by InsuraConnect for users to interact with the system, access features, view information, and perform tasks related to insurance activities.
• Command: A specific instruction or action initiated by a user within InsuraConnect to trigger a particular function, operation, or task, such as scheduling a meeting, processing a policy update, or generating a report.
• Fig (Figure): A reference to a visual representation or illustration within InsuraConnect documentation, often used to depict UI screens, workflow diagrams, or data charts related to insurance processes or functionalities.

Supported prefixes

---

Command summary