User Guide

Table of Contents

• Introduction
  • Warenager’s User Guide
  • About Warenager
• Quick start
• Definitions
• Labels
• Features
• Commands
  • Command summary
  • Prefix summary
  • Components of Warenager
  • Viewing help : help
  • Adding new stock: add
  • Listing of stock: list
  • Deleting of stock: delete
  • Find stocks from inventory: find
  • Find exact stocks from inventory: findexact
  • Update inventory: update
  • Adding notes to stock: note
  • Deleting note(s) from stock: notedelete
  • Viewing details of a stock: stockview
  • Generating statistics: stats
  • Bookmarking stocks in the list: bookmark
  • Unbookmarking stocks in the list: unbookmark
  • Sorting inventory: sort
  • Command Suggestion
  • Generating a CSV file that contains all stocks: print
  • Clearing all data in Warenager: clear
  • Toggling tabs: tab
  • Saving data
  • Exiting Warenager: exit
• FAQ

Introduction

Warenager’s User Guide

This user guide introduces our inventory management application, Warenager, and provides support for the usage of its functionalities. For quick reference, we have provided a summarised table of commands and their usage formats.

About Warenager

Warenager is an inventory management application to help warehouse managers of small scale companies keep track of stocks in their warehouse. It optimizes inventory management tasks for warehouse managers including but not exhaustive of updating, searching and sorting stocks via Command Line Interface (CLI), while still having the benefits of a Graphical User Interface (GUI).

Quick start

To get started using Warenager,

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

   Installing Java 11

   If you have not done Java programming before or have not used CLI-based applications programmed with Java like Warenager, then you probably do not have Java 11 installed in your computer.
   You can install Java 11 here.

2. Download the latest Warenager.jar from here.

3. Copy the jar file you have just downloaded to the folder you want to use as the home folder for your Warenager.

4. Double-click the jar file to start the application.
   

The commands available in the current version of Warenager are: add, delete, update, find, findexact, note, notedelete, stockview, stats, sort, print, bookmark, unbookmark, list, tab, help, clear, and exit. Refer to the Commands section to for details of each command.

Definitions

Terms used in Warenager are defined here. If your term is not stated here, google the term to understand more.

Labels

Label	Meaning
	Cautionary advice/Precautions
	Useful notes/summaries for sections.

Features

Commands

This section provides support for the commands required to perform desired actions on Warenager.

Command summary

Summary of the commands required to perform certain actions is listed in this table:

Prefix summary

Summary of the prefixes known to Warenager is listed in this table:

Components of Warenager

Tabs: Displays the different tabs of the application.
Stock Table: Displays all stocks in your inventory.
Result Display: Displays the result of your command.
Command Box: Place to input your commands.

Viewing help : help

Displays the list of command instructions for features in Warenager and how to use the command.

Format

help

Expected Help Window

Adding new stock: add

Adds a new stock into the inventory. A unique serial number for the new stock will be generated by the program.

Format

add n/<name> s/<source> q/<quantity> l/<location> [lq/<low quantity>]

Examples

add n/Orange s/Shengshiong q/1300 l/Fruits section
add n/Sprite s/Ntuc q/1000 l/Drinks section lq/5000

Below is a guided example for adding stocks:

Step 1. Let’s add stock with the name orange, source of stock shengshiong, quantity of 1300 and location fruits section. The fields are not case-sensitive. Start by entering the command add n/orange s/shengshiong q/1300 l/fruits section in the command box.

Before input:

After input:

You have now added the stock successfully into the stock book. The stock will be added to the bottom of the stock table as shown above.

Listing of stock: list

Lists all the stock(s) in the inventory.

Format

list lt/<list type>

Below is a guided example for deleting stocks:

Step 1. Let’s list out all the bookmarked stocks using the command list lt/bookmark.

Before input:

After input:

Step 2. You can then list out all the stocks that are low in quantity using the command list lt/low.

