About AronaPro

---

Welcome to AronaPro, and we thank you for choosing us as your all-in-one solution! Our product is a desktop app designed primarily for Computing Professors and Teaching Assistants(TAs) to manage your students/professors/TAs' contacts and schedules efficiently, optimised for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). Our simple-to-grasp software also warmly welcomes professors and TAs from various faculties without any technological background!

We are excited to have you on board and to guide you through how to use our software with this guide. Click here to learn more about our User Guide.

Together, let us Centralise, Connect and Coordinate!

---

Table of content

• About AronaPro
  • Table of Content
  • About UserGuide
  • Quick Start
  • Features
    • Understanding our application's interface
    • Notes about command format
    • Help command
    • Add command
    • View command
    • Edit command
    • Find command
    • Delete command
    • Group command
    • Schedule command
    • Pin command
    • Clear command
    • Exit command
    • Saving the data
    • Editting the data file
  • FAQ
  • Existing issues
  • Planned enhancements
  • Command summary

---

About UserGuide

Welcome to our User Guide! Here, we have got everything you need to know about using all of our application's features. If you are already familiar with our application, dive straight into the Features section to discover more. However, if you are new to the application, we have got you covered. You can simply do so by following our guide systematically, starting with the Quick Start section, to quickly get up to speed with AronaPro before you start your own adventure. Let us get started!

---

Quick start

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

2. Download the latest aronapro.jar here.

3. Copy the file to the folder you want to use as the home folder for AronaPro in your desired location. For demonstration purpose, we will save the downloaded jar file into test folder and saved it to Desktop on either Mac or Windows machines.

4. Open a command terminal, either by typing terminal on Mac or PowerShell on Windows machine and perform the following steps to reach the test folder created earlier in order to run the application:

   1. First type ls to see what are all the folders in your current directory.
   2. Type cd <file_name> where the file name refers to the file name you are trying to enter. One tip is that file name can be auto-completed simply by typing the first few letters and hitting Tab.
   3. Repeat i. and ii. above until you see the test folder and cd into it as show in the sequence of diagrams for both Mac and Windows machines below:

   

   

   

5. Lastly, enter the command: java -jar aronapro.jar to run the application.
   A GUI similar to the below should appear in a few seconds.
   

   

   e.g. Typing `help` and pressing Enter will open the help window.
   Some example commands you can try to quickly get started with our application:

   • view : Lists all contacts.

   • add id/E1234567 n/John Doe p/98765432 e/johnd@example.com t/Student g/CS2103T : Adds a student with NAME John Doe with NUSID of E1234567 to AronaPro.

   • delete id/E1234567 : Deletes the person with NUSID of E1234567.

   • clear : Deletes all contacts.

   • exit : Exits the app.

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

---

Features

Understanding our application's interface

Notes about the command format:

• Words in UPPER_CASE are the parameters to be supplied by the user.
  

  In the delete command as such: delete id/NUSID, NUSID is a parameter which need to be supplied.

• Items in square brackets are optional.
  

  n/NAME [t/TAG] can be used as n/John Doe t/Student or simply as n/John Doe without specifying the TAG as it is optional.

• Items with …​ after them can be used multiple times or zero times.
  

  • [g/GROUP]…​ can be used as (i.e. 0 times) or g/CS2101 g/CS2103T, demonstrating that group can be used 2 times by writing them successively on the same line etc.
  • The only exception to the above is when NUSID is of concern where it needs to be used at least once or more. id/NUSID…​ means that you need to use it once as such: id/E1234567 or you can choose to use it more than once: id/E1234567 id/E0123456.

• Parameters can be in any order.
  

  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, view, exit and clear) will be ignored.
  

  If the command specifies help 123, it will be interpreted as help.

• If you are using a PDF version of this document, be careful when copying and pasting commands that span multiple lines as space characters surrounding line-breaks may be omitted when copied over to the application.

Viewing help : help

Shows a message explaining how to access the help page.

