User Guide

SoC InternApply (SIA) is a desktop app for managing internship applications, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, SIA can get your internship application management tasks done faster than traditional GUI apps.

With SoC InternApply, you can easily add an application, edit it later on if there are any changes needed, find the applications based on keywords and also sort them based on priority, interview date and much more! All while not having to worry about saving or storing your applications as this is done internally and automatically by SoC InternApply.

Ultimately, with SoC InternApply, you can worry less about the administrative tasks and focus more on preparing for the interviews themselves!

Table of Contents

• Table of Contents
• Glossary
• Quick start
• Features
  • Adding an application: add
    • Parameters:
      
    • Optional Parameters:
  • Clearing all applications: clear
  • Deleting an application: delete
  • Editing an application: edit
    • Parameters:
    • Advanced Function
  • Exiting the program: exit
  • Finding application(s): find
  • Viewing help: help
  • Listing all applications (with / without sorting): list
    • List all applications (with sorting)
    • List all applications (without sorting)
  • Listing applications with upcoming interviews: reminder
  • Saving the data
  • Summary bar
• FAQ
• Command summary

Glossary

1. SIA (SoC InternApply)

Go To TOC

Quick start

1. Ensure you have Java 11 or above installed in your Computer. You can download it from this website.

2. Download the latest internapply.jar from here.

3. Copy the file to the folder you want to use as the root folder for your SIA (e.g. you can save it in your desktop or downloads folder).
   Note: There will be data (your internship applications) stored into this same folder, but it would not take up much space.

4. Double-click the jar file to start the app. The GUI similar to the diagram below should appear in a few seconds. Note how the app contains some sample data. Do note that for Linux OS, you may have to enable double-click to run JAR files first!
   
   

   

5. Another reminder window should appear automatically similar to the below. Note that this window would contain any upcoming interviews you have in a weeks time.
   
6. 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:

   • addn/Shopee j/Software Engineer Intern p/87438807 e/hr@shopee.sg a/5 Science Park Dr, #06-40 t/SoftwareEngineering pt/LOW ast/NOT_APPLIED : Adds an application with company named Shopee to SIA.

   • clear : Deletes all applications.

   • delete3 : Deletes the 3rd application shown in the current list.

   • edit 1 d/Thank you for using SIA! : Update the details to Thank you for using SIA! for the first application on the list.

   • edit1 idt/17-03-2022 16:00 : Update the interview slot to 17 Mar 2022 16:00 for the first application on the list.

   • findn/shopee : Find all applications that contain the word “Shopee” in its name.

   • list : List all applications — used after find command to show all application.

   • listname desc : Sort all applications base on company name in descending order.

   • reminder : Lists all applications with upcoming interviews within a week from now.

   • help : Shows a message explaining how to access the help page.

   • exit : Exits the app.

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

Go To TOC

Features

Go To TOC

Adding an application: add

Adds an application to SoC InternApply.

Format: add n/NAME_OF_COMPANY j/JOB_TITLE p/PHONE_NUMBER a/ADDRESS e/EMAIL [t/TAG]... [pt/PRIORITY_TAG] [ast/APPLICATION_STATUS_TAG]

Parameters:

• NAME_OF_COMPANY:
  • Name of company you’re applying for.
• JOB_TITLE:
  • Title of the job you are applying for.

• PHONE_NUMBER:
  • Phone number of the company your applying for.
    

• ADDRESS:
  • Address of the company your applying for.
• EMAIL:
  • Email of the company your applying for.

Optional Parameters:

• TAG:
  • Optional Tag that you can set to separate applications
  • E.G. t/Application1, t/Application2
    

• PRIORITY_TAG:
  • Tag indicating the urgency of the application:
  • HIGH,MEDIUM,LOW
• APPLICATION_STATUS_TAG:
  • Tag indicating the status of the application:
  • NOT_APPLIED,APPLIED,INTERVIEWED,REJECTED,ACCEPTED
    

Example usages and expected outcomes:

