Konfigurationsdatei

Überblick

Das Verhalten von Diagnostics lässt sich mithilfe einer externen Konfigurationsdatei im XML-Format parametrisieren. Diese benutzerspezifische Konfigurationsdatei kann dann beim Start des Programms geladen werden. Im Anschluss daran, sind diese Einstellungen verfügbar. Die Datei wird von Diagnostics gelesen, jedoch nie geschrieben.

Struktur

Die Datei ist im XML-Format strukturiert (http://www.xml.org) und muss die Codierung ISO-8859-1 enthalten. Dadurch können jederzeit in einem einfachen Texteditor Sonderzeichen (z. B. Umlaute wie ä, ö und ü) eingegeben werden.

Der Stammknoten heißt <config>. Weitere Unterknoten werden im Abschnitt Parameter beschrieben.

Eine typische Konfigurationsdatei wie unten dargestellt enthält zwei Einträge: autofilesave­filename und defaultfilesavedirectory. Beide Einträge sind als Gruppe unter dem übergeordneten Knoten fileoptions angesiedelt:

<?xml version="1.0" encoding="ISO-8859-1" ?>
<config>
    <fileoptions>
        <autofilesavefilename>
            <![CDATA[Diagnostics_<date>_<counter>.pdi]]
        </autofilesavefilename>
        <defaultfilesavedirectory>
            c:\temp\Diagnostics
        </defaultfilesavedirectory>
    </fileoptions>
</config>

Alle Änderungen an der XML-Datei müssen XML-konform sein. Andernfalls kann die Datei nicht geladen werden. Beim Starten von Diagnostics wird ggf. in einer entsprechenden Diagnose­meldung darauf hingewiesen. In dieser Meldung werden die Zeile und die Spalte mit ungültigem Code genannt. Daraufhin wird das Programm ohne die ungültige Konfigurationsdatei gestartet.

Aufruf

Für das Laden der gewünschten Konfigurationsdatei gibt es zwei Möglichkeiten:

oAutomatisch:

Wenn im Startverzeichnis von Diagnostics eine Datei mit dem Namen Diagnostics.config.xml vorhanden ist, wird diese beim Start automatisch geladen. Das Programm verwendet dann die enthaltenen Einstellungen während des Betriebs.

oManuell:

Sie können die Konfigurationsdatei auch explizit über die Befehlszeile von einem anderen Speicherort im Dateisystem aus laden. Dies hat Vorrang vor einem automatischen Aufruf.

Sie können dazu folgende Syntax in der Befehlszeile verwenden:

-userconfigfile <file name>.

In diesem Fall wird die als <file name> eingegebene Konfigurationsdatei geladen.

Parameter

Die einzelnen Parameter werden an der Stelle beschrieben, an der sie in der Konfigurationsdatei Diagnostics.config.xml erscheinen. Es sind auch Anwendungsbeispiele enthalten. Da sich diese Datei im Programmverzeichnis befindet, können Sie sie ohne Weiteres als Vorlage verwenden.

Darüber hinaus werden die Parameter erneut im Detail beschrieben. Die Parameter werden als XML-Pfade aufgeführt, die deren spezifische Position innerhalb der XML-Datei beschreiben.

Parameter config/fileoptions/autofilesavefilename

Beim Speichern einer Datei kann automatisch ein Dateiname generiert werden. Der Dateiname kann konstante Namenselemente, aktuelle Werte (z. B. das Datum oder den Maschinennamen) und einen Zähler enthalten. Der automatisch generierte Name wird dann als Vorschlag angegeben, beispielsweise im Dialogfeld Speichern unter. Dieser kann übernommen oder überschrieben werden.

Zur Beschreibung des automatisch generierten Namens können Text und Platzhalter verwendet werden.

Beispiel

Aus Diagnostics_date=<date>.pdi ergibt sich der Dateiname Diagnostics_date=2006-03-12.pdi (Das aktuelle Datum wird verwendet.)

Schreiben Sie den Platzhalter in Kleinbuchstaben. Das bedeutet, dass <date> gültig ist, <Date> hingegen nicht erkannt wird.

Der neu erstellte Dateiname kann Zeichen enthalten, die vom Dateisystem nicht unterstützt werden (wenn der Maschinenname z. B. Meine?Maschine lautet). Diese Zeichen werden durch ein kleines x ersetzt.

Beispiel

My?File.pdi wird durch MyxFile.pdi ersetzt.

Die folgenden acht Zeichen werden vom Dateisystem nicht unterstützt und daher ersetzt:

\/:*?"<>|

Die Beschreibung (mit Platzhaltern) des zu generierenden Namens umfasst XML-Sonderzeichen, die nicht einfach in eine XML-Datei geschrieben werden können. Aus diesem Grund muss die Beschreibung in einen CDATA-Abschnitt integriert werden.

Beispiel

Diagnostics_<date>.pdi muss in <!CDATA[Diagnostics_<date>.pdi]] geändert werden, um in die XML-Datei eingefügt werden zu können.

Beispiel für eine Beschreibung eines Dateinamens mit Sonderzeichen, in einen CDATA-Abschnitt integriert:

<?xml version="1.0" encoding="ISO-8859-1" ?>
<config>
  <fileoptions>
    <autofilesavefilename>
      <![CDATA[Diagnostics_<date>.pdi]]
    </autofilesavefilename>
  </fileoptions>
</config>>

Platzhalter

Platzhalter sind von eckigen Klammern umgeben. Sie müssen manuell eingegeben werden. Die nachstehende Liste enthält die möglichen Platzhalter:

o<date>

Aktuelles Datum:

Format: yyyy-MM-dd 

Beispiele

1999-12-01

2006-03-21

o<time>

Aktuelle Uhrzeit im 24-Stunden-Format:

Format: HH-mm-ss 

Beispiele

07-41-29 

19-41-29 

o<counter>

Der Zähler ist eine Ausnahme. Zuerst wird der Platzhalter <counter> im Dateinamen durch eine Zahl ersetzt, beginnend mit 1. Daraus ergibt sich z. B. der Dateiname Diagnostics_1.pdi. Dann wird geprüft, ob dieser Dateiname bereits im gleichen Verzeichnis vorhanden ist. Ist das der Fall, dann wird der Zähler um 1 erhöht und der Process wiederholt, bis keine Datei mit demselben Namen mehr gefunden wird.

o<username>

Entspricht Benutzer im Dialog Maschineninformation.

o<machinename>

Entspricht Name der Maschine im Dialog Maschineninformation.

o<hardwarecode>

Entspricht Hardwarecode der Steuerung im Dialog Maschineninformation.

Beispiele von Aufrufen mit möglichen Ergebnissen

Parameter config/fileoptions/defaultfilesavedirectory

Der Parameter config/fileoptions/defaultfilesavedirectory definiert das Standard­verzeichnis, das beim Öffnen des Dialogfelds Speichern unter zuerst angezeigt wird. Sie können das Verzeichnis nach Bedarf ändern und die Datei speichern.

HINWEIS: Wenn Sie das Dialogfeld Speichern unter erneut aufrufen, wird allerdings wieder das als <defaultfilesavedirectory> angegebene Verzeichnis angezeigt.

Im folgenden Beispiel wird c:\temp\Diagnostics als Standardverzeichnis definiert:

<?xml version="1.0" encoding="ISO-8859-1" ?>
<config>
     <fileoptions>
        <defaultfilesavedirectory>
           c:\temp\Diagnostics
        </defaultfilesavedirectory>
    </fileoptions>
</config>>