Mercurial > dive4elements > gnv-client
annotate doc/config-manual/general_settings.tex @ 942:c53a39cb7809
Moved section Query-configuration to Section Model of Transitions.
doc/trunk@1085 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Tim Englich <tim.englich@intevation.de> |
---|---|
date | Mon, 10 May 2010 13:07:04 +0000 |
parents | 2d84fc30ab58 |
children | 4d1a1917282d |
rev | line source |
---|---|
938
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
1 \section{Configuring the GNV-Server} |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
2 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
3 The configuration of the artifact- and mapserver is been done in the |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
4 central configuration directory at {\tt artifact-server/conf/}. The |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
5 central entry point is the file {\tt conf.xml}. All components of the |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
6 configuration are linked from this document. |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
7 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
8 {\bf Within the configuration the key |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
9 {\verb+${artifacts.config.dir}+} can be used to reference the central |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
10 configuration directory of the artifact-server instance, e.g. |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
11 {\tt /opt/artifact-server}.} |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
12 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
13 The following structure gives an overview of the entire structure |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
14 starting from {\tt conf/}: |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
15 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
16 %% tree /opt/artifact-server/ |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
17 \begin{lstlisting} |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
18 conf/ |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
19 |-- arcsdeconnectionpool.properties # database connection |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
20 |-- charttemplate.xml # general properties for chart generation |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
21 |-- conf.xml # central configuration |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
22 |-- ehcache.xml # configuration of caching system |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
23 |-- log4j.properties # logging of server |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
24 |-- maptemplates # style defintions for rendering maps |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
25 | `-- *.vm |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
26 |-- meshwidth.xml # buffer-size for querying different FIS on |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
27 # meshes |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
28 |-- palette # styling for 2D charts |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
29 | `-- *.xml |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
30 |-- products # configuration of steps in workflows |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
31 | |-- horizontalcrosssection |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
32 | | `-- *.xml |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
33 | |-- horizontalprofile |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
34 | | `-- *.xml |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
35 | |-- layer |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
36 | | `-- *.xml |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
37 | |-- timeseries |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
38 | | |-- *.xml |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
39 | | `-- timegap_definition.xml # definition of a gap depending FIXME |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
40 | |-- verticalcrosssection |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
41 | | `-- *.xml |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
42 | `-- verticalprofile |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
43 | `-- *.xml |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
44 `-- queries.properties # SQL configuration according to products |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
45 \end{lstlisting} |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
46 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
47 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
48 The central config-file {\tt conf/conf.xml} is XML-based and contains the |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
49 following main elements: |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
50 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
51 \begin{lstlisting} |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
52 artifact-database |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
53 |-- geo-backend # pointing to database connection, SQL configuration |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
54 |-- rest-server # port, listen addresses |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
55 |-- database # internal database storing artifacts |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
56 |-- ehcache # pointing to cache configuration |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
57 |-- cleaner # time of cleanups FIXME |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
58 |-- export-secret # signing project files |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
59 |-- factories # list of expert information systems |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
60 |-- artifacts # list of products |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
61 |-- gnv # charts, palettes, interpolation parameters |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
62 |-- mapserver # integration of mapserver |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
63 `-- velocity # templating language used in maptemplates |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
64 \end{lstlisting} |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
65 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
66 The documentation of the configuration will be split up in 4 sections |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
67 addressing different tasks: |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
68 \begin{enumerate} |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
69 \item "Configuring and Running Artifact-Server" covering the main elements {\tt |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
70 geo-backend, rest-server, database, ehcache, cleaner, export-secret} |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
71 \item "Generating Charts -- Background and Configuration" covering |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
72 the main element {\tt gnv} |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
73 \item "Generating Maps -- Background and Configuration" covering the |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
74 main elements {\tt mapserver, velocity} |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
75 \item "Configuring FIS, Products, States, Transitions and |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
76 SQL-Statements" covering the main elements {\tt factories, |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
77 artifacts} |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
78 \end{enumerate} |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
79 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
80 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
81 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
82 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
83 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
84 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
85 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
86 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
87 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
88 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
89 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
90 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
91 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
92 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
93 |
2d84fc30ab58
Added more chapters in config-manual
Hans Plum <hans.plum@intevation.de>
parents:
937
diff
changeset
|
94 |
936
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
95 Some additional Configurations will be done using Systemproperties. This |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
96 Properties will be listed in the last Section of this chapter. |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
97 |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
98 |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
99 \subsubsection{artifact-factories} |
937
052b8bba4f41
Add first part of Documentation of the Sections of conf.xml
Tim Englich <tim.englich@intevation.de>
parents:
936
diff
changeset
|
100 |
052b8bba4f41
Add first part of Documentation of the Sections of conf.xml
Tim Englich <tim.englich@intevation.de>
parents:
936
diff
changeset
|
101 These Section configures the Factories for Artifacts which can be used. |
052b8bba4f41
Add first part of Documentation of the Sections of conf.xml
Tim Englich <tim.englich@intevation.de>
parents:
936
diff
changeset
|
102 The meaning of artifact-factories are explained in Section TODO: LINK to Model of Transition |
052b8bba4f41
Add first part of Documentation of the Sections of conf.xml
Tim Englich <tim.englich@intevation.de>
parents:
936
diff
changeset
|
103 |
936
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
104 \subsubsection{artifacts} |
937
052b8bba4f41
Add first part of Documentation of the Sections of conf.xml
Tim Englich <tim.englich@intevation.de>
parents:
936
diff
changeset
|
105 |
052b8bba4f41
Add first part of Documentation of the Sections of conf.xml
Tim Englich <tim.englich@intevation.de>
parents:
936
diff
changeset
|
106 These Section configures the Artifacts which could be reached using the Artifact-Server. |
052b8bba4f41
Add first part of Documentation of the Sections of conf.xml
Tim Englich <tim.englich@intevation.de>
parents:
936
diff
changeset
|
107 The meaning of artifacts are explained in Section TODO: LINK to Model of Transition |
052b8bba4f41
Add first part of Documentation of the Sections of conf.xml
Tim Englich <tim.englich@intevation.de>
parents:
936
diff
changeset
|
108 |
936
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
109 \subsection{Configure ArtifactServer using Systemproperties} |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
110 \begin{itemize} |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
111 \item artifact.database.dir The folder where the Configuration is located- |
937
052b8bba4f41
Add first part of Documentation of the Sections of conf.xml
Tim Englich <tim.englich@intevation.de>
parents:
936
diff
changeset
|
112 \item query.executor.factory: The absolute Classname which QueryExecutorfactory should be used |
936
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
113 \begin{itemize} |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
114 \item de.intevation.gnv.geobackend.base.query.QueryExecutorFactory : |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
115 Standardfactory without any Addons. |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
116 \item de.intevation.gnv.geobackend.base.query.CachingQueryExecutorFactory: |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
117 Factory with Cache for SQL-Query-Results |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
118 \end{itemize} |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
119 \item caching.query.executor.config: The absolute Path to the Configurationfile |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
120 for the Cache which stores the SQL-Query- |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
121 Results. This only take effect if the |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
122 query.executor.factory-Property is set |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
123 to de.intevation.gnv.geobackend.base.query.CachingQueryExecutorFactory. |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
124 \item caching.cleaner.interval: The Interval in seconds the Caches should be cleaned using the Cachecleaner |
3af26af71c62
Added first Structure for the Documentation of File conf.xml. Added Documentation for Systemproperties
Tim Englich <tim.englich@intevation.de>
parents:
935
diff
changeset
|
125 \end{itemize} |
935
38bc313ef068
Added separat LaTex-File for the Documentation of the general settings.
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
126 |