Installation is separated into three separate sections--Pre-Installation, Installation and Post-Installation. Each section contains two sub-sections that cover how to go about installing the software for Linux and Windows.
Pre-installation procedures involve verifying system requirements, downloading the application from the ORC web site, and uncompressing the downloaded file for your particular platform.
Pre-install procedures Verify system requirements
Check that your system has a minimum of 32 megabytes RAM (required). 48
megabytes of RAM is recommended, and 16-bit color mode with KDE or the Gnome
desktop, in conjunction with displays set to local hosts
Linux kernel v 2.2.12 and glibc v 2.1.2-11 or later.
Java 2 Runtime Environment (Java RE) or Java 2 Software Development Kit (Java SDK),
version 1.4.0 or later. It is recommended that you use version 1.4.0 for any ORC
0.7.x version. This will ensure that pictures obtained via the GetObject
Transaction are not corrupted. You can find Java version 1.4.0 at the following
location.
Download ORC for Linux from the project page. File name should be something like orc-x.x.x.tar.gz, where
"x" represents the major, minor and patch level numbers.
Move downloaded file, orc-x.x.x.tar.gz to some kind of temporary directory -- the
/tmp directory is usually a good choice.
Gunzip and untar the tarball file: tar -xzvf orc-x.x.x.tar.gz
Pre-install procedures Verify system requirements
Check that your system has a minimum of 32 megabytes RAM (required). 48 megabytes
of RAM is recommended for applets running within a browser using the Java
Plug-in product. Running with less memory may cause disk swapping which has a
severe effect on performance. Very large programs may require more RAM for
adequate performance.
Microsoft Windows 95, 98 (1st or 2nd edition), NT 4.0 with Service Pack 5, ME, XP,
2000 Professional, 2000 Server, or 2000 Advanced Server operating systems
running on Intel hardware. In non-English locales, the only edition of Microsoft
Windows 2000 tested with this release is the Professional edition.
A Pentium 166MHz or faster processor
Java 2 Runtime Environment (Java RE) or Java 2 Software Development Kit (Java SDK),
version 1.4.0 or later. It is recommended that you use version 1.4.0 for any ORC
0.7.x version. This will ensure that pictures obtained via the GetObject
Transaction are not corrupted. You can find Java version 1.4.0 at the following
location.
If you have previously installed another version of the Java 2 Runtime Environment
or Java 2 SDK, uninstall it. Use the Microsoft Windows Add/Remove Programs utility,
accessible from the Control Panel (Start --> Settings --> Control Panel).
Download ORC for Windows from the project page. File name should be something like orc-x.x.x.zip, where
"x" represents the major, minor and patch level numbers.
Move downloaded file, orc-x.x.x.zip to some kind of temporary directory.
Unzip the file. I use WinZip, but you can
use just about any application capable of uncompressing the file.
This section involves executing the appropriate installation program for your particular platform.
This section covers the directory structure that results after a successful installation.
After a successful installation, you should end up with the following directories:
/usr
|
/local
|
/orc-x.x.x
|
|
+-----------+-----------------+
| | | | | |
bin doc mlsdb src lib orcdata
|
logs
|
After a successful installation, you should end up with the following directories:
C:
|
\Program Files
|
\orc-x.x.x
|
|
+-----------+-----------------+
| | | | | |
bin doc mlsdb src lib orcdata
|
logs
|
In the following discussion, the /usr/local/orc-x.x.x directory will be referred to as the "Linux installation directory" and the C:\Program Files\orc-x.x.x directory will be referred to as the "Windows installation directory". Note, that the 'x.x.x' found in the installation directory refers to the version number. If the ORC is upgraded, a new installation directory will be created, reflecting the new version. Under Linux, during an upgrade installation, the older properties file and MLS records file will be copied in to the appropriate sub-directories (more on the sub-directories in a moment), of the new Linux installation directory. The older Linux installation directory should get renamed to something like old-orc-x.x.x. However, under Windows, during an upgrade installation, the older properties file and MLS records file will remain in the previous versions Windows installation directory. WINDOWS ONLY: In order to access a prior resource configuration file after an upgrade, manually copy the file from the previous versions Windows installation /mlsdb to the latest Windows installation /mlsdb directory.
The contents and purpose of each sub-directory is defined below.
ORC Directories: Names and Descriptions
This directory contains a shell script, orc.sh (orc.bat for Windows), designed to assist the end-user in running the ORC application. Although it is not mandatory to use this script, it is recommended. Any other binary or related scripts that support the ORC application should be stored here.
This directory cotains a jar'red file whose contents describe the ORC API, as well as the original design specifications, this HOWTO document and a FAQs document. To get at the documentation, simply change into the doc directory, and execute jar -xvf orc-doc-x.x.x.jar from a command-line. Place any other related documentation here.
This directory contains the Multiple Listing Service(MLS) resource configuration (or 'database') file. The structure of this file closely resembles a Windows .ini file. Each record contains name/value pairs describing specific aspects of the MLS. Aspects such as the login URL, username and password required to login, and the Resource types to name but a few. Store any other personalized MLS records configuration files here.
This directory contains a jar'red file whose contents contain the entire set of java source code for the ORC application. To get at the source code, simply change into the src directory, and execute jar -xvf orc-src-x.x.x.jar from a command-line. Place any other related source code (like, if you plan on extending the application with your own code) here.
This directory contains three jar'red files.
Contents contain the compiled code for the ORC application. This is actually the package containing all the ORC class files.
Contents contain the Apache Jakarta Regular Expression API.
Contents contain the implementation of the Getopt Class, among other utilities. The Getopt Class is a port of the GNU getopt functions, and allows for command-line options, such as -h (to request help), for example.
This directory contains (or, will contain) sub-directories that keep the latest data collected from a RETS compatible server. The names of these sub-directories (with one exception), are known as the MLS Identifier(MLSID). The one exception is the logs sub-directory.
This directory contains a log file for each MLS that has been run through the ORC application. The log files are appended to, so that one can have a running history of each download.