By: Team W09-B1 Since: Feb 2018 Licence: MIT
- 1. Introduction
- 2. About This User Guide
- 3. Setting Up CarviciM
- 4. Quick Start
- 5. Features
- 5.1. Viewing help :
help - 5.2. Adding a job entry:
addj - 5.3. Closing a job entry:
closej - 5.4. Adding remark to a job:
remark - 5.5. Reassigning employees of a job:
reassign[Coming in V2.0] - 5.6. Listing all jobs :
listj - 5.7. Listing all ongoing jobs :
listoj - 5.8. Locating jobs by keyword:
findj - 5.9. Selecting job entry by list number:
selectj - 5.10. Archiving job entries:
archive - 5.11. Analysing job entries:
analyse - 5.12. Adding an employee:
adde - 5.13. Listing all employee entries :
liste - 5.14. Deleting an employee entry :
deletee - 5.15. Sorting all employee entries :
sort - 5.16. Selecting employee entry by list number:
selecte - 5.17. Locating employee entries by name:
finde - 5.18. Locating employee entries by tags:
findt - 5.19. Login to Gmail :
login - 5.20. Email assigned employees belonging to a job :
email - 5.21. Importing jobs from an excel file
importAll,import,accept,reject,acceptAll,rejectAll,switch - 5.22. Changing a command word :
set - 5.23. Setting a theme :
theme - 5.24. Listing entered commands :
history - 5.25. Undoing previous command :
undo - 5.26. Redoing the previously undone command :
redo - 5.27. Clearing the application :
clear - 5.28. Exiting the program :
exit - 5.29. Saving the data
- 5.1. Viewing help :
- 6. FAQ
- 7. Command Summary
Welcome to CarviciM! CarviciM (short for Car Servicing Manager) is a desktop application for car servicing managers to manage car servicing jobs with convenience and ease. You can use Carvicim to add jobs, close ongoing jobs, import large number of job entries, manage employees for job assignment and notify employees of jobs through email. CarviciM is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, CarviciM can get your management of servicing jobs done faster than traditional GUI apps. Interested to speed up your car servicing job allocation process? Jump to the Section 3, “Setting Up CarviciM” to get started. Enjoy!
This user guide shows you how to get started using the CarviciM. It shows you how to setup the application, and also how to perform operations in the CarviciM which are lead by examples.
Legend
This icon represents a warning
|
ℹ️
|
This icon represents something noteworthy |
|
💡
|
This icon represents a useful tip |
This represents an input command
This section will show you how to setup the necessary environment in order to run CarviciM on your desktop.
-
Ensure you have Java version
1.8.0_60or later installed in your Computer.ℹ️Having any Java 8 version is not enough. This app will not work with earlier versions of Java 8.
Don’t have Java1.8.0_60or above? Download it here! -
Download the latest
CarviciM.jarhere. -
Copy the file to the folder you want to use as the home folder for CarviciM.
⚠️ Please ensure that there are no other applications using the home folder, it can affect the performance of CarviciM. -
Double-click the file to start the app. You should see the Graphical User Interface (GUI) as shown in the image below.
You are all set to use CarviciM now! To find out more about how to use CarviciM, read the next section.
This section will cover the basics you need to know for using the guide and the application.
The GUI of CarviciM is made up of the various regions as shown in the image below.
- Command Box
-
A region on the GUI which allows you to type in commands.
- Job List Panel
-
A region on the GUI where you can view the list of jobs.
- Job List Indicator
-
A region above the job list panel that indicates if you are viewing unreviewed jobs or saved jobs.
- Employee List Panel
-
A region on the GUI where you can view the list of employees.
- Job Display Panel
-
A region on the GUI which shows you the details of a selected job.
- Result Display
-
A region on the GUI which you can see the feedback to a command, entered in the command box.
Execute a command by typing it in the command box and press Enter.
e.g. typing help into the command box (as shown in the image below), and pressing Enter will open the help window.
Figure 4.2.1 : Typing help into the command box
Here are some example commands you can try:
-
liste: lists all employees' contacts -
adden/John Doe p/98765432 e/[email protected]: adds an employee namedJohn Doeto CarviciM. -
deletee3: deletes the 3rd employee shown in the current list -
exit: exits the app
Before reading more about commands, you should take note of the command format used throughout this user guide:
-
Words in
UPPER_CASEare the parameters to be supplied by the user e.g. inadde n/NAME,NAMEis a parameter which can be used asadde n/John Doe. -
Items in square brackets are optional e.g
n/NAME [t/TAG]can be used asn/John Doe t/mechanicor asn/John Doe. -
Items with
…after them can be used multiple times including zero times e.g.[t/TAG]…can be used ast/mechanic,t/technicianetc. -
Items with
` after them can be used multiple times but has to be used **at least once** e.g. `w/ASSIGNED_EMPLOYEE_INDEXcan be used asw/4,w/5etc. -
Parameters can be in any order e.g. if the command specifies
n/NAME p/PHONE_NUMBER,p/PHONE_NUMBER n/NAMEis also acceptable.
For details of each command, you can refer to Section 5, “Features” below.
This section will explain to you how you can use the features of CarviciM.
To find out more on using CarviciM, you can use this command to open the help menu:
Format: help
To add a new job entry and assign employees to the job, use this command as follows:
Format: addj n/NAME p/PHONE_NUMBER e/EMAIL v/VEHICLE_NUMBER w/ASSIGNED_EMPLOYEE_INDEX+
|
ℹ️
|
|
Example:
addj n/John Doe p/98765432 e/[email protected] v/bhj123 w/3
You will see "New job added: … " in the result display as shown in the image below.
Figure 5.2.1 : Result display indicating that a job has been added
The job list panel will be updated to display the newly added job as seen in the image below.
Figure 5.2.2 : Job list panel before addition of job entry
Figure 5.2.3 : Job list panel after addition of job entry
To indicate that a job is completed in CarviciM, use this command as follows:
Format: closej j/JOB_NUMBER
Example:
closej j/2
This command closes the ongoing job of number 2 in CarviciM.
You will see "Closed Job…" in the result display as shown in the image below.
Figure 5.3.1 : Result display indicating that a job has been closed
You will also see the job of number 2 have its status shown as "closed" in the job list panel.
Figure 5.3.2 : Job list panel before job is closed
Figure 5.3.3 : Job list panel after job is closed
To add remark or special note to an ongoing job entry, use this command as follows:
Format: remark j/JOB_NUMBER r/YOUR_REMARK
Example:
remark j/2 r/An urgent work that should be completed asap
This command will add the remark "An urgent work that should be completed asap" to a job entry of a job number "2".
You will see the message "Remark added to job number …" reflected in the result display (shown in the image below).
Figure 5.4.1 : Result display showing feedback for remark added
To reassign employees belonging to a job due to manpower constraints , use this command as follows:
Format: reassign j/JOB_NUMBER [-/INDEX_OF_EMPLOYEE_TO_RETIRE] [+/INDEX_OF_EMPLOYEE_TO_ASSIGN]
|
ℹ️
|
|
Example:
reassign -/2 -/1 +/3 +/4
This command will retire employees of index 1 and 2 from the assigned employee list belonging to the specified job, and newly assign employees of index 3 and 4 from the list of employees shown in the employee list panel.
To view a list of all jobs in CarviciM, you can use this command to display them in the job list panel:
Format: listj
|
ℹ️
|
|
To view a list of all ongoing jobs in CarviciM, you can use this command to display them in the job list panel:
Format: listoj
To find jobs of specific details, use this command as follows:
Format: finde KEYWORD [MORE_KEYWORDS]
|
ℹ️
|
|
Examples:
-
Example 1:
findj John
You will see all jobs withjohnas their client name (not case-sensitive), shown in the job list panel. -
Example 2:
findj Apr Feb
You will see all jobs withAprorFebas their job detail (not case-sensitive), shown in the job list panel.
To select a specific job entry from the job list panel, use this command as follows:
Format: selectj j/JOB_NUMBER
|
ℹ️
|
|
Example:
listj
You will see a list of job entries displayed in the job list panel.
selectj j/2
You will see that the respective job entry is selected in the job list panel, and the job display panel shows the full details of the job (shown in the image below).
Figure 5.9.1 : Job display panel showing a summary of the selected job
To archive closed job entries within a specified range in CarviciM, use this command as follows:
Format: archive sd/START_DATE ed/END_DATE
|
ℹ️
|
|
Example:
archive sd/Mar 25 2018 ed/Apr 03 2018
The command will save the closed job entries within the selected date range in CarviciM.
You will see "Archived Successfully" in the result display (shown in the image below).
Figure 5.10.1 : Result display indicating that archiving is completed successfully
You will see the newly created archive xml file (shown in the image below).
Figure 5.10.2 : New archivejob xml file created in the data folder
To analyse job entries within the current month in CarviciM, use this command as follows:
Format: analyse
Example:
analyse
The command will analyse the job entries within the current month in CarviciM.
You will see "Result: Number of Jobs: … Number of Ongoing: … Number of Closed: …"
followed by the number of jobs assigned to each employee in the result display (shown in the image below).
Figure 5.11.1 : Result display showing a summary of the job entries
To add a new employee entry into CarviciM, use this command as follows:
Format: adde n/NAME p/PHONE_NUMBER e/EMAIL
Example:
adde n/John Doe p/98765432 e/[email protected]
The command will add the details of the new employee into CarviciM.
You will see "New employee added: …" followed by details of the new employee (shown in the image below).
Figure 5.12.1 : Result display showing the details of the new employee
You will see the newly added details of the employee in the employee list panel (shown in the image below).
Figure 5.12.1 : Employee list panel showing the details of the new employee
To view a list of employee details in CarviciM, use this command as follows:
Format: liste
To remove the details of an employee from CarviciM, use this command as follows:
Format: deletee INDEX
|
ℹ️
|
|
Examples:
-
Example 1:
liste
You will see a list of employee entries displayed in the employee list panel (shown in the image below).
Figure 5.14.1 : Employee list panel displaying the details of all employees
deletee 2
You will see an updated employee list panel which has the 2nd employee entry removed (shown in the image below).
Figure 5.14.2 : Employee list panel displaying the updated list of employees
-
Example 2:
finde david
You will see the results of thefindecommand which shows all employee entries with matching keyword name, in the employee list panel (shown in the image below).
Figure 5.14.3 : Employee list panel displaying the matching list of employees
deletee 1
You will see an updated employee list panel which has the 1st employee entry removed (shown in the image below).
Figure 5.14.4 : Employee list panel displaying the updated matching list of employees
To sort the list of employee entries alphabetically for easy viewing, use this command as follows:
Format: sort
Example:
Given a unsorted list of employees (shown in the image below).
Figure 5.15.1 : Employee List Panel showing a list of unsorted employee entries
You will see the sorted list of employees after the execution of sort command (shown in the image below).
Figure 5.15.2 : Employee List Panel showing a list of sorted employee entries
To select a specific employee entry from the employee list panel and display the assigned jobs, use this command as follows:
Format: selecte INDEX
|
ℹ️
|
|
Examples:
-
Example 1:
liste
You will see a list of employee entries displayed in the employee list panel.selecte 2 -
Example 2:
finde Betsy
You will see the results of thefindecommand which shows all employee entries with matching keyword name.selecte 1
To search for employee entries whose names contain any of the given keywords, use this command as follows:
Format: finde KEYWORD [MORE_KEYWORDS]
|
ℹ️
|
|
Examples:
-
Example 1:
finde John
You will see all employee entries withjohnas their name (not case-sensitive), shown in the employee list panel. -
Example 2:
finde Betsy Tim John
You will see all employee entries withBetsy,Tim, orJohn(not case-sensitive), shown in the employees list panel.
To search for employee entries by tags, use this command as follows:
Format: findt KEYWORD [MORE_KEYWORDS]
|
ℹ️
|
|
Examples:
-
Example 1:
findt technician
You will see all employee entries with the tagtechnican(not case-sensitive), shown in the employee list panel. -
Example 2:
findt technician mechanic
You will see all employee entries with the tagstechnicanand/ormechanic(not case-sensitive), shown in the employees list panel.
|
ℹ️
|
Before using this command, ensure that you are connected to the internet. |
You will need to login to Gmail before you can use the email feature to send out emails to your employees (see Section 5.20 below). To login to Gmail, use the login command as follows:
Format: login
You will be redirected to the Gmail login page on your default internet browser, where you can then proceed to login.
|
ℹ️
|
When you are redirected to the Gmail login page, CarviciM may (although unlikely to happen) appear as if it is not responding. If so, don’t panic! Once you have successfully logged in to Gmail, CarviciM will be up and running again, from exactly where you left off. |
When prompted to give your permission to allow CarviciM to access your Gmail account, click on ALLOW.
|
|
Please do NOT click on |
For your convenience, your authorization information will be stored on your computer’s file system, even after closing and reopening CarviciM. You will, therefore, only need to login once.
|
ℹ️
|
|
To send auto-generated emails containing the job details from your Gmail account to all assigned employees of the job, use this command as follows:
Format: email j/JOB_NUMBER
|
ℹ️
|
|
Take a look at the image below for a sample of the contents of the emails that will be sent when you use this command.
Figure 5.20.1 : Sample of auto-generated email content
Example:
email j/1
Auto-generated emails containing the job details of the job at index 1 of the job list panel will be sent from your Gmail account to all employees assigned to the job.
5.21. Importing jobs from an excel file importAll, import, accept, reject, acceptAll, rejectAll, switch
To import all jobs into CarviciM directly, use this command as follows:
Format: importAll FILEPATH
Similar to import command, importAll also loads an excel file,
additionally it accepts all job entries. importAll is equivalent to an
import and acceptAll.
Example:
importAll excel-file.xlsx
Imports example excel file excel-file.xlsx shown in import, accepts all job entries and saves the reviewed job entries as an external excel file.
You should see:
To discretely import job entries, here are the steps you should follow:
-
import a file
-
acceptandrejectjob entries.
To start import a file, use this command as follows:
Format: import FILE_PATH
|
💡
|
If your imported file does not reflect correctly, there is an old save file from the autosave feature. To rectify the problem:
|
|
ℹ️
|
|
|
|
|
Here is an example of an excel sheet that can be imported:
| client name | client phone | client email | vehicle number | employee name | employee phone | employee email | status | remarks | empty column | |
|---|---|---|---|---|---|---|---|---|---|---|
John Doe |
91234567 |
SXX1234X |
Jim |
87654321 |
Your remark |
Ongoing |
||||
… |
|
💡
|
The columns can be interchanged, with empty column at the last column.
|
Example:
import excel-file.xlsx
Imports the example file excel-file.xlsx shown above. You should see:
You can use this command to switch between the list of unreviewed jobs and jobs in CarviciM.
Format: switch
|
ℹ️
|
You can see the current job list in the job list indicator. |
You can use 4 commands when reviewing changes:
-
accept NUMBER -
reject NUMBER -
acceptAll -
rejectAll
To accept a job with job index NUMBER in the imported list, use this command as follows:
Format: accept NUMBER
Example:
accept 1
Accepts the job entry with job index number 1 and removes it from imported list.
To accept all remaining jobs, use this command as follows:
Format: acceptAll
Example:
acceptAll
Accepts all remaining job entries and clears the imported list.
To reject a job with job index NUMBER in the imported list, use this command as follows:
Format: reject NUMBER
Example:
reject 1
Rejects job entry with job index number 1 and removes it from imported list. It is not added to CarviciM.
While accepting or rejecting changes, you can enter your comments behind the command.
|
💡
|
You can type any sentence as a comment, as long as it is separated from the last argument with a spacebar character. |
Examples:
-
Example 1:
accept 1good job`
Accepts first job and attaches "good job" as a comment to the first job. -
Example 2:
acceptAll well done
Accepts all remaining imported jobs and attaches "well done" as a comment to all the remaining imported jobs. -
Example 3:
reject 1 Speak to you during tomorrow’s meeting.
Rejects first job and attaches "Speak to you during tomorrow’s meeting." as a comment to the first job. -
Example 4:
rejectAll Please check the customer details.
Rejects all remaining imported jobs and attaches "Please check the customer details." as a comment to all the remaining imported jobs.
To send your feedback to the job list providers, look for the save file generated after importing and reviewing your jobs.
CarviciM autosaves your comments to an excel file with -comments.xls or -comments.xlsx appended,
in the same directory.
|
|
When copying -comments.xls or -comments.xlsx files, try to keep the original copy in the folder. It helps to prevent
reimporting the same jobs from the a file with the same name twice.
|
To set an easy to use word in place of a default command word, use this command as follows:
Format: set OLD_COMMAND_WORD NEW_COMMAND_WORD
|
ℹ️
|
|
|
💡
|
|
You don’t have to worry if you forgot your custom words! They will be displayed in the result display whenever you make a mistake!
Examples:
-
Example 1:
set adde a
Setsaddecommand word toausing default.
You will see "a has been set as an alternative for adde!" in the result display. -
Example 2:
set deletee d
set d delete
Setsdtodeleteusing default.
You will see "d has been replaced with delete!" in the result display.
To set the theme of the application for a change of working environment, use this command as follows:
Format: theme INDEX
|
ℹ️
|
|
You will be able to select from these 3 themes:
Figure 5.20.1 : Mauve Theme
Figure 5.20.2 : Dark Theme
Figure 5.20.3 : Light Theme
Example:
theme
You will see the list of valid themes to choose from in the result display.
theme 1
You will see the theme of the application set as the selected one.
To find out what commands that you have executed recently, use this command to list a history of executed commands in reverse chronological order:
Format: history
|
ℹ️
|
Pressing the ↑ and ↓ arrows will display the previous and next input respectively in the command box. |
Nobody’s perfect. To reverse an undoable command that was executed by mistake, use this command to restore CarviciM to the state before the execution of that command:
Format: undo
|
ℹ️
|
Undoable commands: those commands that modify CarviciM’s content ( |
Examples:
-
Example 1:
deletee 1
Deletes the first employee in CarviciM.+You will see that the first employee is no longer displayed in the employee list panel.liste
Shows all employees in CarviciM.
You will not see the deleted employee of index 1 in employee list panel.undo(reverses thedelete 1command)
You will see the deleted employee present in the employee list panel again. -
Example 2:
closej j/1
You will see that job number 1 is removed from the job list panel.undo(reverses theclosej j/1command)
You will see that job number 1 is added back into the job list panel.undo
Theundocommand fails as there are no undoable commands.
To reverse an unwanted undo command that was executed, use this command as follows:
Format: redo
Examples:
-
Example 1:
deletee 1
You will see that the first employee entry is removed from the employee list panel.undo(reverses thedeletee 1command)
You will see that the deleted employee entry is added back into the employee list panel.redo(reapplies thedeletee 1command)
You will see that the same employee entry is removed from the employee list panel again. -
Example 2:
closej j/1
You will see that the job number 1 has its status changed to "closed" in the job list panel.deletee 1
You will see that the first employee entry is removed from the employee list panel.undo(reverses thedeletee 1command)
You will see that the deleted employee entry is added back into the employee list panel.undo(reverses theclosej j/1command)
You will see that the closed job number 1 has it status changed to "ongoing" in the job list panel.redo(reapplies theclosej j/1command)
You will see that the job number 1 has its status changed back to "closed" again, in the job list panel.redo(reapplies thedeletee 1command)
You will see that the same employee entry is removed from the employee list panel.
To have an empty CarviciM app, use this command to clear everything in the app:
Format: clear
|
ℹ️
|
|
Q: How do I transfer my data to another Computer?
A: Install the app in the other computer and overwrite the empty data file it creates with the file that contains the data of your previous Address Book folder.
Q: Can I use this application without internet connection?
A: You will be able to use most commands in CarviciM except for the login and email command.
Q: Why can’t I use my mouse?
A: CarviciM is targeted at users who can type fast. The commands can be executed faster than with a mouse if you are fast typer.
Q: I want to be able to view an employee’s schedule on a calendar so that I can better allocate jobs. How can I do that?
A: We hear you. We are currently working on this feature, and it will be one of the new features in CarviciM 2.0. Do watch out for the update!
Q: The problem that I am facing is not listed here. What can I do?
A: Don’t worry, simply drop us an email at [email protected] and we will respond to you shortly.
This section contains a summary of all the commands that you can use in CarviciM.
| Description | Command Format | Example |
|---|---|---|
Job Management Features |
||
Add Job |
|
|
Close Job |
|
|
List Ongoing Jobs |
|
|
List All Jobs |
|
|
Find Jobs |
|
|
Select A Job Entry |
|
|
Archive Job Entries |
`archive sd/START_DATE ed/END_DATE |
|
Analyse Job Entries |
|
|
Employee Entries Management Features |
||
Add Employee Entry |
|
|
Delete Employee Entry |
|
|
Find Employees Entries |
|
|
Select Employee |
|
|
List Employee Entries |
|
|
Sort Employee |
|
|
Import Features |
||
Import Excel File |
|
|
Accept Imported Job |
|
|
Reject Imported Job |
|
|
Accept All Imported Jobs |
|
|
Reject All Imported Jobs |
|
|
Other Features |
||
Viewing Help |
|
|
History |
|
|
Undo A Command |
|
|
Redo A Command |
|
|
Email Assigned Employees Of A Job |
|
|
Change Command Word |
|
|
Apply Theme |
|
|
Clear Entire CarviciM |
|
|
Exit The Application |
|
|