# HG changeset patch
# User Tim Englich <tim.englich@intevation.de>
# Date 1273224984 0
# Node ID 3af26af71c6220925ffc699cc0f59da4ca8802b3
# Parent  38bc313ef0683c0fcc8eea921454a55b7f8f5852
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties

doc/trunk@1077 c6561f87-3c4e-4783-a992-168aeb5c3f6f

diff -r 38bc313ef068 -r 3af26af71c62 doc/ChangeLog
--- a/doc/ChangeLog	Fri May 07 08:43:07 2010 +0000
+++ b/doc/ChangeLog	Fri May 07 09:36:24 2010 +0000
@@ -1,3 +1,10 @@
+2010-05-07  Tim Englich  <tim@intevation.de>
+
+	* general_settings.tex:
+	Added first Structure and XML-Structure for the documentation
+	of the File conf.xml.
+	Added the Documentation for the System-Properties.
+
 2010-05-07  Tim Englich  <tim@intevation.de>
 
 	* general_settings.tex:
diff -r 38bc313ef068 -r 3af26af71c62 doc/config-manual/general_settings.tex
--- a/doc/config-manual/general_settings.tex	Fri May 07 08:43:07 2010 +0000
+++ b/doc/config-manual/general_settings.tex	Fri May 07 09:36:24 2010 +0000
@@ -1,12 +1,72 @@
 \section{General Settings}
 \subsection{Structure of Configurationfile}
-conf.xml
+The Configuration of the Artifact-Server will generally be done in one single
+File. This file is called conf.xml and is stored in the folder conf of the 
+Artifact-Server.
+Some additional Configurations will be done using Systemproperties. This 
+Properties will be listed in the last Section of this chapter.
+
+The Configuration is modelled using XML.
+The main Structure of the XML-Document now will be explained:
+
+\begin{verbatim}
+artifact-database
+|--artifact-factories
+|--artifacts
+|--gnv
+|  |--charttemplate
+|  |--palettes
+|  |--horizontal-cross-section-profile
+|  |--horizontal-cross-section
+|  |--vertical-cross-section
+|  |--shapefile-directory
+|  `--map-generator
+|--mapserver
+|--velocity
+|--ehcache
+|--geo-backend
+|--rest-server
+|--cleaner
+`--database
+\end{verbatim}
+
+\subsubsection{artifact-factories}
+\subsubsection{artifacts}
+\subsubsection{gnv}
+\subsubsection{mapserver}
+\subsubsection{velocity}
+\subsubsection{ehcache}
+\subsubsection{geo-backend}
+
 queries.properties
 arcsdeconnectionpool.properties
 SQL:
     Clarify the special mechanism of the internal functions
         ST\_ASTEXT(SHAPE)
         ST\_ASTEXT(RASTER)
+
+\subsubsection{rest-server}
+\subsubsection{cleaner}
+\subsubsection{database}
+
+
 \subsection{Set the Communicationport}
 \subsection{Logging}
+\subsection{Configure ArtifactServer using Systemproperties}
+\begin{itemize}
+    \item artifact.database.dir The folder where the Configuration is located-
+    \item query.executor.factory: The absoulte Classname which QueryExecutorfactory should be used
+    \begin{itemize}
+        \item de.intevation.gnv.geobackend.base.query.QueryExecutorFactory :
+              Standardfactory without any Addons.
+        \item de.intevation.gnv.geobackend.base.query.CachingQueryExecutorFactory: 
+              Factory with Cache for SQL-Query-Results
+    \end{itemize}
+    \item caching.query.executor.config: The absolute Path to the Configurationfile 
+                                         for the Cache which stores the SQL-Query-
+                                         Results. This only take effect if the
+                                         query.executor.factory-Property is set
+                                         to de.intevation.gnv.geobackend.base.query.CachingQueryExecutorFactory.
+    \item caching.cleaner.interval: The Interval in seconds the Caches should be cleaned using the Cachecleaner
+\end{itemize}