[mapserver-commits] r8229 - in trunk/docs: howto input/vector

svn at osgeo.org svn at osgeo.org
Tue Dec 9 21:18:26 EST 2008


Author: hobu
Date: 2008-12-09 21:18:26 -0500 (Tue, 09 Dec 2008)
New Revision: 8229

Modified:
   trunk/docs/howto/Configure Oracle and UMN.txt
   trunk/docs/input/vector/oracle_spatial.txt
Log:
convert to ReST

Modified: trunk/docs/howto/Configure Oracle and UMN.txt
===================================================================
--- trunk/docs/howto/Configure Oracle and UMN.txt	2008-12-10 01:41:09 UTC (rev 8228)
+++ trunk/docs/howto/Configure Oracle and UMN.txt	2008-12-10 02:18:26 UTC (rev 8229)
@@ -1,331 +1,258 @@
-<p>
-</p><p align="center"><b>Installation
-of mapsewrver access to oralce (locator/spatial) v10g on an Ubuntu
-Depper Drake box</b></p>
-<p align="center">Till
-Adams</p>
-<p align="center">Bonn,
-02.02.2007</p>
-<p><br />
-</p>
-<p><b>0.)
-Preface</b></p>
-<p>This
-manual was written, because I spent several days googling around to
-get my UMN having access to an oracle database. I'm NOT an oracle
-expert, so the aim of this document is just toput a lot of googled
-knowledge in ONE place. 
-</p>
-<p>Hopefully
-it will preserve  many of people spending analog amount of time than
-I did! (Or: If you have the choice: Try PostGIS ;-))</p>
-<p><br />
-</p>
-<p>Before
-we start, some basic knowledge, i didn't know before:</p>
-<ul><li><p>Mapserver
-	can access oracle spatial as well as geodata from any oracle locator
-	installation! Oracle locator comes with every oracle instance, there
-	is no need for an extra license.</p>
-	</li><li><p>There
-	is no need for further installation of any packages beside
-	oracle/oracle OCI</p>
-</li></ul>
-<p><br />
-</p>
-<p><b>1.)
-System</b></p>
-<p>We
-assume that oracle is already installed, there is a database and
-there is some geodata in the database. The following pathes should be
-known by the reader:</p>
-<p><br />
-</p>
-<p>
-ORACLE_HOME<br />ORACLE_SID</p>
-<p>
-ORACLE_BASE<br />LD_LIBRARY_PATH</p>
-<p><br />
-</p>
-<p>We
-also assume that you have installed <b>apache2</b> (our version was
-2.0.49) and you are used to work with Linux/UNIX systems. We also
-think you are able to handle the editor vi/vim.</p>
-<p>Ensure
-that the oracle-user who later accesses the database has write-access
-to the oracle_home direcotry.</p>
-<p>We
-also assume, that you already have setup the tnsnames.ora file. It
-should look like that:</p>
-<p><br />
-</p>
-<p>
-MY_ORACLE = <br />  (DESCRIPTION
-= <br />    (ADDRESS = (PROTOCOL = TCP)(HOST =
-host)(PORT = 1521)) <br />    (CONNECT_DATA = <br />     
-(SERVICE_NAME = your_name) <br />    ) <br />  ) 
-</p>
-<p><br />
-</p>
-<p>It
-is important that you know the NAME of the datasource, in this
-example this is “MY_ORACLE“ and will be used further on. Done
-that, you're fine using
-<b>“</b><a href="mailto:User/Password at MY"><b>User/Password at MY</b></a><b>_ORACLE“</b>
-in your mapfile to connect to the oracle database. But first
-we have to do some more stuff.</p>
-<p><br />
-</p>
-<p><br />
-</p>
-<p><b>2.)
-Compile mapserver</b></p>
-<p>Compile
-as normal compilation and set this flag</p>
-<p>
-#
---with-oraclespatial=/path/to/oracle/home/</p>
-<p>If
-mapserver configure and make runs wel, try</p>
-<p>
-# ./mapserv -v</p>
-<p>This
-should at least give this output:</p>
-<p>
-INPUT=ORACLESPATIAL</p>
-<p>If
-you got that, you're fine from the mapserver point of view. 
-</p>
-<p><br />
-</p>
-<p><br />
-</p>
-<p><b>3.)
-Set Environment Variables</b><br />It is important to set all
-environment variables correctly. There are one the one hand
-system-wide environment variables to be set, on the other hand there
-should be set some for the cgi-directory in your Apache
-configuration.</p>
-<p><br />
-</p>
-<p><b>3a)
--&gt;System Variables:</b></p>
-<p>On
-Ubuntu (and on many other systems) there is the file “/etc/profile“
-which sets environment variables for all users on the system (you may
-also dedicate user-specific environment variables by editing the
-users “.profile“ file in their home dorectory, but usually the
-oracle database users are not users of the system with their own
-home)</p>
-<p><br />
-</p>
-<p>Set
-the following variables with:</p>
-<p>
-# cd /etc</p>
-<p>
-# echo export
-ORACLE_HOME=/path/to/oracle/home &gt;&gt; /etc/profile 
-</p>
-<p>
-  **(e.g.
-ORACLE_HOME=/app/oracle/ora10g)</p>
-<p>
-# echo export
-ORACLE_BASE=path/to/oracle &gt;&gt; /etc/profile 
-</p>
-<p>
-  **(e.g.
-ORACLE_HOME=/app/oracle)</p>
-<p>
-# echo export
-ORACLE_SID=MY_ORACLE &gt;&gt; /etc/profile 
-</p>
-<p>
-# echo export
-LD_LIBRARY_PATH=path/to/oracle/home/lib &gt;&gt; /etc/profile 
-</p>
-<p>
-  **(e.g.
-ORACLE_HOME=/app/oracle/ora10g/lib)</p>
-<p>The
-command comes silent, so there is no system output if you didn't
-mistype anything!</p>
-<p><br />
-</p>
-<p><b>3b)
--&gt; Setting the Apache Environment</b></p>
-<p>
-Sometimes it is confusing WHERE to
-set WHAT in the splitted apache2.conf-files. In the folder
-“/etc/apache2/sites_available“ you find your sites-file. If you
-did not do sth. Special e.g. installing virtual hosts, the file is
-named “default“. In this file, the apache cgi-directory is
-defined. Our file looks like this:</p>
-<p>
-<br />
-</p>
-<p>
-  ScriptAlias
-/cgi-bin/ /var/www/cgi-bin/ 
-</p>
-<p>
-  &lt;Directory "/var/www/cgi-bin"&gt;</p>
-<p>
-               AllowOverride None</p>
-<p>
-               Options ExecCGI
--MultiViews +SymLinksIfOwnerMatch</p>
-<p>
-              Order allow,deny</p>
-<p>
-              Allow from all</p>
-<p>
-       &lt;/Directory&gt;</p>
-<p>
+.. _oci_install:
+
+*****************************************************************************
+ Oracle Installation
+*****************************************************************************
+
+:Author: Till Adams
+:Last Updated: 2007/02/16
+
+.. contents:: Table of Contents
+    :depth: 2
+    :backlinks: top
+
+
+.. index:: 
+    pair: Oracle, install
+
+
+Preface
+------------------------------------------------------------------------------
+
+This document explains the whole configuration needed to get the connect
+between MapServer :ref:`cgi` and an Oracle database server on a linux (Ubuntu)
+box. The aim of this document is just to put a lot of googled knowledge in ONE
+place. Hopefully it will preserve many of people spending analog amount of
+time than I did!
+
+This manual was written, because I spent several days googling around to get
+my UMN having access to an oracle database. I'm NOT an oracle expert, so the
+aim of this document is just to put a lot of googled knowledge in ONE place.
+Hopefully it will preserve many of people spending analog amount of time than
+I did! (Or: If you have the choice: Try :ref:`PostGIS <input_postgis>` ;-))
+
+Before we start, some basic knowledge, I didn't know before:
+
+* Mapserver can access oracle spatial as well as geodata from any oracle
+  locator installation! Oracle locator comes with every oracle instance, there
+  is no need for an extra license.
+	
+* There is no need for further installation of any packages beside
+  oracle/oracle OCI
+
+System Assumptions
+------------------------------------------------------------------------------
+
+We assume that Oracle is already installed, there is a database and there is
+some geodata in the database. The following paths should be known by the
+reader:
+
+* ORACLE_HOME
+* ORACLE_SID
+* ORACLE_BASE
+* LD_LIBRARY_PATH
+
+We also assume that you have installed **apache2** (our version was 2.0.49)
+and you are used to work with Linux/UNIX systems. We also think you are able
+to handle the editor :ref:`vi/vim <vim>`.
+
+We ensure that the Oracle user who later accesses the database has
+write-access to the oracle_home directory.
+
+We also assume, that you already have setup the tnsnames.ora file. It should
+look like that:
+
+::
+
+    MY_ORACLE = 
+        (DESCRIPTION = 
+            (ADDRESS = (PROTOCOL = TCP)(HOST = host)(PORT = 1521))
+            (CONNECT_DATA =
+                (SERVICE_NAME = your_name) 
+            ) 
+        ) 
+
+It is important that you know the NAME of the datasource, in this example this
+is "MY_ORACLE" and will be used further on. Done that, you're fine using
+``User/Password at MY_ORACLE`` in your mapfile to connect to the oracle database.
+But first we have to do some more stuff.
+
+Compile MapServer
+------------------------------------------------------------------------------
+
+Compile as normal compilation and set this flag:
+
+::
+
+
+    --with-oraclespatial=/path/to/oracle/home/</p>
+
+If MapServer configure and make runs well, try
+
+::
+
+    ./mapserv -v
+    
+This should at least give this output:
+
+::
+
+    INPUT=ORACLESPATIAL
+
+If you got that, you're fine from the MapServer point of view.
+
+Set Environment Variables
+------------------------------------------------------------------------------
+
+It is important to set all environment variables correctly. There are one the
+one hand system-wide environment variables to be set, on the other hand there
+should be set some for the cgi-directory in your Apache configuration.
+
+System Variables
+..............................................................................
+
+On Ubuntu (and on many other systems) there is the file "/etc/profile" which
+sets environment variables for all users on the system (you may also dedicate
+user-specific environment variables by editing the users ".profile" file in
+their home directory, but usually the oracle database users are not users of
+the system with their own home)
+
+Set the following variables:
+
+::
+
+    $ cd /etc
+
+
+    $ echo export ORACLE_HOME=/path/to/oracle/home >> /etc/profile 
+
+    # **(e.g. ORACLE_HOME=/app/oracle/ora10g)
+
+    $ echo export ORACLE_BASE=path/to/oracle >> /etc/profile 
+
+    # **(e.g. ORACLE_HOME=/app/oracle)
+
+    $ echo export ORACLE_SID=MY_ORACLE >> /etc/profile 
+
+    $ echo export LD_LIBRARY_PATH=path/to/oracle/home/lib >> /etc/profile 
+
+    # **(e.g. ORACLE_HOME=/app/oracle/ora10g/lib)
+
+The command comes silent, so there is no system output if you didn't mistype
+anything!
+
+
+
+Setting the Apache Environment
+..............................................................................
+
+
+Sometimes it is confusing WHERE to set WHAT in the splitted
+apache2.conf-files. In the folder "/etc/apache2/sites_available" you find your
+sites-file. If you did not do sth. Special e.g. installing virtual hosts, the
+file is named "default". In this file, the apache cgi-directory is defined.
+Our file looks like this:
+
+::
+
+    ScriptAlias /cgi-bin/ /var/www/cgi-bin/ 
+    <Directory "/var/www/cgi-bin">
+           AllowOverride None
+           Options ExecCGI -MultiViews +SymLinksIfOwnerMatch
+           Order allow,deny
+           Allow from all
+    </Directory></p>
+
 In this file, the local apache
