This section allows you to start caring for your clients as soon as possible! It will help you install and start using the application as fast as possible.

Installation instructions

1. To use ConnectCare you will require Java 11 to be installed in your computer.

If you have Java 11 installed

2. Check that it is the correct version
   • Windows or macOS users might find this guide useful.
   • Linux users might find this guide useful.
   • If you have the correct version skip ahead to step 4, otherwise, follow step 3 to install Java 11.

If you do not have Java 11 installed

3. Install Java 11 based on your Operating System

   • Windows users should use this guide.
   • MacOS users should use this guide.
   • Linux users should use this guide.

4. Download the latest release of connectcare.jar here.

Find the latest release with the 'Latest tag'

Click on the .jar file at the bottom of the page to download it

5. Copy the jar file to the folder you want to use as the home folder.

Startup instructions

6. Double-click on the connectcare.jar file to start the application.
   • If you are facing issues, you can consult this guide.
   • macOS users might experience a pop-up that says "connectcar.jar cannot be opened because it is from an unidentified developer." To solve this issue, please consult this Apple guide

Click here to return to the table of contents!

You're now onboarded to our app! Read further in our CLI Guide Section to find out about all the various features and commands that the ConnectCare application offers!

CLI guide

Our application uses a CLI and primarily, running commands is how users interact with the application.

Structure

Each command has the general structure:

1. Main command
2. Parameters

To enter a command:

1. Click on the text box with the placeholder text Enter command here...
2. Type in your command, which is made up of a main command, followed by parameters if applicable. Here we have the command add n/Derek Lau p/92784935 e/dlau@example.com entered into the command box.

Figure 1.1: Application on startup

Figure 1.2: Application with command in textbox

3. Press the ENTER key and voilà! You have added your first client with the CLI!

Figure 1.3: Application after command is executed

Notes about the command format

• In this guide, 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.

• Parameters 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.

• Parameters 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.

• Extraneous parameters for commands that do not take in parameters (such as help, list, exit and clear) will be ignored. e.g. if the command specifies help 123, it will be interpreted as help.

Click here to return to the table of contents!

You're all set to use the CLI to its full potential! Read further in our Features Section to find out about all the various features and commands that the ConnectCare application offers! Or jump straight to the Command Summary if you are already familiar with the features!

Features

Client Management

Connect care provides the following commands to help you manage your clients:

• Adding a client: add
• Deleting a client: delete
• Updating a client: update
• Listing all clients: list
• Finding clients: find
• Displaying a client's information: display
• Clearing all entries: clear

Adding a client: add

This command adds a new client to your client list.

Format: add n/NAME p/PHONE_NUMBER e/EMAIL [a/ADDRESS] [k/NEXT_OF_KIN] [d/DESCRIPTION] [t/TAG]…

Examples:

• add n/John Doe p/98765432 e/johnd@example.com
• add n/Betsy Crowe t/friend d/Takes anxiety medication k/Bethany Crowe e/betsycrowe@example.com a/Blk 684A Jurong West Central 1 #10-124 p/92748321 t/lowPriority
• add n/Aaron James p/84362143 e/billj@example.com a/400 Balestier Road #02-27 Balestier Plaza t/highPriority k/John Doe d/Has low blood pressure

Walkthrough:

The screenshots below are what you would expect when using the add command. In this example, after using the list command, the full clients list is displayed. Thereafter, the add command was used, using the parameters add n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 k/Joe Doe d/Has a history of memory loss t/mentalIllness t/owesMoney. After execution, the client John Doe is added successfully with the corresponding parameters!

Figure 1.1: Before the add command is executed

Figure 1.2: After the add command is executed

What if the command was used with invalid parameters? In the example on the left, the command add n/Matthew Kit was used, which does not contain all the compulsory parameters. Here the error message shown tells us that our command format is invalid and shows an example command, which lets you know the correct parameters to use for the command. In the example on the right, the command add n/Matthew Kit p/abc65432 e/matk@example.com a/123, Queenstown Ave 2, #03-25 k/Sofie Poe d/Short of hearing is used, which again is invalid. Here the error message shown is Phone numbers should only contain numbers, and it should be at least 3 digits long which lets you know specifically that the phone number given was invalid. As the commands given were invalid, there would be no changes to the client list.

Figure 1.3: After the invalid add command without all parameters is executed

Figure 1.4: After the invalid add command with incorrect parameters is executed

Click here to return to the table of contents!

Deleting a client: delete