Before input:

After input:

Step 3. Lastly, listing out all the stocks using the command list lt/all.

Before input:

After input:

Deleting of stock: delete

Deletes the stock(s) using the stock’s serial number from the inventory. Multiple stocks can be deleted simultaneously.

Format

delete sn/<serial number> [sn/<serial number>]...

Examples

delete sn/courts1 sn/courts2

Below is a guided example for deleting stocks:

Step 1. Before you start any deletion, you might want to use the command list lt/all to list all the stocks you have in Warenager.

Step 2. Let’s delete the stock with serial number COURTS2. The fields are not case-sensitive.
A valid delete input would be delete sn/courts2.

Before input:

After input:

Step 3. Multiple stocks can also be deleted at the same time. Let’s delete 2 stocks with serial numbers COURTS3 and COURTS4. It can be done by chaining the serial numbers when deleting.
A valid delete input would be delete sn/courts3 sn/courts4.

Before input:

After input:

Find stocks from inventory: find

Displays a list of stocks found in the inventory that contains all keywords specified in ANY one of fields searched.

Format

find { [n/<name>] [sn/<serial number>] [s/<source>] [l/<location>] }

Search criteria

• Only stocks that contain all the search keywords for a field will be displayed.
  e.g. find n/ChickenNuggets will not match stock with Name: Chick.
  e.g. find n/ChickenNuggets abcdef will not match stock with Name: ChickenNuggets.
  

• Search is case-insensitive. e.g. find n/ashLey will match stock with Name: Ashley.

• Any stock with any field that contains all the search keywords in any of the fields searched will be displayed.
  

Examples

find n/banana sn/SHENGSIONG

will match both Stock 1 and Stock 2

find l/section

will match both Stock 1 and Stock 2.

find n/chicken l/poultry

will match only Stock 2.

find s/ntuc l/singapore

will match only Stock 1.

Below is a guided example for finding stocks:

Step 1. Start by adding 3 stocks to your stock list.
add n/apple juice s/ntuc l/fruits section a q/100
add n/banana bun s/ntuc l/fruits section b q/200
add n/pineapple tart s/cold storage l/fruits section c q/300

The 3 stocks added should appear in your Data tab as shown in the image below.

Let’s find the stock with name that contains apple or source that contains cold.

Step 2. Type the command find n/apple s/cold into the command box and enter. The result display should show the keywords you searched for and how many stocks were found.
In this case, the two stocks with names apple juice and pineapple tart would be found.

After input:

You have successfully used the find command.

Let’s add an additional field into the search.

Step 3. Type the command find n/apple s/cold l/unknown in the command box and enter. The same two stocks as in Step 2 should be found as they still match n/apple.

After input:

You are now done with the guided tutorial for find.

Find exact stocks from inventory: findexact

Displays a list of stocks found in the inventory that contains all keywords specified in ALL fields searched.

Format

findexact { [n/<name>] [sn/<serial number>] [s/<source>] [l/<location>] }

Search criteria

• Only stocks that contain all the search keywords for all fields will be displayed.
  e.g. findexact n/ChickenNuggets s/ntuc will not match stock with Name: Chick, Source: ntuc.
  e.g. findexact n/Chicken sn/1111 will match stock with Name: ChickenNuggets, SerialNumber: 1111.
  e.g. findexact n/ChickenNuggets abcdef l/section b will not match stock with Name: ChickenNuggets, Location: section b.
  

• Search is case-insensitive. e.g. findexact n/ashLey s/nTuC will match stock with Name: Ashley, Source: ntuc.

• Any stock with fields containing all the search keywords in all the fields searched will be displayed.
  

Examples

findexact n/banana sn/SHENGSIONG

will not match Stock 1 and Stock 2.

findexact l/section

will match both Stock 1 and Stock 2.

findexact n/chicken l/section

will match only Stock 2.

