====== CommandClient ======

Die **eBiss.CommandClient.exe** erlaubt es verschiedene Kommandos oder Jobs per Kommandozeilen-Modus((Command Line, DOS-Eingabeaufforderung)) zu starten((Wichtig: Den CommandClient als Administrator ausführen)).

<code>
eBiss.CommandClient.exe --<parameter>
</code>
Mögliche Parameter für den eBiss.CommandClient sind:
^CommandClient Parameter Name ^ Funktion ^
|**ShowHelp**|startet und öffnet die eBiss Hilfe|
|**StopHelp**|beendet die eBiss Hilfe|
|**GetServerState**|Liefert die ausgeführten und aktuell laufenden Jobs und die aktiven Client Sitzungen|
|**SmoothShutdown**|"Reibungslose Herunterfahren des eBiss-Dienstes": Beim reibungslosen Herunterfahren werden zuerst alle Automatisierungen angehalten und dann bis zu 30 Minuten auf das Beenden der laufenden Jobs gewartet. Sollten nach 30 Minuten noch Jobs laufen, dann werden diese abgebrochen und der Dienst beendet|
|**RunJob (/r) "Jobname"**|startet einen Job|
|**node "Node Oid"**|Ein Unterknoten, in dem der Job ausgeführt werden soll (Change Node in Place). Hierzu muss der Job öffentlich sein.|
|**HelpService** <Methode>|speziell für den Hilfe-Dienst gedacht, siehe [[#ebiss_commandclient_-_hilfe_installieren|Hilfe installieren]]|

**Beispiel**: <code>eBiss.CommandClient.exe --SmoothShutdown</code>

====== eBiss CommandClient - Hilfe installieren ======

__Der CommandClient sollte als Administrator aufgerufen werden.__
Wenn Sie die Hilfe als Dienst laufen lassen, dann sollte die Hilfe nicht auf der lokalen IP (nicht auf 127.0.0.1) konfiguriert sein.

<code>
eBiss.CommandClient.exe --HelpService <Methode>
</code>
Mögliche Optionen für die Methode:

^Methode Name ^ Funktion ^
|**Install**| installiert den eBissHelpService Dienst|
|**Uninstall**| Deinstalliert den eBissHelpService Dienst|
|**Start**| Startet den Dienst|
|**Stop**| Hält den Dienst an|



====== eBiss CommandClient - Anwendungsbeispiel ======

Nachfolgend erfahren Sie anhand von Anwendungsbeispielen wie Sie den CommandClient verwenden könnten.

==== Voraussetzungen ====
  - Der eBiss.Service muss aktiv sein.
  - Die Konfig Datei //"eBiss.CommandClient.exe.config"// muss vorhanden sein. Konfigurationsbeispieldatei s.u.
  - Die Jobs des eBiss-Workflows müssen vorhanden und lauffähig sein.

====Job aus der Kommandozeile starten ====

  - Windows Start -->Ausführen --> cmd --> Kommando-Dialog öffnet.
  - Zum eBiss-Verzeichnis navigieren und folgendes Kommando eingeben um den benannten Job //JobName// zu starten:<code>eBiss.CommandClient.exe /r:JobName</code>

**Beispiele:**
<code>eBiss.CommandClient.exe /r:Import_Articles</code>
<code>eBiss.CommandClient.exe /r:"Hole von Extern"</code>
Ausführen vom Job im Unterknoten.
<code>eBiss.CommandClient.exe /r:"Hole von Extern" /node:ff407aac-4174-44bb-aa21-9c59a1a802bf</code>

Bitte beachten, falls Leerzeichen im Jobnamen vorhanden sind, müssen Anführungszeichen **(")** verwendet werden.

====eBiss Hilfe aus der Kommandozeile administrieren ====
Installiert den eBiss Help Service auf Ihrem System:
<code>eBiss.CommandClient.exe --HelpService Install </code>

Stoppt den aktuell laufenden eBiss Help Service
<code>eBiss.CommandClient.exe --HelpService Stop</code>

Deinstalliert den eBiss Help Service
<code>eBiss.CommandClient.exe --HelpService Uninstall</code>

==== Konfigurationsbeispieldatei ====

<code>
<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <appSettings>
    <add key="eBiss.ServerURL" value="tcp://127.0.0.1:9999/eBiss.ApiServer" />
    <add key="eBiss.Client.AutoUser" value="Admin" />
    <add key="eBiss.Client.AutoPass" value="Password" />
  </appSettings>
</configuration>
</code>