# HG changeset patch
# User Tim Englich <tim.englich@intevation.de>
# Date 1272629927 0
# Node ID 29a675796e76ed74f80b01da4972aac20d2c0caf
# Parent  03d58951889ea50f6a0242a8b4cb92262cbd9764
Added the first descriptions of the Configuration of Artifact-Factories, Artifacts representing a FIS and the Products which can be configured to the different FIS.

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

diff -r 03d58951889e -r 29a675796e76 doc/ChangeLog
--- a/doc/ChangeLog	Fri Apr 30 11:12:46 2010 +0000
+++ b/doc/ChangeLog	Fri Apr 30 12:18:47 2010 +0000
@@ -1,4 +1,12 @@
 2010-04-30  Tim Englich  <tim.englich@intevation.de>
+
+	* config-manual/model_of_transitions.tex:
+	Added the first descriptions of the Configuration of
+	Artifact-Factories, Artifacts representing a FIS and the Products
+	which can be configured to the different FIS.
+
+2010-04-30  Tim Englich  <tim.englich@intevation.de>
+
 	* config-manual/config-manual.tex:
 	Added Include for File model_of_transitions.tex into the main
 	Document.
diff -r 03d58951889e -r 29a675796e76 doc/config-manual/model_of_transitions.tex
--- a/doc/config-manual/model_of_transitions.tex	Fri Apr 30 11:12:46 2010 +0000
+++ b/doc/config-manual/model_of_transitions.tex	Fri Apr 30 12:18:47 2010 +0000
@@ -1,7 +1,102 @@
 \section{Model of transitions}
 \subsection{General principle of model of transitions}
         - FIS -> product -> transitions in data model
-    
+The configuration of the provided FIS are devided in three parts.
+
+* Configuration of the Artifactfactories which represents the FIS.
+* Configuration of main Artifacts which will be instantiated if an 
+  Artifactfactory was called.
+* Configuration of the different Artifacts which provides Products which can be 
+  served by the FIS.
+
+\subsubsection{Configuration of ArtifactFactories}
+The Point of Enty into the system is to configure an Artifactfactory.
+Each Artifactfactory represents one FIS.
+It is possible to configure several Artifactfactories.
+The Artifactfactories will be vonfigured in the Section 
+/artifact-database/artifact-factories of the Configurationfile.
+
+\begin{lstlisting}
+<artifact-factory name='fis\_marnet' 
+                  description='Factory to create an artifact to be used with the FIS NEWFISNAME'  
+                  ttl='3600000' 
+                  artifact='de.intevation.artifactdatabase.ProxyArtifact'>
+                  de.intevation.gnv.artifacts.GNVProductArtifactFactory
+</artifact-factory>
+\end{lstlisting}
+
+At this moment the following Attributes of an Artifact-Factory are configurabel.
+* name: The Name of the Artifact. Must be unique in one Artifact-Server
+* description: Short description which Job the Artifactfactory has to do.
+* ttl: The Time to Live: The Time using Milliseconds an Artifact created by this 
+       factory can live without any Userinteraction.
+* artifact: The Name of the Class of the Artifact which should be created.
+
+// TODO: List of Artifacts which currently used in this Configuration? 
+
+\subsubsection{Configuration of main Artifact}
+To each Artifact-Factory it is necessary to configure one Artifact which will be 
+created from the Factory.
+This Artifact is the representation of the specific FIS.
+It contains the Configuration which product will be serverd for ths FIS.
+
+The Artifacts are configured in the Section /artifact-database/artifacts of 
+the Configurationfile.
+
+\begin{lstlisting}
+<artifact name='fis\_marnet'>
+    <products>
+     ...
+    </products>
+</artifact>
+\end{lstlisting}
+
+The Key is to use the same Name for the Artifact as used for the Artifactfactory.
+The Name has to be unique.
+In the Section /artifact/products it is possible to define several Products as 
+explained in the next Section.
+
+\paragraph{Products to an Artifact}
+One Artifact can provide several Products.
+To do this it is required to configure them as shown below in the Section 
+/artifact/products
+
+\begin{lstlisting}
+<product name= "timeSeries">
+      <artifact-factory name="timeSeries" 
+                        description="Artiefactfactory for Instantiating the Artifact for TimeSeries on TimeSeriesPoints"  
+                        ttl="300000" 
+                        artifact="de.intevation.gnv.timeseries.TimeSeriesArtifact">
+           de.intevation.gnv.artifacts.GNVArtifactFactory
+      </artifact-factory>
+      <parameters>
+          <parameter name="sourceid" 
+                     value="4"/>
+          <parameter name="fisname" 
+                     value="fis\_marnet"/>
+      </parameters>
+ </product>
+ \end{lstlisting}
+
+Each Product is represented by an Artifact. To create this Artifact we have to 
+use an Artifact-Factory which is configured in each product 
+(/product/artifact-factory).
+
+Each Product can have several parameters /product/parameters/parameters.
+The Parameter named sourceid and fisname are required Parameters.
+
+The Parameter fisname contains the key to the Name of the FIS. The Key must be 
+unique.
+The Parameter sourceid contains the key to identify the FIS in the 
+DataWareHouse. (MEDIAN.SOURCEINFO)
+
+
+\subsubsection{Configuration of the Product-Artifacts}
+\paragraph{States}
+\paragraph{Transitions}
+\paragraph{Outputstate}
+
+
 \subsection{Adding a new FIS}
 In this Section it will explained which steps has to be done to integrate a new 
 FIS into the Artifact-Server.