Skip to content

Latest commit

 

History

History
599 lines (418 loc) · 17.1 KB

UserGuide.adoc

File metadata and controls

599 lines (418 loc) · 17.1 KB
Raw

Marketing Morph - User Guide

By: Sky Walker Since: Feb 2019 Licence: NUS

1. Introduction

Marketing Morph is for marketers who want to organize consumer data. More importantly, Marketing Morph will allow marketers to use a GUI to keep track of different consumers, maintain client lists, and perform market analysis and research in one simple interface.

2. Quick Start

  1. Ensure you have Java version 9 or later installed in your Computer.

  2. Download the latest addressbook.jar here.

  3. Copy the file to the folder you want to use as the home folder for your Address Book.

  4. Double-click the file to start the app. The GUI should appear in a few seconds.

    Ui

  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.

  6. Some example commands you can try:

    • list : lists all contacts

    • addadd n/Jane Doe p/23456789 e/[email protected] a/113, Clementi Ave 2, #02-24 s/5000 o/teacher r/single : adds a contact named Jane Doe to the Address Book.

    • delete1 : deletes the 1st contact shown in the current person list

    • exit : exits the app

  7. Refer to Section 3, “Features” for details of each command.

3. Features

Command Format

  • Words in UPPER_CASE are the parameters to be supplied by the user e.g. in add n/NAME, NAME is a parameter which can be used as add n/John Doe.

  • Items in square brackets are optional e.g n/NAME [t/TAG] can be used as n/John Doe t/friend or as n/John Doe.

  • Items with …​ after them can be used multiple times including zero times e.g. [t/TAG]…​ can be used as   (i.e. 0 times), t/friend, t/friend t/family etc.

  • Parameters can be in any order e.g. if the command specifies n/NAME p/PHONE_NUMBER, p/PHONE_NUMBER n/NAME is also acceptable.

3.1. Viewing help : help

Format: help

3.2. Adding a person : add

Adds a person to the consumer list.
Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS s/SALARY o/OCCUPATION r/RELATIONSHIP [t/TAG]…​

💡
 A person can have any number of tags (including 0)

Examples:

  • add n/Jane Doe p/23456789 e/[email protected] a/113, Clementi Ave 2, #02-24 s/5000 o/teacher r/single

  • add n/John Doe p/98765432 e/[email protected] a/311, Clementi Ave 2, #02-25 s/100000 o/banker r/single t/friends t/owesMoney

3.3. Adding a company : addcpny

Adds a company to the client list

Format: addcpny n/NAME p/NUMBER e/EMAIL a/ADDRESS s/REVENUE o/SECTOR r/STRUCTURE [t/TAG]…

Explanation: REVENUE represents a company’s yearly revenue. SECTOR represents the type of company i.e. Food, Retail, Bank. STRUCTURE distinguishes the organization of the company i.e. Conglomerate, Local, International, Private, Public, etc.

Examples:

addcpny n/Walmart p/98765432 e/[email protected] a/John street, block 123, #01-01 s/234525223 o/Retail r/Corporation

addcpny n/Betsy Cakes p/1234567 e/[email protected] a/Bob street, block 232 s/2242023 o/Food r/LocalBusiness t/popular t/local

3.4. Listing all persons : list

Shows a list of all persons in the consumer list.
Format: list

3.5. Listing all companies : listcpny

Shows a list of all companies in the clients list.
Format: listcpny

3.6. Editing a person : edit

Edits an existing person in the consumer list.
Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​

  • Edits the person at the specified INDEX. The index refers to the index number shown in the displayed person list. The index must be a positive integer 1, 2, 3, …​

  • At least one of the optional fields must be provided.

  • Existing values will be updated to the input values.

  • When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.

  • You can remove all the person’s tags by typing t/ without specifying any tags after it.

Examples:

  • edit 1 p/91234567 e/[email protected]
    Edits the phone number and email address of the 1st person to be 91234567 and [email protected] respectively.

  • edit 2 n/Betsy Crower t/
    Edits the name of the 2nd person to be Betsy Crower and clears all existing tags.

3.7. Editing a company : editcpny

Edits an existing company in the client list.
Format: editcpny INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​

  • Edits the company at the specified INDEX. The index refers to the index number shown in the displayed company list. The index must be a positive integer 1, 2, 3, …​

  • At least one of the optional fields must be provided.

  • Existing values will be updated to the input values.

  • When editing tags, the existing tags of the company will be removed i.e adding of tags is not cumulative.

  • You can remove all the company’s tags by typing t/ without specifying any tags after it.

Examples:

  • editcpny 1 p/91234567 e/[email protected]
    Edits the phone number and email address of the 1st company to be 91234567 and [email protected] respectively.

  • editcpny 2 n/Small Money t/
    Edits the name of the 2nd company to be Small Money and clears all existing tags.

