Introduction

TalentSG is a desktop application designed for HR professionals and recruiters who need to efficiently manage candidates and job roles. Built with productivity in mind, TalentSG is optimized for those who prefer a Command Line Interface (CLI) experience while still benefiting from a Graphical User Interface (GUI). This combination allows users to perform tasks through concise, text-based commands and receive visual feedback for each command executed.

TalentSG streamlines the process of tracking candidates, organizing job roles, and filtering based on status or skillsets. With a flexible command structure, users can work intuitively without having to remember overly complex commands, making TalentSG both powerful and user-friendly.

If you’re a fast typist, TalentSG can significantly speed up your candidate management workflow compared to traditional GUI-only applications. It is especially useful for those who value precision and speed, as the CLI minimizes the clicks and steps required to complete various HR tasks.

This document provides an in-depth guide to using TalentSG’s features and commands, ensuring that users can maximize their experience with the app. We currently support both Windows and Mac operating systems, so feel free to jump to Quick Start to begin.

We hope TalentSG becomes an indispensable tool in your recruitment and candidate management journey!

This app is a desktop app for managing candidates and job roles, optimized for use via a Command Line Interface (CLI) while still providing the benefits of a Graphical User Interface (GUI). If you can type fast, this app can help you manage your candidates and job roles faster than traditional GUI apps.

Table of Contents

• Command Summary
• Symbols and Tips
• Quick Start
• Features
  • Notes About the Command Format
  • Viewing Help: help
  • Adding a Person: add
  • Listing All Persons: list
  • Editing a Person: edit
  • Finding Persons by Name: find
  • Deleting a Person: delete
  • Filtering Contacts by Status: filter
  • Clearing All Entries: clear
  • Exiting the Program: exit
  • Saving Data
  • Editing the Data File
  • Archiving Data Files
• FAQ
• Known Issues
• Glossary
• Feedback and Support

Command Summary

Detailed information can be found under Features.

This project is based on the AddressBook-Level3 project created by the SE-EDU initiative.

Symbols and Tips

Throughout this guide, you’ll encounter several symbols. Refer to these symbols as you explore the guide. Each provides quick insights or warnings that can make your experience smoother:

• [Tip]: Useful information to enhance your experience.
• [Note]: Important information you should be aware of.
• [Caution]: Critical information to prevent potential issues.

Quick Start

1. Check Java Installation: Ensure you have Java 17 or above installed on your computer.
   • Check Java version on Windows
   • Check Java version on Mac
   • If your computer does not have Java or its version is below Java 17, you may refer to:
     • Install Java on Windows
     • Install Java on Mac
   • 📋:If you’re using an older version of Java, certain features might not work as expected. Updating to the latest version is recommended.
2. Download TalentSG: Get the latest .jar file from here. Tip To avoid typing the full path every time, place the TalentSG.jar file in a frequently accessed folder or create an alias for it on your system.
   
   
3. Set Up Home Folder: Copy the TalentSG.jar file to the Desktop to launch.
   
   
4. Run the Application:
   • Open a command terminal.
   • Navigate (cd) to the folder containing the .jar file.
     Example: cd C:\Users\[username]\Downloads
   • Run the application with the command:

     java -jar TalentSg.jar
     

     [⚠Caution]:Ensure you’re in the correct directory before running the TalentSG.jar command. Running it in an incorrect directory will result in a “file not found” error.
     
     

5. 🎉 A GUI similar to the one below should appear in a few seconds! 🎉 📋:Note how the app contains some sample data.
   
   

6. Interact with TalentSG:
   • Type your command into the command box and press Enter to execute it.
   • For example, typing help and pressing Enter will display the help message. ✨
7. Try Out Example Commands:
   • list : Lists all contacts.
   • add n/John Doe p/98765432 e/johnd@example.com a/123 Main St s/Java,Python st/Active note/Great candidate ex/5 years in HR dr/Software Engineer : Adds a contact named John Doe to TalentSG.
   • delete 3 : Deletes the 3rd contact shown in the current list.
   • clear : Deletes all contacts.
   • exit : Exits the app.
