Aufbau Eines Kommandoskripts - Stober SC6 Handbuch

STÖBER
20.6.7.2

Aufbau eines Kommandoskripts

Das Skript ist im JSON-Datenformat (*.json) mit Kodierung UTF-8 mit BOM aufgebaut. Eine Einführung zu JSON finden Sie
unter:
https://www.json.org/json-de.html
Information
Nutzen Sie für die Erstellung eines Skripts für die DriveControlSuite einen JSON-Editor wie JSON Editor Online, JSONViewer
oder Visual Studio Code.
Es werden im Skript drei Datentypen gemäß dem Standard JSON RFC-7159 benutzt:
§ Boolean
§
String
§ Integer
Das Skript ist in die drei Abschnitte "settings", "sequence" und "commands" gegliedert.
20.6.7.2.1 Settings
In diesem Abschnitt können übergreifende Einstellungen für das Skript definiert werden. Der gesamte Abschnitt ist
optional. Entfällt er, wird keine Log-Datei erstellt und die DriveControlSuite wird nach Ausführen des Skripts nicht beendet.
Attribute
§ "logFilePath": Pfad zur Log-Datei, <optional> <String>
§ "quitWhenDone": Verhalten der DriveControlSuite nach Ablauf der Verarbeitung, <optional> <String>
Beispiel
"setting": {
"logFilePath": "%COMMANDFILE%/LoadNewConfig.log",
"quitWhenDone": "never"
},
Angabe einer Log-Datei (logFilePath)
In einer Log-Datei wird der Ablauf in chronologischer Reihenfolge protokolliert. Sofern eine Datei angegeben wird, wird das
Skript nur gestartet, wenn diese Datei erfolgreich angelegt werden kann. Im Attribut logFilePath wird der Name der
anzulegenden Datei angegeben. Die Angabe kann entweder als absolutes Verzeichnis oder relativ zum Kommandoskript-
Verzeichnis
(%COMMANDFILE%)
kann der Dateiname um den aktuellen Zeitstempel erweitert werden. Der Zeitstempel wird in der Form
%TIMESTAMP%
YYYYMMDD-hhmmss übergeben.
Beenden nach Abschluss (quitWhenDone)
quitWhenDone kann drei Werte zugewiesen bekommen, die das Verhalten nach Abschluss des Skripts bestimmen.
"never"
"noErrors"
"always"
erfolgen. oder dienen als Trennzeichen des Pfades. Durch die Angabe
\\ /
DriveControlSuite bleibt nach Skriptende geöffnet (Default-Einstellung).
DriveControlSuite wird nach Skriptende geschlossen, sofern keine Fehler aufgetreten sind.
DriveControlSuite wird nach Skriptende in jedem Fall geschlossen.
20 | Anhang
297