eBiss 3

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
======= CommandClient ======

The **eBiss.CommandClient.exe** allows to start different commands or jobs via command line mode((Command Line, DOS prompt))((Important: Running the CommandClient as administrator)).

<code>
eBiss.CommandClient.exe --<parameter>
</code>
Possible parameters for the eBiss.CommandClient are
^CommandClient Parameter Name ^ Function ^
|**ShowHelp**|starts and opens the eBiss Help|
|**StopHelp**|Stop the eBiss help|
|**GetServerState**|Retrieves the executed and currently running jobs and the active client sessions
|**SmoothShutdown**|"Smooth shutdown of the eBiss Service": during a smooth shutdown, all automations are first paused, and the system then waits up to 30 minutes for running jobs to complete. If any jobs are still running after 30 minutes, they are aborted and the service is terminated|
|**RunJob (/r) "Job Name "**|starts a job|
|**node "Node Oid"**|A sub node in which the job should be statet (Change Node in Place). The job must be public for doing this|
|**HelpService** <Method>|specially designed for the help service, see [[#ebiss_commandclient_-_help_install|help]]|

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

====== eBiss CommandClient - Install Help ======

__The CommandClient should be called as administrator. __
If you run the help as a service, then the help should not be configured on the local IP (not 127.0.0.1).

<code>
eBiss.CommandClient.exe --HelpService <Method>
</code>
Possible options for the method:

^Method Name ^ Function ^
|**Install**| installs the eBissHelpService service
|**Uninstall**| Uninstalls the eBissHelpService service
|**Start**|Start the service|
|**Stop**|| Stops the service|



====== eBiss CommandClient - Application example ======

In the following you will learn how to use the CommandClient by means of application examples.

==== Prerequisites ====
  - The eBiss.service must be active.
  - The config file //"eBiss.CommandClient.exe.config"// must exist. For a Configuration sample file see below.
  - The jobs of the eBiss workflow must be available and executable.

====start job from the command line ====

  - Windows Start --> Run --> cmd --> Command dialog opens
  - Navigate to the eBiss directory and enter the following command to start the named job //JobName//:<code>eBiss.CommandClient.exe /r:JobName</code>

**Examples.

<code>eBiss.CommandClient.exe /r:Import_Articles</code>
<code>eBiss.CommandClient.exe /r: "Get from outside"</code>
Run job in a sub node, for this the Job 'Get from outside' must be public:
<code>eBiss.CommandClient.exe /r:"Get from outside" /node:ff407aac-4174-44bb-aa21-9c59a1a802bf</code>

Please note, if there are spaces in the job name, quotation marks **(")** must be used.

====administer eBiss help from the command line ===
Installs the eBiss Help Service on your system
<code>eBiss.CommandClient.exe --HelpService Install </code>

Stops the currently running eBiss Help Service
<code>eBiss.CommandClient.exe --HelpService Stop</code>

Uninstalls the eBiss Help Service
<code>eBiss.CommandClient.exe --HelpService Uninstall</code>

==== Configuration sample file ====

<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>
eBiss 3

User Tools

Site Tools

Page Tools
