TeamTracker User Guide

Welcome to TeamTracker, your ultimate solution for managing contacts and tasks!

Designed with simplicity in mind, TeamTracker seamlessly combines the ease of a Graphical User Interface (GUI) with the efficiency of a Command Line Interface (CLI), catering to users of all technical abilities.

Tailored for individuals with fast typing speeds who prefer keyboard-centric navigation to mouse-driven interfaces, TeamTracker is the ideal solution for anyone looking to enhance their task management workflow.

Don't worry if you are not tech-savvy – TeamTracker is designed for effortless use, whether you are a coding geek or just getting started. Our intuitive interface makes task and contact management a breeze, so you can focus on what matters most without any hassle.

This User Guide serves as your comprehensive resource for mastering TeamTracker's features and maximizing its potential. Whether you're a seasoned pro or new to task management software, this guide will equip you with the knowledge needed to harness the full capabilities of TeamTracker.

---

Quick start

Install and launch application

1. Ensure you have Java 11 or above installed in your Computer. Run java -version on your command terminal to check your Java version.

2. Download the latest TeamTracker.jar from here.

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

4. Open a command terminal, cd into the folder you put the jar file in, and use the java -jar TeamTracker.jarcommand to run the application (if you are not sure how to use the command terminal, refer to this section for a more detailed guide).
   A GUI similar to the below should be displayed in a few seconds. Note how the app contains some sample data.
   

   

5. Congratulations, you are now a TeamTracker user! Get ready to take control of your tasks and contacts efficiently!
   You can begin with the Basic tutorial section or refer to the Features section if you already had prior experience.

---

(If you have no experience on command terminal) Open and navigate the command terminal

1. Search for "Terminal", open the first app that popped up. A UI similar to the below should appear.
   

   

2. Go to the folder you put the file TeamTracker.jar. Then, right-click on the jar file, select "Properties", and copy the details in the "Location:" field. Use the picture below for references.
   

   

3. Go back to the Terminal, type cd followed by a whitespace, then paste the location you just copied and Enter. Now you should be at the folder where TeamTracker.jar is stored.

4. Type java -jar TeamTracker.jar then Enter to run the application and the app User Interface should be displayed.
   

   

If not, you might run java -version to check the Java version of your computer before running the jar file. Read the Quick start section again to check the Java version required for our app. 5. Congratulations, you are now a TeamTracker user! Get ready to take control of your tasks and contacts efficiently!
You can begin with the Basic tutorial section or refer to the Features section if you already had prior experience.

---

Basic tutorial (for starters)

In this tutorial, we will guide you through the basics of using our app to manage your tasks efficiently. With TeamTracker, staying organized has never been easier. Let's get started!

The image below is the application interface with more detailed annotations for you to gain a better understanding of each part in our app.

You can see that the UI is divided into four main parts:

• Command Box: This is where you enter your command into the app.
• Message Box: After you entered a command, the message showing the result of a command will be shown here.
• Person List: Displays the list of people stored in your app.
  • Each person has a name that is displayed beside their number on the list. As names are the most natural way for you to distinct between people, we made it the most notable part for person so that you can look at different people with ease.
  • Under the name are other personal information of a person. From top to bottom, they are phone number, address and email. These additional information are used when you need to contact a friend or group mate about any issues you might have.
  • Additional information that will be shown later is the tasks assigned to a person. When a task is assigned to a person, that task will be displayed as a block under the person's name. In this image, there are no tasks assigned to any person.
• Task List: Displays the list of tasks stored in your app.
  • Each task has a task name beside their number on the list. Similar to person, names are the best way for you to distinct between tasks, so we choose it to be the most notable part in each task.
  • Beside task name is another essential aspect for managing tasks, which is task status. A task can either be Done or Not Done. Therefore, when you look at tasks, you would prioritize tasks that are unfinished before those that are done already.
  • Under the task name is task priority, which can be Low, Medium, or High. This also determines how important a task is so you can choose which one to finish first.
  • Under the task priority is task description, which contains the details of a task that task name did not cover.
  • Another additional information that was left out in this part is task deadline. Deadline contains a date and time and it tells you when a task is due so that you can plan accordingly.

Now, let's try to add a task into our task list. Type addtask n/MA HW d/math homework 4 week 12 p/high into the command box and press Enter. The result should be similar to this:

After you finish a task, you can mark that task as done. From the image above, you can see that the task "MA HW" is at number 1 on the list. Therefore, to mark that task as done, type marktask 1 and this should be your result:

