<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="scheduler_job_documentation_v1.1.xsl"?>
<description xmlns="http://www.sos-berlin.com/schema/scheduler_job_documentation_v1.1"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://www.sos-berlin.com/schema/scheduler_job_documentation_v1.1 http://www.sos-berlin.com/schema/scheduler_job_documentation_v1.1.xsd">
   <job xmlns:xhtml="http://www.w3.org/1999/xhtml"
        order="both"
        name="YADEHistoryJob"
        tasks="unbounded"
        title="Import YADE Transfer History Entries into a Database">
      <script language="java"
              java_class="sos.jadehistory.job.JADEHistoryJob"
              resource="6"/>
  </job>
   <releases xmlns:xhtml="http://www.w3.org/1999/xhtml">
      <release id="1.0" created="2008-12-15" modified="2008-12-15">
         <title>version 1.0</title>
         <author name="Robert Ehrlich" email="robert.ehrlich@sos-berlin.com"/>
      </release>
  </releases>
   <configuration>
      <note xmlns:xhtml="http://www.w3.org/1999/xhtml" language="de">
         <div xmlns="http://www.w3.org/1999/xhtml">Dieser Job kann standalone oder auftragsgesteuert eingesetzt werden.
        Die Parameter werden entsprechend als Job- oder Auftragsparameter verarbeitet.
      </div>
      </note>
      <note xmlns:xhtml="http://www.w3.org/1999/xhtml" language="en">
         <div xmlns="http://www.w3.org/1999/xhtml">This job can be used standalone or as an order driven job.
        Parameters are respectively accepted as job parameters or as order parameters.
      </div>
      </note>
      <params>
         <param xmlns:xhtml="http://www.w3.org/1999/xhtml"
                name="position_repeat_count"
                required="false"
                default_value="3">
            <note language="de">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              Anzahl Wiederholungen, um die Datei-Position in der Datenbank zu ermitteln.
            </p>
               </div>
            </note>
            <note language="en">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              Number of repetitions to determine the file position in the database.
            </p>
               </div>
            </note>
         </param>
         <param xmlns:xhtml="http://www.w3.org/1999/xhtml"
                name="position_repeat_interval"
                required="false"
                default_value="1">
            <note language="de">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              Zeit (in Sekunden) zwischen der Wiederholundgen.
            </p>
               </div>
            </note>
            <note language="en">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              Time (in seconds) between repetitions.
            </p>
               </div>
            </note>
         </param>
         <param xmlns:xhtml="http://www.w3.org/1999/xhtml"
                name="db_class"
                required="false"
                default_value="Job Scheduler Connection">
            <note language="de">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              Java-Klasse der YADE History Datenbankverbindung (SOS)
            </p>
               </div>
            </note>
            <note language="en">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              Java class for YADE History database connection (SOS)
            </p>
               </div>
            </note>
         </param>
         <param xmlns:xhtml="http://www.w3.org/1999/xhtml"
                name="db_driver"
                required="false"
                default_value="Job Scheduler Connection">
            <note language="de">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              JDBC Driver Name der YADE History Datenbankverbindung
            </p>
               </div>
            </note>
            <note language="en">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              JDBC Driver name for YADE History database connection
            </p>
               </div>
            </note>
         </param>
         <param xmlns:xhtml="http://www.w3.org/1999/xhtml"
                name="db_url"
                required="false"
                default_value="Job Scheduler Connection">
            <note language="de">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              JDBC Driver-spezifische URL der YADE History Datenbankverbindung
            </p>
               </div>
            </note>
            <note language="en">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              JDBC Driver specific URL for YADE History database connection
            </p>
               </div>
            </note>
         </param>
         <param xmlns:xhtml="http://www.w3.org/1999/xhtml"
                name="db_user"
                required="false"
                default_value="Job Scheduler Connection">
            <note language="de">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              Datenbank-Benutzer der YADE History Datenbankverbindung
            </p>
               </div>
            </note>
            <note language="en">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              Database user for YADE History database connection
            </p>
               </div>
            </note>
         </param>
         <param xmlns:xhtml="http://www.w3.org/1999/xhtml"
                name="db_password"
                required="false"
                default_value="Job Scheduler Connection">
            <note language="de">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              Datenbank-Kennwort der YADE History Datenbankverbindung
            </p>
               </div>
            </note>
            <note language="en">
               <div xmlns="http://www.w3.org/1999/xhtml">
                  <p>
              Database password for YADE History database connection
            </p>
               </div>
            </note>
         </param>
      </params>
   </configuration>
   <documentation xmlns:xhtml="http://www.w3.org/1999/xhtml" language="de">
      <div xmlns="http://www.w3.org/1999/xhtml">
      YADE-Dateien sind einfache Textdateien im CSV-Format oder Datenbanktabellen, die pro Server-System vorgehalten werden und in denen Shell Scripte einen Log-Eintrag generieren. Dieser Job importiert den Inhalt einer YADE-Datei oder -Datenbanktabelle
      in eine zentrale Datenbank.
      <br/>
         <br/>
      Eine YADE-Datei oder Datenbanktabelle muss folgende Felder beinhalten:
      <br/>
         <br/>
      
         <em>guid, mandator, transfer_start:Datetime('yyyy-mm-dd HH:MM:SS'), transfer_end:Datetime('yyyy-mm-dd HH:MM:SS'),<br/>
      pid, ppid, operation, localhost, localhost_ip, local_user,<br/>
      remote_host, remote_host_ip, remote_user, protocol, port,<br/>
      local_dir, remote_dir, local_filename, remote_filename,<br/>
      md5, status, last_error_message, log_filename, file_size</em>

         <br/>
         <br/>
      Der Feldmodifizierer <em>:Datetime</em> kann für andere Datumsformate der Eingabedatei angepasst werden. Beim Import aus Datenbanktabellen wird immer ein ISO-Zeitstempel verarbeiet.
      <br/>
         <br/>
      
         <strong>Hinweis:</strong> Eine YADE-Datei oder Datenbanktabelle darf auch beliebig viele zusätzlichen Felder beinhalten.<br/>
      Voraussetzung für Import von diesen zusätzlichen Felder in die Datenbank ist<br/> dass in der Tabelle <em>JADE_FILES_HISTORY</em> gleichnamigen Spalten existieren.
      <br/>
         <br/>
      
      
      Der Job speichert die Position und die Dateigröße des jeweils letzten YADE-Eintrags innerhalb der YADE-Datei in der Datenbank, um beim wiederholten Lesen der Datei nicht alle Einträge verarbeiten zu müssen.
      YADE-Dateien können daher jederzeit geleert werden, falls sie aufgrund einer Vielzahl von Job-Läufen zu groß werden.
    </div>
  </documentation>
   <documentation xmlns:xhtml="http://www.w3.org/1999/xhtml" language="en">
      <div xmlns="http://www.w3.org/1999/xhtml">
      YADE files are simple text files in CSV format or database tables that are located in remote server systems. A YADE History is written per start of a shell script. This job imports the entries of a YADE History file or database table into a central database.
      <br/>
         <br/>
      A YADE History file or database table must contain the following fields:
      <br/>
         <br/>
      
         <em>guid, mandator, transfer_start:Datetime('yyyy-mm-dd HH:MM:SS'), transfer_end:Datetime('yyyy-mm-dd HH:MM:SS'),<br/>
      pid, ppid, operation, localhost, localhost_ip, local_user,<br/>
      remote_host, remote_host_ip, remote_user, protocol, port,<br/>
      local_dir, remote_dir, local_filename, remote_filename,<br/>
      md5, status, last_error_message, log_filename, file_size</em>

         <br/>
         <br/>
      The field modifier <em>:Datetime</em> could be used to reflect different timestamp formats in input files. When importing from a database table ISO timestamp formats are automatically used.
      <br/>
         <br/>
      
         <strong>Note:</strong> A YADE file or a database table can contain additional fields.<br/>
      A condition for import of this additional fields into the data base is:<br/> Table <em>JADE_FILES_HISTORY</em> has columns with the same names.
      <br/>
         <br/>
      
      This job stores the position and the file size of the last YADE History entry within a YADE file in the database in order to avoid repeated processing of records. Therefore YADE files could be truncated at any time should they grow too large.
    </div>
  </documentation>
</description>