This command allows you to delete a client at a specified INDEX from your client list.

Format: delete INDEX

Examples:

• delete 1 would delete the first client in your client list.
• delete 2 would delete the second client in your client list.

Walkthrough:

The screenshots below are what you would expect when using the delete command. In this example, after using the list command, the full clients list is displayed. Thereafter, the delete 3 command was used, removing John Doe, the first person in the list, from the list of client contacts.

Figure 1.1: Before the delete 3 command is executed

Figure 1.2: After the delete 3 command is executed

What if the command was used with an incorrect index? In the example on the left, delete 0 command was used, which is an invalid index. Here the error message shown is Invalid command format! ... Parameters: INDEX (must be a positive integer) which lets you know to retype the command with a larger index value. In the example on the right, delete 4 is used, which again is invalid. Here the error message shown is The person index provided is invalid which lets you know to retype the command with a lower index. As the commands given were invalid, there would be no changes to the client list.

Figure 1.3: After the invalid delete 0 command is executed

Figure 1.4: After the invalid delete 4 command is executed

Click here to return to the table of contents!

Updating a client: update

This command helps update existing client's information in the client list in the event that something changes.

Format: update u/EXISTING_USER [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DESCRIPTION] [k/NEXTOFKIN] [t/TAG]…

Example:

• update u/Jane Doe n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-011 This command updates Jane Doe's information to be as follows:
  
  • name: John Doe
  • phone no: 98765432
  • email: johnd@example.com
  • address: John street, block 123, #01-011

Walkthrough:

The screenshots below are what you would expect when using the update command. In this example, after using the list command, the full clients list is displayed. Thereafter, the update command was used, using the parameters u/Peter Crow p/94325412 e/petercrow@example.com. After execution, the client Peter Crow is updated successfully with the corresponding parameters!