3.8. Locating persons by name : find

Finds persons whose names contain any of the given keywords.
Format: find 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

  • Persons matching at least one keyword will be returned (i.e. OR search). e.g. Hans Bo will return Hans Gruber, Bo Yang

Examples:

  • find John
    Returns john and John Doe

  • find Betsy Tim John
    Returns any person having names Betsy, Tim, or John

3.9. Locating companies by name : findcpny

Finds companies whose names contain any of the given keywords.
Format: findcpny KEYWORD [MORE_KEYWORDS]

  • The search is case insensitive. e.g mcdonalds will match McDonalds

  • The order of the keywords does not matter. e.g. McDonalds Bojangles will match Bojangles McDonalds

  • Only the name is searched.

  • Only full words will be matched e.g. McDonald will not match McDonalds

  • Companies matching at least one keyword will be returned (i.e. OR search). e.g. McDonalds Bojangles will return McDonalds, Bojangles

Examples:

  • find Burger
    Returns Burger Spot and Burger King

  • find Burger Taco Shoes
    Returns any person having names Burger, Taco, or Shoes

3.10. Locating persons by occupation : findOccupation

  • The search is case insensitive. e.g teacher will match Teacher

  • Only the occupation is searched.

  • Only full words will be matched e.g. Tea will not match Teacher

  • Persons matching the occupation will be returned

Examples:

  • findOccupation teacher
    Returns Bob and Alice (Their occupation is teacher)

3.11. Locating companies by sector : findSector

  • The search is case insensitive. e.g bank will match Bank

  • Only the sector is searched.

  • Only full words will be matched e.g. Ban will not match Bank

  • Companies matching the sector will be returned

Examples:

  • findCompany bank
    Returns OCCC (Its sector is bank)

3.12. Deleting a person : delete

Deletes the specified person from the address book.
Format: delete INDEX

  • Deletes the person at the specified INDEX.

  • The index refers to the index number shown in the displayed person list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • list
    delete 2
    Deletes the 2nd person in the address book.

  • find Betsy
    delete 1
    Deletes the 1st person in the results of the find command.

3.13. Deleting a company : deletecpny

Deletes the specified Company from the address book.
Format: deletecpny INDEX

  • Deletes the company at the specified INDEX.

  • The index refers to the index number shown in the displayed company list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • list
    delete 2
    Deletes the 2nd company in the address book.

  • find Burger
    delete 1
    Deletes the 1st company in the results of the find command.

3.14. Selecting a person : select

Selects the person identified by the index number used in the displayed person list.
Format: select INDEX

  • Selects the person and loads a Google Maps address of the person at the specified INDEX.

  • The index refers to the index number shown in the displayed person list.

  • The index must be a positive integer 1, 2, 3, …​

Examples:

  • list
    select 2
    Selects the 2nd person in the consumer list.

  • find Betsy
    select 1
    Selects the 1st person in the results of the find command.

3.15. Listing entered commands : history

Lists all the commands that you have entered in reverse chronological order.
Format: history

ℹ️

Pressing the ↑ and ↓ arrows will display the previous and next input respectively in the command box.

3.16. Undoing previous command : undo

Restores the address book to the state before the previous undoable command was executed.
Format: undo

ℹ️

Undoable commands: those commands that modify the address book’s content (add, delete, edit and clear).

Examples:

  • delete 1
    list
    undo (reverses the delete 1 command)

  • select 1
    list
    undo
    The undo command fails as there are no undoable commands executed previously.

  • delete 1
    clear
    undo (reverses the clear command)
    undo (reverses the delete 1 command)

3.17. Redoing the previously undone command : redo

Reverses the most recent undo command.
Format: redo

Examples:

  • delete 1
    undo (reverses the delete 1 command)
    redo (reapplies the delete 1 command)

  • delete 1
    redo
    The redo command fails as there are no undo commands executed previously.

  • delete 1
    clear
    undo (reverses the clear command)
    undo (reverses the delete 1 command)
    redo (reapplies the delete 1 command)
    redo (reapplies the clear command)

3.18. Clearing all entries : clear

Clears all entries from the address book.
Format: clear

3.19. Exiting the program : exit

Exits the program.
Format: exit

3.20. Sorting persons by name/salary/occupation/residential area/group : sortper

Lists all people that meet the specified filter requirement(in sequence/reverse order).

Format: sortper name/salary/phone/email/occupation/address/relationship seq/rev

Examples:

sortper salary seq (list all persons by salary in sequence order)

sortper phone rev (list all persons by their phone number in reverse order)

3.21. Sorting companies by name/revenue/occupation/residential area/group : sortcpny

Lists all companies that meet the specified filter requirement(in sequence/reverse order).

Format: sortper name/revenue/phone/email/occupation/address/relationship seq/rev

Examples:

sortcpny revenue seq (list all companies by revenue in sequence order)

