RETS Naming Conventions
The “RETS Field Mapping” document referenced in this document is available at www.ntreis.net under “Technical Support / NTREIS RETS”.
The RETS Metadata is based on the SQL Tables that underlie the Tempo MLS Database and the names used in RETS can be tied back to the fields in the Tempo SQL Tables.
A field in RETS has 5 different names. See the “RETS Field Mapping” document for examples of the names:
|
LongName |
This is the most user friendly name. |
|
ShortName |
These names can be somewhat cryptic. |
|
StandardName |
Many fields lack a standard name. |
|
SystemName |
These names very closely tie into the actual schema name on the MLS Tables. |
|
DBName |
Even more cryptic than the ShortName. |
It is your choice as to the name you choose to use in RETS, but you will find the long name in most cases is the easiest to work with, especially with the MarketLinx RETS Connector client.
Many fields in the NTREIS RETS implementation do not have a StandardName.
Depending on your application, the SystemName may be best for you to use. However, some of the System Names are not clear as to their meaning or how they are used. To assist with this, NTREIS is providing a list of fields showing on the “IDXData” and “nonIDX” worksheets on the “RETS Field Mapping” document which contains this information:
|
Metadata_Class |
RETS Metadata Class |
|
SystemName |
These names very closely tie into the actual schema name on the MLS Tables. |
|
StandardName |
Many fields lack a standard name. |
|
LongName |
This is the most user friendly name. |
|
DBName |
Even more cryptic than the ShortName. The DBName is based internal processes used by the MLS Vendor and should not be used in any capacity. The MLS Vendor recommends using the SystemName as it is the only reliable name to use for tracking system changes. It is unique and does not ever change |
|
ShortName |
These names can be somewhat cryptic. |
|
TempoTable |
The Tempo Table that contains this field. |
|
Tempo Schema Name |
The name of the field in the Tempo Table. |
|
InputLabel |
The label for this field on the Input Screen when adding a listing |
|
FieldType |
This does not exist in either the RETS Metadata or the TEMPO MLS Tables. It was provided by NTREIS to help our RETS users identify the type of field. See the “Field Type” discussion below. |
|
Definition |
This is the informal definition/description of the field. |
|
Comments |
Used as necessary to clarify information about the field. |
If you are new to the NTREIS MLS System, you may find it useful to look at the Listing Input Sheets to see the fields and the data that can be entered. You can find the Listing Input Sheets at http://www.ntreis.net/resources/forms.asp under “Forms Available for Download”. This is a very easy way to view the different values that can be entered in into certain fields.
Updated: 3/26/2009