Supplemental Application Information: DD on RETS 1.x
 Share
The version of the browser you are using is no longer supported. Please upgrade to a supported browser.Dismiss

 
View only
 
 
Still loading...
ABCDEFG
1
Data Dictionary 1.3 / 1.4
2
Supplemental Application Information - Instructions
3
4
Overview
5
The Supplemental Application Information (SAI) will assist the RESO Compliance Department with the Data Dictionary evaluations. It provides information required by the RESO Compliance department to perform the evaluation tests and ensure compliance. Additional information may be required depending upon the individual nature of the Data Dictionary implementation.
6
NOTE: This SAI is for RETS 1.x implementations of the Data Dictionary only.
Different formats will be required and provided when other data transports are to be certified.
7
8
It is recommended this information is made available to those who will connect with the submitted system.
9
10
Supplemental Application Information (SAI) Instructions
11
The SAI begins as a spreadsheet template, available through Google Sheets. It may be downloaded as a spreadsheet to be filled in offline. Alternately, a copy of the template may be made, filled in, and remain online. (Online copies must be shared with certification@reso.org.) The SAI should be delivered or shared when the Data Dictionary application is submitted.
12
13
The following sections provide instructions for each tab within the SAI spreadsheet.
14
15
Common Column Definitions
16
Some columns have the same definition when defining field information, regardless of where the appear in the SAI. They are compiled here to simplify the documentation.
17
18
ResourceThe resource where the field is found. Examples: Property, Office, Agent, Media, etc. (These may vary per system.)
19
ClassThe class within the resource where the field is found. Examples: Residential, Mobile Home, Commercial, Farm, etc. (These may vary per system.) Please include the class even if there is only one within the resource.
20
SystemNameThe field’s SystemName as listed in the RETS 1.x metadata.
21
StandardNameThe field’s StandardName as listed in the RETS 1.x metadata. This is to match the Data Dictionary StandardName used in the compliance testing.
22
23
Resource Class Mappings (REQUIRED for ALL Application)
24
Certification is based on the full RETS 1.x metadata pulled from a server: DMQL Query: Type=METADATA-SYSTEM&ID=*.
25
Only those resources and classes with a Data Dictionary equivalent will be tested. The applicant must assign which Data Dictionary Resource and Class will be used for testing each resource and class downloaded.
26
The Data Dictionary Resource/Class columns have been filled in with values from the Data Dictioinary. Applicants are to place the corresponding Resouce and Class pairs from their own metadata. Applicants may repeat as many of the provided Resource/Class pairs are needed. FOR EXAMPLE: A "PropertyDeleted" resource would be paired with "Property" for compliance testing of its structure even though it is technically not a "Property" resource.
27
28
Column Details:
29
Metadata ResourceExamples: Property, Office, Agent, Media, etc. (These may vary per system.)
30
Metadata ClassExamples: Residential, Mobile Home, Commercial, Farm, etc. (These may vary per system.) Please include the class even if there is only one within the resource.
31
Test? (Y/N)Should this Resource/Class be tested for Data Dictionary compliance?
32
Data Dictionary ResourceThe Data Dictionary resource used to compare with the Metadata Resource on the same row. Examples: Property, Member, Office, Contacts, Media, HistoryTransactional, SavedSearch, or OpenHouse.
The recommended values have been provided in the template.
33
Data Dictionary ClassThe Data Dictionary class used to compare with the Metadata Class on the same row. Examples: RESI, RLSE, RINC, LAND, MOBI, FARM, COMS, COML, BUSO, etc.
The recommended values have been provided in the template.
34
Data Dictionary Resource/Class DefinitionsThe Data Dictionary Resource/Class definitions copied from the Data Dictionary to provide help in understanding what the abbrevitions may mean. These will assist in matching applicant resources/classses with what is in the Data Dictionary.
35
36
Known Non-Compliant Fields
37
This sheet is to contain a list of Data Dictionary fields that are mapped by the applicant but are not compliant.
38
NOTE: Certification may still be awarded even though non-compliant fields exist or are mapped. Currently, only “Core Fields” must be compliant to receive certification.
39
40
Column Details:(Common Columns)See "Common Column Definitions" section above.
41
Error TypeThe state of non-compliance: Notice, Warning, or Error.
42
Source InfoAny additional information about the source field (MLS) that may be relevant.
43
Dictionary InfoAny additional information about the Data Dictionary that may be relevant.
44
Corrective ActionThe corrective action the applicant plans to take to make the fied compliant in future updates.
45
46
Known Non-Data Dictionary StandardName
47
This sheet is to contain a list of SystemName fields that use a StandardName that are not found in the Data Dictionary.
48
49
Column Details:(Common Columns)See "Common Column Definitions" section above.
50
Field Definition / Usage
The definition of the field being with the non-Data Dictionary name.
51
Misc InfoAny additional information the applicant wishes to provide.
52
53
54
"Duplicate Lookup Values" Tab
55
This sheet is to contain a list of Data Dictionary Enumerations values that appear more than once in the applicant’s metadata.
56
This only applies to those enumerations with the same definition.
57
Similarly-named enumerations with different definitions, based on location context, do not need to be listed.
58
59
Items listed on this tab need to come in pairs or larger sets. Each set may represent lookups of different values but the same definition (“Master Bedroom” v. “Bedroom 1”) or the same value and definition but in different locations (“PropertySubType/Cabin” v. “ArchitecturalStructure/Cabin”).
60
61
Column Details:(Common Columns)See "Common Column Definitions" section above.
62
LookupNameThe lookup name used by the field.
63
Lookup LongValueThe lookup’s LongValue. This is the value that matches the one defined in the Data Dictionary. The ShortValue and Value do not need to be provided as they do not impact certification testing.
64
Matching IDA number to identify which lookup values are matches. All of the rows in the first matching set will have "1", the second set, "2", etc. Separating eac hset with a blank row would also be helpful.
65
Lookup DefinitionsProviding the lookup’s definition is important when the same LongValue is used in multiple locations.
66
DesctiptionA description of why the lookups are included in this tab and any additional information that should be considered during the certification process.
67
68
"External Lookup Validation" Tab
69
A list of Data Dictionary Enumerations that are validated outside the transport method AND their values.
70
Feel free to duplicate this tab as many times as desired if placing each enumaration list on a separate tab is more convenient.
71
72
Column Details:(Common Columns)See "Common Column Definitions" section above.
73
DataTypeThe datatype of the non-enumerated list as defined in the metadata. Examples: Character, Number.
74
Enumeration MethodA description of how the field’s enumerated list is validated. Examples: user interface, external database, etc.
75
Lookup ValueLookup Value: The lookup’s value that is defined outside the metadata.
76
DescriptionAny additional miscellaneous information that should be considered during the certification process.
77
78
March 2015 - DRAFT
Loading...
 
 
 
Instructions
ResourceClassMappings
Known Non-Compliant Fields
Known Non-Data Dictionary StandardName
Duplicate Lookup Values
External Lookup Validation