UWS User Guide

Console Tool

In addition to the management tool a simple windows console tool will be provided too. This tool provides different functionality to control installed universal windows services. After the UWS is installed you could call it from your console line by typing the path of the installation directory (default would be C:\Program Files\CC-SE\Universal Windows Service\) and uwsManagement.exe for the console based management tool.

If the console tool will be started without any console line arguments then the following screen appears:

Config UWS

1. Install new service

You could register a new universal windows service which uses the installed uws.exe as executable. The following settings must or could be made: service name, display name and description of the new service.

Every service need an own XML configuration file where all settings are made. When the service was started it looks for a *.config file in the installation directory with the same name as it's service name.

For example: If your service has the service name "uws1" the service looks for a configuration file with name "uws1.config" at the installation directory.

The default values for service installation are the following. In addition to that the service will start automatically after the installation.

  • start type - Service will be installed as automatic service.

  • log on information - Service will be run under the local system account.

2. Uninstall existing service

Unregister the selected universal windows service as windows service from your system. Note that only the registry entry for the service will be deleted not the executable files in application directory. You have to give a valid service name.

3. List installed services

Show a simple list of all installed universal windows services and their states.

4. Delete all services

Unregister all installed universal windows services from your system. Note that only the registry entries will be deleted not the executable files in application directory.

5. Start service

Gives you the change to manually start a universal windows service. You have to give a valid name of an installed service.

6. Stop service

Similar to number 5 you could stop a universal windows service by entering a valid name of an installed service.

7. Send custom command

Send a custom command to a installed service, e.g. reload command which forces the service to reload configuration settings.

0. End program

Leaves the configuration programm.

uwsManagement.exe

But it is also possible to call the tool from console with different arguments so that no user interaction is necessary. The following command line arguments are supported:

Argument Description
install Install a new universal windows service. The following additional attributes are possible or necessary:

name - The name of the new service. A required attribute.

display - The display name of the new service. Also required.

desc - The description of the new service. A optional attribute.

uninstall Uninstall a registered universal windows service. The following additional attribute is necessary:

name - The name of a registered service.

list List all installed universal windows services.
deleteall Delete all installed universal windows services.
start Start an installed service. The following additional attribute is necessary:

name - The name of an installed service.

stop Stop an installed service. The following additional attribute is necessary:

name - The name of an installed service.

send Send a custom command to installed service. The following additional attribute are possible or necessary:

name - The name of an installed service. A required attribute.

cmd - The custom command which should be done. Also required. Select one of the following values:

reload - Force the service to reload configuration.

Note: There are two different ways to enter the name of a service or command string.

  • Enter name or command with own parameter:
  • uwsManagement /start /name=serv1

    uwsManagement /send /name=serv1 /cmd=reload

  • Enter name or command as action value:
  • uwsManagement /uninstall serv1

    uwsManagement /send serv1 /cmd reload