Mapping a new MLS board

- Before adding a RETS board

- Adding a RETS board

- Map the board in rope

- Create Yamls

- Create board MCP

- Test 

- Email Client

Before adding a RETS board:

RETS MD to check credentials: http://retsmd.realgeeks.com/ and log out.

From the ticket > get credentials and enter them into rets md

  • If credentials work and you can see > proceed to add rets board in rope. 
  • If login error, you will need to email the board regarding failing credentials find out why and the whole mapping process is stalled until we can progress from this step.
  • Make sure there are no spaces at end/start of credentials

  • If you run into any errors during this process, you can view the errors in our logs for rope in papertrail here:

    https://papertrailapp.com/systems/rope/events

  • We have a checklist to help with the process of mapping the MLS board. 

Adding a RETS Board:

Step 1:

Go to rope > Add rets board top right

Don't leave any spaces when pasting the information in!!!

Board name: use board's acronym _ state so ex. GFAR_MT

Board id: next available board number ex. 346

Hostname: same as login to RETS MD

Username: same as login to RETS MD

Password: same as login to RETS MD

User agent: same as login to RETS MD

User agent: if this isn't used in RETS MD, you dont need to fill it in

Use proxy: some boards require use ip address: check box if this is necessary

Validate ssl certs: always checked

Rets version: always try 1.7.2 - in rare cases, it will be 1.5

If you see a 500 error screen, make sure you don't have any spaces before or after the credentials.  

Step 2:

Pretty straight forward: 

Step) You can skip commercial and rentals. Only highlight Res, mul and land.

Step 4:

Look in RETS MD and make sure the 

Uid field: unique identifier. If there is a heart and a key icons in LIST_1, use that LIST_1

matching the uid to key field in rets md, and status to field list# commonly

Mls number field: 

Timestamp field: 

time stamp was listing modification time.

Status field: 

Step 5:

Copy the timestamp and page it in the "Full query". If internal server error, you need to adjust the full query. Star, heart fields, construct a query based off the required fields. 

use a pipe thing when replacing star thing with status value. Example:

(LIST_15=|GMW0IKAC7F2)|(LIST_15=|GNSMGTHFW4I)|(LIST_15=|GMW0IKAJW1R)

Sometimes you need to try the unique identifyer query (LIST_1) if an error displays. If that doesn't work, try the other heart symbol fields. (field id = 0+)

If all else fails, email the MLS board and ask for an example query to pull all listings. Include 

Check other board for examples to see how they got their query. 

 

Step 6:

It will auto generate the Delta query. YOU DONT NEED TO DO ANYTHING! LUCKY U!

For the timestamp field: Sometimes you have to insert time and status.  Commonly just click save and done

(loading should take about 20 sec)

 

Now it's time to map the board in rope!!

Mapping a board in Rope:

The bulk of the work is done in this step.

Refer to the Initial Field Mapping.

Fill in the "Image Path" field. This can be found within the Property table's Object Types in RETS-MD. Use the high quality image path if available.

In RETS-MD --> Object Types, you would look for "Listing Photo".

The "Full query" is filled out automatically when you create the board in rope. You would need to create a full query to create the board in rope, then it will be autofilled in. 

Fill in the Image Delta Query based on the image timestamp. It is similar to the Delta Query field.

LEAVE THE DEBUG QUERY BLANK!

Depending on your preference, either remove all of the fields at once and then fill back in the ones that are required/optional or while you are removing all, watch out for the ones that are required/optional and keep those ones/change the field name to the ones shown on here.

Recommended for beginners: remove all fields and then carefully add back in the fields that are required/optional. 

When mapping property types, you check in RETS-MD and it only shows "Listing", you click on it and search for propertytype. Look to the right of it and click "Values". You would use the long value in your code.

Every new board is going to be placed on database m10e-2 -- unless it is going to be combined with another board that is on m10d-2

Mapping terms you can choose from the drop-down and what they mean:

