Running ELM applications as Windows Services

Running ELM applications as Windows services

Engineering Lifecycle Management applications can be configured to run as Windows services. This allows the applications to be run automatically (on Windows startup), and to be run in the background without having to use an administrative login session.

The server management scripts for WebSphere Liberty deployments of ELM have been enhanced to be able to register, unregister, start, and stop Windows services. Similar enhancements have also been performed for the Jazz Authorization Server (JAS) and the Distributed Cache Microservice (DCM) application.

ELM Script Options

The server.startup.bat script supports the following additional command options:

-registerWinService [serviceName]
-unregisterWinService [serviceName]
-startWinService [serviceName]
-stopWinService [serviceName]

If no serviceName value is specified, the default name clm along with Engineering Lifecycle Management(clm) is used. More than one service can be registered (for separate server installations that are using different port numbers) by specifying a unique serviceName for each service.

Once a service is registered with -registerWinService, open the clm windows service you recently created. By default the Local Service account is specified in the This account field on the Log On tab. If the Local Service account is not a valid account, you must replace it with a valid windows account which has the required permissions or select the Local System account option. You can manually start and stop the service using -startWinService and -stopWinService. You can also start and stop the service using the Windows Services app, and the service registration can be edited to change the startup type (for example, Automatic or Automatic (Delayed Start)).

The server.shutdown.bat script supports the following additional option:

You can stop a service using either server.shutdown.bat -service or server.startup.bat -stopWinService (or the Windows Services app).

JAS Script Options

The start-jazz.bat script for the Jazz Authorization Server supports the following additional command options:

-registerWinService
-unregisterWinService
-startWinService
-stopWinService

Since there is no requirement to run more than one JAS on the same server, there is no option to specify a service name; it is always jazzop.

The stop-jazz.bat script supports the following additional option:

You can stop JAS using either stop-jazz.bat -service or start-jazz.bat -stopWinService (or the Windows Services app).

DCM Script Options

The distributedCache.start.bat script supports the following additional command options:

-registerWinService [-name serviceName] [jreBinPath]
-unregisterWinService [-name serviceName] [jreBinPath]
-startWinService [-name serviceName] [jreBinPath]
-stopWinService [-name serviceName] [jreBinPath]

More than one DCM service can be registered by specifying unique service names (for separate installations using different port numbers). You can use the -name option to distinguish the serviceName argument from the jreBinPath argument, which is required if the DCM installation area has been moved from the default location (server\clustering\cache in a JTS deployment). The default service name is dcm.

The distributedCache.stop.bat script supports the following additional option:

You can stop the DCM using either distributedCache.stop.bat -service or distributedCache.start.bat -stopWinService (or the Windows Services app).

When any of the commands are executed to register, unregister, start, or stop Windows services, information specific to the operation are written to a log file named commons-daemon.<date>.log, in the logs folder for the server. If any problems are encountered when running one of the services commands, additional information is stored in the log file.