RTPM User Guide

RealtorTrackerPlusMax (RTPM) is the hottest new computer app for realtors. RTPM allows you to manage your clients, optimized for use via a Command Line Interface (CLI), aimed at maximising your speed in entering data. Whether you are learning how to get into the real estate industry, or looking for a simple and free app to get rid of your cluttered spreadsheets, RTPM is for you!

Contents

• Quick Start
  
• Configuration
  
• Features
  
  • Adding a client
    
    • Adding a buyer: buyer
      
    • Adding a seller: seller
      
  • Editing a client
    
    • Editing a buyer: bedit
      
    • Editing a seller: sedit
      
  • Deleting a client
    
    • Deleting a buyer: bdelete
      
    • Deleting a seller: sdelete
      
    • Clearing all entries: clear
      
  • Setting a client's priority
    
    • Setting a buyer's priority: bprio
      
    • Setting a seller's priority: sprio
      
  • Viewing the clients
    
    • Filtering buyers and sellers: filter
      
    • Listing all buyers and sellers: list
      
    • Displaying a buyer from buyer list: blist
      
    • Displaying a seller from seller list: slist
      
    • Sorting buyers: bsort
      
    • Sorting sellers: ssort
      
  • Miscellaneous commands
    
    • Undoing previous action: undo
      
    • Redoing previous action: redo
      
    • Viewing help: help
      
    • Exiting the program: exit
      
• FAQ
  
• Known Issues
  
• Command Summary
  
• Appendices
  • Appendix A: Warnings
    
  • Appendix B: Fields
    
  • Appendix C: Similar names
    
  • Appendix D: Definitions
    

Quick Start

1. Ensure you have Java 11 or above installed in your computer. For more info, check the FAQ.

2. Download the latest rtpm.jar here.

3. Move the application to the folder you want to use as the setup folder for RTPM. (On startup, the application will generate a few files for configuration and storage.)

4. You should be able to run the application by double-clicking. If this does not work for you, check the FAQ.
   A display similar to the below should appear in a few seconds. If you are starting the app for the first time, there will be some sample data loaded.
   

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

   • buyer n/John Doe : Adds a buyer named John Doe to the RTPM.

   • list : Lists all buyers and sellers.

   • bdelete 2 : Deletes the 2nd buyer shown in the current list.

   • exit : Exits the app.

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

Configuration

If you are looking to change the size of the application, resizing can simply be done by clicking and dragging the borders in the direction you desire. If you do this to the white header atop the app, you can also move the window around. Both size and position of the application are saved, so that you don't need to spend time fiddling with the window.

Features

Here are some things regarding RTPM's features to take note of before using them.

Adding a buyer: buyer

You can add buyers with a few keystrokes, instead of having to use an excel sheet. The buyer command allows you to add a buyer with just their name, so that you can quickly add them on the go.

You can also include contact details of the buyer with the [p/PHONE_NUMBER] and [e/EMAIL] fields, and add more details about them with the [t/TAG] field.

Format: buyer n/NAME [p/PHONE_NUMBER] [e/EMAIL] [ah/HOME_ADDRESS] [i/HOUSE_INFO] [prio/PRIORITY] [t/TAG]…

Example: buyer n/Jane Doe p/91234567 e/janedoe@gmail.com ah/1 College Ave East i/Central Area 5 Room Condominium prio/high

Adding a seller: seller

Similar to buyer, the seller command allows you to add clients who have homes to sell. Additionally, you can add information about the house that your client wants to sell with the [i/HOUSE_INFO] field.

Format: seller n/NAME [p/PHONE_NUMBER] [e/EMAIL] [ah/HOME_ADDRESS] [as/SELLING_ADDRESS] [i/HOUSE_INFO] [prio/PRIORITY] [t/TAG]…

Example: seller n/Ryan p/91234567 e/ryan@gmail.com ah/My Secret Home as/47D Lor Sarhad, Singapore 119164 i/4 Room Flat in Sarhad Ville prio/high

Editing a buyer: bedit

Congratulations on adding buyers and sellers! Now, when you have time to review your client's information, you can fill in additional information about buyers, or edit their existing information.

The bedit command allows you to edit any information about your buyer, so that you can capture the dynamic needs of your client. To select the buyer you want to edit, just indicate their index number.

Format: bedit INDEX PREFIX/VALUE [MORE_PREFIX/VALUE]…

• INDEX: A positive integer (1, 2, 3, …) which must not exceed the last index in the buyers' list
• PREFIX/VALUE: Refer to the appendix linked above.

Example: bedit 3 e/example@email.com ah/Residential Street

Editing a seller: sedit

Similar to bedit, the sedit command allows you to edit the information of a home seller.

Format: sedit INDEX PREFIX/VALUE [MORE_PREFIX/VALUE]…