• add n/Shopee j/Software Engineer Intern p/87438807 e/hr@shopee.sg a/5 Science Park Dr, #06-40 t/SoftwareEngineering

Feedback message:

New application added: Shopee; Job Title: Software Engineer Intern; 
Phone: 87438807; Email: hr@shopee.sg; Address: 5 Science Park Dr, #06-40; 
Interview Slot: Interview date is not set.; Details: To add details, use the edit command; 
Tags: SoftwareEngineering

• add n/Shopee j/Software Engineer Intern p/87438807 e/hr@shopee.sg a/5 Science Park Dr, #06-40 t/SoftwareEngineering pt/HIGH ast/NOT_APPLIED

Feedback message:

This application already exists in InternApply

Go To TOC

Clearing all applications: clear

Clears all applications from SoC InternApply.

Format: clear

Go To TOC

Deleting an application: delete

Deletes the specified application from SoC InternApply.

Format: delete INDEX

• Deletes the application at the specified INDEX.
• The index refers to the index number shown in the displayed application list.
• The index must be a positive integer 1, 2, 3, …​
• The index inputted must not exceed 2147483647 and must be a natural number.

Example usages:

• list followed by delete 2 deletes the 2nd application.

Expected outcome:

The previous 2nd application is removed from the storage and a new list of applications is shown.

Go To TOC

Editing an application: edit

Edits an existing application in SoC InternApply.

Format: edit INDEX [n/NAME] [j/JOB_TITLE] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [idt/INTERVIEW_DATE_TIME] [d/DETAILS] [t/TAG]... [pt/PRIORITY_TAG] [ast/APPLICATION_STATUS_TAG]

CAUTION: The edit command will overwrite your existing application data.

• Edits the application at the specified INDEX. The index refers to the index number shown in the displayed application list. The index must be a positive integer 1, 2, 3, …
• At least one of the optional fields must be provided.
• The index inputted must not exceed 2147483647 and must be a natural number.
• Existing values will be updated to the input values.
• You cannot edit an application to become a duplicate of another application. Any attempts will be prevented. Please refer to our Notes about duplicate applications

Parameters:

• NAME, JOB_TITLE, PHONE_NUMBER, EMAIL, ADDRESS
  • For the above fields, all restraints from the add command is applicable.
  • E.G. edit 1 e/SoCStudent@example.com n/NUS Research Edits the email and name of the 1st application to be SoCStudent@example.com and NUS Research respectively.

• INTERVIEW_DATE_TIME
  • You can add an interview slot that includes both date and time by using idt/INTERVIEW_DATE_TIME
  • The interview date time, INTERVIEW_DATE_TIME, must be in the follow format dd-MM-yyyy HH:mm.
  • You can remove INTERVIEW_DATE_TIME by using idt/ without specifying anything after it.
    
• DETAILS
  • You can add details to the application by using d/DETAILS
  • You can enter new lines in the details input by using \n
  • You can remove DETAILS by typing d/ without any strings following it, which will revert the field back to the default of To add details, use the edit command
  • To edit the details of an application, you can follow this format (adding \n to type in a new line): edit 1 d/Example details \nThis is a newline of the details
    e.g.edit 1 d/This company requires a preliminary coding round.\n I should practice more on HackerRank will result in this details being added:

    This company requires a preliminary coding round. 
    I should practice more on HackerRank
    

• TAGS, PRIORITY_TAG, APPLICATION_STATUS_TAG
  • You can change the priority or application status of an application by using pt/High or ast/Applied
  • The tags are not case-sensitive
  • Entering pt/high when the application priority tag is high is permitted but does not change anything

Example usages and expected outcomes:

• edit 2 j/Intern idt/ Edits the job title of the 2nd application to be Intern and clears the existing interview date time.
• edit 1 t/Singapore ast/APPLIED Edits the tags and application status tag of the 1st application to Singapore and APPLIED respectively. Since the priority tag is not specified, the 1st application will keep its current priority tag if it had any.