findexact n/banana s/ntuc l/singapore

will not match Stock 1 and Stock 2.

Below is a guided example for finding stocks using findexact:

Step 1. Start by adding 3 stocks to your stock list.
add n/apple juice s/ntuc l/fruits section a q/100
add n/banana bun s/ntuc l/fruits section b q/200
add n/pineapple tart s/cold storage l/fruits section c q/300

The 3 stocks added should appear in your Data tab as shown in the image below.

Let’s find the stock with name that contains apple and source that contains cold.

Step 2. Type the command findexact n/apple s/cold into the command box and enter. The result display should show the keywords you searched for and how many stocks were found.
In this case, only one stock, with the name pineapple tart, would be found.

After input:

You have successfully used the findexact command.

Let’s add an additional field into the search.

Step 3. Type the command findexact n/apple s/cold l/unknown and enter. No stock should be found as there is no stock with the location unknown.

After input:

You are now done with the guided tutorial for findexact.

Update inventory: update

Updates the details of the desired stock(s), requires the serial number of stock(s).

Format

update sn/<serial number> [sn/<serial number]... [iq/<increment value> | nq/<new quantity>] [n/<name>] [l/<location>] [lq/<low quantity>]

Values to be updated are case-insensitive.

Below is a guided example for updating stocks:

Step 1. Before you start any updating activity, make sure to use the command list lt/all to list all the stocks you have in Warenager. The list shown below will be the basis reference for this guided example.

Step 2. Let’s update the stock with serial number NTUC1. Let’s update the name to Apple and the low quantity to 100. Remember that the fields are case-insensitive.
A valid update input would be update sn/ntuc1 n/apple lq/100.

Before input:

After input:

Step 3. Multiple stocks can also be updated at the same time. Let’s update 2 stocks with serial numbers FAIRPRICE1 and FAIRPRICE3. It can be done by chaining the serial numbers when updating.
Let’s update the low quantity to 200 and the location to Discount section A valid update input would be update sn/fairprice1 sn/fairprice3 lq/200 l/discount section.

Before input:

After input:

Adding notes to stock: note

Adds a note to the stock specified, displayed in the notes column for that stock. Multiple notes can be added to the stock and each note will be indexed.

Format

note sn/<serial number> nt/<note>

Example

note sn/SHENG SIONG1 nt/chicken will expire soon

Below is a guided example for adding notes to stocks:

Step 1. Start with adding these 3 stocks in your stock book in your Data tab as shown in the image below.

Let’s add a note to stock with name Apple juice.

Step 2. Type note sn/ntuc1 nt/buy on wednesday into the command box and enter. You will see the note added to the stock with name Apple juice at note index 1 in the Notes column.

After input:

Let’s add different note to the same stock as in Step 2.

Step 3. Type note sn/ntuc1 nt/another note for the SAME stock! into the command box and enter. You will see the note added to the stock with name Apple juice at note index 2 in the Notes column.

After input:

Let’s add a note to a different stock from that in Steps 1 and 2.

Step 4. Type note sn/COLD STORAGE1 nt/3 pineapple tarts JUST arrived into the command box and enter. You will see the note added to the stock with name Pineapple tart at note index 1 in the Notes column.

After input:

You are now done with the guided tutorial for note.

Deleting note(s) from stock: notedelete

Deletes a note, specified by the note’s index, from the stock specified by its serial number.

Format

notedelete sn/<serial number> ni/<note index>

Example

notedelete sn/ntuc1 ni/1

Below is a guided example for deleting notes from stocks:

Step 1. Start with these stocks in your stock book in your Data tab as shown in the image below.

Let’s delete a note from the stock with name Pineapple tart.

Step 2. Type notedelete sn/cold storage1 ni/2 into the command box and enter. You will see that the note at note index 2, pineapple tarts for CNY of the stock with serial number coldstorage1 has been deleted.

After input:

You have successfully used the notedelete command.