• INDEX: A positive integer (1, 2, 3, …) which must not exceed the last index in the sellers' list
• PREFIX/VALUE: Refer to the appendix linked above.

Example: sedit 3 e/example@email.com ah/Residential Street

Deleting a buyer: bdelete

Congratulations on helping a buyer find their dream home! With the deal now complete, it's time to shift your focus onto securing the next deal and making the next buyer satisfied.

The bdelete command allows you to delete a buyer based on their index number in the buyers’ list, so that you can keep your buyer list organised and de-cluttered by keeping only the relevant buyers and removing outdated entries.

Format: bdelete INDEX

• INDEX: A positive integer (1, 2, 3, …) which must not exceed the last index in the buyers' list

Example: bdelete 3

Deleting a seller: sdelete

Similar to bdelete, the sdelete deletes a seller based on their index number in the sellers’ list, so that you can keep your seller list organised and de-cluttered by keeping only the relevant sellers and removing outdated entries.

Format: sdelete INDEX

• INDEX: A positive integer (1, 2, 3, …), which must not exceed last index in the sellers’ list

Example: sdelete 3

Clearing all entries : clear

Clears all entries from the address book.

Format: clear

Setting a buyer's priority: bprio

Get your priorities straight. Focus on the tasks that matter the most, and maximise your time and productivity by securing the most important deals, first and foremost.

The bprio command allows you set the priority level of a buyer based on their index number in the buyer's list, so that you can seamlessly differentiate buyers at a glance by their priority level. The priority tags are colored intuitively for you to easily spot a buyer's priority level at first glance. After assigning priorities to your buyers, a simple bsort prio/d command would then sort your buyer list by priority level, with the higher priority buyers appearing first at the top of the list, allowing you to get started with the right client, right away.

Format: bprio INDEX PRIORITY

• INDEX: A positive integer (1, 2, 3, …) which must not exceed the last index in the buyer's list
• PRIORITY: See here.

Example: bprio 3 high

Setting a seller's priority: sprio

Similar to bprio, the sprio command allows you to set the priority level of a seller (instead of a buyer) based on their index number in the seller's list, so that you can seamlessly differentiate sellers too at a glance by their priority level.

Format: sprio INDEX PRIORITY

• INDEX: A positive integer (1, 2, 3, …) which must not exceed the last index in the buyer's list
• PRIORITY: See here.

Example: sprio 3 high

Filtering buyers and sellers: filter

Say goodbye to the struggles of scrolling through your entire list to find that one elusive client.

The filter allows you to find any client by name easily, so you never have to waste time searching for a client no matter how long your lists get.

• This command only matches names
• Your keywords can be given in any order
• Only complete words will be matched
• Any match will result in the buyer or seller being displayed

Format: filter KEYWORD [MORE_KEYWORDS]…

• KEYWORD: No restrictions; case-insensitive

Example: filter John Doe

Expected output when the command succeeds:

Listing all buyers and sellers: list

The list command allows you to display all buyers and sellers, so that you can get back to work after using the filter command or editing the data file directly.

Format: list

Displaying a buyer from buyer list: blist

The blist command allows you to display the information of any buyer as a status message, so that you can view it, or highlight and copy it for further use.

Format: blist INDEX

• INDEX: A positive integer (1, 2, 3, …) which must not exceed the last index in the buyers' list

Example: blist 3

Displaying a seller from seller list: slist

The slist command allows you to display the information of any seller as a status message, so that you can view it, or highlight and copy it for further use.

Format: slist INDEX

• INDEX: A positive integer (1, 2, 3, …) which must not exceed the last index in the sellers' list

Example: slist 3

Sorting buyers: bsort

Elevate your contact list through organisation based on your priorities.

The bsort command allows you to quickly organise your buyer contacts by various criteria, so that you can sieve out your most important contacts to maintain and the most valuable opportunities you have.

Format: bsort [PREFIX/DIRECTION]

• PREFIX: Choose one of:
  • n - sort by name
  • ah - sort by home address
  • i - sort by house info
  • prio - sort by priority
• DIRECTION: "a" OR "d" for ascending or descending respectively

Examples:

• bsort to sort by original order
• bsort n/d to sort by name descending

Sorting sellers: ssort

Elevate your contact list through organisation based on your priorities.

The ssort command allows you to quickly organise your seller contacts by various criteria, so that you can sieve out your most important contacts to maintain and the most valuable opportunities you have.

Format: ssort [PREFIX/DIRECTION]

• PREFIX: Choose one of:
  • n - sort by name
  • ah - sort by home address
  • i - sort by house info
  • prio - sort by priority
• DIRECTION: "a" OR "d" for ascending or descending respectively

Examples:

• ssort to sort by default
• ssort n/d to sort by name descending

Undoing previous action: undo

Made a mistake? The undo command allows you to undo the previous action, easily correcting your mistakes and keeping your contact list on track.

Format: undo