Figure 1.1: Before the `update command is executed

Figure 1.2: After the update command is executed

What if the command was used with invalid parameters? In the example on the left, the command update u/Unknown Person p/92374832 was used, which specifies a name not in the name list. Here the error message shown is The person name provided is invalid which lets you know that you are trying to update a client that does not exist. In the example on the right, the command update u/Peter Crow p/abc123 is used, which again is invalid. Here the error message shown is Phone numbers should only contain numbers, and it should be at least 3 digits long which lets you know specifically that the phone number given was invalid. As the commands given were invalid, there would be no changes to the client list.

Figure 1.3: After the invalid update command with an invalid client is executed

Figure 1.4: After the invalid update command with invalid parameters is executed

Click here to return to the table of contents!

Listing all clients: list

This command shows a list of all persons.

Format: list

Examples:

The screenshots below are what you would expect when using the list command. In this example, after using the find command, only Peter Crow was shown in the list. Thereafter, the list command was used, displaying the entire list of client contacts.  

Figure 1.1: Before the list command is executed Figure 1.2: After the list command is executed

Click here to return to the table of contents!

Finding clients: find

This command allows you to find clients in your client list by specifying client parameters that you are interested in.

Format: find [n/NAME]… [a/KEYWORD]… [e/KEYWORD]… [t/KEYWORD]… [k/KEYWORD]… [d/KEYWORD]… [p/KEYWORD]…

Example:

• find p/99824412
• find n/xavier k/polly
• find n/bobby

Walkthrough:

Let's say your client list contains the following clients:

Figure 1.1: An example client list in ConnectCare (as indicated by the red box)

• find n/alex would return Alex Yeoh as the client name matches with alex.
• find n/alex p/99272758 would return Alex Yeoh as the client name matches with alex as well as Bernice Yu as the client phone number matches with 99272758.
• find p/9 would return Bernice Yu, Charlotte Oliveiro and David Li as their phone numbers all start with 9.

Click here to return to the table of contents!

Displaying a client's information: display

This command allows you to view a client's information in a more detailed manner

Format: display NAME

Examples:

display Peter Crouch would display all of Peter's information as a contact card on the application.

Walkthrough:

The screenshots below are what you would expect when using the display command. In this example, after using the list command, the full clients list is displayed. Thereafter, the display Peter Crouch command was used, displaying Peter. The cursor automatically moves to the description box, allowing you to make changes to Peter's details. After making the necessary changes, hit enter. The details will be updated and you will be redirected back to the home page with the clients list. At no stage do you need to reach for the mouse!

Figure 1.1: Before the display command is executed Figure 1.2: After the display command is executed

  Click here to return to the table of contents!

Clearing all entries : clear

This command allows you to purge your client list, removing ALL clients in your client list.

Format: clear

Click here to return to the table of contents!

You are now an expert in managing your clients! Now that we are done with the Client management features let's move on to the Appointment management features!

Appointment Management

ConnectCare provides the following commands to help you manage your appointments:

• Adding an appointment: schedule add
• Deleting an appointment: schedule delete

Adding an appointment: schedule add

This command allows you to add an appointment with the specified parameters.

Format: schedule add h/HEADING t/TIME d/DESCRIPTION n/CLIENT_NAME

Once the command is entered, the event should be added to the events panel on the right of the application.

Examples:

• schedule add h/Meeting with Client t/2/14/2024 0930 d/Discuss project details n/John Doe
• schedule add h/Discharge plan meeting t/02/14/2024 1000 d/Discuss discharge n/Jack Doe

Walkthrough:

The screenshots show what you should expect on your screen while executing this command: schedule add h/Meeting with Client t/2/14/2024 0930 d/Discuss project details n/John Doe. Once the command is entered, the event should be deleted on the events panel on the right of the application.

Figure 1.1: Before the schedule add command is executed

Figure 1.2: After the schedule add command is executed

Click here to return to the table of contents!

Deleting Appointment : schedule delete

This command allows you to remove an appointment with the specified parameters.

Format: schedule delete h/HEADING

Once the command is entered, the event should be removed from the events panel on the right of the application.

Examples:

• schedule delete h/Meeting with Client
• schedule delete h/Discharge plan meeting

Walkthrough:

The screenshots show what you should expect on your screen while executing this command: schedule delete h/Client Checkin. Once the command is entered, the event should be added to the events panel on the right of the application.

Figure 1.1: Before the schedule delete command is executed

Figure 1.2: After the schedule delete command is executed

Click here to return to the table of contents!

Program Controls

ConnectCare provides the following commands for navigating the application:

• Undoing a command: undo
• Redoing a command: redo
• Shortcuts
• up arrow
• down arrow

Undoing a command : undo

This command allows you to undo your last command, restoring the ConnectCare application to its previous state.

Format: undo

Walkthrough:

The screenshots below are what you would expect when using the undo command.

In this example, after using the add command to add a new client Charlie, I wish to undo this addition as bertrand will not be assigned to me. As seen in the second image, after using the undo command, Charlie is no longer present in the client list as his addition has been undone.  

Figure 1.1: Before the undo command is executed Figure 1.2: After the undo command is executed

Click here to return to the table of contents!

Redoing a command : redo

This command allows you to redo your command, reversing any changes that were previously undone.

Format: redo

Walkthrough:

The screenshots below are what you would expect when using the redo command.

In this example, after undoing an update of my client's name from Peter Crow to Peter Crouch, we can see that the current client list has his name as Peter Crow As seen in the second image, after using the redo command, the change is redone, and the client list shows the client's name as Peter Crouch

Figure 1.1: Before the redo command is executed Figure 1.2: After the redo command is executed

Click here to return to the table of contents!

Shortcuts

These are a list of keyboard actions to better navigate our application

Click here to return to the table of contents!

Now that we are better able to navigate our application, let's move on to explore the Miscellaneous commands!

Miscellaneous Commands

Viewing Help : help

This command displays a popup message with a link to access this User Guide.

Format: help

Figure 1: Pop-up when the help command is entered

Click here to return to the table of contents!

Exiting the program : exit

This command allows you to exit the application.

Format: exit

Click here to return to the table of contents!

Saving the data

Your locally saved client list will be updated after any change is made, so no further action needs to be taken when operating the application! On start-up, your existing client list (if it exists) will also be automatically loaded, so don't worry about that!

Click here to return to the table of contents!

Congratulations, you've reached the end of all of our current features! If you ever forget any of the commands a quick look at the command summary would help!

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

Click here to return to the table of contents!

Command summary

Click here to return to the table of contents!

Glossary

CLI

CLI stands for Command Line Interface, which is a way for you to interact with the application with only textual commands, there is no need for a mouse. Once you learn the commands, CLIs can be faster for repetitive tasks than navigating menus with a mouse. For more information, see also the Wikipedia article for CLI

Local

Local applications runs on the same computer it is launched on and there is no program or data that is being ran or transferred to another remote machine. For more information, see also this Microsoft article for Local and Remote execution

Click here to return to the table of contents!