(--------): This is the default setting. It means strings. It is mainly used for mapping agent/office id and zip code (and other fields that we don't add to the advanced search).

to_geolocation: used for longitude/latitude

to_title: For Capitalization = used for location fields/ example = county, city, etc

to_float: used for decimal points/ example = acres

to_list: multiselect dropdowns

to_int: list price, sold price, beds, baths --> no decimals

to_upper: for statuses --> makes things uppercase

to_date: closing date, list date

to_bool: foreclosure, shortsale and YN fields

error_on_n: if agent doesn't want a property to be shown 

(Reminder:  If you are going to create a field, make it all lowercase with an _ in between the words: 

IF the board has already been mapped, then save and run a refresh properties:

 example:

./background.sh ./runner.py refresh_known_properties --skip-images 21

When it is done in papertrail, you can then add the new field(s) to both the forms and fields yamls.)

Map in property path 1 at a time

3 Core Property Type Mappings: Residential, Multifamily, and Land.

Residential property path commonly also includes condos, manufactured, and mobile listings.

When looking through the fields, try to find foreclosures and short sales. These may need custom mapping.

Make notes of things that seem irregular. Remove rubbish fields, name relevant fields.  Save the fields.

Here is an example type that is mapped out: 

You can find the how the mls board sends us what to add such as tt_res by looking in RETS-MD.

When done, create prop, fields, and form YAMLs for board.

Useful link for pulling prop fields: http://rope.realgeeks.com/dump_prop_fields/'Insert Board ID Here'

 


Correct any errors, then merge and deploy branch when ready.

 

When you have completed filling out the board in rope, run a full_prop. 

EX.

./foreground.sh ./runner.py full_prop 344

If there are any errors, you can stop the full prop by pressing control+c. If there are any errors, fix the error in rope and run it again. 

To double check why the listing is erroring out, debug the listing and check the property type. Maybe it's a rental. 

 Now you can run a full photo: 

EX. 

./foreground.sh ./runner.py full_photo 344

After 

Create YAMLs

Create a Form, Fields and Prop Fields yaml file based on the template files.

forms = search_forms/forms/template.yaml

fields = search_forms/forms/fields/template.yaml

prop_fields = prop_fields/tempate.txt (be sure to save the prop_field file for this board as a yaml file)

 

Create MCP board

In order for a website to use the data from the database for this board, the board must be added to MCP Boards.

When setting up the MCP board, you must set the following fields:

  • Board Name
  • Boards
  • Search Fields
  • Search Forms
  • Prop Fields Yml
  • Search Status Map
  • Alert Status Map
  • Don't worry about adding a IDX url. It is updated automatically.  

Test on site

Since this is a new MLS board, we can add the data to the clients site and see if there is any additional work to be done. If this were a remapped site where the client is already live, we would get the new remapped version on our development site first.

Things to check:

  • Correct title-casing on all fields, especially geographic and street name fields. Correct this in rope.
  • Look for poor quality field, for instance a subdivision field that is a type-in field and has all sorts of terrible misspellings.  Elect to not use this field on the site and in the default YAMLs for the board.
  • Images must be complete and high-quality. There is ofter multiple image feeds and by default we map a low-quality one.  Go back to rope, use RETS-MD and find the HQ image feed to use.
  • Street names must be complete, look for missing suffixes (Dr., Ave., St., etc).
  • Office and agent data must be mapped, names and IDs
  • Check that all advanced search fields are functioning and make sense, i.e., there are fewer home built since 2013 as there were built since 2008
  • Make sure foreclosures and short sales are mapped.

If the map search isn't responsive, it needs to be geocoded.

- If the board doesn't give you longitude or latitude, then  you'll need to add the geo_addr custom field which you can find here.

Email client(s)

Email the client with the following as the subject:

Real Geeks Website - <INPUT REAL GEEKS DEV SITE URL>

 

the following as the body:

 

Let us know if there are specific fields that people searching for properties in your area might want to use.  We will then search through your data feed and see if that info is available.

  Let us know if you want your homepage or advanced search form defaulted to anything as well.  If you want to limit the areas available on your search, send over a list and we will do our best to accommodate you.  

You may contact Real Geeks support through our web form at  , by emailing support@realgeeks.com or by phone at 844.311.4969 during business hours, Hawaii time.

  Just a quick note, your images may not be showing up right away but they will load eventually.  We look forward to hearing back from you.   Thank you, Real Geeks

Back to top.