Mercurial > dive4elements > gnv-client

comparison doc/config-manual/general_settings.tex @ 938:2d84fc30ab58

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
937:052b8bba4f41 938:2d84fc30ab58
1 \section{General Settings} 1 \section{Configuring the GNV-Server}
2 \subsection{Structure of Configurationfile} 2
3 The Configuration of the Artifact-Server will generally be done in one single 3 The configuration of the artifact- and mapserver is been done in the
4 File. This file is called conf.xml and is stored in the folder conf of the 4 central configuration directory at {\tt artifact-server/conf/}. The
5 Artifact-Server. 5 central entry point is the file {\tt conf.xml}. All components of the
6 configuration are linked from this document.
7
8 {\bf Within the configuration the key
9 {\verb+${artifacts.config.dir}+} can be used to reference the central
10 configuration directory of the artifact-server instance, e.g.
11 {\tt /opt/artifact-server}.}
12
13 The following structure gives an overview of the entire structure
14 starting from {\tt conf/}:
15
16 %% tree /opt/artifact-server/
17 \begin{lstlisting}
18 conf/
19 |-- arcsdeconnectionpool.properties # database connection
20 |-- charttemplate.xml # general properties for chart generation
21 |-- conf.xml # central configuration
22 |-- ehcache.xml # configuration of caching system
23 |-- log4j.properties # logging of server
24 |-- maptemplates # style defintions for rendering maps
25 | `-- *.vm
26 |-- meshwidth.xml # buffer-size for querying different FIS on
27 # meshes
28 |-- palette # styling for 2D charts
29 | `-- *.xml
30 |-- products # configuration of steps in workflows
31 | |-- horizontalcrosssection
32 | | `-- *.xml
33 | |-- horizontalprofile
34 | | `-- *.xml
35 | |-- layer
36 | | `-- *.xml
37 | |-- timeseries
38 | | |-- *.xml
39 | | `-- timegap_definition.xml # definition of a gap depending FIXME
40 | |-- verticalcrosssection
41 | | `-- *.xml
42 | `-- verticalprofile
43 | `-- *.xml
44 `-- queries.properties # SQL configuration according to products
45 \end{lstlisting}
46
47
48 The central config-file {\tt conf/conf.xml} is XML-based and contains the
49 following main elements:
50
51 \begin{lstlisting}
52 artifact-database
53 |-- geo-backend # pointing to database connection, SQL configuration
54 |-- rest-server # port, listen addresses
55 |-- database # internal database storing artifacts
56 |-- ehcache # pointing to cache configuration
57 |-- cleaner # time of cleanups FIXME
58 |-- export-secret # signing project files
59 |-- factories # list of expert information systems
60 |-- artifacts # list of products
61 |-- gnv # charts, palettes, interpolation parameters
62 |-- mapserver # integration of mapserver
63 `-- velocity # templating language used in maptemplates
64 \end{lstlisting}
65
66 The documentation of the configuration will be split up in 4 sections
67 addressing different tasks:
68 \begin{enumerate}
69 \item "Configuring and Running Artifact-Server" covering the main elements {\tt
70 geo-backend, rest-server, database, ehcache, cleaner, export-secret}
71 \item "Generating Charts -- Background and Configuration" covering
72 the main element {\tt gnv}
73 \item "Generating Maps -- Background and Configuration" covering the
74 main elements {\tt mapserver, velocity}
75 \item "Configuring FIS, Products, States, Transitions and
76 SQL-Statements" covering the main elements {\tt factories,
77 artifacts}
78 \end{enumerate}
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
6 Some additional Configurations will be done using Systemproperties. This 95 Some additional Configurations will be done using Systemproperties. This
7 Properties will be listed in the last Section of this chapter. 96 Properties will be listed in the last Section of this chapter.
8 97
9 The Configuration is modelled using XML.
10 The main Structure of the XML-Document now will be explained:
11
12 \begin{verbatim}
13 artifact-database
14 |--artifact-factories
15 |--artifacts
16 |--gnv
17 | |--charttemplate
18 | |--palettes
19 | |--horizontal-cross-section-profile
20 | |--horizontal-cross-section
21 | |--vertical-cross-section
22 | |--shapefile-directory
23 | `--map-generator
24 |--mapserver
25 |--velocity
26 |--ehcache
27 |--geo-backend
28 |--rest-server
29 |--cleaner
30 `--database
31 \end{verbatim}
32 98
33 \subsubsection{artifact-factories} 99 \subsubsection{artifact-factories}
34 100
35 These Section configures the Factories for Artifacts which can be used. 101 These Section configures the Factories for Artifacts which can be used.
36 The meaning of artifact-factories are explained in Section TODO: LINK to Model of Transition 102 The meaning of artifact-factories are explained in Section TODO: LINK to Model of Transition
38 \subsubsection{artifacts} 104 \subsubsection{artifacts}
39 105
40 These Section configures the Artifacts which could be reached using the Artifact-Server. 106 These Section configures the Artifacts which could be reached using the Artifact-Server.
41 The meaning of artifacts are explained in Section TODO: LINK to Model of Transition 107 The meaning of artifacts are explained in Section TODO: LINK to Model of Transition
42 108
43 \subsubsection{gnv}
44 109
45 This Section configures all GNV-specific settings of the Artifact-Server.
46 //TODO add paragraphs and explain the child-elements.
47
48 \subsubsection{mapserver}
49
50 The Section Mapserver is introduced to be able to configure all Settings which
51 are required to setup the WMS-Export of the GNV-Artifacts.
52
53 It is possible to Configure the following settings:
54
55 \begin{itemize}
56 \item server: The URL the WMS of the GNV-Artifacts will be reached from
57 Clients.
58 \end{itemize}
59
60 \subsubsection{velocity}
61
62 Velocity is an Library which is used in this Project.
63 Velocity has it's own Logging, so that it is necessary to configure
64 this to get Loginformations.
65
66 \begin{itemize}
67 \item logfile: The absolute Path to the Logfile of Velocity.
68 \end{itemize}
69
70 \subsubsection{ehcache}
71
72 The Ehcache is used to implement an Cache storing the Thematic-Data of the
73 different Sessions.
74
75 It is possible to configure this Cache in many ways. To realize this it is
76 possible to configure the following settings:
77
78 \begin{itemize}
79 \item configuration: The absolute Path to the Configuration-File.
80 It is possible to start with \$\{artifacts.config.dir\}
81 to reference the file from the Directory which includes
82 the Configuration
83 \end{itemize}
84
85
86 \subsubsection{geo-backend}
87
88 The geo-backend is an separate Module of this Project. It encapsulate the logic
89 which is required to provide the Access to the Databasebackend.
90 At this Time only the Access to the ArcSDE is implemented.
91
92 To setup the geo-backend the following settings are required:
93
94 \begin{itemize}
95 \item backend-configuration: The absolute Path to the File which contains the
96 properties to establish the Connection to the
97 Databasebackend.
98 \item query-configuration: The absolute Path to the File which contains all
99 SQL-Statements which are required to fetch the
100 Thematic-Data
101 \end{itemize}
102
103 Both Path can start with \$\{artifacts.config.dir\} to reference the file from
104 the Directory which includes the Configuration.
105 \paragraph{Backend-Configuration (arcsdeconnectionpool.properties)}
106 110
107 \paragraph{Query-configuration (queries.properties)} 111 \paragraph{Query-configuration (queries.properties)}
108 112
109 This File contains Key-Value-Pairs to define SQL-Statements. 113 This File contains Key-Value-Pairs to define SQL-Statements.
110 All Queries will be handle using the Prepared-Statement-Syntax using "?" 114 All Queries will be handle using the Prepared-Statement-Syntax using "?"
125 \item INTERSECTS(SHAPE,"?"): Will only return the Elements which Geometry 129 \item INTERSECTS(SHAPE,"?"): Will only return the Elements which Geometry
126 intersects the given Geometry ("?" will be 130 intersects the given Geometry ("?" will be
127 replace with an WKT) 131 replace with an WKT)
128 \end{itemize} 132 \end{itemize}
129 133
130 \subsubsection{rest-server}
131 \subsubsection{cleaner}
132 \subsubsection{database}
133
134
135 \subsection{Set the Communicationport}
136 \subsection{Logging} 134 \subsection{Logging}
137 \subsection{Configure ArtifactServer using Systemproperties} 135 \subsection{Configure ArtifactServer using Systemproperties}
138 \begin{itemize} 136 \begin{itemize}
139 \item artifact.database.dir The folder where the Configuration is located- 137 \item artifact.database.dir The folder where the Configuration is located-
140 \item query.executor.factory: The absolute Classname which QueryExecutorfactory should be used 138 \item query.executor.factory: The absolute Classname which QueryExecutorfactory should be used
http://dive4elements.wald.intevation.org