User Guide

LoyaltyLift is a desktop application designed for small business owners to manage their customers and orders efficiently, allowing you to improve customer relations and increase customer loyalty. It is optimised for users who are fast typists while still having the benefits of a visual interface.

With LoyaltyLift, you can easily keep track of your customers’ preferences, purchase history, and contact information, enabling you to provide personalised service that will keep them coming back. Our application makes it easy to manage orders and provide rewards, helping you grow your business while delivering an exceptional customer experience.

This user guide provides in-depth documentation on LoyaltyLift installation process, command features and common questions that you might have. In addition, the quick start guide provides an end-to-end setup process to get you started.

Are you excited yet? Let’s get started!

Table of contents

• Using this guide
• Quick start
• Getting to know LoyaltyLift
  • Navigating around LoyaltyLift
  • Add your first customer and order
  • Following your order to completion
  • Rewarding your customers
  • Extra remarks
• Features
  • Customer
    • Adding a customer : addc
    • Listing customers : listc
    • Locating customers by name : findc
    • Viewing a customer : viewc
    • Editing a customer : editc
    • Deleting a customer : deletec
    • Bookmark a customer : markc
    • Un-bookmark a customer : unmarkc
    • Setting a customer’s note : setnotec
    • Appending a customer’s note : appendnotec
  • Rewards
    • Setting reward points for a customer : setpoints
    • Adding/Subtracting points for a customer : addpoints
  • Orders
    • Adding an order : addo
    • Listing all orders : listo
    • Locating orders by name : findo
    • Viewing an order : viewo
    • Editing an order : edito
    • Advancing an order’s status : advo
    • Reverting an order’s status : revo
    • Cancelling an order : cancelo
    • Deleting an order : deleteo
    • Setting an order’s note : setnoteo
    • Appending an order’s note : appendnoteo
  • Miscellaneous
    • Clearing all entries : clear
    • Exiting the program : exit
    • Viewing help : help
  • Saving the data
• FAQ
• Command summary
  • Customer
  • Rewards
  • Order
  • Miscellaneous

Using this guide

We want to ensure you can easily navigate our guide, so we’ve included some icons to help you along the way.

Here’s a quick guide to what they all mean:

Icons	Meaning
	Useful tips
	Notable information you should be aware of
	Important information you should read before proceeding
	Examples of a command or feature

🠕 Back To Top

Quick start

1. Ensure your computer has Java 11 or above installed.
   • If you need to install Java, the official website provides download links for most computer systems.
   • You can verify your computer’s Java installation with this instruction.

2. Download the latest loyaltylift.jar from here.

3. Copy the file to any empty folder; this will be your designated home folder for LoyaltyLift.

4. Double-click on loyaltylift.jar to launch LoyaltyLift.
   A similar GUI, as seen below, should appear in a few seconds. Note how the app contains some sample data.
   

5. Type the command in the command box (which says Enter command here...) and press Enter to execute it. e.g. typing help and pressing Enter will open the help window.
   Some example commands you can try:

   • listc : Lists all customers.

   • addc n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01 : Adds a customer named John Doe to LoyaltyLift.

   • viewc 1 : Displays information of the 1st customer in the current customer list on the right panel (Information Panel)

   • deletec 3 : Deletes the 3rd customer shown in the current customer list.

   • clear : Deletes all customers and orders.

   • exit : Exits the app.

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

🠕 Back To Top

Getting to know LoyaltyLift

This section is designed to help new users get started with using LoyaltyLift. In this section, you will learn how to perform essential tasks such as adding customers, creating orders, and setting up rewards. By the end of these tutorials, you will have a solid understanding of the fundamental features of LoyaltyLift and how to use them effectively to improve your business operations.

So, let’s dive in and get started!

Navigating around LoyaltyLift

Before starting your journey with LoyaltyLift, let’s take a quick look at the layout of LoyaltyLift.

It comprises 3 panels, the Information Panel, Command Panel and List Panel. The List Panel displays either customers or orders, controlled by List Tabs.

The components are summarised below.

Using the Command Panel

The Command Panel is where you type and submit your commands. LoyaltyLift then processes your request and performs them if it is successful.

If LoyaltyLift understands your request, it will perform it and display feedback that it has succeeded, as seen below.

Otherwise, the input font will turn red instead, as seen below. The feedback will assist you in correcting the command as much as possible.

Now that you are familiar with the layout of LoyaltyLift, you are ready to jump right into using the application!

🠕 Back To Top

Add your first customer and order

In this tutorial, you will learn how to add your first customer Lyndon Edwards and his order of 2 of his favourite Banana Cake. Finally, you will learn to remove a customer and observe that all orders belonging to a customer will be removed as well.

