EffiTrack User Guide

Notes about the command format:

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

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

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

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

Notes about the parameters:

• NAME: The name of the employee.

  • Only alphanumeric names with spaces is allowed.
  • Special characters are not allowed in names.
  • Employee of the same name are not allowed to be added to EffiTrack, or edit an existing employee's name to the same name as another existing employee in EffiTrack.
  • NAME is case-sensitive (e.g. john Doe is not the same as John Doe)
  • NAME is space-sensitive (e.g. John Doe is not the same as John Doe)

• PHONE_NUMBER: The phone number of the employee.

  • Has a minimum limit of 3 digits and maximum limit of 15 digits.

• EMAIL: The email address of the employee.

  • Valid as long as it follows the format of `local-part@domain and should not include whitespace
  • local-part should only contain alphanumeric characters and the following special characters +, _, . and - is allowed.
  • local-part may not start or end with any special characters.
  • local-part must be followed with an @.
  • domain is made up of one or more domain label.
    • Each domain label is separated by a ..
    • Last domain label must be at least 2 characters long.
    • Each domain label must start and end with alphanumeric characters.
    • Each domain label contains alphanumeric characters, separated only by -, if any.

• ADDRESS: The home address of the employee.

  • Can take any values, but should not be blank.

• DEPARTMENT: The department of the employee.

  • Only alphanumeric department names with spaces is allowed.
  • Special characters are not allowed in department names.

• EFFICIENCY: The efficiency score of the employee.

  • Takes in integer values in the range 0 to 100.

• TAG: The tag of the employee.

  • Should be alphanumeric without any whitespace. e.g: SisterBrother

• INDEX: The index refers to the index number shown in the displayed employee list.

  • Assigned to employee based on the order added into employee list.
  • Must be a positive integer (e.g. 1, 2, 3, …​) and should not be out of bound of the employee list.
  • Can only take integer within the maximum bound of int data type (up to 2147483647), otherwise it will not be considered as a positive integer.

• TASK: The task title of task.

  • Only alphanumeric task titles with spaces is allowed.
  • Special characters are not allowed in task titles.
  • Task of the same task title are not allowed to be assigned to different employees.
  • TASK is case-sensitive (e.g. project is not the same as Project)
  • TASK is space-sensitive (e.g. Project A is not the same as Project A)

• KEYWORD: The keyword of the query.

  • KEYWORD is case-insensitive.

• THRESHOLD: The threshold of efficiency score of the employee.

  • Takes in integer values in the range 0 to 100.

• COMMENT: The comment about the employee.

  • Can take in any values.

</>

Viewing help : help

Shows a message explaining how to access the help page.

Format: help

Adding an employee: add

Adds an employee to EffiTrack.

Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS d/DEPARTMENT eff/EFFICIENCY [t/TAG]…​

Examples:

• add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 d/Finance eff/80
• add n/Betsy Crowe t/friend e/betsycrowe@example.com a/Newgate Prison p/1234567 d/Murder eff/10 t/criminal

Listing all employees : list

Shows a list of all employees in EffiTrack.

Format: list

Editing an employee : edit

Edits an existing employee in EffiTrack.

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

• Edits the employee at the specified INDEX. The index refers to the index number shown in the displayed employee 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.
• Name of employee cannot be edited to a name that already exists even if other fields are different.
• When editing tags, the existing tags of the employee will be removed i.e adding of tags is not cumulative.
• You can remove all the employee’s tags by typing t/ without specifying any tags after it.

Examples:

• edit 1 p/91234567 e/johndoe@example.com Edits the phone number and email address of the 1st employee to be 91234567 and johndoe@example.com respectively.
• edit 2 n/Betsy Crower t/ Edits the name of the 2nd employee to be Betsy Crower and clears all existing tags.

Edit deadline of a task : edit_deadline

Edit the deadline of an employee's task

Format: edit_deadline INDEX by/dd-MM-yyyy HHmm

Example:

• edit_deadline 1 by/22-04-2024 2359

Locating employees by name: find

Finds employees whose names contain any of the given keywords.

Format: find KEYWORD [MORE_KEYWORDS]

• 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.
• Partial words will be matched e.g. Han will 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

Examples:

• find John returns john and John Doe

• find alex david returns Alex Yeoh, David Li
  

  

Locating employees by department: filter

Filters employees by their department or tags

Format: filter KEYWORD [MORE_KEYWORDS]

• The search is case-insensitive. e.g finance will match Finance
• The order of the keywords does not matter. e.g. Quantitative Finance will match Finance Quantitative
• Only the departments and tags are searched.
• Partial words will be matched e.g. Fin will match Finance
• Persons matching at least one keyword will be returned (i.e. OR search). e.g. Marketing Fiance will return Quantitative Finance, Marketing

Examples:

• filter Finance returns Finance and Quantitative Finance

• filter resource returns Human Resource, Resource Management
  

  

Deleting an employee : delete

Deletes the specified employee from EffiTrack.

Format: delete INDEX

• Deletes the employee at the specified INDEX.
• The index refers to the index number shown in the displayed employee list.
• The index must be a positive integer 1, 2, 3, …​

Examples:

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

Assign a task: assign

Assign a task to a specific person.

Format: assign task/TASK_TITLE by/dd-MM-yyyy HHmm to/INDEX

• Assigns the task to 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, …​
• The deadline must be in the correct format
• Task box might be displayed in a collapsed form but could be clicked on to expand for full details

Examples:

• assign task/Complete Project Proposal by/20-04-2024 2359 to/1 Assign the 'Complete Project Proposal' task to the first person in the address book.

Reassigning a task: reassign

Reassign a specific task from one person to another.

Format reassign from/FROMINDEX to/TOINDEX

• Assigns the task, which was previously assigned to person at the specified FROMINDEX, to the person at the specified TOINDEX
• The index refers to the index number shown in the displayed employee list.
• The index must be a positive integer 1, 2, 3, …​

Marking a task : mark

Mark the specified task as done.

Format: mark task/TASKNAME o/INDEX

• Mark the specified task with TASKNAME as done.
• The index refers to the index number shown in the displayed employee list.
• The index must be a positive integer 1, 2, 3, …​
• Updates the person in charge's efficiency as such:
  • Completed on the deadline: efficiency + 1
  • Completed N days early: efficiency + N
  • Completed N days late: efficiency - 2N

Examples:

• mark task/Submit Project o/1 mark the task Submit Project assigned to the first employee in EffiTrack as done.

Finding a task : findtask

Finds the person(s) in charge of the task. Note that this only updates the person list on the right side of the UI, and not the task list and the bottom left corner.

Format findtask KEYWORD

• The search is case-insensitive. e.g report will match Report
• The order of the keywords do not matter. e.g. report submit will match submit report
• Only the task name is searched.
• Partial words will be matched e.g. report will match reports

Finding a free person : findfree

Finds the person(s) who has no current task.

Format findfree

Filtering employees by efficiency: filter_efficiency

Filters employees with efficiency less than or equals to a given threshold.

Format: filter_efficiency THRESHOLD

• The threshold must be an integer in the range 0 to 100.

Examples:

• filter_efficiency 30 returns employees with efficiency 0 to 30.

Clearing all entries : clear

Clears all entries from EffiTrack.

Format: clear

Exiting the program : exit

Exits the program.

Format: exit

Undoing the previous command : undo

Undo the previous command.

Format: undo

Redoing the previous command : redo

Reverts the latest undo command.

Format: redo

Displaying the command history : history

Displays the commands executed from most recent to earliest, inclusive of invalid commands. It only stores commands used in a single session of usage of the program and is cleared if the app is restarted.

Format: history

Adding a comment to an employee : comment

Adds comment to an employee

Format: comment INDEX c/COMMENT

Example:

• comment 1 c/Good at database management.

Saving the data

EffiTrack 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

EffiTrack 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.

Archiving data files [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 EffiTrack 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.

---

Command summary