Clientele+ seamlessly combines client contacts, payment tracking and more in one efficient package, tailored specifically for freelance software developers.

• Quick start
• Features
  • Accepted values by field
  • General Commands
    • Viewing help: help
    • Listing all Clients: list
    • Clearing All Entries: clear
    • Exiting the Program: exit
  • Client Management
    • Add Client Details: add
    • Update Client Details: edit
    • Finding Clients: find
    • Delete Client Details: delete
    • Blacklist a Client: blacklist
    • Whitelist a Client: whitelist
    • Sort Client list: sort
    • Archive a Client: archive
    • Unarchive a Client: unarchive
    • Listing all archived clients: archive-list
    • Deadline Reminder
  • Data Management
    • Saving the Data
    • Editing the data file
    • Undo Command [coming in v2.0]
    • Add Notes for a Client [coming in v2.0]
  • FAQ
  • Known issues
  • Command summary

Quick start

1. Ensure you have Java 17 or above installed in your Computer.

2. Download the latest ClientelePlus.jar file from here.

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

4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar ClientelePlus.jar command to run the application.
   A GUI similar to the below should appear in a few seconds

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 clients’ contacts.

   • add n/John Dimon p/98765432 e/johnd@gmail.com a/Maxwell Street, #05-01 t/JP Morgan py/pending cs/active d/09-09-2024 : Adds a client contact named John Dimon with pending payment to Clientele+.

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

   • blacklist 1 : Blacklists the 1st client contact shown in the current list.

   • archive 2 : Archives the 2nd client contact shown in the current list.

   • edit n/James Thompson d/11-05-2025 : Set a client’s deadline, and automatically update reminder manager

   • find n/Jeremy : Finds all clients whose name matches Jeremy

   • edit n/Joseph Wharton py/late : Update client’s payment status (will display as red $ on GUI)

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

Features

Accepted values by field

General Commands

Viewing help: help

Shows a message explaining how to access the help page.

Format: help

Listing all Clients: list

Show a list of all clients contacts in Clientele+.

Format: list

Tip:
You can use this command to return to the main client list.

Clearing All Entries: clear

Clears all entries from Clientele+.

Format: clear

Caution:
This command permanently deletes all clients from the main client list. This action cannot be undone. Please ensure you fully understand the consequences before proceeding. This command does not affect clients in the archived list.

Exiting the Program: exit

Automatically saves all of the user’s client data and exits the program.

Format: exit

Tip:
You can also exit the program by clicking the “x” at the top left corner of the window. The program will automatically save your data before closing.

Client Management

Add Client Details: add

Add a client to Clientele+, including details such as client name, contact information, project deadline, project status, payment status and client status. Accepted values are as specified in the accepted values table above.

Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS d/DEADLINE [t/TAG]…​ [ps/PROJECT_STATUS] [py/PAYMENT_STATUS] [cs/CLIENT_STATUS]

• Clients with the same NAME, EMAIL and PHONE NUMBER are considered duplicates and will not be added.
• A person can have 0 or more tags.
• NAME is case-insensitive. John Doe and joHN dOE are considered the same name, but name is stored in the same case as the input (so John Doe is stored as John Doe and JOHN Doe is stored as JOHN Doe).
• If PAYMENT_STATUS is not specified, default payment status of pending is used.
• If CLIENT_STATUS is not specified, default client status of active is used.
• If PROJECT_STATUS is not specified, default project status of in progress is used.

Examples:

• add n/John Dimon p/98765432 e/johnd@gmail.com a/Maxwell Street, #05-01 t/JP Morgan t/CTO ps/in progress py/pending cs/active d/09-09-2024
• add n/Betsy Crowe t/SoftEng Inc e/betsycrowe@gmail.com a/Wallich Street p/1234567 t/Founder d/11-04-2024

Tip:
1. The deadline could be the date you need to submit the project to the client.
2. The deadline could instead be the date by which you need to follow up with a potential client.
3. Payment status values are displayed as an icon with the colours orange, yellow, green and red for the values pending, partial, paid and late respectively.
4. You may hover over the Payment Status Icon to view the payment status as text.

Update Client Details: edit