Tip: If you have not done so, use the clear command to remove the sample data!

Your first customer, Lyndon Edwards

Adding your first customer is effortless on LoyaltyLift using addc. Enter the following command to insert a new customer Lyndon Edwards and some basic contact information.

addc n/Lyndon Edwards p/93015612 e/lyndon@example.com a/Loyalty Street 103, block 122

The application should already have your customer displayed by this step. Nonetheless, you can always type the following commands to list all customers and view the first customer in LoyaltyLift, corresponding to Lyndon Edwards.

listc
viewc 1

Your first order, 2 x Banana Cakes

Now that Lyndon Edwards is in LoyaltyLift, we can add an order for him. This can be done with the addo command like the following.

addo 1 n/Banana Cake q/2 

Likewise, the application should already have the order opened for your convenience. To do this manually, you can list all your orders and view the first order’s information by performing the following commands.

listo
viewo 1

Clear application data again

Before ending this tutorial, let us clear our application data by removing Lyndon Edwards and his Banana Cake order.

While the clear command achieves this quickly, we can also simply remove Lyndon Edwards from LoyaltyLift with the deletec command.

deletec 1

Caution: In addition to removing Lyndon Edwards from the application, all of his orders are also removed!

Hence, you will notice that the order list is now empty, and our application is back to a clean slate.

listo

🠕 Back To Top

Following your order to completion

By following this tutorial, you will learn how to update your order’s status in LoyaltyLift, which will help you better understand and manage the process of orders in your business.

The order’s status

In LoyaltyLift, an order can have the following status.

• Pending
• Paid
• Shipped
• Completed
• Cancelled

Before we start, head over to Add your first customer and order to include Lyndon Edwards and the Banana Cake order. However, do not clear the application data as we will use the order for this tutorial.

Advancing an order’s status

Let’s look at our current list of orders, which should only consist of the order of Banana Cake.

listo

Notice that the order’s status is now Pending. The advo command will come in handy to advance an order’s status, which takes the order index as its only parameter.

advo 1

Now, the status of the order should be Paid. Doing this multiple times will eventually update the order’s status to Completed. Afterwards, further attempts to advance the order status will return an error!

Reverting an order’s status

To revert an order’s status, the revo command is similar to advo but has the inverse effect.

revo 1

Now, the status of the order should be Pending. As expected, trying to revert the status when it is already Pending, will be met with an error!

Cancelling an order

An order can be cancelled at any stage of the order. This can be performed with the cancelo command.

cancelo 1

Looking at the order status, it is now reflected as Cancelled. Once an order is cancelled, its status can no longer be advanced.

Tip: If you accidentally cancel an order, you can still revert its status!

🠕 Back To Top

Rewarding your customers

This tutorial will teach you the rewards system in LoyaltyLift and how you can apply it to boost your business’s customer loyalty.

The tier system

In LoyaltyLift, there are three tiers with their associated point threshold.

Before we start, head over to Add your first customer and order to include Lyndon Edwards and the Banana Cake order. However, do not clear the application data as we will use the customer for this tutorial.

Rewarding your customers with points is an effortless process on LoyaltyLift using setpoints or addpoints.

In this scenario, we want to add points to Lyndon Edwards for his Banana Cake order! Here, we assume that Lyndon Edwards is at your first index.

Enter the following command to add points to Lyndon Edwards to reward him points.

addpoints 1 pt/800

You should see that Lyndon Edwards has 800 points.

Now that Lyndon Edwards has some points, let’s claim a reward on his behalf for being a loyal customer. In this scenario, it costs 500 points for a water bottle. Let’s deduct 500 points from Lyndon Edwards to reward him with a water bottle! Using the addpoints command, you can then track his new points again.

Enter the following command to subtract points from Lyndon Edwards after claiming a reward.

addpoints 1 pt/-500

You should observe that Lyndon Edwards has 300 points remaining. However, do note that he still has 800 cumulative points, as cumulative points are not subtracted away while claiming rewards.

Lastly, perhaps what you did above was a mistake. Lyndon Edwards should have 8000 points for being such a loyal customer. You can overwrite his previous points and cumulative points, using the setpoints command!

setpoints 1 pt/8000

You should see that Lyndon Edwards now has 8000 points and 8000 cumulative points. Also, you should observe that he is now part of the Silver tier, as he has above 5000 cumulative points!

Tip: The difference between setpoints and addpoints is that setting points will also set cumulative points to the same amount. If you wish to keep the current cumulative points, use the addpoints command instead.

You should now be able to reward any of your customers with our point system!

🠕 Back To Top

Extra remarks

While these tutorials cover a simplified situation of adding a customer and order, you may need more complex control/tasks, and LoyaltyLift is ready for it!

Here are some recommended features to explore after this tutorial.

