User Guide

Table of Contents

• Table of Contents
• Introduction
• Legend
• Quick start
• Features
  • GUI Introduction
  • Prefix and Input Summary
  • Viewing help : help
  • Adding an applicant: add
  • Listing all applicants : list
  • Viewing a specific applicant : view
  • Searching for an applicant : search
  • Adding skills to an applicant: addskill
  • Editing an applicant : edit
  • Sorting applicants : sort
  • Flagging an applicant : flag
  • Deleting an applicant : delete
  • Clearing the applicants : clear
  • Exiting the program : exit
  • Saving the data
  • Editing the data file
• FAQ
• Glossary
• Command summary

Introduction

What is LinkedOUT?

LinkedOUT is the only application that any experienced recruiter needs. LinkedOUT allows recruiters to keep track of many applicants, and the job they applied for. You can store their contact details, skills and the round of their application, all in one place.

LinkedOUT helps recruiters manage the multiple job applications they may receive on a daily basis. With many applications, it may be difficult to keep track of each applicant and which application round they are currently at.

Thus, LinkedOUT aims to improve a recruiter’s experience. LinkedOUT presents recruiters with the ability to flag important applicants, edit applicants easily and search for them with ease.

LinkedOUT comes with a Command Line Interface (CLI) as well as a Graphical User Interface (GUI) in order to provide recruiters a more streamlined experience.

Who is this User Guide for?

This user guide is meant for users who wish to learn how to use our application. It is best suited for recruiters who are looking to incorporate this app into their daily workflows.

If you would like to learn more about the technical aspects of our application instead, you can do so by reading our Developer Guide.

Back to top

Legend

Tip: Tips are placed in this guide to serve as suggestions that you can try out while using our application.

Caution: Cautions are placed in this guide to serve as warnings for certain actions.

Back to top

Quick start

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

2. Download the latest LinkedOUT.jar from here.

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

4. For Windows: Double-click the file to start the app.
   For Mac: Open up a terminal in the current folder which contains the LinkedOUT jar file
   Then, run the following command to open the file that you have downloaded in step 2:
   java -jar LinkedOUT.jar

   
   

   LinkedOUT comes with sample data for you to experiment on. Upon starting the application, you should see the following screen:

   

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 job applicants, along with an overview of each applicant.

   • addn/Bob p/99999999 e/bob@example.com j/Data Analyst r/Interview s/Pandas : Adds an applicant named Bob to the list of applicants.

   • delete1 : Deletes the first applicant from the list of applicants.

   • exit : Exits the app.

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

Back to top

Features

Back to top

GUI Introduction

Back to top

Prefix and Input Summary

The table below illustrates the meaning of the prefixes and their respective inputs

Back to top

Viewing help : help

Shows you a message explaining how to access the help page.

Format:

help

Example:

help

Sample Output:

Back to top

Adding an applicant: add

Allows you to add a new applicant to the LinkedOUT application with the following information:

• NAME: Applicant’s name
• PHONE_NUMBER: Applicant’s phone number
• EMAIL: Applicant’s email
• JOB: The job the applicant applied for
• ROUND: The round of job application that the applicant is at
• SKILL: Particular skills the applicant may have

Format:

add n/NAME p/PHONE_NUMBER e/EMAIL j/JOB r/ROUND [s/SKILL]…​

Example:

add n/Bob p/99999999 e/bob@example.com j/Data Analyst r/Interview s/Pandas s/Python

Sample Output:

Back to top

Listing all applicants : list

Allows you to list out all job applicants, along with an overview of each applicant.

Format:

list

Example:

list

Sample Output:

Back to top

Viewing a specific applicant : view

Allows you to view a specific applicant, by inputting the applicant’s full name.

Format:

view NAME

• You must provide an exact match of an applicant’s full name in order to view their details.
  e.g. If an applicant’s full name is Steve Jobs, and the command provided is view Steve then LinkedOUT will not display Steve Jobs’s details.
  
• The view command is case-insensitive.
  e.g Viewing hans will match an applicant with name Hans.
• Only full name will be matched.
  e.g. Viewing Han Lee will not match an applicant with name Han.
• Only applicants with the right amount of spacing in their full name will be matched.
  e.g. Viewing HanLee will not match an applicant with name Han Lee.

Example:

view Bernice Yu

Sample Output:

Back to top

Searching for an applicant : search

Allows you to search for applicants containing the input attributes and the attribute has to be an exact word. You can search for the applicant based on name, job, round or skills.

Format:

search [n/NAME]…​ [j/JOB]…​ [r/ROUND]…​ [s/SKILL]…​

• You must provide a full match for attributes you want to search for.
  e.g. Searching n/Hans will match an applicant with name Hans Lee but will not match an applicant with name Han.
  
• The search command is case-insensitive.
  e.g Searching n/hans will match an applicant with name Hans.
• You can search for a combination of attributes. After a search command, applicants will be displayed in descending order of matched attributes. The applicant with the most number of matches is shown at the top of the list.
  e.g Searching n/Hans j/Engineer will match with applicants with either name Hans or job Engineer. Applicant with both name and job matched will be displayed on the top of the list.
• At least one attribute must be provided to be searched. i.e. search is an invalid command.

Tip: You can try searching for multiple attributes in the applicant list. Try search n/Alex s/Java to search for applicants with the name Alex or skill Java!

Example:

search n/Roy s/Java

Sample Output:

Back to top

Adding skills to an applicant: addskill

Allows you to add skills to a specific applicant. The index number used corresponds to the one in the displayed applicant list. This command does not replace any pre-existing skills.

