The package supports downloading of RETS information to a number of different
formats. The configuration file for each type of target is located in a plain
text format and can be found at
{INSTALLATION_DIRECTORY}
/
{TARGETS_DIRECTORY}
/{TARGET_NAME}. The TARGET_NAME is selected when a
Target is
defined
. It is a good idea to keep a backup of Target configurations in
this directory.
The formats that this package supports are:
- Open-Realty 2.0
- The popular Open Source website.
- RDB
- A "flat" table layout of data for a number of vendors.
- XML
- A structured document.
- CSV
- Comma-seperated Value structured document.
Although the format associated with each target type is different, the
following fields are common across the formats:
- TYPE - Defines the type of Target this configuration
represents. Legal values are OR, RDB, XML or CSV.
- DESCRIPTION - A text description of the Target.
|
Open-Realty 2.0
Open-Realty Version 2.0 is supported by a Relational Database approach that
contains separate index, image and elements tables. The index table has one
row for each listing. The images table is similar in design to the index table.
The elements table has one row that describes each field. The columns are
mapped from the
SUMMARY_ITEM
parameter for the Source when you create an Extract.
- OPEN_REALTY_INSTALL_PATH - The path to the installation of the
Open-Realty package. This must be a fully defined path.
Defaults to "/work/projects/open-realty201".
- USERID_FIELD - The field within the USER_TABLE that contains the
user ids defined in the installation. Defaults to "userdb_id".
- USERID_NAME - The field within the USER_TABLE that contains the
user names defined in the installation. Defaults to "userdb_user_name".
- METADATA_FIELD - The field within the METADATA_TABLE that contains
the fields defined in the installation. Defaults to
"listingsformelements_field_name".
- METADATA_TYPE - The field within the METADATA_TABLE that contains
the data types of the fields defined in the installation. Defaults to
"listingsformelements_field_type".
- METADATA_REQUIRED - The field within the METADATA_TABLE that
denoted whether a field is required or not. Defaults to
"listingsformelements_required".
- DATA_FIELD - The field within the DATA_TABLE that contains
the name of fields with data. Defaults to
"listingsdbelements_field_name".
- DATA_VALUE - The field within the DATA_TABLE that contains
the data values of the fields defined in the installation. Defaults to
"listingsebelements_field_value".
- BRAND - The type of database. Legal values are mysql and postgres7.
This value is read directly from the Open-Realty configuration.
- SERVER - The URL for Open-Realty. This value is read directly from
the Open-Realty configuration.
- ACCOUNT - The DB user for Open-Realty. This value is read directly
from the Open-Realty configuration.
- PASSWORD - The DB password for Open-Realty. This value is read
directly from the Open-Realty configuration.
- DATABASE - The DB database for Open-Realty. This value is read
directly from the Open-Realty configuration.
- USER_TABLE - The DB user table for Open-Realty. This value is read
directly from the Open-Realty configuration.
- CLASS_LISTING_TABLE - The name of the DB table used by Open-Realty
2.1 to control which listings are assigned to classes of property. This value
is read directly from the Open-Realty configuration.
- CLASS_TABLE - The name of the DB table used by Open-Realty 2.1 that
contains class information. This value is read directly from the Open-Realty
configuration.
- METADATA_TABLE - The DB metadata table for Open-Realty. This value
is read directly from the Open-Realty configuration.
- COLUMN_LIST - A list of columns that are defined. This value
is read directly from the Open-Realty configuration.
- TYPE_LIST - A list of data types in the same order as COLUMN_LIST.
This value is read directly from the Open-Realty configuration.
- REQUIRED_LIST - A list of fields from COLUMN_LIST that are required.
This value is read directly from the Open-Realty configuration.
- INDEX_TABLE - The DB index table for Open-Realty. This value
is read directly from the Open-Realty configuration.
- DATA_TABLE - The DB data table for Open-Realty. This value
is read directly from the Open-Realty configuration.
- CACHE_PATH - The fully-qualified path to use for ADODB caching.
This value is read directly from the Open-Realty configuration.
- DAYS_UNTIL_EXPIRATION - The number of days a downloaded listing
will remain active in the system
This value is read directly from the Open-Realty configuration.
- IMAGE_TABLE - The DB image table for Open-Realty. This value
is read directly from the Open-Realty configuration.
- IMAGE_UPLOAD_PATH - The fully-qualified path to use to store
downloaded images and thumbnails.
This value is read directly from the Open-Realty configuration.
- THUMBNAILS - A boolean denoting whether to creatre thumbnails for
downloaded images.
This value is read directly from the Open-Realty configuration.
- THUMBNAIL_PROGRAM - The program to use to create thumbnails.
This value is read directly from the Open-Realty configuration.
- GD_VERSION_2 - If gd is used to produce thumbnails, a boolean
that denotes the use of gc version 1 or gd version 2. This value is read
directly from the Open-Realty configuration.
- PATH_TO_IMAGEMAGICK - The path to the ImageMagick program.
This value is read directly from the Open-Realty configuration.
- THUMBNAIL_WIDTH - The width of thumbnails to produce for
downloaded images. Height is calculated automatically This value is read
directly from the Open-Realty configuration.
- THUMBNAIL_QUALITY - The quality of thumbnails to produce for
downloaded images. This value is read directly from the Open-Realty
configuration.
- LISTING_DESCRIPTION_TEMPLATE - A template of used to to create
page titles in Open-Realty. Plain text is interpreted literally and file
names should be enclosed with curly braces like so "{listingID}".
|
|
RDB
This section contains settings that are used to create downloads into
tables in a database. There are separate data and image tables. The data
table has one row for each listing and the image table has one row for
each image. The columns are mapped from the
SUMMARY_ITEM
parameter for the Source when you create an Extract.
- BRAND - The type of database. Legal values are mysql, oracle,
mssql, access and postgres.
- SERVER - The URL for the database.
- ACCOUNT - The user account for the database.
- PASSWORD - The user account password for the database.
- DATABASE - The database.
- DATA_TABLE - The database table to fill with text information.
- INCLUDE_IMAGES - A boolean that indicates whether or not to
download images. If set to "false", other image information for this
Target (IMAGE_TABLE, IMAGE_TABLE_KEY, IMAGE_DOWNLOAD_PATH and
IMAGE_COLUMN_LIST) will be ignored. Defaults to "true".
- IMAGE_TABLE - The database table to fill with image information.
Only the following fields can be mapped into the columns of this table when
you define an Extract:
- ID - the
UNIQUE_KEY
.
- INDEX - the position of the image starting with 0.
- URL - the web address of the image (if it is available).
If the Source has the
MEDIA_LOCATION
parameter set to "false", images are downloaded directly from the RETS server
and this value will be "DIRECT".
- PATH - the full path on disk to the downloaded image.
The INCLUDE_IMAGES parameter must be set to "true" for this setting to have
an effect.
- IMAGE_TABLE_KEY - The column of the IMAGE_TABLE to use for the
unique key. Used to identify the
UNIQUE_KEY
if the listing.
The INCLUDE_IMAGES parameter must be set to "true" for this setting to have
an effect.
- IMAGE_DOWNLOAD_PATH - The fully-qualified path to use to store
downloaded images and thumbnails.
The INCLUDE_IMAGES parameter must be set to "true" for this setting to have
an effect.
- AUTO_CREATE - A boolean representing whether to create a table if it
does not already exist. Defaults to "false".
- COLUMN_LIST - A list of columns in the DATA_TABLE that are eligible
to be filled.
- IMAGE_COLUMN_LIST - A list of columns in the IMAGE_TABLE that are
eligible to be filled.
The INCLUDE_IMAGES parameter must be set to "true" for this setting to have
an effect.
|
|
XML
This section contains settings that are used to create downloads into a
single XML-formatted file with a user defined container element. The tag
names of sub-elements are the fields specified in the
SUMMARY_ITEM
parameter for the Source and are choosen when you create an
Extract.
- CONTAINER_NAME - The name of the XML container to use.
- FILE_NAME - The name of the file to create with the downloaded
data.
- DATA_DOWNLOAD_PATH - The fully-qualified path to use to store
downloaded data. The locatin of FILE_NAME
- INCLUDE_IMAGES - A boolean that indicates whether or not to
download images. If set to "false", other image information for this
Target (IMAGE_DOWNLOAD_PATH) will be ignored.
Defaults to "true".
- IMAGE_DOWNLOAD_PATH - The fully-qualified path to use to store
downloaded images and thumbnails.
The INCLUDE_IMAGES parameter must be set to "true" for this setting to have
an effect.
|
|
CSV
This section contains settings that are used to create downloads into a single
comma-separated file. The column names are the fields specified in the
SUMMARY_ITEM
parameter for the Source and are choosen when you create an
Extract.
- FILE_NAME - The name of the file to create with the downloaded
data.
- DATA_DOWNLOAD_PATH - The fully-qualified path to use to store
downloaded data. The location of FILE_NAME
- INCLUDE_IMAGES - A boolean that indicates whether or not to
download images. If set to "false", other image information for this
Target (IMAGE_DOWNLOAD_PATH and IMAGE_FILE_NAME) will be ignored.
Defaults to "true".
- IMAGE_DOWNLOAD_PATH - The fully-qualified path to use to store
downloaded images and thumbnails.
The INCLUDE_IMAGES parameter must be set to "true" for this setting to have
an effect.
- IMAGE_FILE_NAME - The name of the file to create with the downloaded
image information.
The INCLUDE_IMAGES parameter must be set to "true" for this setting to have
an effect.
|
|
|
|