sortcpny phone rev (list all companies by their phone number in reverse order)

3.22. Find clients: findCli [coming in v2.0]

Lists all persons deemed capable of affording a specific product based on salary

Format: findCli PRICE

Examples:

findCli 100

findCli 20

3.23. Find shops: findShops [coming in v2.0]

Lists all stores a person is deemed capable of visiting based on salary and store pricing

Format: findShops [n/NAME] [s/SALARY]

Examples:

findShops n/steve smith

findShops s/25000

3.24. Add to favorite list: favorite

Adds a person to the “favorite” list

  • The full name must be specifid

  • If the full name isn’t specified it displays a list of potential persons

  • The person must exist as a client and can only be favorited once

Format: favorite n/NAME

Examples:

  • favorite John Doe

  • favorite John (recommends all John’s in the addressbook, adds none)

multipleJohns

3.25. Delete person from favorite list: delFav

Removes a person to the “favorite” list

  • The full name must be specifid

  • The person must exist as a favorite

Format: delFav n/NAME

Examples:

  • delFav John Doe

  • favorite John Doe
    delFav John Doe

3.26. List the favorite list: listFav

Lists all persons in the “favorite” list under the clients panel in alphabetical order

Format: listFav

Example:

  • favorite John Doe
    favorite Alex Yeoh
    favorite Roy Balakrishnan
    favorite David Li
    listFav

listFav

3.27. Create group: group [coming in v2.0]

Creates a group of persons

Format: group GROUPNAME [[n/NAME] [a/ADDRESS]]…​

Examples:

group g1 n/bob a/123 streets n/steve a/456 main n/smith a/111 abc st

group winners n/jacob a/1 queen st n/adam a/10 north st

3.28. Export data as CSV: export

Exports the data to a CSV file

Format: export [FILEPATH] [FILENAME]

Examples:

export /Users/fandongzhe/Desktop/fg market (type in the whole filepath)

3.29. Show average salary for all persons: averageSalary

Shows average salary for all persons in the address book

Format: averageSalary

3.30. Show median salary for all persons: medianSalary

Shows median salary for all persons in the address book

Format: medianSalary

3.31. Show maximum salary for all clients: findmax

Show maximum salary for all clients in the address book

Format: findmax

3.32. Show minimum salary for all clients: findmin

Show minimum salary for all clients in the address book

Format: findmin

3.33. Show average revenue for all companies: averageRevenue

Shows average revenue for all companies in the address book

Format: averageRevenue

3.34. Show median revenue for all revenue: medianRevenue

Shows median revenue for all companies in the address book

Format: medianRevenue

3.35. Saving the data

Address book data are saved in the hard disk automatically after any command that changes the data.
There is no need to save manually.

3.36. Encrypting data files [coming in v2.0]

{explain how the user can enable/disable data encryption}

4. FAQ

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.

5. Command Summary

  • Add add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS s/SALARY o/OCCUPATION r/RELATIONSHIP [t/TAG]…​
    e.g. add n/James Ho p/22224444 e/[email protected] a/123, Clementi Rd, 1234665 s/100 o/baker r/single t/friend t/colleague

  • Add Company addcpny n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS s/REVENUE o/SECTOR r/STRUCTURE [t/TAG]…​
    e.g. addcpny n/McDonalds p/22342422 e/[email protected] a/23244 Super Tasty Rd s/303030303030 o/Food r/InternationalCorp

  • Clear Persons : clear

  • Clear Companies : clearcpny

  • Delete Person : delete INDEX
    e.g. delete 3

  • Delete Company : deletecpny INDEX
    e.g. delete 2

  • Edit Person : edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​
    e.g. edit 2 n/James Lee e/[email protected]

  • Edit Company : editcpny INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]…​
    e.g. editcpny 1 n/Burger King

  • Find Person : find KEYWORD [MORE_KEYWORDS]
    e.g. find James Jake

  • Find Company findcpny KEYWORD [MORE_KEYWORDS]
    e.g. findcpny McDonalds

  • Find Occupation findOccupation KEYWORD
    e.g. findOccupation professor

  • Find Sector findSector KEYWORD
    e.g. findSector bank

  • List Persons : list

  • List Companies : listcpny

  • Sort Persons : sortper

  • Sort Companies : sortcpny

  • Help : help

  • Select : select INDEX
    e.g.select 2

  • Add Favorite : favorite

  • Show Average Salary : averageSalary

  • Show Median Salary : medianSalary

  • Show Average Revenue : averageRevenue

  • Show Median Revenue : medianRevenue

  • Delete Favorite : delFav

  • List Favorite : listFav

  • History : history

  • Undo : undo

  • Redo : redo

  • group : group GROUPNAME [[n/NAME] [a/ADDRESS]]…​

  • export : export [CLIENTS] [CONSUMERS] [ALL]