Skip to content

UserGuide.md

Latest commit

 

History

History
281 lines (195 loc) · 9.28 KB

UserGuide.md

File metadata and controls

281 lines (195 loc) · 9.28 KB

User Guide for Busyness Manager

Sign-In Process:

  1. Enter business name.
    • If business name does not exist in Busyness Manager, user will be asked for permission to start First-Time Setup.
      • Input "yes" to proceed with First-Time Setup and create a new business account.
      • Input anything else to terminate Busyness Manager and restart.
      • This sign-in process allows users to register multiple businesses on one device.
  2. Enter business ID.
  3. Enter business password.
    • If ID and password are correct, message stating that login is successful will be shown.
    • If ID and/or password are incorrect, user will be asked if they have forgotten their ID and password.
      • Input "yes" to display the business ID and password. (Busyness Manager will terminate after showing)
      • Input anything else to terminate Busyness Manager and restart.

First-Time Setup:

  1. Enter business ID. (A whole number)
  2. Enter business name. (A set of words)
  3. Enter business password. (A sequence of characters)
  4. Enter business type: FNB or RETAIL. (case-sensitive)
  5. Message stating that the setup is successful is shown.

Note: If the user wants to edit these Credentials information, they may do so within the data/<business name>.txt file. However, there is no guarantee that Busyness Manager will work as intended after any kinds of modifications to the .txt file. This issue will be improved in subsequent versions.

Features:

  • Login

    • Requires business ID and password.
    • Subsequent features can be accessed after logging in.
    • Password can be retrieved.

  • Viewing Help: help

    • Provides possible command instructions and expected formatting.

  • Adding a Product: add

    • Adds a product to the products-for-sale list.

  • Deleting a Product: delete

    • Removes a product from the products-for-sale list.

  • Changing Info of Products: update

    • Updates data of a specified product in the products-for-sale list.
    • Data to be updated must be specified during command input.

  • Printing List of Products: list

    • Prints the entire list of products for sale (according to product ID).

  • Incrementing Sold Product Value, Decrementing Inventory Value: sold

    • Changes the quantity of available inventory and the quantity sold.

  • Clear the Quantity Sold: clear

    • Changes the quantity sold of a specified product to 0.

  • Compute Total Amount of Sale Transactions: revenue

    • Adds up all the products sold, multiplied by their respective prices.
    • Given a product ID, provides the revenue of a specified product.

  • Search for a Product: search

    • Given a product name, searches for the corresponding product.
    • Given a product ID, searches for the corresponding product.

Command Summary:

Important things to take note:

  • There must always be ONE SPACE between any command (e.g. update), flag (e.g. /name), and value (e.g. MILK).
  • Add a slash (/) in front of any flag.
  • To input ID of product, just the non-zero part will suffice. (i.e. 1 instead of ID_0001)
  • Quantity of all products must be a WHOLE number under 1 million.
  • Price of all products can be up to 2 DECIMAL PLACES, and must be under $1 million.
  • Names of all products must be ONE-WORD long. (further explained below)
  • IDs will NOT be usable after deletion. (further explained below)

Adding a Product

add P_NAME P_QTY P_PRICE

  • Creates a new product object & attaches different attributes to it (with an auto-generated ID).
  • Values:
    • P_NAME → Name of the product to create. (must be one-word only)
    • P_QTY → Quantity of the product to create that is available for sale. (must be whole number)
    • P_PRICE → Price of the product to create. (must be 2 decimal places)

Example:

  • Input -> add MILK 50 2.50
  • Output ->Product added: ID_0001: MILK | Qty: 50 | Sold: 0 | Price: $2.50

Deleting a Product

delete P_ID

  • Deletes a specified product with the given ID.
  • Values:
    • P_ID → ID of the product to delete. (just the non-zero part will suffice)

Example:

  • Input -> delete 1
  • Output -> Product removed: ID_0001: MILK | Qty: 50 | Sold: 0 | Price: $2.50

Updating a Product Name

update P_ID /name NEW_NAME

  • Changes one or more attributes of a specified product.
  • Flags:
    • /name → Flag to indicate the attribute to edit is the product name.
  • Values:
    • P_ID → ID of the product to modify. (just the non-zero part will suffice)
    • NEW_NAME → New name of the product to modify. (must be one-word only)