Let’s try deleting all the notes from the stock with serial number ntuc1 with one command.

Step 3. Type notedelete sn/ntuc1 ni/0 into the command box and enter. You will see that all the notes of the stock with serial number ntuc1 has been deleted.

After input:

You are now done with the guided tutorial for notedelete.

Viewing details of a stock: stockview

Shows the details of the stock, specified by its serial number, in the Stock View tab.

Details of the stock that are shown:

• Name
• Serial Number
• Quantity left
• Low quantity threshold
• Location stored in warehouse
• Notes

Format

stockview sn/<serial number>

Example

stockview sn/ntuc1

Below is a guided example for viewing a stock:

Let’s see what the Stock View tab looks like first before using the stockview command.

Step 0. When you start up Warenager, click into the Stock View tab and it should look as shown in the image below.

Clicking into the Stock View tab:

Step 1. Start with these stocks in your stock book in your Data tab as shown in the image below.

Let’s view the stock with serial number COLD STORAGE1.

Step 2. Type stockview sn/cold storage1 into the command box and enter. You will be brought to the Stock View tab with the stock details shown as in the image below.

After input:

You have successfully used the stockview command.

Let’s try updating the stock that you have just viewed. You may skip this Step 3 and just read through what will happen if you do not want to update your stock.

Step 3. Type update sn/cold storage1 n/pineapple tart 2 into the command box and enter. You will be brought back to the Data tab with the stock’s name updated. Click back to the Stock View tab and you will see that the information for the stock that was viewed has been updated.

After input:

Clicking back to the Stock View tab:

Let’s try deleting the stock that you have just viewed. You may skip this Step 4 and just read through what will happen if you do not want to delete your stock.

Step 4. Type delete sn/cold storage1 into the command box and enter. You should be brought back to the Data tab with the stock deleted. Click back to the Stock View tab and you should see that the Stock View tab has been emptied as the stock is no longer in your stock book.

After input:

Clicking back to the Stock View tab:

You are now done with the guided tutorial for stockview.

Generating statistics: stats

Generates a statistical view in a pie chart depicting the target fields.

Format

stats st/<statistics type>

Examples

stats st/source
stats st/source-qd-abc ("abc" is an existing source company)

Below is a guided example for displaying statistics:

Step 1. Start Warenager. Suppose you want to display source statistics. After the input, you should notice that the title in the statistics window as highlighted corresponds to the type of statistics shown.
The valid statistics input would be stats st/source.

Before input:

After input:

Step 2. Now suppose you want to display source statistics for the source company courts. After the input, you should notice that the title in the statistics window as highlighted now corresponds to the source company courts.
The valid statistics input would be stats st/source-qd-courts.

Before input:

After input:

Bookmarking stocks in the list: bookmark

Bookmarks the desired stock(s). Bookmarking a stock pushes the stock to the top of the stock list.

Format

bookmark sn/<serial number> [sn/<serial number>]...

Below is a guided example for viewing a stock:

Step 1. Let’s say you want to bookmark the stock with serial number giant1. You can bookmark the stock by using the command bookmark sn/giant1. Below shows the desired outcome.

Before input:

After input:

Step 2. Let’s say you want to bookmark multiple stocks with serial numbers fairprice1 and ntuc1. You can bookmark the stock by using the command bookmark sn/fairprice1 sn/ntuc1. Below shows the desired outcome.

Before input:

After input:

Unbookmarking stocks in the list: unbookmark

Removes bookmark from the desired stock(s).

Format

unbookmark sn/<serial number> [sn/<serial number>]...

Below is a guided example for viewing a stock:

Step 1. Let’s say you want to unbookmark the stock with serial number giant1. You can unbookmark the stock by using the command unbookmark sn/giant1. Below shows the desired outcome.

Before input:

After input:

Step 2. Let’s say you want to unbookmark multiple stocks with serial numbers giant1 and cold storage1. You can unbookmark the stock by using the command unbookmark sn/giant1 sn/cold storage1. Below shows the desired outcome.

Before input:

After input:

Sorting inventory: sort

Sort the inventory by a specific field and order.

Format

sort o/<order> by/<field>

Below is a guided example for sorting stocks:

Step 1. The list shown below will be the basis reference for this guided example.

Step 2. In the picture above, the stock is sorted by serial number in ascending order. Suppose that you now want to view the stocks by name in ascending order instead.
A valid sort input would be sort o/ascending by/name.

Before input:

After input:

Step 3. It is also possible to sort in descending order. Suppose that you now want to view the stocks by quantity in descending order.
A valid sort input would be sort o/descending by/quantity.

Before input:

After input:

Command Suggestion

Sometimes user will type in wrong commands. Warenager will help such user by suggesting the correct format of the command if the command word is valid. If the command word is invalid, then Warenager will try to predict and suggest the closest command to whatever the user has typed.

Below is a guided example for command suggestion:

Step 1. The list shown below will be the basis reference for this guided example.

Step 2. Suppose now you want to add a new stock with the following description:

• name: eggplant
• source: fairprice
• quantity: 500
• low quantity: 100
• location: vegetable section

A valid input would be add n/eggplant s/fairprice q/500 l/vegetable section lq/100.

But you make a mistake and instead entered ad n/eggplant sn/fairprice q/500 l/vegetable section lq/100

Before input:

After input:

Step 3. As shown above, the suggestion add n/eggplant s/<source> q/500 l/vegetable section lq/100 is generated. Now you can amend our input according to the suggested format. You now enter a valid input add n/eggplant s/fairprice q/500 l/vegetable section lq/100.

Before input:

After input:

As shown above, the stock has been successfully added.

Generating a CSV file that contains all stocks: print

Generates a CSV file that contains all stocks.

Format

print fn/<file name>

Examples

print fn/stocks

Below is a guided example for creating CSV file:

Step 1. Let’s create a CSV file with a file name of stocks. Start by typing print fn/stocks in the command box.

Step 2. After successfully executing the command, proceed to the folder which contains Warenager. Click on the data folder circled in red.

Step 3. Open stocks.csv folder circled in red with excel.

Step 4. The stocks in your inventory will be listed according the to format shown below. The file also includes the latest update time for the stocks.csv.

Step 5. The columns and rows in the csv file will not be formatted to show the full text in a cell. You will need to resize the columns and row of the excel sheet to see the full text of a cell as shown below.

Clearing all data in Warenager: clear

Clears all the existing data in Warenager.

Format

clear

Below is the expected outcome for clearing Warenager:

Before input:

After input:

Toggling tabs: tab

Toggles between the tabs in Warenager.

Format

tab

Below is a guided example for toggling tabs:

In this example, Warenager is started up for the first time. Observe that you are always in the data tab after each startup.

Step 1. Now input the command word tab and hit enter. This should bring you to the next tab, which is the Statistics tab.

Before input:

After input:

Step 2. Now input the command word tab again and hit enter. This should bring you to the next tab, which is the Stock view tab.

After input:

Step 3. Now input the command word tab again and hit enter. This should bring you back to the Data tab.

After input:

Saving data

Data (all stocks in inventory in JSON) is automatically saved to [root directory]/data/stockbook.json when any of these commands are executed:

• add
• delete
• note
• notedelete
• update
• clear

The set of used serial number sources is automatically saved to [root directory]/data/serialnumbers.json when any of these commands is executed:

• add

Exiting Warenager: exit

Terminates the program.

Format

exit

FAQ

Q: Can I use Warenager on any OS?
A: Yes. Warenager is supported by Windows, Mac and Linux.

Q: Can I use Warenager on another device?
A: Yes. Simply transfer the JSON data files under /data and copy over to the same directory /data in the Warenager of your other device.