Advanced Function

Removing Tags from existing application.

CAUTION: While it is possible to use these special Tags while editing other fields of an existing application in SoC InternApply, we highly recommend not doing so unless you know what you are doing. However, if you wish to do so please refer to the description below beforehand.

Format: edit INDEX [t/removetags] [t/removepriority] [t/removestatus]

• Removes the Tags from an existing application.
• [t/removetags] will remove all Optional Tags from an application (i.e. Tags with the prefix t/).
• [t/removepriority] will remove the Priority Tags from an application (i.e. Tags with the prefix pt/).
• [t/removestatus] will remove the Application Status Tags from an application (i.e. Tags with the prefix ast/).
• These special Tags are not case-sensitive (i.e. typing t/ReMOveTagS would also work).
• These special Tags cannot be used as a valid Optional Tag for your applications.
• These special Tags can be used in any order, and you can either use 1 of them, a pair of them, or all 3 of them.
• These special Tags takes precedence over all other Tag inputs. Refer to the Example usage below for reference.
• You can still use these special Tags even if the respective Tags do not exist for the specified application. Nothing will happen in this case.
• If removing any of the Tags from an application causes it to become a duplicate application the command will be invalid. Please refer to our Notes about duplicate applications

Example usages and expected outcomes

• edit 1 t/removetags t/removepriority Removes all the Optional Tags and the Priority Tag from the 1st application.
• edit 1 p/65258719 t/removestatus Removes the Application Status Tag from the 1st application. Edits the phone number of the 1st application to be 65258719
• edit 1 pt/HIGH t/removepriority Special Tags takes precedence over all other Tag inputs. Removes the Priority Tag from the 1st application. Ignores the pt/HIGH input.
• edit 1 t/removestatus t/Singapore t/ExEmployee Special Tags takes precedence over all other Tag inputs. Removes the Application Status Tag from the 1st application. Ignores the t/Singapore t/ExEmployee inputs.
• edit 1 t/removestatus followed by edit 1 t/removestatus First removes the Application Status Tag from the 1st application. Then does nothing since there does not exist an Application Status Tag for the 1st application.

Go To TOC

Exiting the program: exit

Exits the program.

Format: exit

Go To TOC

Finding application(s): find

Finds existing applications in SoC InternApply.

Format: find [n/NAME] or find [j/JOB_TITLE] or find [t/TAG]... or find [pt/PRIORITY_TAG] or find [ast/APPLICATION_STATUS_TAG]

• Finds the applications with the fields containing keywords given in the input (partial keywords accepted as well).
• Keywords are case-insensitive.
• Parameters are only expected once (except tags). e.g. find n/shopee n/grab is equivalent to find n/grab, the last occurrence of the parameter will be taken.
• However, for n/ and j, more than 1 word can be accepted per field i.e. find n/aftershock pc will display any application with the name aftershock or pc.
• If more than 1 different fields are given, i.e. find n/shopee j/ML, only the first field (in the sequence of [n/NAME], [j/JOB_TITLE], [t/TAG]…, [pt/PRIORITY_TAG], [ast/APPLICATION_STATUS_TAG]) will be processed, i.e. find n/shopee j/ML is the same as find n/shopee, find j/ML n/shopee is also the same as find n/shopee

Example usages and expected outcomes:

• find n/shopee finds and displays all applications with “Shopee” in its name.
• find j/ML finds and displays all applications with “ML” in its job title.
• find pt/HIGH finds and displays all applications with “HIGH” in its priority tag.
• find ast/applied finds and displays all applications with “applied” in its application status. (note that it is case-insensitive)
• find t/overseas finds and displays all applications with “overseas” in its tags.
• find t/overseas t/USA finds and displays all applications with “overseas” or “USA” in its tags.

Go To TOC

Viewing help: help

This command displays a message explaining how to access the help page.

Format: help

Example usages:

help

Expected outcome:

A popup window showing a link to the help page, as shown below.

Go To TOC