Example:

  • Input -> update 1 /name FRESH_MILK
  • Output -> Product updated: ID_0001: FRESH_MILK | Qty: 50 | Sold: 0 | Price: $2.50

Updating a Product Quantity

update P_ID /qty NEW_QTY

  • Changes one or more attributes of a specified product.
  • Flags:
    • /qty → Flag to indicate the attribute to edit is the product quantity.
  • Values:
    • P_ID → ID of the product to modify. (just the non-zero part will suffice)
    • NEW_QTY → New quantity of the product to modify. (must be whole number)

Example:

  • Input -> update 1 /qty 60
  • Output -> Product updated: ID_0001: FRESH_MILK | Qty: 60 | Sold: 0 | Price: $2.50

Updating a Product Price

update P_ID /price NEW_PRICE

  • Changes one or more attributes of a specified product.
  • Flags:
    • /price → Flag to indicate the attribute to edit is the product price.
  • Values:
    • P_ID → ID of the product to modify. (just the non-zero part will suffice)
    • NEW_PRICE → New price of the product to modify. (must be 2 decimal places)

Example:

  • Input -> update 1 /price 3.00
  • Output -> Product updated: ID_0001: FRESH_MILK | Qty: 60 | Sold: 0 | Price: $3.00

Printing Product List

list

  • Prints the current list of products.
  • Attributes displayed:
    • Product ID
    • Product name
    • Quantity of product not sold
    • Quantity of product sold
    • Product price

Example:

  • Input -> list
  • Output -> Product list: (next line) ID_0001: FRESH_MILK | Qty: 60 | Sold: 0 | Price: $3.00

Format of Product List: ID_NUMBER: PRODUCT_NAME | QTY | QTY_SOLD | PRICE

Recording a Sale

sold P_ID QTY_SOLD

  • Changes the sales record and updates the inventory list.
  • Values:
    • P_ID → ID of the product that was sold. (just the non-zero part will suffice)
    • QTY_SOLD → Quantity of the product that was sold. (must be whole number)

Example:

  • Input -> sold 1 5
  • Output -> Sales recorded: Product ID: ID_0001, Quantity Sold: 5

Clearing Sold Quantity

clear P_ID

  • Sets the quantity sold to zero for the specified product.
  • Values:
    • P_ID → ID of the product to clear. (just the non-zero part will suffice)

Example:

  • Input -> clear 1
  • Output -> Sales cleared: Product ID: ID_0001

Computing Revenue

revenue / revenue P_ID

  • Computes the total amount of revenue.
  • Optional P_ID value (to check revenue for a specific product).

Example (Overall Revenue):

  • Input -> revenue
  • Output -> Revenue of FRESH_MILK: 15.00 (next line) Total Revenue: 15.00

Example (Specific Product Revenue):

  • Input -> revenue 1
  • Output -> Revenue of FRESH_MILK: 15.00

Searching for a Product by Name

search /name P_NAME

  • Returns the information of the product that matches the given name.
  • Flags:
    • /name → Flag to indicate the attribute to search is the product name.
  • Values:
    • P_NAME → Name of the product to search for. (must be one-word only)

Example:

  • Input -> search /name FRESH_MILK
  • Output -> ID_0001: FRESH_MILK | Qty: 60 | Sold: 0 | Price: $3.00

Searching for a Product by ID

search /id P_ID

  • Returns the information of the product that matches the given ID.
  • Flags:
    • /id → Flag to indicate the attribute to search is the product ID.
  • Values:
    • P_ID → ID of the product to search for. (just the non-zero part will suffice)

Example:

  • Input -> search /id 1
  • Output -> ID_0001: FRESH_MILK | Qty: 60 | Sold: 0 | Price: $3.00

Known Bugs:

  1. The names of all products in the inventory must be one-word only. This means that names like fresh milk and cheese tofu are not accepted. To add products with names like these, the space in their names must be replaced by underscores. For instance, fresh milk must be replaced by fresh_milk, and cheese tofu must be replaced by cheese_tofu. This bug is due to implementation limitations, and will be addressed in future versions.
  2. After an ID is deleted, it will not be usable within that business's inventory. While this may be a bug to some users, this is by design. In the context of business operations, product IDs ought not to be re-used for data integrity purposes. Furthermore, in databases like our inventory, there is the need to ensure that the primary keys in databases, which in this case are the product IDs, are unique and immutable. Thus, in Busyness Manager, the product IDs will not be reusable after deletion from the inventory.