Here you might ask "Why is the task MA HW moved to number 3?". That is because we want you to see the tasks that you have not finished first when you look at the list. More details are given in the Notes about tasks order section.

After you have finished the task "MA HW", you might no longer need to store that task in the app. In that case, type deletetask 3 since the task is now at position number 3 on the list. And this is what you should see:

Congratulations! You have learned how to add, mark, and delete tasks using TeamTracker. With these basic commands, you can start managing your tasks with ease.

For a comprehensive overview of all the powerful commands at your fingertips, be sure to check out the Features section to unlock the full potential of TeamTracker.

---

Features

Notes

Notes about tasks order

When managing tasks in TeamTracker, it's essential to understand the order in which tasks are displayed to ensure efficient organization:

Notes about reading command guide

Each command in this guide are formatted with the following conventions:

Notes about the command format

Managing Person

Adding a person: add

Adds a person to the person list.

Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS​

Result:

• If all input you provided is valid, that person will be added to the person list with their respective personal information.
• If any of the input (names, phone numbers, emails, address) you provided is invalid, the respective error message for that invalid input will appear, so that you know how to change your input accordingly,
• If any of the input (names, phone numbers, emails, address) is missing, the invalid command format message will be shown, along with the correct format for the command.

Examples:

• add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01
• add n/Betsy Crowe e/betsycrowe@example.com a/Newgate Prison p/1234567

Listing all persons : list

Shows a list of all persons stored.

Format: list

Result: Show the full person list.

Example: list

Editing a person : edit

Edits an existing person in the list.

Format: edit PERSON_INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS]

Notes:

• 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 for that respective field.

Result:

• If no fields are provided, an error message will be displayed.
• Otherwise, the app replaces the value in the field you specified with the value you provided.

Examples:

• edit 1 p/91234567 e/johndoe@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 Edits the name of the 2nd person to be Betsy Crower.

Locating persons by name: find

Finds persons whose names contain any of the given keywords.

Format: find KEYWORD [MORE_KEYWORDS]

Notes:

• The search is case-insensitive. e.g hans will match Hans
• The order of the keywords does not matter. e.g. Hans Bo will match Bo Hans
• Only the name is searched.
• Only full words will be matched e.g. Han will not match Hans
• Persons matching at least one keyword will be returned (i.e. OR search). e.g. Hans Bo will return Hans Gruber, Bo Yang

Result:

• If no matching name is found, an empty list is displayed
• If the search find at least one person, all person found will be displayed as a list and they are sorted by their names lexicographically.

Examples:

• find John returns john and John Doe
• find alex david returns Alex Yeoh, David Li
  

Deleting a person : delete

Deletes the specified persons from the address book.

Format: delete PERSON_INDEX [MORE_PERSON_INDICES]

Notes:

• Duplicate indices will be removed, e.g. delete 1 1 is the same as delete 1.
• The order of the indices does not matter, e.g. delete 1 2 is the same as delete 2 1.
• The indices refer to the index numbers shown in the displayed person list.
• The indices must be positive integers 1, 2, 3, ...
• If at least one of the indices are invalid, the command fails, e.g. list followed by delete 1 2 fails if there is only one person in the address book.

Result:

• If one of the INDEX you provided is not on the displayed list, an error message will be shown. It will tell you the index you provided is invalid
• Otherwise, the person(s) with the index(or indices) you provide on the displayed person list is/are deleted.

Examples:

• list followed by delete 1 2 deletes the first two persons in the address book.
• find Betsy followed by delete 1 deletes the 1st person in the results of the find command.

Clearing all entries : clear

Clears all entries from the address book.

Format: clear

Result: delete all person on the person list.

Managing task

Adding a task: addtask

• Adds a task to the task list with three levels of priority (LOW, MEDIUM, HIGH).
• Priority can also be in integers (1-Low, 2-Medium, 3-High).
• The deadline is optional for the adding of tasks.

Format: addtask n/TASK_NAME d/TASK_DESCRIPTION p/TASK_PRIORITY [by/TASK_DEADLINE]​

Notes:

• Task name can be any characters, not just alphanumeric. Same for task description.
• Task priority currently has three values: Low, Medium, or High, and their respective numerical values are 1, 2, and 3. Therefore, for priority, you can use both low, medium and high or 1, 2, 3 respectively.
• Task deadline must be in the format dd-MM-yyyy HH:mm.

Result:

