Kommandozeilentool¶
Mit dem Kommandozeilentool startest du vorbereitete Jobs ganz einfach aus einem Skript oder durch einen Scheduler ohne grafische Oberfläche.
Du startest dabei diese Anwendung folgendermassen:
FileSystemWorkerCommand.exe c:\Jobs\ExampleJob.fswj
Startest du die Anwendung so, wird der angegebene Job ausgeführt als hättest du im Editor den Run Knopf gedrückt.
Optionen¶
Die Applikation versteht die folgende Optionen:
- -h, --help¶
Gibt du diese Option an, werden dir alle möglichen Optionen auf der Konsole angezeigt. Schau dir Kapitel Hilfe Anzeigen für alle Details dazu an.
- --output-mode=<mode>, -o=<mode>¶
Damit steuerst du, wie und ob Ausgaben auf der Konsole angezeigt werden. Schau dir Kapitel Konsolen Ausgabe Steuern für alle Details dazu an.
- --parameter=<parameter>, --param=<parameter>, -p=<parameter>¶
Mit dieser Option kannst du Parameter an den Job übergeben welche du dort als Platzhalter verwenden kannst. Schau dir Kapitel Parameter Übergeben für alle Details dazu an.
Hilfe Anzeigen¶
Mit der --help
Option kannst du dir jederzeit eine Übersichtsseite mit allen möglichen Optionen anzeigen. Diese Ausgabe kann beispielsweise so aussehen:
c:\> FileSystemWorkerCommand.exe --help
FileSystemWorkerCommand.exe [options] {jobFile}
Options:
--config-dir=... [list]
Add another directory to scan for configuration files.
--config-file=... [list]
Add another configuration file to parse.
--help, -h [boolean value]
Displays help about command line arguments.
--license-activate=... [string value]
Activate the application online with the given code.
--license-auto-reactivate [boolean value]
Check if the license is about to expire and automatically reactivate it with the last used code.
--license-deactivate [boolean value]
Deactivate the application.
--license-help [boolean value]
Display all available command line options for the license system.
--license-import=... [string value]
Import a license file from an offline activation. Specify the path to the file for the import.
--license-offline [boolean value]
Display the URL for a manual offline activation.
--license-offline-qrc [boolean value]
Display a QRC for a manual offline activation.
--license-reactivate [boolean value]
Reactivate the application online with the last used code.
--license-status [boolean value]
Display the current status of the license.
--license-status-json [boolean value]
Display the current status of the license in parseable JSON format.
--output-mode=..., -o=... [string value]
The mode for the console output.
--param=..., --parameter=..., -p=... [list]
A custom parameter which can be used in placeholders of the job.
Die hier gezeigte Ausgabe kann von der dir angezeigten abweichen. Sie dient lediglich der Illustration.
Konsolen Ausgabe Steuern¶
Mit der Option --output-mode
steuerst du die Ausgabe von Log-Nachrichten auf der Konsole. Die Option erwartet eine der folgenden Bezeichner als Wert:
Bezeichner |
Beschreibung |
---|---|
|
Schaltet jede Ausgabe auf der Konsole ab. Diese Option ist ideal, wenn du das Kommandozeilentool aus einem Skript oder durch den Scheduler aufrufst. |
|
Zeigt Informationen, Warnungen und Fehler auf der Konsole an. Dies ist die Vorgabe, wenn du die Option weglässt. |
|
Entspricht |
|
Zeigt zusätzlich auch Trace Meldungen auf der Konsole an. |
|
Entspricht |
Parameter Übergeben¶
Mit der --parameter
Option kannst du deinem Job Werte über die Kommandozeile übergeben. Dabei gibst du als Wert eine Kombination eines Parameternamens und dessen Wert an. Das sieht beispielsweise so aus:
c:\> FileSystemWorkerCommand.exe -p=file:example.txt -p=start:2021-01-01 MyJob.fswj
Der Aufbau des Werts hinter der Option entspricht dem folgenden Format:
--parameter=<Name>:<Wert>
Beachte dabei, dass der <Wert>
keine Leerzeichen erhalten darf. Falls du in diesem Wert Leerzeichen verwenden möchtest, musst du diesen auf der Kommandozeile in Anführungszeichen setzen:
c:\> FileSystemWorkerCommand.exe "-p=text:Text with Spaces" MyJob.fswj
Den Bezeichner welchen du als <Name>
angibst, kannst du in deinem Job mit dem Platzhalter ●[cp|<Name>]●
verwenden. Du findest alle Details dazu im Kapitel Platzhalter Referenz.