Mercurial > dive4elements > gnv-client
diff doc/config-manual/general_settings.tex @ 938:2d84fc30ab58
Added more chapters in config-manual
doc/trunk@1079 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Hans Plum <hans.plum@intevation.de> |
---|---|
date | Sun, 09 May 2010 18:19:53 +0000 |
parents | 052b8bba4f41 |
children | c53a39cb7809 |
line wrap: on
line diff
--- a/doc/config-manual/general_settings.tex Fri May 07 10:19:28 2010 +0000 +++ b/doc/config-manual/general_settings.tex Sun May 09 18:19:53 2010 +0000 @@ -1,34 +1,100 @@ -\section{General Settings} -\subsection{Structure of Configurationfile} -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. +\section{Configuring the GNV-Server} + +The configuration of the artifact- and mapserver is been done in the +central configuration directory at {\tt artifact-server/conf/}. The +central entry point is the file {\tt conf.xml}. All components of the +configuration are linked from this document. + +{\bf Within the configuration the key +{\verb+${artifacts.config.dir}+} can be used to reference the central +configuration directory of the artifact-server instance, e.g. +{\tt /opt/artifact-server}.} + +The following structure gives an overview of the entire structure +starting from {\tt conf/}: + +%% tree /opt/artifact-server/ +\begin{lstlisting} +conf/ +|-- arcsdeconnectionpool.properties # database connection +|-- charttemplate.xml # general properties for chart generation +|-- conf.xml # central configuration +|-- ehcache.xml # configuration of caching system +|-- log4j.properties # logging of server +|-- maptemplates # style defintions for rendering maps +| `-- *.vm +|-- meshwidth.xml # buffer-size for querying different FIS on + # meshes +|-- palette # styling for 2D charts +| `-- *.xml +|-- products # configuration of steps in workflows +| |-- horizontalcrosssection +| | `-- *.xml +| |-- horizontalprofile +| | `-- *.xml +| |-- layer +| | `-- *.xml +| |-- timeseries +| | |-- *.xml +| | `-- timegap_definition.xml # definition of a gap depending FIXME +| |-- verticalcrosssection +| | `-- *.xml +| `-- verticalprofile +| `-- *.xml +`-- queries.properties # SQL configuration according to products +\end{lstlisting} + + +The central config-file {\tt conf/conf.xml} is XML-based and contains the +following main elements: + +\begin{lstlisting} +artifact-database +|-- geo-backend # pointing to database connection, SQL configuration +|-- rest-server # port, listen addresses +|-- database # internal database storing artifacts +|-- ehcache # pointing to cache configuration +|-- cleaner # time of cleanups FIXME +|-- export-secret # signing project files +|-- factories # list of expert information systems +|-- artifacts # list of products +|-- gnv # charts, palettes, interpolation parameters +|-- mapserver # integration of mapserver +`-- velocity # templating language used in maptemplates +\end{lstlisting} + +The documentation of the configuration will be split up in 4 sections +addressing different tasks: +\begin{enumerate} + \item "Configuring and Running Artifact-Server" covering the main elements {\tt +geo-backend, rest-server, database, ehcache, cleaner, export-secret} + \item "Generating Charts -- Background and Configuration" covering + the main element {\tt gnv} + \item "Generating Maps -- Background and Configuration" covering the + main elements {\tt mapserver, velocity} + \item "Configuring FIS, Products, States, Transitions and + SQL-Statements" covering the main elements {\tt factories, + artifacts} +\end{enumerate} + + + + + + + + + + + + + + + + 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} @@ -40,69 +106,7 @@ These Section configures the Artifacts which could be reached using the Artifact-Server. The meaning of artifacts are explained in Section TODO: LINK to Model of Transition -\subsubsection{gnv} - -This Section configures all GNV-specific settings of the Artifact-Server. -//TODO add paragraphs and explain the child-elements. - -\subsubsection{mapserver} - -The Section Mapserver is introduced to be able to configure all Settings which -are required to setup the WMS-Export of the GNV-Artifacts. - -It is possible to Configure the following settings: - -\begin{itemize} - \item server: The URL the WMS of the GNV-Artifacts will be reached from - Clients. -\end{itemize} - -\subsubsection{velocity} - -Velocity is an Library which is used in this Project. -Velocity has it's own Logging, so that it is necessary to configure -this to get Loginformations. - -\begin{itemize} - \item logfile: The absolute Path to the Logfile of Velocity. -\end{itemize} - -\subsubsection{ehcache} -The Ehcache is used to implement an Cache storing the Thematic-Data of the -different Sessions. - -It is possible to configure this Cache in many ways. To realize this it is -possible to configure the following settings: - -\begin{itemize} - \item configuration: The absolute Path to the Configuration-File. - It is possible to start with \$\{artifacts.config.dir\} - to reference the file from the Directory which includes - the Configuration -\end{itemize} - - -\subsubsection{geo-backend} - -The geo-backend is an separate Module of this Project. It encapsulate the logic -which is required to provide the Access to the Databasebackend. -At this Time only the Access to the ArcSDE is implemented. - -To setup the geo-backend the following settings are required: - -\begin{itemize} - \item backend-configuration: The absolute Path to the File which contains the - properties to establish the Connection to the - Databasebackend. - \item query-configuration: The absolute Path to the File which contains all - SQL-Statements which are required to fetch the - Thematic-Data -\end{itemize} - -Both Path can start with \$\{artifacts.config.dir\} to reference the file from -the Directory which includes the Configuration. -\paragraph{Backend-Configuration (arcsdeconnectionpool.properties)} \paragraph{Query-configuration (queries.properties)} @@ -127,12 +131,6 @@ replace with an WKT) \end{itemize} -\subsubsection{rest-server} -\subsubsection{cleaner} -\subsubsection{database} - - -\subsection{Set the Communicationport} \subsection{Logging} \subsection{Configure ArtifactServer using Systemproperties} \begin{itemize}