Legacy version Runtime command lines

Note: See Runtime command lines for more information on this subject.
Note: Returned code legend:
  • Exit status: Value returned by the COMBIVIS connect Runtime process following a command query.
Important: Except in Windows CE, always enter start "" /wait before any command lines in your COMBIVISconnectRuntime.exe file. This prevents the process from ending before an exit code is returned. For example: start "" /wait "<path>\COMBIVISconnectRuntime.exe" –remoteAccessServiceConnected.
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.
-remoteAccessServiceConnected

See the Runtime connection status. Enter echo %ERRORLEVEL% to view the Exit status.

Exit status:
  • 0: Runtime is not connected to the server
  • 1: Runtime is connected to the server
-remoteAccessSessionCount

See how many remote supervisors are connected to the Runtime from COMBIVIS connect. Enter echo %ERRORLEVEL% to view the Exit status.

Exit status:
  • N: Number of supervisors connected to the Runtime from COMBIVIS connect
-getanonymousid
Note: Mind all the lower case letters.

View the ID and password required to register a Runtime device to a domain. Enter echo %ERRORLEVEL% to view the Exit status.

Exit status:
  • -1: Runtime is not connected to the COMBIVIS connect servers
  • 0: The device is already registered to a domain
  • ID: The ID used for the domain registration
-getanonymouspassword
Note: Mind all the lower case letters.

View the ID and password required to register a Runtime device to a domain. Enter echo %ERRORLEVEL% to view the Exit status.

Exit status:
  • -1: Runtime is not connected to the COMBIVIS connect servers
  • 0: The device is already registered to a domain
  • Password: The password used for the domain registration.
-requestAssistance

Enable an assistance request. If The user must provide contact details when assistance is requested is enabled, you must provide three additional parameters that correspond to the fields Name, Contact information, and Description. Enter echo %ERRORLEVEL% to view the Exit status.

Exit status:
  • -1: Runtime is not connected to the COMBIVIS connect servers
  • 0: Error. The assistance request cannot be opened
  • 1: The assistance request opened correctly
-closeAssistance

Close an assistance request. Enter echo %ERRORLEVEL% to view the Exit status.

Exit status:
  • -1: Runtime is not connected to the COMBIVIS connect servers
  • 0: Error. The assistance request cannot be closed
  • 1: The assistance request closed correctly
-canRequestAssistance

Check if an assistance request can be opened. Enter echo %ERRORLEVEL% to view the Exit status.

Exit status:
  • -1: Runtime is not connected to the COMBIVIS connect servers
  • 0: The Runtime cannot open an assistance request
  • 1: The Runtime can open an assistance request
-quit

Disconnect Runtime when it is running.
-version

See the Runtime version.

Examples for Windows systems (except Windows CE)

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

Parameters Description
"<path>\COMBIVISconnectRuntime.exe" -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.
"\COMBIVISconnectRuntime.exe" -disconnect

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

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

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

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

Close the system keyboard.
"<path>\COMBIVISconnectRuntime.exe" -remoteAccessServiceConnected

See the Runtime connection status.

The example below shows a Runtime query that uses -remoteAccessServiceConnected with a .NET and VBScript.

var process = new Process();
var path = @"C:\Program Files (x86)\KEB\COMBIVISconnect\Runtime\COMBIVISconnectRuntime.exe";
process.StartInfo.FileName = path;
process.StartInfo.Arguments = "-remoteAccessServiceConnected";
process.StartInfo.CreateNoWindow = true;
process.StartInfo.UseShellExecute = false;
process.Start();
process.WaitForExit();
Console.WriteLine("Runtime is connected to Access Server? " + process.ExitCode);

set wshShell = CreateObject("WScript.Shell")
prog = "C:\Program Files (x86)\KEB\COMBIVISconnect\Runtime\COMBIVISconnectRuntime.exe"
prog = chr(34) & prog & chr(34)
prog = prog & " " & chr(45) & "remoteAccessServiceConnected"
strErrorCode = wshShell.run(prog,7,1)
WScript.Echo strErrorCode
"<path>\COMBIVISconnectRuntime.exe" -remoteAccessSessionCount

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

View the password value required to register a Runtime device to a domain.
"<path>\COMBIVISconnectRuntime.exe" -getanonymousid

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

Enquire Runtime about the server connection status. The return value is available in a environment variable called ERRORLEVEL.
"<path>\COMBIVISconnectRuntime.exe" -requestAssistance

Enable an assistance request. If The user must provide contact details when assistance is requested is enabled, you must provide three additional parameters that correspond to the fields Name, Contact information, and Description.

Example: "<path>\COMBIVISconnectRuntime.exe" -requestAssistance "John Doe" "john.doe@email.com" "A brief description of the problem"
"<path>\COMBIVISconnectRuntime.exe" -closeAssistance

Close an assistance request.
"<path>\COMBIVISconnectRuntime.exe" -getRequestAssistanceStatus

See an assistance request status.
"<path>\COMBIVISconnectRuntime.exe" -canRequestAssistance

Check if an assistance request can be opened.
"<path>\COMBIVISconnectRuntime.exe" -exportConnectionLog

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

Example: "<path>\COMBIVISconnectRuntime.exe" --exportConnectionLog --fromDate "2020-06-06" --toDate "2020-06-07" --outputDirectory "/tmp"
"<path>\COMBIVISconnectRuntime.exe" -quit

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

See the Runtime version.

Notes for Windows CE

For Windows CE systems, the executable file name is COMBIVISconnectRuntimeCE.exe.

The exit code is set to an environmental variable named ERRORLEVEL.