-environemtns variables must be set. We did it within a location-block
-like this:</p>
-<p>
-        &lt;Location "/cgi-bin/"&gt;</p>
-<p>
-           SetEnv ORACLE_HOME
-"/path/to/oracle/home"</p>
-<p>
-        &lt;/Location&gt;</p>
-<p>
-Where /cgi-bin/ in the opening
-location block refers to the script alias /cgi-bin/ and the TNS_ADMIN
-directory point to the location of the tnsnames.ora file.</p>
-<p>
-Then restart apache:</p>
-<p>
-#
-/etc/init.d/apache2 force-reload</p>
-<p><br />
-</p>
-<p><br />
-</p>
-<p><b>4.)
-Create mapfile</b></p>
-<p>Before
-we start creating our mapfile ensure that you have a your access data
-(User/Password) and that you know the Oracle SRID, which could be
-different from the proj-EPSG!</p>
-<p><br />
-</p>
-<p>The
-data access Parameters:</p>
-<p>  CONNECTIONTYPE
-oraclespatial</p>
-<p>  CONNECTION
-'user/password at MY_ORACLE'</p>
-<p>  DATA
-'GEOM FROM MY_LAYER USING SRID 82032'</p>
-<p>  [...]</p>
-<p><b>Where</b></p>
-<p>GEOM
-is the name of the feometry column</p>
-<p>MY_LAYER
-the name of the table</p>
-<p>82032
-is equivalent to the EPSG code 31468 (German projection system)</p>
-<p><br />
-</p>
-<p><br />
-</p>
-<p><b>5.)
-Testing &amp; Error handling</b></p>
-<p>So
-you are fine now. Load the mapfile in your application and try it. If
-everything goes well: Great, if not, possibly this ugly error-emssage
-occurs (this one cmae by querying mapserver through the WMS interface
-as a GetMap-request):</p>
-<p>
-&lt;ServiceExceptionReport
-version="1.0.1"&gt;</p>
-<p>
- &lt;ServiceException&gt;</p>
-<p>
-            msDrawMap(): Image
-handling error. Failed to draw layer named 'test1'.</p>
-<p>
-            msOracleSpatialLayerOpen():
-OracleSpatial error. Cannot create OCI Handlers.   <br />           
-Connection failure. Check the connection string. Error: .</p>
-<p>
- &lt;/ServiceException&gt;</p>
-<p>
-&lt;/ServiceExceptionReport&gt;</p>
-<p><br />
-</p>
-<p>This
-points us towards, that there might be a problem with the connection
-to the database.</p>
-<p>First
-of all, let's check, if the mapfile is all right. Therefore we use
-the maüpserver utility programm “shp2img“. 
-</p>
-<p>Let's
-assume you are in the directory, where you compiled mapserver and run
-shp2img:</p>
-<p>
-# cd /var/src/mapserver_version/</p>
-<p>
-# shp2img -m
-/path/to/mapfile/mapfile.map -i png -o /path/to/output/output.png</p>
-<p>
-<br />
-</p>
-<p>
-The output of the command should
-look like this:</p>
-<p>
-[Fri Feb  2 14:32:17 2007].522395
-msDrawMap(): Layer 0 (test1), 0.074s</p>
-<p>
-[Fri Feb  2 14:32:17 2007].522578
-msDrawMap(): Drawing Label Cache, 0.000s</p>
-<p>
-[Fri Feb  2 14:32:17 2007].522635
-msDrawMap() total time: 0.075s</p>
-<p>
-<br />
-</p>
-<p>
-If not, this possibly points you
-towards any error in your mapfile or in the way to access the data
-directly. In this case. Look for the mapserver_oraclespatial_howto
-document on the mapserver homepage. If there is a problem with your
-oracle connect, the same message as above (MsDrawMap() ...) occurs.
-Check your mapfile syntax and/or the environment settings for oracle.</p>
-<p>
-<br />
-</p>
-<p>
-For Debian/Ubuntu it's worth also
-checking the file “/etc/environment“ and testwise to add the
-system variables comparable to 3a)</p>
-<p>
-<br />
-</p>
-<p>
-If the output is OK, you may have a
-look at the generated image (output.png). Then your problem reduces
-to the access of apache to oracle home directory. Carefully check
-your apache configuration. Please note, that the apache.config file
-differs in several linux-distributions. For this paper we talk about
-Ubuntu, which should be the same as Debian.</p>
-<p>
-<br />
-</p>
-<p>
-Regards,</p>
-<p>
-<br />
-</p>
-<p>
-Till Adams, Bonn in February 2007</p>
-<p>
-<br />
-</p>
+environment variables must be set. We did it within a location-block
+like this:
+
+::
+
+    <Location "/cgi-bin/">
+        SetEnv ORACLE_HOME "/path/to/oracle/home"
+    </Location></p>
+
+Where /cgi-bin/ in the opening location block refers to the script alias
+/cgi-bin/ and the TNS_ADMIN directory point to the location of the
+tnsnames.ora file.
+
+Then restart apache:
+
+::
+
+    $ /etc/init.d/apache2 force-reload
+
+Create mapfile
+..............................................................................
+
+Before we start creating our mapfile ensure that you have a your access data
+(User/Password) and that you know the Oracle SRID, which could be different
+from the proj-EPSG!
+
+The data access Parameters:
+* CONNECTIONTYPE oraclespatial
+* CONNECTION 'user/password at MY_ORACLE'
+* DATA 'GEOM FROM MY_LAYER USING SRID 82032'
+[...]
+
+Where:
+* GEOM is the name of the geometry column
+* MY_LAYER the name of the table
+* 82032 is equivalent to the EPSG code 31468 (German projection system)
+
+
+Testing & Error handling
+..............................................................................
+
+So you are fine now. Load the mapfile in your application and try it. If
+everything goes well: Great, if not, possibly this ugly error-emssage occurs
+(this one cmae by querying MapServer through the WMS interface as a
+GetMap-request):
+
+::
+
+    <ServiceExceptionReport version="1.0.1">
+        <ServiceException>
+            msDrawMap(): Image handling error. Failed to draw layer named 'test1'.
+            msOracleSpatialLayerOpen(): OracleSpatial error. Cannot create OCI Handlers.         
+            Connection failure. Check the connection string. Error: .
+        </ServiceException>
+    </ServiceExceptionReport>
+
+This points us towards, that there might be a problem with the connection to
+the database. First of all, let's check, if the mapfile is all right.
+Therefore we use the MapServer utility program :ref:`shp2img_utility`.
+
+Let's assume you are in the directory, where you compiled MapServer and run
+shp2img:
+
+::
+
+    $ cd /var/src/mapserver_version/
+
+    $ shp2img -m /path/to/mapfile/mapfile.map -i png -o /path/to/output/output.png
+    
+
+The output of the command should look like this:
+
+::
+
+[Fri Feb  2 14:32:17 2007].522395 msDrawMap(): Layer 0 (test1), 0.074s
+[Fri Feb  2 14:32:17 2007].522578 msDrawMap(): Drawing Label Cache, 0.000s
+[Fri Feb  2 14:32:17 2007].522635 msDrawMap() total time: 0.075s
+
+If not, this possibly points you towards any error in your mapfile or in the
+way to access the data directly. In this case, take a look at :ref:`oci`. If
+there is a problem with your oracle connect, the same message as above
+(MsDrawMap() ...) occurs. Check your mapfile syntax and/or the environment
+settings for Oracle.
+
+For Debian/Ubuntu it's worth also checking the file "/etc/environment" and
+test-wise to add the system variables comparable to `System Variables`_
+
+If the output is OK, you may have a look at the generated image (output.png).
+Then your problem reduces to the access of apache to oracle home directory.
+Carefully check your apache configuration. Please note, that the apache.config
+file differs in several linux-distributions. For this paper we talk about
+Ubuntu, which should be the same as Debian.

Modified: trunk/docs/input/vector/oracle_spatial.txt
===================================================================
--- trunk/docs/input/vector/oracle_spatial.txt	2008-12-10 01:41:09 UTC (rev 8228)
+++ trunk/docs/input/vector/oracle_spatial.txt	2008-12-10 02:18:26 UTC (rev 8229)
@@ -4,9 +4,9 @@
  Oracle Spatial
 *****************************************************************************
 
-MapServer can support Oracle Spatial through OGR.  With this method, OGR must be compiled with 
-Oracle Spatial support and MapServer must be compiled to use OGR.
-In addition, MapServer also supports Oracle Spatial natively. 
+MapServer can support Oracle Spatial through OGR. With this method, OGR must
+be compiled with Oracle Spatial support and MapServer must be compiled to use
+OGR. In addition, MapServer also supports Oracle Spatial natively.
 
 
 Map file example using OGR Support



More information about the mapserver-commits mailing list