Allows updating of various statuses of an existing client. Accepted values are as specified in the accepted values table above.

Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [d/DEADLINE] [t/TAG]…​ [ps/PROJECT_STATUS] [py/PAYMENT_STATUS] [cs/CLIENT_STATUS]

• 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.
• Any fields not specified will remain unchanged.

Examples:

• edit 1 p/91234567 e/johndoe@example.com Updates the first person’s phone number to 91234567 and email address to johndoe@example.com
• edit 2 n/Betsy Crower t/ Updates the name of the 2nd person to be Betsy Crower and clears all existing tags.
• edit 1 ps/completed py/paid cs/old Updates the project status, payment status and client status of the 1st person to be completed, paid and old respectively.

Tip:
If a client’s project deadline has passed and the client’s project status is in progress, the GUI labels the client card as OVERDUE. So if the client has paid, and your business with them is finished, you can set their project status to completed so the deadline field doesn’t show OVERDUE.

Finding Clients: find

Finds persons in main client list who match parameters specified. Accepted values are as specified in the accepted values table above.

Format: find [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [d/DEADLINE] [t/TAG]… [ps/PROJECT_STATUS] [py/PAYMENT_STATUS] [cs/CLIENT_STATUS]

• All values matched for any parameter are case-insensitive.
• The order of the name keywords does not matter. e.g. n/Hans Bo will match Bo Hans.
• Persons matching at least one name keyword will be returned (i.e. OR search). e.g. find n/Han Bo will return Hans Gruber, Bo Yang.
• Names only need to match the start of a word. e.g. find n/Han OR find n/B matches Hans Bo.
• Phone number, email, address, project status, tags, payment status, client status and deadline must match the exact string. e.g. ps/in progress will not match ps/in prog.
• All fields need to be matched for a person to be found e.g. find n/Rah py/paid ps/in progress matches those clients whose name segment (first name, middle name, last name etc) starts with “Rah”, payment status is paid and project status is in progress.
• When searching by tags, if multiple tags are specified then only one of the tags need to be matched.

Examples:

• find n/John returns john and John Doe.
• find n/John ps/completed returns all clients whose names start with “John” and project status is set to completed.
• find n/John t/homeowner t/ceo returns all clients whose names start with “John” and have either a “ceo” tag or a “homeowner” tag.

• find n/alex david returns Alex Yeoh, David Li:
  

  

Note:
After applying the find command, making changes to the displayed client list will bring you back to the main client list where the changes are applied.

Tip:
Shortcuts: Finding blacklisted/whitelisted clients
To find all clients that are blacklisted (with no other fields specified), the command blacklist can be entered. Similarly, the whitelist command can be entered to find all clients who are whitelisted.
Note: Both of these commands need to be entered without any parameters otherwise the app responds with an error message. Similar to the find command, making changes to the displayed client list will bring you back to the main client list where the changes are applied.

Delete Client Details: delete

Deletes the specified person from Clientele+.

Format: delete [n/NAME] [id/INDEX]

• Deletes clients identified by the specified INDEX or NAME.
• NAME Acceptable values are same as above; the command looks for an exact, case-insensitive match in the name.
  • E.g.: delete n/John will match john, JOHN and John, but not John Doe.
• INDEX refers to the index number shown in the displayed person list, and must be a positive integer 1, 2, 3, …​

Examples:

• delete n/John deletes the client with the name John.
• list followed by delete id/2 deletes the 2nd person in the list.
• find n/Betsy followed by delete id/1 deletes the 1st person in the result of the find command.

Tip:
If you try to delete by name but there are 2 or more clients in the list with that same name, you will be shown a list of those clients and prompted to delete by index instead.

Blacklist a Client: blacklist

Marks a client as “blacklisted”.

Format: blacklist INDEX

• Marks the client specified by the index INDEX as “blacklisted”.
• INDEX refers to the index number shown in the displayed person list and must be a positive integer 1, 2, 3, …

Examples:

• blacklist 2 marks the second person in the list as blacklisted

Tip:
Entering blacklist on its own without any other parameters will display all clients who have been blacklisted.

Whitelist a Client: whitelist

Whitelists a previously-blacklisted client.

Note: A client is considered to be on the whitelist if their client status is not “blacklisted”.

Format: whitelist INDEX cs/NEW_CLIENT_STATUS

• Changes the status of the client specified by the index INDEX from “blacklisted” to NEW_CLIENT_STATUS.
• INDEX refers to the index number shown in the displayed person list.
• INDEX must be a positive integer 1, 2, 3, …
• NEW_CLIENT_STATUS refers to the new status of the client. Acceptable values are potential, unresponsive, old and active.

Examples:

• whitelist 2 cs/active whitelists the second person in the list and marks them as an active client.
• whitelist 1 cs/old whitelists the first person in the list and marks them as an old client.

Tip:
Entering whitelist on its own without any other parameters will display all clients who have been whitelisted.

Sort Client list: sort

Sorts the client list in ascending order by the specified field.

Format: sort FIELD ORDER

• FIELD can be either deadline or name (case-insensitive)
• ORDER can be either ascending or descending (case-insensitive)

Examples:

• sort name ascending sorts the client list alphabetically by name in ascending order.
• sort deadline descending sorts the client list by project deadline (later dates first).

Tip:
Clientele+ saves you the hassle of sorting the list every time you open the app. Every time you sort, it will save the list in the specified sort order.

Archive a Client: archive

Archives a client present in the main client list.

Format: archive INDEX

• INDEX refers to the index number shown in the displayed person list and must be a positive integer 1, 2, 3, …

Examples:

• archive 1 archives the first person in the main client list, removing it and storing it in an archived list

Unarchive a Client: unarchive

Unarchives a client and adds the client back to the main client list.

Format: unarchive INDEX

• INDEX refers to the index number shown in the displayed person list and must be a positive integer 1, 2, 3, …

Examples:

• unarchive 1 removes the first person from the archived list, adding it back to the main client list

Listing all archived clients: archive-list

Shows a list of all archived clients’ contacts in Clientele+.

Format: archive-list

Note:
The archive list is a purely read-only list. You can only use 5 commands while viewing it:
1. unarchive (to unarchive a client)
2. list (to navigate back to the main client list)
3. exit (to exit the application)
4. help (to view the help window)
5. archive-list (redundant)

All other commands will require you to navigate back to the main client list first using the list command.

Deadline Reminder

The Deadline Reminder feature automatically tracks the latest upcoming and overdue deadlines for active clients and displays them in the footer. This feature runs without any command input from the user.

• Reminders are only shown for clients with an active client status and in progress project status.
• The feature does not track completed projects or old/unresponsive/blacklisted/potential clients.
• If there are overdue deadlines, only overdue projects are shown; upcoming deadlines will not be displayed

Examples:

Single Client Due Today:

• John has deadline due today. This shows that John, an active client, has a deadline due today.

More Than Three Clients Due Today:

• John, Alice, Charlie and 1 more have deadlines due today. This shows that John, Alice, Charlie, and one additional active client have deadlines due today.

No Active Clients With Upcoming Or Overdue Deadlines:

• No upcoming or overdue reminders. This indicates there are no active clients with upcoming or overdue deadlines.

Note:
Reminders shown are only for clients in the main client list, not for those in the archive list.

Data Management

Saving the Data

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

Editing the data file

Clientele+ data is 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.

Data of archived clients is saved automatically as a separate JSON file [JAR file location]/data/archivedAddressBook.json.

Caution:
If your changes to the data file makes its format invalid, Clientele+ will discard all data and start with an empty data file at the next run. Hence, it is recommended to take a backup of the file before editing it.
Furthermore, certain edits can cause the Clientele+ to behave in unexpected ways (e.g., if a value entered is outside of the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.

Undo Command [coming in v2.0]

Details coming soon …

Add Notes for a Client [coming in v2.0]

Details coming soon …

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.

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. If you minimize the Help Window and then run the help command (or use the Help menu, or the keyboard shortcut F1) again, the original Help Window will remain minimized, and no new Help Window will appear. The remedy is to manually restore the minimized Help Window.
3. Sorting for clients with same Name/Deadline: When a sort is applied, if multiple people share the same name or deadline, modifying other fields (e.g. project status) may shuffle their order, though sorting among different names or deadlines remains correct. This bug is due to a JavaFX SortedList issue and will be fixed in an upcoming update. More details in the Developer’s Guide.

Command summary