• If any of the compulsory input is missing, an error message of invalid command format will appear.
• If task priority are specified with a value different from the {low, medium, high, 1, 2, 3} set, an error message about task priority will be shown.
• If the deadline is not in the correct DateTime format, an error message about deadline will be displayed.
• Otherwise, if all the inputs are valid, a new task is added to the task list using the information provided.

Examples:

• addtask n/Task 1 d/Do homework p/HIGH
• addtask n/Task 1 d/Do homework p/1
• addtask n/Task 1 d/Do homework p/HIGH by/12-12-2024 23:59

Assigning a task: assign

Assigns a task to persons.

Format: assign TASK_INDEX to/PERSON_INDEX [MORE_PERSON_INDICES]

Notes:

• Duplicate person indices will be removed, e.g. assign 1 to/1 1 is the same as assign 1 to/ 1.
• The order of the person indices does not matter, e.g. assign 1 to/1 2 is the same as assign 1 to/2 1.
• The task/person indices refer to the index numbers shown in the displayed task/person list.
• The indices must be positive integers 1, 2, 3, ...
• If at least one of the indices are invalid, the command fails, e.g. list followed by assign 1 to/1 2 fails if there is only one person in the address book.
• If a specified person is already assigned the task, the command still succeeds, and no change will occur to the person.

Result:

• If at least one of the index provided is invalid, an error message will be displayed.
• Otherwise, the task assigned will be shown under each assigned person's name.

Examples:

• list and listtask followed by assign 1 to/1 2 assigns the 1st task in the task list to the first two persons in the address book.
• find Betsy and findtask implement followed by assign 1 to/1 assigns the 1st task in the results of the findtask command to the 1st person in the results of the find command.

Unassigning a task: unassign

Unassigns a task to persons.

Format: unassign TASK_INDEX to/PERSON_INDEX [MORE_PERSON_INDICES]

Notes:

• Duplicate person indices will be removed, e.g. unassign 1 to/1 1 is the same as unassign 1 to/ 1.
• The order of the person indices does not matter, e.g. unassign 1 to/1 2 is the same as unassign 1 to/2 1.
• The task/person indices refer to the index numbers shown in the displayed task/person list.
• The indices must be positive integers 1, 2, 3, ...
• If at least one of the indices are invalid, the command fails, e.g. list followed by unassign 1 to/1 2 fails if there is only one person in the address book.
• If a specified person is already not assigned the task, the command still succeeds, and no change will occur to the person.

Result:

• If at least one of the index provided is invalid, an error message will be displayed.
• Otherwise, that task under each assigned person's name will be deleted and the person(s) is/are unassigned from the task.

Examples:

• list and listtask followed by unassign 1 to/1 2 unassigns the 1st task in the task list to the first two persons in the address book.
• find Betsy and findtask implement followed by unassign 1 to/1 unassigns the 1st task in the results of the findtask command to the 1st person in the results of the find command.

Clearing all tasks of a person: cleartask

Clears all tasks of a person.

Format: cleartask PERSON_INDEX

Result: Delete all tasks assigned to a person

Examples

• cleartask 1

Marking tasks: marktask

Marks a task in the task list as Done.

Format: marktask TASK_INDEX [MORE_TASK_INDICES]

Notes:

• Duplicate indices will be removed, e.g. marktask 1 1 is the same as marktask 1.
• The order of the indices does not matter, e.g. marktask 1 2 is the same as marktask 2 1.
• The indices refer to the index numbers shown in the displayed task list.
• The indices must be positive integers 1, 2, 3, ...
• If at least one of the indices are invalid, the command fails, e.g. list followed by marktask 1 2 fails if there is only one task in the task list.
• If a specified task is already marked as done, the command still succeeds, and no change will occur to the task.

Result:

• If at least one of the index provided is invalid, an error message will be displayed.
• Otherwise, the task(s) at the index (or indices) provided will be marked as Done

Examples:

• list followed by marktask 1 2 marks the first two tasks in the task list as done.
• findtask implement followed by marktask 1 marks the 1st task in the results of the find command as done.

Unmarking a task: unmarktask

Marks a task in the task list as Not Done.

Format: unmarktask TASK_INDEX [MORE_TASK_INDICES]

Notes:

• Duplicate indices will be removed, e.g. unmarktask 1 1 is the same as unmarktask 1.
• The order of the indices does not matter, e.g. unmarktask 1 2 is the same as unmarktask 2 1.
• The indices refer to the index numbers shown in the displayed task list.
• The indices must be positive integers 1, 2, 3, ...
• If at least one of the indices are invalid, the command fails, e.g. list followed by unmarktask 1 2 fails if there is only one task in the task list.
• If a specified task is already marked as not done, the command still succeeds, and no change will occur to the task.