Format: help

Adding a person: add

Adds a person to AronaPro.

Format: add id/NUSID n/NAME p/PHONE_NUMBER e/EMAIL t/TAG [g/GROUP]…​

Note:

• The NUSID refers to the NUSID shown in the displayed person list.
• The NUSID must be a 7-digit number following a capital 'E'.
• NAME can consist of numbers.
• NAME can be duplicated for different persons.
• PHONE_NUMBER has to be 3-10 digits long.
• EMAIL can be duplicated for different persons.
• EMAIL follows the following format and constraints:
  • It should have a local-part followed by a @ and then a domain name.
    • Local-part should only contain alphanumeric characters and special characters(+ _ . -).
    • Local-part may not start or end with any special characters.
    • Domain name is made up of domain label separated by periods.
    • Domain name must end with a domain label at least 2 characters long.
      • Have each domain label start and end with alphanumeric characters.
      • Have each domain label consist of alphanumeric characters, separated only by hyphens, if any.
• For TAG, the valid forms have to be either 1 of these: Professor, TA, Student, None.
• For GROUP, the group must only contain alphanumeric characters or spaces.

Tip: A person can have 0 or more groups.

Examples:

• add id/E1234567 n/John Doe p/98765432 e/johnd@example.com t/Student g/CS2103T

  This command would add a person with NUSID of E1234567, NAME of John Doe, PHONE_NUMBER of 98765432, EMAIL of johnd@example.com TAG of Student, GROUP of CS2103T into AronaPro.

  

• add id/E7654321 n/Betsy Crowe t/TA e/betsycrowe@example.com p/92345678

  This command would add a person with NUSID of E7654321, NAME of Betsy Crowe, TAG of TA, EMAIL of betsycrowe@example.com, PHONE_NUMBER of 92345678 into AronaPro.

  

Viewing all persons : view

Shows the entire list of persons in AronaPro.

Format: view

Editing a person's information : edit

Edits the information of a person of a specified NUSID in AronaPro.