Redoing previous action: redo

The redo command allows you to restore a previously undone action, making it easy to go back to any state and continue working from there.

Format : redo

Viewing help: help

Unsure of how to use our system or forgot the available commands? The help command allows you to access our user guide, ensuring that you have all the information you need at your fingertips.

Format: help

Exiting the program: exit

Wrap up your contact management session and start making the deals happen.

The exit command allows you to terminate the program gracefully and securely, safeguarding all data and changes you've made during the session.

Format: exit

FAQ

A list of frequently asked questions to resolve common issues you may have.

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 RTPM home folder.

Q: My entries are missing! Did they get deleted somehow?
A: One possible fix is to try calling the list command. If you manually edit the data file, or you filtered the list, the entries may not appear in the application until you refresh the list.

Q: I made a mistake! How do I fix it?
A: You can make use of the handy undo and redo commands to fix any errors made.

Q: I can't double-click on the application to run it!
A: First, check that you have Java 11 installed. If you do, and you still can't double-click, try this: Open a command terminal,use the cd command to change into the folder you put the application file in, and type in the java -jar rtpm.jarcommand to run the application.

Q: How do I install Java 11?
A: Try installing from the official Oracle archive here.

Q: I still have issues!
A: Try contacting our developer team by creating an issue on our GitHub, and we will see how we can help.

Known issues

1. When using multiple screens, if you move the application to a secondary screen, and later switch to using only the primary screen, the GUI will open off-screen. The remedy is to delete the preferences.json file created by the application before running the application again.

2. Adding multiple contacts with excessively long names (>5000 characters) may cause RTPM to lag significantly. It is recommended to use nicknames or initials if necessary.

3. Long fields can cause the details of a client to not be displayed fully. A workaround is to use the slist/blist commands to display the details of the client in the result box.

Command summary

Appendix A: Warnings

RTPM allows you to flexibly input most fields of data, so that the app doesn't unnecessarily restrict you. For example, you can insert chinese characters as names, or use slashes to abbreviate "son of" as "s/o".

Hence, the warning system aims to inform you of any valid but possibly unintended inputs. The warning system is able to alert you of multiple errors at once, allowing you to correct all mistakes together instead of one-by-one.

The warning system is also used to notify you when there are two similar buyers or sellers, or when a buyer shares the same name as a seller. This reduces the chance that you will accidentally make two entries for the same person, cluttering your data. See Appendix C for more details.

Warning!; [Phone numbers should only contain numbers, and it should 
be at least 3 digits long. Area codes are allowed, signified by a 
'+' and up to 3 numbers, followed by a space separating this from 
the main number.]
Please ignore if this is expected.

Warning!; [Emails should be of the format local-part@domain and 
adhere to the following constraints:
1. The local-part should only contain alphanumeric characters and 
these special characters, excluding the parentheses, (+_.-). The 
local-part may not start or end with any special characters.
2. This is followed by a '@' and then a domain name. The domain 
name is made up of domain labels separated by periods.
The domain name must:
    - end with a domain label at least 2 characters long
    - have each domain label start and end with alphanumeric 
      characters
    - have each domain label consist of alphanumeric characters, 
      separated only by hyphens, if any.]
Please ignore if this is expected.

Appendix B: Fields

Here, we provide the exact checks that our application does for you, and the warning given if the field is inappropriate.

Appendix C: Similar names

RTPM does checks to ensure users do not accidentally enter the same person twice, preventing cases where you have duplicate entries. This is also true if you try to edit two people to have the same name.

There may be some ambiguity when names are similar but not exactly the same; in this case, the app will warn the user in case this was unintentional, but will not prevent the command from executing.

An example when the same name is detected across buyers and sellers: This seller potentially also exists in the buyer list: If so, please verify that their contact information is the same

An example when similar names are detected: The seller is similar to one of the sellers in the list!

An example when the same name is detected: This seller already exists in the address book (This is not allowed, hence the command will not execute.)

Appendix D: Definitions

Provided is a useful definition list of terms that were used in the guide and in the application.

• Area code: A prefix for phone numbers in the format +123, containing anywhere from 1 to 3 digits.
• Alphanumeric: Consisting of only English-language letters and the digits from 0-9.
• CLI: Command-Line Interface. A text-based means of interacting with applications. In RTPM, you use this to interact with the internal logic.
• Client: In RTPM, refers to either a buyer or a seller.
• Hard disk: The storage component of your computer.
• Index: Any positive (above 0) integer.
• Integer: A number without a fractional part.
• JSON: A storage format that RTPM uses to store its data. See here for more info.
• Numerical: Consisting only digits from 0-9.
• Parameters: Specific details, instructions and information about the command you are executing.
• Priority: The importance of a specific client, as determined by you.
• RTPM: The acronym for this app, RealtorTrackerPlusMax.
• Special characters: All non-alphanumeric characters.