• Editing a customer or order’s information with editc or edito
• Assigning a customer as an individual or enterprise with addc or editc

🠕 Back To Top

Features

🠕 Back To Top

Customer

Adding a customer : addc

You can include your new customer into LoyaltyLift with addc.

Format

addc n/NAME p/PHONE e/EMAIL a/ADDRESS [ct/{ind|ent}]

Listing customers : listc

This command shows a list of customers in the List Panel. You can filter and sort the list by specifying additional details.

Format

listc [s/{name|points}] [f/{marked|ind|ent}]

• Lists customers with the specified sort and filter option.

Locating customers by name : findc

This command helps you find customers whose names contain any of the given keywords.

Format

findc 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
• Customers matching at least one keyword will be returned (i.e. OR search). e.g. Hans Bo will return Hans Gruber, Bo Yang

Viewing a customer : viewc

You can view all information about your customer in a single location; this command displays all about them in the Information Panel.

Format

viewc CINDEX

• Displays the customer’s information at the specified CINDEX.

Tip: You can click on the customer in the table directly for the same effect!

Editing a customer : editc

Customer information can change over time. Thus, editc lets you update their personal information, such as their phone number and address.

Format

editc CINDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [ct/{ind|env}]

• Edits the customer at the specified CINDEX.
• At least one of the optional fields must be provided.
• Existing values will be updated to the input values.

Deleting a customer : deletec

If a customer requests that their information be removed from LoyaltyLift, deletec helps you remove their profile and orders.

Format

deletec CINDEX

• Deletes the customer at the specified CINDEX.

Bookmark a customer : markc

You can use this command to prioritise a customer among the customer list.

Format

markc CINDEX

• Bookmarks the customer at the specified CINDEX.​

Un-bookmark a customer : unmarkc

unmarkc allows you to remove a bookmark of a customer.

Format

unmarkc CINDEX

• Un-bookmarks the customer at the specified CINDEX.

Setting a customer’s note : setnotec

By creating a note, you can keep track of essential details of your customers, such as their preferences or previous feedback.

Format

setnotec CINDEX nt/NOTE

• Sets NOTE as the note of the customer at the specified CINDEX.
• Customers, by default, have a blank note.

Tip: You can remove a customer’s note by specifying no value after the prefix!

Appending a customer’s note : appendnotec

In the event that you have more information to add for a customer, appendnotec comes in handy to add details to an existing note without replacing it.

Format

appendnotec CINDEX nt/NOTE

• Adds NOTE to any existing note of the customer at the specified CINDEX.

🠕 Back To Top

Rewards

Setting reward points for a customer : setpoints

setpoints allows you to directly set both the current and cumulated points of a customer.

Format

setpoints CINDEX pt/POINTS

• Sets the points of the customer at the specified CINDEX to POINTS.
• Customers, by default, have 0 points.

Tip: Setting points will also set cumulative points to the same amount. If you wish to keep the current cumulative points, use the addpoints command instead.

Adding/Subtracting points for a customer : addpoints

With addpoints, you can add or subtract points from your customers as they place orders. LoyaltyLift keeps track of their cumulated points and assigns them a tier to tell you who are your most loyal customers!

Format

addpoints CINDEX pt/POINTS

• Adds or subtracts the points of the customer at the specified CINDEX by POINTS.
• If the points subtracted is greater than what the customer has, the command will not be executed.
• If the points added will result in points or cumulative points being greater than 999999, the command will not be executed.

Tip: addpoints will also result in an addition of cumulative points, while subtraction will not affect cumulative points.

🠕 Back To Top

Orders

Adding an order : addo

When your customer requests an order, you can include the order and its information with addo.

Format

addo CINDEX n/NAME [q/QUANTITY] [a/ADDRESS]

• Adds an order for the customer at the specified CINDEX.

Listing all orders : listo

This command shows you a list of orders in the List Panel. You can filter and sort this list by specifying more details.

Format

listo [s/{created|name|status}] [f/STATUS]

• List orders with the specified sort and filter option.

Caution: Currently, you are unable to add the same order name and quantity for the same customer twice on the same day!

Locating orders by name : findo

findo helps you find orders whose names contain any of the given keywords.

Format

findo KEYWORD [MORE_KEYWORDS]

• The search is case-insensitive. e.g. chocolate will match Chocolate
• The order of the keywords does not matter. e.g. chocolate cake will match cake chocolate.
• Only the order name is searched.
• Only full words will be matched e.g. chocolate will not match chocolatey
• Orders matching at least one keyword will be returned (i.e. OR search). e.g. chocolate cake will return chocolate muffin, crepe cake

Viewing an order : viewo

You can view all information about your order in a single location; viewo displays all about an order in the Information Panel.