8. Explore Features: Refer to the Features section for detailed information on each command.

Features

TalentSG provides a variety of features to help you manage candidates and job roles effectively.

Notes About the Command Format

• UPPER_CASE: Parameters to be supplied by the user.
  • E.g., in add n/NAME, NAME can be John Doe.
• [Square Brackets]: Optional items.
  • E.g., n/NAME [t/TAG] can be n/John Doe t/friend or n/John Doe.
• Ellipsis (…): Items that can be used multiple times, including zero times.
  • E.g., [t/TAG]... can be t/friend, t/friend t/family, or omitted entirely.
• Parameters Order: Parameters can be in any order.
  • E.g., n/NAME p/PHONE_NUMBER is the same as p/PHONE_NUMBER n/NAME.
• Extraneous Parameters: Ignored for commands that do not take parameters.
  • E.g., help 123 is interpreted as help.
• Copying Commands: Be cautious when copying multi-line commands from PDFs; line breaks may affect the command execution.

Viewing Help: help

Format: help

Shows a message explaining how to access the help page.

Adding a Person: add

Adds a new candidate to TalentSG.

Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS dr/DESIRED_ROLE s/SKILLS ex/EXPERIENCE st/STATUS note/NOTE [t/TAG]...

Constraints

Example

add n/John Doe p/98765432 e/johnd@example.com a/311, Clementi Ave 2, #02-25 dr/Software Engineer s/Java, Python, C++ ex/Project Manager at Google from 2010-2020 st/Interviewed note/Super confident t/friends t/owesMoney

Image Example

Command: ` add n/Jason Bill p/90065432 e/jason@example.com a/31, Clementi Ave 4, #02-20 dr/Software Engineer s/Java, Python, C++ ex/CTO at Google st/Applied note/Responsible t/friends `

After the add command ran:

Listing All Persons: list

Shows a list of all applicants in TalentSG.

Format: list

Image Example

Command: ` list `

Before the list command ran:

After the list command ran:

Editing a Person: edit

Edits an existing person in the address book.

Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [s/SKILLS] [st/STATUS] [note/NOTE] [ex/EXPERIENCE] [dr/DESIRED_ROLE] [t/TAG]...

Constraints

• INDEX: Must be a positive integer corresponding to the candidate’s position in the list.
• At Least One Field: Must be provided.
• Existing Values: Will be replaced with new inputs.

Examples

• edit 1 p/91234567 e/johndoe@example.com: Updates phone and email of the first candidate.
• edit 2 n/Betsy Crower t/: Changes the name and clears all tags of the second candidate.

Image Example

Command: ` edit 1 st/Rejected note/arrogant `

Before the edit command ran:

After the edit command ran:

Finding Persons by Name: find

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

Examples:

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

Caution: If you search for “Han,” contacts named “Hans” will not appear in the results. Always search by full words.

Image Example

Command: ` find John Stanley `

Before the find command ran:

After the find command ran:

Deleting a Person: delete

Removes a candidate from TalentSG.

Format: delete INDEX

Constraints

• INDEX: Refers to the candidate’s number in the current list.
• Positive Integer: Must be 1, 2, 3, etc.

Examples

• list followed by delete 2: Deletes the second candidate.
• find Betsy followed by delete 1: Deletes the first candidate in the search results.

Image Example

Command: ` delete 2 `

Before the delete command ran:

After the delete command ran:

Filtering Contacts by Status: filter

Filters candidates based on their status.

Format: filter st/STATUS

Notes

• Case-Insensitive: The search is case-insensitive.
• Available Statuses:
  • Applied
  • Screening
  • Interview Scheduled
  • Interviewed
  • Offer
  • Onboarding
  • Hired
  • Rejected