Listing all applications (with / without sorting): list

List all applications (with sorting)

Sorts the list of all applications in SoC InternApply based on the provided parameters.

Format: list [sorting paramter] [order by]

Sorting parameters:

• name : Sort by name of the company in alphabetical order starting with A in ascending order.
• interview : Sort by interview date of applications starting with the latest earliest date.
• priority : Sort by priority in the following ascending order - (NO_TAG), LOW, MEDIUM, HIGH.

• status : Sort by status in the following ascending order - ACCEPTED, REJECTED, INTERVIEWED, APPLIED and NOT_APPLIED, (NO_TAG).

• If there is more than one application have similar fields, the company name of the application will be used as tiebreak to sort alphabetically (i.e. Application 1 with company name AAA and HIGH priority and Application 2 with company name BBB and HIGH priority are sorted by priority in ascending order — Application 1 will be ranked higher than Application 2).

Order by:

• asc : Order by ascending.
• desc : Order by descending (reverse order of ascending).

Examples:

• list interview desc
• list name desc, running this will output:
  

  Sorted applications by name order by desc.
  

List all applications (without sorting)

The list command also works without parameters. It will show the list in the last sorted order used by the user. This is used after using the find feature to list out all applications.

Example:

• list

Listed all application(s).

Go To TOC

Listing applications with upcoming interviews: reminder

Shows a list of applications with upcoming interviews, falling within a week from now, in SoC InternApply.

Format: reminder

Example usages:

reminder

Expected outcome:

A popup window showing a list of applications with upcoming interviews within a week from now, as shown below.

Go To TOC

Saving the data

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

Go To TOC

Summary bar

The summary bar is automatically updated on successful execution of any command.

Example summary bar (highlighted in red):

Go To TOC

FAQ

Q1: How do I know where my internship applications data is stored?
A: Please locate where SoC InternApply is being stored on your computer. You will see a folder named data found in the root folder of the application (the folder containing SoC InternApply) Inside the data folder, you can find a data file named internapplymemory.json, which stores all the applications.

Q2: How do I transfer my data to another computer?
A: Refer to the 1st QnA to locate the data file. Install the app in the other computer. Copy the contents of the data file of SoC InternApply from your previous computer and paste it in the empty data file of SoC InternApply of the new computer.

Q3: When I run SIA for the first time, I do not see any of the sample application. How can I get the sample applications to appear in SIA?
A: Refer to the 1st QnA to locate the data folder. Delete any existing files in the data folder and run SoC InternApply again.

Q4: I have an existing application to a company that I applied to where I got rejected and I am trying to reapply to the same company with the exact same details. Since SIA cannot have duplicate applications, what should I do?
A:
Option 1: Using edit, you can simply reuse the existing application with updated information.
Option 2: If you are looking to keep the existing application and it’s information untouched, then we suggest including an additional “t/NthAttempt” to differentiate your new application and the existing application. This will not violate our duplication clause while also allowing you to keep information on your existing application.

Q5: How many applications can SIA track?
A: 2147483647 applications can be tracked.

Q6: When I use find followed by edit sometimes the application that I edited disappears form the main window. Am I doing something wrong?
A: This can happen when you find applications with a specific field like NAME and then edit the NAME of an application that you found to something that no longer meets the criteria of the find command.
For example, if you call find n/Grab followed by edit 1 n/Shopee the 1st application will disappear since it is no longer an application with a NAME containing Grab

Q7: Why is the idt/ not recognised by add command?
A: idt/ is intentionally excluded from the add command. More often than not, students who apply for an internship do not receive an interview slot from the get go. Taking this into consideration, we decided that users need not include a valid InterviewSlot input just as a placeholder value to add new applications.

Q8: I just used the list command to sort my applications. Is it possible to revert sorting order?
A: Unfortunately due to the current limitations of our application, you will not be able to revert the sorting order after using list. This includes the order in which applications were added into SIA so please do your sorting with caution.

Go To TOC

Command summary

Go To TOC