FitBiz - User Guide

Similar to most modern CLIs, users of FitBiz can press the ↑ and ↓ arrow keys to cycle through their previously entered commands. If you have prior experience in using a CLI, feel free to skip this section as this should be second nature to you. If not, here is a quick tutorial on how to use this time saving feature.

First, start by typing anything into the Command Box. It need not have to be a valid command (like those shown in Section 3, “Commands”). In our example, we chose to type Hello World:

Next, hit the Enter key to enter the command into FitBiz. Notice that whatever you have typed in the Command Box should have disappeared. If you did not enter a valid command (like Hello World), the border of the Command Box would have turned red, and you would have been prompted by a message saying Unknown command in the Result Box like shown:

Next, continue entering different commands into the Command Box. You can safely ignore all the Unknown command prompts for now.

Once you feel like you have entered enough commands into FitBiz, try hitting the ↑ key several times. You should start to see the history of your entered commands displaying in the Command Box in reverse chronological order. If you press the ↑ key enough times (or simply hold down the key), you would realise that the command in the Command Box no longer changes. In our case, it displays Hello World, our first ever entered command.

Likewise, you can also see your more recent commands by pressing the ↓ key. Again, if you press it enough times, you would realise that the text from the Command Box disappeares (right after displaying your most recent command). This means that you have reached the end of your command history.

Again, similar to most modern CLIs, users of FitBiz can press the Tab key to autocomplete commands that they have partially typed. If the partially typed letters uniquely identifies a valid command in FitBiz (see Section 3, “Commands”), the complete command will automatically appear in the Command Box. Otherwise, a list of all commands similar to the ambiguous letters will appear in the Result Box.

Also, we understand that some of FitBiz’s commands may be particularly long and diffcult to remember. In order to remedy this, we have also provided autocompletion of parameter prefixes for some commands, as well as the use of Tab to easily get to the next prefix. When autocompleting commands, the caret position will also be automatically set to the most optimal position corresponding to the completed command.

To see this feature in action, type add-c into the Command Box and press Tab:

Immediately, you should have noticed three things:

Now, you can also press the Tab key repeatedly to go to the next parameter prefix, instead of wasting time using your mouse.

Note however, that there are some similar commands in FitBiz that have the same few starting letters. For example: both add-c and add-e starts with the letter "a". As such, hitting Tab when you have only typed a in the Command Box will not autocomplete either command (unfortunately, FitBiz cannot read your mind). However, you will find that the command will be completed up till add-, the point where add-e and add-c differs. The Result Box will also prompt you with the list of all similar commands found:

To autocomplete the parameter prefixes like in the first example above, you would just have to complete the command and press Tab once more.

The command is simply list-c, and has no additional parameters.

Let’s say you start off with the full Client List as shown below.

Now, let’s say you use the command filter-c to filter the clients with the Paleo tag as such:

Your Client List will now display only the clients that have the Paleo tag. In this example, the only client that fit this requirement is Alex Yeoh.

Let’s say you are done with the filter, and want to list all your clients on the Client List again. Simply enter `list-c`into the Command Box and you should be able to see the following:

No clients shown on the Client List

You may be greeted with the following scene. This means that there are no clients in your FitBiz. You can begin adding clients by using the add-c command. Do refer to the add-c section in this document for help regarding add-c.

This section acts as a summary of the important things to note when using find-c including their parameters.

Let’s say that you want to find a client named "Bryan Low" in Client List. You can simply use the find-c command as shown.

You might face some errors or difficulties when you find-c. In this section, you will be able to understand these errors and resolve them. You will also get a better understanding of the reply from the result box when using find-c.

This section summarises the format and important information to note while using the add-c command.

*The set of special characters are !#$%&'*+/=?{|}~^.-`

Lets say you want to add a new client with the following details:
Name: Amanda Low
Phone number: 95436543
Email: AmandaLow@dmail.com
Address: West Coast Grove 69
Birthday: 5 April 1990
Sport: Swimmer
Tag: Vegetarian

If you are facing errors or difficulty adding a client, you can refer to the common errors and problems listed below and resolve your error using the solution given.

In FitBiz, you cannot add 2 clients with the either same phone number or email.

For example, you have client with the email RachelTan@dmail.com and you want to add another client with the same email.

The following error message will be shown.

To solve this issue, ensure that any new client you add does not have the same phone number or email as existing client.

This section acts as a summary of the important things to note when using edit-c and its parameters. The square bracket shows that it is optional and your command will still execute even if you do not enter them. However, at least one of them have to be specified. The ellipsis after a parameter …​ means that there can be multiple of that same type of parameter.

*The set of special characters are !#$%&'*+/=?{|}~^.-`

Let’s say you want to edit the address and assign 3 sports (Tennis, Hockey, Badminton) to client Irfan Ibrahim. From the Client List, you can see that his client INDEX is 3.

Next, you can enter the command edit-c 3 a/New Address #123456 s/Tennis s/Hockey s/Badminton in the Command Box.

Enter the command, and you should see that the Result Box displays the edited client’s information, and that the Client List has updated Irfan Ibrahim to show the new changes.

You might face some errors or difficulties when you use edit-e. In this section, you will be able to understand these errors and resolve them.

Result box not displaying updated client’s information