Examples

• filter st/Applied: Displays all candidates marked as “Applied”.
• filter st/Interviewed: Shows candidates marked as “Interviewed”.

Image Example

Command: filter screening

Before the filter command ran:

After the filter command ran:

Invalid Status

If an invalid status is input (e.g., filter applying), an error message will appear:

Invalid status: applying. Valid statuses are: Applied, Screening, Interview Scheduled, Interviewed, Offer, Onboarding, Hired, Rejected

Clearing All Entries: clear

Removes all candidates from TalentSG.

Format: clear

Image Example

Before the clear command ran:

After the clear command ran:

Exiting the Program: exit

Closes the TalentSG application.

Format: exit

Image Example

Running the exit command:

Saving Data

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

Editing the Data File

Advanced users can edit the data file located at [JAR file location]/data/addressbook.json.

Caution:

• If your changes to the data file make its format invalid, TalentSG will discard all data and start with an empty data file at the next run.
• It is recommended to take a backup of the file before editing it.
• Certain edits can cause TalentSG to behave unexpectedly (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.

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

Q: Help! Double-clicking TalentSG.jar does not launch the application - what should I do?
A: Trying running the application from the command line using the following command: java -jar TalentSg.jar. Windows users can use the Command Prompt application to do this while Mac users can use the Terminal application.

Q: When I minimise the application, the entire application has shrunk and now it is gone! Help!
A: Currently our application do not allow diagonal or vertical resizing of the it. It is best not to resize the application at all and leave it as the maximized mode. For the this problem, we suggest that you try to maximise the application from the task manager or try to split the screen with another application so that StudyBuddyPro will resize back to normal. If the mentioned solutions fail, please do download TalentSg again!

Q: How do I save my data?
A: TalentSG saves your data automatically after every command.

Q: How do I update to the latest version of TalentSG?
A: Simply download the latest .jar file released on our GitHub page.

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.

Glossary

Interfaces

• CLI (Command Line Interface): A text-based interface where users type commands to interact with the application, providing faster and more precise control than a graphical interface.

• GUI (Graphical User Interface): A visual interface that lets users interact with the app through graphical elements like buttons, icons, and windows, making it more user-friendly.

Commands & Formats

• Command Format: The structure in which commands are entered in the CLI. It includes keywords, parameters, and optional elements that allow flexibility in entering information.

• Command Parameters: Specific data (e.g., NAME, PHONE_NUMBER, EMAIL) you supply when using commands to customize their actions. Parameters may be required or optional, depending on the command.

• Placeholder Value: A generic example value in command formats (e.g., n/NAME, p/PHONE_NUMBER) that shows where users should insert their own specific information.

Data & Fields

• Index: A number indicating a specific item in a list, such as a candidate or job entry. For example, the index “2” refers to the second item displayed in the current list.

• Status: A label representing the current stage of a candidate in the hiring process (e.g., Applied, Interviewed, Hired). Useful for filtering and organizing candidates based on their progress.

• Tag: A custom label that can be added to candidates, like “friend” or “urgent,” to help categorize or prioritize them. Multiple tags can be assigned to each candidate.

• Field: An attribute or property of a candidate, such as “Name,” “Phone Number,” or “Email,” that can be edited or displayed.

Functional Categories

• Module: A feature grouping within TalentSG that includes functions related to candidates and job roles, such as adding, listing, and filtering candidates.

• Filter: A command that narrows down displayed candidates based on specific criteria, such as “status” or “skills,” simplifying searching and management.

Resources & Links

• Hyperlink: Underlined and often blue text within the document that, when clicked, redirects to external resources, guides, or downloads. Requires an internet connection.

• File Path: The directory location on your computer where specific files are stored (e.g., [JAR file location]/data/addressbook.json), often used when accessing or editing files.

• Backup: A saved copy of the data file, recommended before making manual changes to avoid data loss.

back to top