<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="scheduler_job_documentation.xsl"?>
<description xmlns="http://www.sos-berlin.com/schema/scheduler_job_documentation_v1.0" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sos-berlin.com/schema/scheduler_job_documentation_v1.0 http://www.sos-berlin.com/schema/scheduler_job_documentation_v1.0.xsd">

  <job name  = "JobSampleLogParser"
       title = "Sample job for usage with Microsoft LogParser"
       order = "no">
    <script language = "vbscript"
            resource = "1"/>
  </job>

  <releases>
    <release id="1.0" created="2006-02-20" modified="2006-02-21">
      <title>Version 1.0</title>
      <author name="Andreas Püschel" email="andreas.pueschel@sos-berlin.com"/>
      <note language="de"><div xmlns="http://www.w3.org/1999/xhtml">Initiale Auslieferung</div></note>
      <note language="en"><div xmlns="http://www.w3.org/1999/xhtml">initial release</div></note>
    </release>
  </releases>

  <resources>
    <file os="all" type="java" file="sample_logparser.vbs" id="1">
      <note language="de"><div xmlns="http://www.w3.org/1999/xhtml">Implementierungsbeispiel</div></note>
      <note language="en"><div xmlns="http://www.w3.org/1999/xhtml">Sample Implementation</div></note>
    </file>
  </resources>

  <configuration>
    <params id="job_parameter">
      <param name="input_format" default_value="TEXTLINEInputFormat" required="true">
        <note language="de">
          <div xmlns="http://www.w3.org/1999/xhtml">
            Der Parameter benennt das LogParser Eingabeformat. Zur Verarbeitung von Job Scheduler Protokollen
            sollte das Format <em>TEXTLINEInputFormat</em> verwendet werden.
          </div>
        </note>
        <note language="en">
          <div xmlns="http://www.w3.org/1999/xhtml">
            This parameter specifies the LogParser input format. For Job Scheduler log files
            this should be <em>TEXTLINEInputFormat</em>.
          </div>
        </note>
      </param>
      <param name="input_spec" default_value="[job scheduler main log]" required="true">
        <note language="de">
          <div xmlns="http://www.w3.org/1999/xhtml">
            Der Parameter spezifiziert die Eingabedateien, die mit LogParser verarbeitet werden sollen.
            Fehlt der Parameter, dann wird die aktuelle Protokolldatei des Job Schedulers verwendet.
          </div>
        </note>
        <note language="en">
          <div xmlns="http://www.w3.org/1999/xhtml">
            This parameter specifies input files that should be processed with LogParser.
            If this parameter is not given, then the current Job Scheduler log file will be used.
          </div>
        </note>
      </param>
      <param name="output_format" default_value="TSVOutputFormat" required="true">
        <note language="de">
          <div xmlns="http://www.w3.org/1999/xhtml">
            Der Parameter benennt das LogParser Ausgabeformat. Als Voreinstellung wird ein tabuliertes Textformat verwendet.
          </div>
        </note>
        <note language="en">
          <div xmlns="http://www.w3.org/1999/xhtml">
            This parameter specifies the LogParser output format. By default a tabulated text format is used.
          </div>
        </note>
      </param>
      <param name="output_spec" default_value="logs/[job name].csv" required="true">
        <note language="de">
          <div xmlns="http://www.w3.org/1999/xhtml">
            Der Parameter spezifiziert die Ausgabe für LogParser.
            <br/><br/>
            <ul>
              <li>Dateiname<br/><br/>
                Für Textformate ist dies der Name einer Ausgabedatei.
              </li>
              <li>Datenbankverbindung<br/><br/>
                Für Datenbankverbindungen ist dies der Name der Tabelle, die die Einträge aufnimmt.
              </li>
            </ul>
            <br/>
            Als Voreinstellung wird eine Ausgabedatei im <code>logs</code> Verzeichnis mit dem Namen des Jobs
            und der Endung <code>.csv</code> erzeugt.
          </div>
        </note>
        <note language="en">
          <div xmlns="http://www.w3.org/1999/xhtml">
            This parameter specifies the output for LogParser.
            <br/><br/>
            <ul>
              <li>filename<br/><br/>
                For text formats this this the name of the output file.
              </li>
              <li>database connection<br/><br/>
                For output to databases this is the name of table that imports the entries.
              </li>
            </ul>
            <br/>
            By default an output file with the name of the job and the extension <code>.csv</code>
            will be created in the <code>logs</code> directory.
          </div>
        </note>
      </param>
      <param name="output_connection" default_value="" required="false">
        <note language="de">
          <div xmlns="http://www.w3.org/1999/xhtml">
            Der Parameter spezifiziert die Verbindungszeichenfolge für eine Datenbankverbindung,
            falls das Ausgabeformat <code>SQLOutputFormat</code> verwendet wird,
            siehe Parameter <code>output_spec</code>.
          </div>
        </note>
        <note language="en">
          <div xmlns="http://www.w3.org/1999/xhtml">
            This parameter specifies the connect string for a database connection
            should the output format <code>SQLOutputFormat</code> have been used,
            see parameter <code>output_spec</code>.
          </div>
        </note>
      </param>
    </params>
  </configuration>

  <documentation language="de">
    <div xmlns="http://www.w3.org/1999/xhtml">
      Der Job zeigt wie die API Methoden des Microsoft LogParsers und des Job Schedulers zur
      Analyse oder Konvertierung von Protokollen eingesetzt werden.
      <br/><br/>
      Dieses Beispiel enthält Code zur Erzeugung von Ausgabe in CSV Dateien oder in einer Datenbank.
      <br/><br/>
      Dieser Job ist nur für Windows verfügbar und benötigt die Installation von VBScript
      ab Version 5.6 sowie von LogParser ab Version 2.2.
    </div>
  </documentation>

  <documentation language="en">
    <div xmlns="http://www.w3.org/1999/xhtml">
      This job shows how to use the API methods of Microsoft LogParser and of the Job Scheduler API
      for analysis or conversion of log files.
      <br/><br/>
      This sample implementation contains code to process output to csv files or to a database.
      <br/><br/>
      This job is available for Windows only and requires VBScript to be installed starting with version 5.6
      and of LogParser starting with version 2.2.
    </div>
  </documentation>
</description>
