Program Execution

The program can be run as a console application or as a Windows service. In both cases, start the application file xSuiteInterface5.exe from the program directory.

As a minimum, the application file requires access to the global configuration data (see Data Format and Data Sources) with general program settings. Only files are supported as the source of the data. By default, a configuration file is searched for directly in the program directory under the same name as the EXE file but, depending on the file type, with a different extension such as .json or .ini/.cfg (e.g., xSuiteInterface5.json).

For projects that are structurally more complex, the configuration file is usually located in a separate folder. Therefore, specify the path to the global configuration file (folder and file name) explicitly as a call parameter of the EXE file:

xSuiteInterface.exe /ConfigFile "{configuration file path}"

The path of the folder of the EXE file to be executed can be specified as either absolute or relative.

If the program is to be run as a Windows service, it must be registered as a Windows service. If it has not been registered via the base configuration during installation, you can register it using the regular Windows command line tool sc.exe. Start the command prompt with administrative privileges. The command might look like the following (this being the simplest case):

sc.exe create "{service name}" binPath= "{.exe path}"

If the parameter with the reference to the configuration file is to be specified here too, enclose the values binPath and ConfigFile in quotation marks, in their entirety, in the order shown below. Write embedded quotes with a backward slash (\"):

sc.exe create "{service name}" binPath= "\"{.exe path}\" /ConfigFile \"{configuration file path}\""

For information on additional options for the sc.exe tool (e.g., specifying the service account and startup type) (see sources such as https://docs.microsoft.com/de-de/windows-server/administration/windows-commands/sc-create). Alternative to setting these up at this stage, such settings can also be adjusted later via the Windows Service Control interface.

Regardless of the execution type, starting the program with the rights of a (local) administrator account is mandatory.