Open RETS Client, ORC HOWTO (DEPRACATED VERSION)

IMPORTANT: This version of the HOWTO pertains to ORC, version 0.7.x, which is no longer supported

Robert Stagner

Software Developer/Analyst
Application Development

restagner@ispwest.com

Revision History
Revision 1.4.02004-10-19Revised by: res
Updated title page, Section 1.2 and Section 1.6 to reflect new e-mail address.
Revision 1.3.02003-08-11Revised by: res
Updated Section 5.4 to reflect the new nomenclature used for the resource related command-line options. The -a, -o, and -p options have been deprecated, and replaced with -A, -O and -P, respectively. An additional option, -T, has been added to handle Tax resources. Updated Section 2.3 to indicate support for the GetMetadata Transaction.
Revision 1.2.02003-06-14Revised by: res
Added a subsection to Section 5 (Running the Open RETS Client), describing how to use the -m option in order to capture Multimedia Objects from the RETS Server. Also, updated Section 2.3 (Open RETS Client) to reflect support of the GetObject Transaction.
Revision 1.1.02003-04-08Revised by: res
Added color to verbatim text and placed Section 1 on its own page.
Revision 1.0.02003-03-31Revised by: res
Initial release.

Table of Contents
1. Preface
1.1. About the Author
1.2. Copyright Information
1.3. Disclaimer
1.4. New Versions
1.5. Acknowledgments
1.6. Feedback
2. Introduction
2.1. What is RETS?
2.2. What is a RETS Client?
2.3. Open RETS Client
3. Installation
3.1. Pre-Installation
3.1.1. Linux
3.1.2. Windows
3.2. Installation
3.2.1. Linux
3.2.2. Windows
3.3. Post-Installation
3.3.1. Linux Directory Structure
3.3.2. Windows Directory Structure
3.3.3. Description of directories (Linux & Windows)
4. Configuration
4.1. Resource Configuration File
4.2. Editing / Updating a Record
4.2.1. Adding a New Resource
4.2.2. Altering Search Transaction Parameters
4.2.2.1. Count Parameter
4.2.2.2. Select Parameter
4.2.2.3. StandardNames Parameter
4.2.2.4. Limit Parameter
4.2.2.5. Format Parameter
4.2.2.6. RestrictedIndicator Paramter
4.2.2.7. Offset Parameter
4.3. Adding a New Record
4.3.1. Automatic Record Creation
4.3.2. Manual Record Creation
5. Running the Open RETS Client
5.1. Getting Help
5.2. Running ORC Without an MLSID
5.3. Running ORC With an MLSID
5.4. Retrieving Specific Resource Data
5.5. Retrieving Specific Resource Data With a Command-line Query
5.6. Retrieving Media Data
A. Resource Configuration File Parameters
References