Result:

• If at least one of the index provided is invalid, an error message will be displayed.
• Otherwise, the task(s) at the index (or indices) provided will be marked as Not Done.

Examples:

• list followed by unmarktask 1 2 marks the first two tasks in the task list as not done.
• findtask implement followed by unmarktask 1 marks the 1st task in the results of the find command as not done.

Deleting a task: deletetask

Deletes the specified tasks from the task list.

Format: deletetask TASK_INDEX [MORE_TASK_INDICES]

Notes:

• Duplicate indices will be removed, e.g. deletetask 1 1 is the same as deletetask 1.
• The order of the indices does not matter, e.g. deletetask 1 2 is the same as deletetask 2 1.
• The indices refer to the index numbers shown in the displayed task list.
• The indices must be positive integers 1, 2, 3, ...
• If at least one of the indices are invalid, the command fails, e.g. listtask followed by deletetask 1 2 fails if there is only one task in the task list.

Result:

• If at least one of the index provided is invalid, an error message will be displayed.
• Otherwise, the task at the given index (or indices) are deleted.

Examples:

• listtask followed by deletetask 1 2 deletes the first two tasks in the task list.
• findtask implement followed by deletetask 1 deletes the 1st task in the results of the findtask command.

Editing a task: edittask

Edits an existing task in the task list.

Format: edittask TASK_INDEX [n/TASK_NAME] [d/TASK_DESCRIPTION] [p/TASK_PRIORITY] [by/TASK_DEADLINE]​

Notes:

• Edits the task at the specified TASK_INDEX. The index refers to the index number shown in the displayed task 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.

Result:

• If the TASK_INDEX provided is invalid, an error message is displayed.
• If no optional fields are provided, an error message is displayed.
• Otherwise, the app replaces the value in the field you specified with the value you provided.

Examples:

• edittask 1 p/high
• edittask 2 d/new description by/04-04-2024 10:33
• edittask 3 n/new task d/new description p/low by/04-04-2024 10:33

Listing the tasks: listtask

Shows a list of all tasks in the task list.

Format: listtask

Result: List all tasks stored in the app.

Examples:

• listtask

Finding a task or tasks by task name: findtask

Finds tasks which names contain any of the given keywords.

Format: findtask KEYWORD [MORE_KEYWORDS]

Notes:

• The search is case-insensitive. e.g 2103t will match 2103T
• The order of the keywords does not matter. e.g. findpriority implement will match implement findpriority
• Only the task name is searched.
• Only full words will be matched e.g. prio will not match priority
• Tasks matching at least one keyword will be returned (i.e. OR search). e.g. 2103t 2101 will return 2101 CA3, 2103t milestone

Result:

• If no matching task name is found, an empty list is displayed.
• If the search find at least one task, all tasks found will be displayed as a sorted task list.

Examples:

• findtask implement returns implement findpriority and implement mass ops
• findtask cs2103t cs2101 returns CS2101 CA3, CS2103T developer guide

Others

Viewing help : help

Shows a message explaining how to access the help page (the User Guide).

Format: help

Result: Display a box that contains the link to the User Guide.

Exiting the program : exit

Exits the program.

Format: exit

Result: Close the app.

Saving the data

AddressBook and TaskList 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

AddressBook data are saved automatically as a JSON file [JAR file location]/data/addressbook.json. TaskList data are saved automatically as a JSON file [JAR file location]/data/tasklist.json. Advanced users are welcome to update data directly by editing the data files.

Future updates

Create group [coming in v2.0]

The Create group command enables users to select a list of unique individuals from their contacts and create a group comprising those chosen members.

Clear task list [coming in v2.0]

This command will be very similar to the clear command, but instead of clearing the person list, this command would clear the task list instead.

Undo a command [coming in v2.0]

The Undo command in TeamTracker offers users the convenience of reverting the most recent action with a simple command. Whether an accidental deletion or unintended modification, this feature provides you a quick and efficient way to backtrack the last action, restoring the previous state effortlessly.

---

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

Q: Why is there no way to delete only the deadline of a task?
A: Currently we do not have a command that supports such specific task. However, one alternative to achieve your desired result is to delete the task you want to remove the deadline, then add that task again with all the old fields except for deadline. The process is somewhat tedious, but it gives you what you desired.

---

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.

---

Command summary