Format: edit id/NUSID [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [t/TAG] [g/GROUP]…​

Note:

• The NUSID refers to the NUSID shown in the displayed person list.
• The NUSID must be a 7-digit number following an 'E'.
• NAME can consist of numbers.
• NAME can be duplicated for different persons.
• PHONE_NUMBER has to be 3-10 digits long.
• EMAIL can be duplicated for different persons.
• EMAIL follows the following format and constraints:
  • It should have a local-part followed by a @ and then a domain name.
  • Local-part should only contain alphanumeric characters and special characters(+ _ . -).
  • Local-part may not start or end with any special characters.
  • Domain name is made up of domain label separated by periods.
    • Domain name must end with a domain label at least 2 characters long.
    • Have each domain label start and end with alphanumeric characters.
    • Have each domain label consist of alphanumeric characters, separated only by hyphens, if any.
• When editing TAG, the valid forms have to be either 1 of these: Professor, TA, Student, None.
• When editing GROUP, the group must only contain alphanumeric characters or spaces.
• At least one of the optional fields must be provided.
• Existing values will be replaced by and updated to the new input values.
• Attempt to edit a person with NUSID not in AronaPro would result in an error message.

Examples:

• edit id/E0123456 p/91234567 e/johndoe@example.com

  This command would edit the phone number and email address of the person with NUSID E0123456 to be 91234567 and johndoe@example.com respectively.

  

• edit id/E1234567 n/Betsy t/Professor

  This command would edit the name and the tag of the person with NUSID E1234567 to be Betsy and Professor respectively.

  

Finding a person: find

Finds persons whose details match ALL the given keywords.

Format: find [id/NUSID] [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [t/TAG] [g/GROUP]…​

Note:

• The NUSID search matches people that has a prefix that STARTS WITH the query (e.g E0123 fetches E0123456).
• The NAME search is case-insensitive. e.g hans will match Hans.
• The order of NAME keywords does not matter. e.g. Hans Bo will match Bo Hans.
• Only full words will be matched for NAME e.g. Han will not match Hans.
• Persons matching ANY word will be selected for NAME (e.g. Hans Bo will fetch Hans Gruber, Bo Yang).
• The PHONE_NUMBER search matches people that has a number that STARTS WITH the query (e.g 9123 fetches 91237654).
• The EMAIL search uses a PARTIAL, case-insensitive match. (e.g. charles matches PrinceCharles@kingston.com).
• The TAG search uses an EXACT case-sensitive match.
• The GROUP search fetches people with ALL specified groups (e.g g/CS2101 g/CS2103T matches a person who minimally has BOTH these Groups).
• Persons matching all parameters will be returned (i.e. AND search).

Examples:

• find n/roy

  This command would return Roy G Biv and Roy Balakrishnan.

  

• find n/roy g/CS2101

  This command would return Roy Balakrishnan who is the only person matching both the 2 conditions.

  

Deleting a person : delete

Deletes person of a specified NUSID from the filtered address book OR deletes all persons from a specified GROUP from the filtered address book.

Format 1: delete id/NUSID

Note:

• Deletes the person of a specified NUSID.
• The NUSID refers to the NUSID shown in the displayed person list.
• The NUSID must be a 7-digit number following an 'E'.

Examples:

• delete id/E0123456

  This commmand will delete an existing person with NUSID of "E0123456".

  

Format 2: delete g/GROUP

Note:

• Deletes ALL people in a specified GROUP.
• The group refers to the group shown in the displayed person list.
• The group must exist in AronaPro beforehand.

Examples:

• delete g/CS2103T

  This command will delete an existing person with GROUP of "CS2103T".

  

Assigning people to a group : group

Assigns either a group or a tag to a person of a specified NUSID from AronaPro.

Format: group id/NUSID…​ [g/GROUP]…​ [t/TAG]

Note:

• Groups the person of a specified NUSID.
• The NUSID refers to the NUSID shown in the displayed person list.
• The NUSID must be a 7-digit number following an 'E'.
• More than one NUSID can be specified for a group command to group more than one person (group id/E1234567 id/E0123456 g/Friends).
• At least one of the optional fields must be provided.
• When assigning TAG, the valid forms have to be either 1 of these: Professor, TA, Student, None.
• When assigning GROUP, the group must only contain alphanumeric characters or spaces.
• Existing values will be replaced by and updated to the new input values.
• A person can be assigned to a non-existing group.

Examples:

• group id/E0123456 g/CS2101

  This command will assign or change a group of the person with NUSID E0123456 to 'CS2101'.

  

• group id/E0123456 t/TA

  This command will assign or change the tag of the person with NUSID E0123456 to 'TA'.

  

Schedule a meeting with a person: schedule

Schedule a meeting with a person in AronaPro.

Format: schedule id/NUSID [s/SCHEDULE r/REMARK]

Note:

• Schedule a meeting with a person of the specified nusId on the specified SCHEDULE with a REMARK.
• The NUSID refers to the NUSID shown in the displayed person list.
• The NUSID must be a 7-digit number following an 'E'.
• Both SCHEDULE and REMARK must be either provided or not provided.
• If SCHEDULE and REMARK are not provided and the Schedule command is used as a standalone, the schedule will be removed (schedule id/E1234567).

Tip: The SCHEDULE must be in one of the formats: DD/MM/YYYY, DD-MM-YYYY, DD.MM.YYYY, MMM DD, YYYY, DD MMM YYYY. Example of date formats include: 12-12-2024, 12/12/2024, 12.12.2024, Dec 12, 2024, 12 Dec 2024.

Examples:

• schedule id/E0123456 s/12-12-2024 r/Consultation

  This command will schedule a meeting with the person of NUSID E0123456, with SCHEDULE on 12th December 2024 and a REMARK of Consultation. If there was a previous date, or remark, it will be replaced!

  

• schedule id/E0123456

  This command will remove the schedule with the person of NUSID E0123456.

  

Pinning a person: pin

Pins a person to the top of AronaPro.

Format: pin id/NUSID

Note:

• The NUSID refers to the NUSID shown in the displayed person list.
• The NUSID must be a 7-digit number following an 'E'.

Examples:

• pin id/E0123456

  This command will pin a student with NUSID of "E0123456".

  

Clearing all entries : clear

Clears all entries from AronaPro.

Format: clear

Exiting the program : exit

Exits the program.

Format: exit

Saving the data

AronaPro 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

All data from the application 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.

Caution: If your changes to the data file makes its format invalid, AronaPro 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 AronaPro to behave in unexpected ways (e.g., if a value entered is outside the acceptable range). Therefore, edit the data file only if you are confident that you can update it correctly.

---

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 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. When using the schedule command, the command does not check for the validity of the date entered. Hence, it is important to ensure that the date entered is valid.
3. When using the schedule command, the command does not check if the valid date entered is in the future. Hence, it is important to ensure that the date entered is in the future.
4. When using the edit command, the command does not check for the validity of the domain name of the email entered as writing an incorrect domain name after the @ is accepted (e.g. @random.com). Hence, it is important to ensure that a valid domain name is entered.
5. When using the group command with a very long group name, the group name may be hidden from view. The remedy is to resize the window to view the full group name.
6. When adding/editing a person's email address with a very long email address, the email address may be hidden from view. The remedy is to resize the window to view the full email address.
7. When resizing the window to a smaller size, the GUI may not fully display the person's information; for example: name, tag, remark. The remedy is to resize the window to a larger size to view all the information.
8. When adding/editing names with special characters, i.e. !@#$%^&*()_+, the application does not allow such names to be added/edited. The remedy is to avoid using special characters in the names.
9. When using any command We do not check for extra unrecognized flags (e.g. z/), as it might be included in certain fields such as people names: Muhammad S/O Ahmad, group names: code/design lab etc. The remedy is to check what flags are valid before/while using a command.

---

Planned enhancements

Team size: 5

1. Validity of date entered: The current behaviour of the schedule command does not check for the validity of the date entered. We plan to implement a check to ensure that the date entered is valid.
2. Future date check: The current behaviour of the schedule command does not check if the valid date entered is in the future. We plan to implement a check to ensure that the date entered is in the future.
3. Validity of email domain entered: The current behaviour of the edit command does not check for the validity of the domain name of the email entered. We plan to implement a check to ensure that a valid domain name is entered.
4. Ordering date in chronological order: There is currently no ordering of date in any ways in our UI. We plan to implement sorting of the dates in chronological order to aid our users in remembering the dates for their schedules.
5. Group name visibility: When using the group command with a very long group name, the group name may be hidden from view. We plan to implement a feature to allow users to view the full group name. Either by truncating the group name, allowing the user to view the full group name or limiting the length of the group name.
6. Email address visibility: When adding/editing a person's email address with a very long email address, the email address may be hidden from view. We plan to implement a feature to allow users to view the full email address. Either by truncating the email address, allowing the user to view the full email address or limiting the length of the email address.
7. Tag information visibility: When resizing the window to a smaller size, the GUI may not fully display the person's tag information. We plan to implement a minimum size for the window to ensure that all information is displayed.
8. Tag case sensitivity: When editing tags, the valid forms have to be either 1 of these: Professor, TA, Student, None. We plan to implement a feature to allow users to enter tags in any case (e.g., professor, ta, student, none) and still be recognised as valid tags.
9. Special characters in names: When adding/editing names with special characters, i.e. !@#$%^&*()_+, the application does not allow such names to be added/edited. We plan to implement a feature to allow users to enter names with special characters.
10. One schedule per person: Currently, a person can only have one schedule. We plan to implement a feature to allow a person to have multiple schedules.

---

Command summary