When you use edit-c, instead of seeing the updated client’s information in the Result Box, you might sometimes encounter an error message informing you about the specifications for the format of the command. This error message varies according to the mistake detected in the parameters given. For simplicity, let’s look at one example scenario.

Let’s say you attempt to edit the email of Irfan Ibrahim and happen to give an incorrect format of the email that does not follow the rules given in the parameters table above for EMAIL. Consider the following command: edit-c 3 e/invalidEmail.

As seen above, the EMAIL is of the wrong format as it does not include the @ symbol and not of the xxx@yyy format.

In the example above, the EMAIL field was faulty. This behaviour of FitBiz also applies to other faulty parameters for the edit-c command, where FitBiz will display information relevant to the faulty parameter, to help you troubleshoot and correct your input.

This section acts as a summary of the important things to note when using delete-c including their parameters.

Let’s say that you want to delete the client named "Alex Yeoh" in client list. You can simply use the delete-c command as shown.

You might face some errors or difficulties when you use delete-c. In this section, you will be able to understand these errors and resolve them.

This section acts as a summary of the important things to note when using view-c including their parameters.

Let’s say that you want to view the details of the client named "Alex Yeoh" in client list. You can simply use the view-c command as shown.

You might face some errors or difficulties when you use view-c. In this section, you will be able to understand these errors and resolve them.

This section acts as a summary of the important things to note when using add-e including their parameters. The square bracket shows that it is optional and your command will still execute even if you do not enter them.

Let’s say that you want to add an exercise with the following details:

You can use the add-e command to add the exercise as shown.

You might face some errors or difficulties when you use add-e. In this section, you will be able to understand these errors and resolve them.

This section acts as a summary of the important things to note when using edit-e including their parameters. The square bracket shows that it is optional and your command will still execute even if you do not enter them. However, at least one of them have to be specified.

Let’s say that you want to edit an exercise done by the client you are currently viewing. The exercise that you want to edit is the one highlighted in the photo below.

The exercise, "Bench Press", currently is 4 reps and weight of 100. However, they might be entered wrongly and you want to change the values. You can use the edit-e command to edit the exercise as shown.

You might face some errors or difficulties when you use edit-e. In this section, you will be able to understand these errors and resolve them.

If you find that you are unable to execute this command successfully, there are a few things you can check:

This section acts as a summary of the important things to note when using schedule. The square bracket shows that it is optional and your command will still execute even if you do not enter them.

Let’s say you want to schedule a weekly Monday 11:00am to 12:00pm slot for your client Alex Yeoh. Alex Yeoh is the first client on your Client List.

You can see that Alex Yeoh’s client index is 1. Therefore, you can proceed to type the schedule command in the Command Box to assign a schedule slot to him.

After you enter the command, you can see that the Result Box has notified you of the new overwritten schedule, and that Alex Yeoh’s schedule slot has appeared on the Schedule Panel on Monday.

Now let’s say you want to add multiple schedules to Bernice Yu: Monday 8:00am to 10:00pm and Tuesday 4:00pm to 6:00pm. You can do that by adding both of these timings into the schedule command following the same format as above.

Now enter the command, and you’ll see that Bernice’s schedules also show up on the Schedule Panel.

Finally, let’s say Alex no longer has any schedule slots, and you want to clear it. Simply type in schedule 1 sch/ in the Command Box to clear his schedule, and you should see this.

You might face some errors or difficulties when you use schedule. In this section, you will be able to understand these errors and resolve them.

Overlapping schedules

You might encounter the message that "One or more of your input schedules have overlapping time periods. Please check again." This means that there is a overlapping time period between at least two of your input schedules. In this case as shown below, the first schedule sch/MON-1100-1200 conflicts with the second schedule sch/MON-1200-1300 because the end time of the first schedule overlaps with the start time of the second schedule.

Invalid command format

You might encounter the error message from the Result Box specifying the format that you should be using for the schedule command. This means that there are one or more errors in the format of your input for the schedule command. In the example input shown below, schedule 2 sch/TUESDAY-800-1:00, there are multiple errors. First, the DAY should be three letters. Next, the STARTTIME and ENDTIME should follow the HHmm format. The correct input for this should be schedule 2 sch/TUE-0800-1300.

If you find that you are unable to execute this command successfully, there are a few things you can check:

Let’s say you want to filter through your list of clients and only display those with the tag healthy and play the sport badminton.

Tags with spaces

When you want to filter the clients list with multiple tags like healthy and sporty, you might enter the command shown below.

You will then encounter the error Tags names should be alphanumeric.

This error occurs because TAG only accepts letters and numbers but not spaces. To solve the problem, add an additional delimiter for each tag you want to specify. Note that sports does not require multiple delimiter.

The list of successfully filter clients will then be displayed.

This section acts as a summary of important things to note when using graph including their parameters.

Let’s say that you wish to view the exercise graph of Alex Yeoh for the exercise Sumo Deadlift from the date 01-01-2020 to 13-04-2020 and you want to focus on the weight he lifted during the exercise.

You can use the graph command to view the graph of the exercise following the steps as shown:

You might face some errors or difficulties when you use graph. In this section, you will be able to understand these errors and resolve them. You will also get a better understanding of the reply from the Result Box when using graph.