Runtime command lines

You can launch the COMBIVISconnectRuntimeCli program by entering some comman lines in your command prompt.

The COMBIVISconnectRuntimeCli is available for COMBIVIS connect Runtime starting from version 11.10. Use the COMBIVISconnectRuntime.exe file for Runtime versions older than 11.10.
Note: See Legacy version Runtime command lines for more information on this subject.
Note: Command line parameters are only supported on the following systems: Windows, except for Windows CE and Windows XP.
Note: Returned code legend:
  • Standard output: Output information following a comman line entry.
  • Exit status: The command entered in the COMBIVISconnectRuntimeCli file was run successfully and is printed in the Logs.
Parameters Description
--connect

Connect Runtime to the COMBIVIS connect servers when Runtime is already running but disconnected. Runtime connects automatically by default, unless you have not entered the --disconnect command line.
--disconnect

Disconnect Runtime from the COMBIVIS connect servers. Connection to the remote assistance service is not possible.
--showChat

Open the assistance chat window.
--hideChat

Hide the assistance chat window.
--showKeyboard

Open the system keyboard.
--hideKeyboard

Close the system keyboard.
--openWebUI

Open Windows Runtime through a web page.
--remoteAccessServiceConnected

See the Runtime connection status.

Standard output:
  • 0: Runtime is not connected to the server
  • 1: Runtime is connected to the server
Exit status:
  • 0: The command entry is successful
  • 1: The connection to the Runtime is unsuccessful
--remoteAccessSessionCount

See the quantity of remote supervisors that are connected to the Runtime from COMBIVIS connect.

Standard output:
  • N: Number of supervisors connected to the Runtime from COMBIVIS connect.
Exit status:
  • 0:The command entry is successful
  • 1: The connection to the Runtime is unsuccessful
--getanonymousID

View the ID and password required to register a Runtime device to a domain.

Exit status:
  • 0: The command entry is successful
  • 1: The connection to the Runtime is unsuccessful
  • 2: Runtime is not connected to the COMBIVIS connect servers
  • 3: The device is already registered to a domain.
--exportConnectionLog
Export connection logs. Indicate the logs parameters --fromDate, --toDate and --outputDirectory.
Note: If you select an invalid date range, the exported logs return zero results.
Exit status:
  1. 0: The command entry is successful
  2. 1: The connection to the Runtime is unsuccessful
  3. 2: The connection logs export is unsuccessful
--setRuntimePassword followed by the <password> that you want to set up.

Configure a password to access Windows Runtime.

Exit status:
  1. 0: The password setup is successful
  2. 1: You do not have the user rights to change the password
  3. 2: The password does not meet the security compliance standards
--unsetRuntimePassword

Remove a previously set password to access Windows Runtime

Exit status:
  1. 0: The password is successfully removed
  2. 1: You do not have the user rights to change the password
--quit

Disconnect Runtime when it is running.
--version

See the Runtime version.
-h, --help

See the list of the currently available commands.

Examples

The path identifies the Runtime installation path. For example: C:\Program Files (x86)\KEB\\Runtime\.

Parameters Description
"<path>\COMBIVISconnectRuntimeCli" --connect

Connect Runtime to the COMBIVIS connect servers when Runtime is already running but disconnected. Runtime connects automatically by default, unless you have not entered the --disconnect command line.
"\COMBIVISconnectRuntimeCli" --disconnect

Disconnect Runtime from the COMBIVIS connect servers. Connection to the remote assistance service is not possible.
"<path>\COMBIVISconnectRuntimeCli" --showChat

Open the assistance chat window.
"<path>\COMBIVISconnectRuntimeCli" --hideChat

Hide the assistance chat window and disconnect Runtime from the remote assistance service.
"<path>\COMBIVISconnectRuntimeCli" --showKeyboard

Open the system keyboard.
"<path>\COMBIVISconnectRuntimeCli" --hideKeyboard

Close the system keyboard.
"<path>\COMBIVISconnectRuntimeCli" --openWebUI

Open Windows Runtime through a web page.
"<path>\COMBIVISconnectRuntimeCli" --remoteAccessServiceConnected

See the Runtime connection status.

"<path>\COMBIVISconnectRuntimeCli" --remoteAccessSessionCount

See the quantity of remote supervisors that are connected to the Runtime from COMBIVIS connect.
"<path>\COMBIVISconnectRuntimeCli" --getanonymousID

View the ID and password required to register a Runtime device to a domain. The following example shows how to query the Runtime through the --getAnonymousID parameter by using .NET:

var process = new Process();
process.StartInfo.FileName = @"C:\Program Files (x86)\KEB\COMBIVISconnect\Runtime\COMBIVISconnectRuntimeCli.exe";
process.StartInfo.Arguments = "--getAnonymousID";
process.StartInfo.CreateNoWindow = true;
process.StartInfo.RedirectStandardOutput = true;
process.StartInfo.UseShellExecute = false;
process.StartInfo.WindowStyle = ProcessWindowStyle.Hidden;
process.Start();
process.WaitForExit();
Console.WriteLine("AnonymousID, Password: " + process.StandardOutput.ReadToEnd());
Console.WriteLine("exit code: " + process.ExitCode);
Console.ReadLine();
"<path>\COMBIVISconnectRuntimeCli" --exportConnectionLog

Export connection logs. Indicate the logs parameters --fromDate, --toDate and --outputDirectory.

Example: "<path>\COMBIVISconnectRuntimeCli" --exportConnectionLog --fromDate "2020-06-06" --toDate "2020-06-07" --outputDirectory "/tmp"
"<path>\COMBIVISconnectRuntimeCli" --setRuntimePassword

Configure a password to access Windows Runtime. For example:

"<path>\COMBIVISconnectRuntimeCli" --setRuntimePassword <password>
"<path>\COMBIVISconnectRuntimeCli" --unsetRuntimePassword Remove a previously set password to access Windows Runtime.
"<path>\COMBIVISconnectRuntimeCli" --quit

Disconnect Runtime when it is running.
"<path>\COMBIVISconnectRuntimeCli" --version

See the Runtime version.
"<path>\COMBIVISconnectRuntimeCli" -h, \COMBIVISconnectRuntimeCli" --help

See the list of the currently available commands.