Format

viewo OINDEX

• Displays the order’s information at the specified OINDEX.

Tip: You can click on the order in the table directly for the same effect!

Editing an order : edito

As your customer may request changes in the order, such as the address, you can update this information with edito.

Format

edito OINDEX [n/NAME] [q/QUANTITY] [a/ADDRESS]

• Edits the order at the specified OINDEX.
• At least one of the optional fields must be provided.
• Existing values will be updated to the input values.

Advancing an order’s status : advo

As you process the order for your customer, you can update the order’s status easily with advo.

Format

advo OINDEX

• Advances the order at the specified OINDEX.
• An order’s status will be advanced in the following sequence: Pending, Paid, Shipped, Completed.

Tip: If the order is completed, the status cannot be advanced further

Reverting an order’s status : revo

In the event that an order’s progress has to reset backwards, revo helps you revert the order to the previous status.

Format

revo OINDEX

• Edits the order at the specified OINDEX.
• An order’s status will be reverted in the following sequence: Completed, Shipped, Paid, Pending.

Cancelling an order : cancelo

With cancelo, you can update an order’s status as cancelled whenever an order is invalid or the customer cancels an order.

Format

cancelo OINDEX

• Cancels the order at the specified OINDEX.

Deleting an order : deleteo

If you need to remove an order from LoyaltyLift, you can do so with deleteo.

Format

deleteo OINDEX

• Deletes the order at the specified OINDEX.

Setting an order’s note : setnoteo

By creating notes for your orders, you can save crucial details of orders, such as customer requests or preferred delivery timings.

Format

setnoteo OINDEX nt/NOTE

• Sets NOTE as the note of the order at the specified OINDEX.
• Orders, by default, have a blank note.

Tip: Similarly to setnotec, You can remove an order’s note by specifying no value after the prefix!

Appending an order’s note : appendnoteo

In the event that an additional customer request for an order comes in, you can use appendnoteo to add to the existing note of an order.

Format

appendnoteo OINDEX nt/NOTE

• Adds NOTE to any existing note of the customer at the specified OINDEX.

🠕 Back To Top

Miscellaneous

Clearing all entries : clear

Clears all your customers and orders from LoyaltyLift.

Format

clear

Exiting the program : exit

Exits the program.

Format

exit

Viewing help : help

Shows a message explaining how to access the help page.

Format

help

Saving the data

Customer and order data are saved in the hard disk automatically after any command that changes the data. There is no need for you to save manually.

🠕 Back To Top

FAQ

Customers

Q: My customer’s name includes special characters such as Jôse; how can I add this customer into LoyaltyLift?
A: Currently, LoyaltyLift cannot store a customer’s name with special characters. However, one workaround is to add the customer by replacing the special character with a close equivalent, such as Jose, and use the setnotec command to type his actual name, such as setnotec 1 nt/Jôse.

Q: How do I view a customer’s order history in LoyaltyLift?
A: The order history of a customer is available when you view the customer’s information in the information panel. To do so, you can first use findc command to locate the customer, then viewc command to display the customer in the information panel. The order history is found under the History section.

Q: How can I store specific requests from my customer’s for an order?
A: Using the setnoteo command, you can add information such as special customer requests for that particular order! Here is an example when your customer requests lesser sugar: setnoteo 1 nt/less sugar.

Q: The note I have saved for my customer is no longer valid; how do I clear the note for this customer?
A: Assuming the customer is at position 1 in your customer list, you can execute the command setnotec 1 nt/ to clear the current notes for a customer.

Orders

Q: Why are orders deleted or missing after deleting a customer with deletec?
A: Orders are closely tied to a customer in LoyaltyLift. Once a customer has been removed, all the customer’s orders needs to be cleared. If this is not ideal, we recommend avoiding deleting any customers.

Q: Can my orders have a different address than the customer’s address?
A: Yes! When you create an order using addo, you can specify the new address with the parameter a/. If this is not specified, the customer’s address is used instead for your convenience.

Q: I have cancelled or completed an order by accident. How do I undo this action?
A: With the revo command, you can quickly revert the order’s last status change you have made with advo or cancelo!

Rewards

Q: Are the reward tiers of my customers based on the cumulated points or the current points they have?
A: Currently, LoyaltyLift determines the tiers of your customers by the cumulated points. However, if you feel that a customer no longer deserves the tier, you can use setpoints to replace both his current and cumulated points so that it would be below the threshold of the tier!

Q: Is there a limit to my customers’ cumulated points?
A: There is currently a limit of 999999 cumulated points for every customer. Do not fret as we will look into increasing this limit in future releases!

🠕 Back To Top

Command summary

Customer

Rewards

Order

Miscellaneous

🠕 Back To Top