Format:

addskill INDEX [s/SKILL]…

• Index of applicant specified must not be more than the total number of applicants in LinkedOUT.
  e.g If there are only 4 applicants in the app but 5 is specified, then the addition will not be carried out as it is invalid.
• Index of applicant specified must be a positive number.
  e.g As we label our applicants incrementally starting from 1 (e.g 1, 2, 3, and so on), an index of -1 will not be tagged to an applicant and the addition will not be carried out as it is invalid.
• If you would like to replace or remove certain skills instead, consider using edit.
• At least one skill must be provided to be added. i.e. addskill INDEX is an invalid command.

Example:

addskill 1 s/React s/Vue

Sample Output:

Back to top

Editing an applicant : edit

Allows you to edit specific details of the applicant identified by the index number. The index number used corresponds to the one in the displayed applicant list. Existing values will be overwritten by the input values.

Format:

edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [j/JOB] [r/ROUND] [s/SKILL]…​

• Index of applicant specified must not be more than the total number of applicants in LinkedOUT.
  e.g If there are only 4 applicants in the app but 5 is specified, then the edit will not be carried out as it is invalid.
• Index of applicant specified must be a positive number.
  e.g As we label our applicants incrementally starting from 1 (e.g 1, 2, 3, and so on), an index of -1 will not be tagged to an applicant and the edit will not be carried out as it is invalid.
• As an applicant can have more than 1 skill, you may remove skills using edit as illustrated by the following example:
  e.g An applicant has skills Excel, Word, Docs. To remove the skill Excel, you may type the following command. edit INDEX s/Word s/Docs.
• You may also add skills using edit. However, a simpler way of doing so would be to use our alternative command addskill.
  To add skills with edit, you may do so as illustrated by the following example:
  e.g An applicant has skill Excel. To add the skills Word and Docs, you may type the following command. edit INDEX s/Excel s/Word s/Docs.
• You can remove all of an applicant’s skills by simply typing edit INDEX s/ without adding anything behind s/.
  
  Caution: This will clear all skills previously added for an applicant and cannot be undone.
• At least one attribute must be provided to be edited. i.e. edit INDEX is an invalid command.

Example:

edit 1 p/91234567 e/yeoh.99@example.com s/Rust

Sample Output:

Back to top

Sorting applicants : sort

Allows you to sort the list of applicants temporarily by name or by job. That is to say, the list will not stay sorted if you were to use other commands following sort. You can sort based on ascending or descending order.

Format:

sort f/FIELD o/ORDER

• You must provide either NAME or JOB as field to be sorted, both are case-insensitive
  e.g if the field is NAME, then the list will be sorted based on applicant’s name in the order given.
• You must provide either ASC or DESC for order, both are case-insensitive. ASC stands for ascending and DESC stands for descending
  e.g if the order is ASC, then the list will be sorted in ascending order based on the field given.

Example:

sort f/job o/asc

Sample Output:

Back to top

Flagging an applicant : flag

Allows you to flag an applicant identified by the index number. The index number used corresponds to the one in the displayed applicant list. Flagged applicants will appear at the top of the list and are identified with a flag symbol.

Format:

flag INDEX

• Index of applicant specified must not be more than the total number of applicants in LinkedOUT.
  e.g If there are only 4 applicants in the app but 5 is specified, then the flagging will not be carried out as it is invalid.
• Index of applicant specified must be a positive number.
  e.g As we label our applicants incrementally starting from 1 (e.g 1, 2, 3, and so on), an index of -1 will not be tagged to an applicant and the flagging will not be carried out as it is invalid.
• Flag acts like a toggle. To un-flag the applicant, you may simply re-type the same command.

Tip: Try flagging the first applicant by typing flag 1. You should see it at the top with a flag symbol. Then try un-flagging the same applicant with flag 1.

Example:

flag 1

Sample Output:

Extended Example for unflagging:

flag 1

Extended Sample Output for unflagging:

Back to top

Deleting an applicant : delete

Allows you to delete a specific applicant, specified by index.

Caution: If you delete a specific applicant, LinkedOUT will permanently discard the applicant’s data.

Format:

delete INDEX

• Index of applicant specified must not be more than the total number of applicants in LinkedOUT.
  e.g If there are only 4 applicants in the app but 5 is specified, then the deletion will not be carried out as it is invalid.
• Index of applicant specified must be a positive number.
  e.g As we label our applicants incrementally starting from 1 (e.g 1, 2, 3, and so on), an index of -1 will not be tagged to an applicant and the deletion will not be carried out as it is invalid.

Example:

delete 1

Sample Output:

Back to top

Clearing the applicants : clear

Clears the list of applicants.

Caution: LinkedOUT will discard all data and start with an empty data file once you select ‘Yes’ on the confirmation box. Selecting ‘No’ will cancel the action.

Format:

clear

Example:

clear 

Sample Output:

Back to top

Exiting the program : exit

Exits the program.

Format:

exit

Example:

exit

Back to top

Saving the data

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

Back to top

Editing the data file

LinkedOUT data is saved in [JAR file location]/data/linkedout.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, LinkedOUT will discard all data and start with an empty data file on the next run.

Back to top

FAQ

Q: How do I transfer my data to another Computer?
A: You may first install the app in another computer. Then, you may overwrite the empty data file it creates with the file containing data from the previous LinkedOUT home folder.

Back to top

Glossary

• GUI: Graphical User Interface: Refers to the user interface that the user interacts with.
• CLI: Command Line Interface: Refers to a computer program that accepts text inputs.

Back to top

Command summary

Back to top