Try OpenEdge Now
skip to main content
Administration Guide
TCMAN Reference : Server actions : Register and manage an instance as a Windows service (service)
 

Register and manage an instance as a Windows service (service)

Purpose

(Windows only) Registers or unregisters an instance as a Windows service. After an instance is registered, you can start, stop, or check the status of the service with this action.
Note: Before you register an instance as a Windows service, you must install JDK 1.8 (for example, jdk1.8.0_66) and set the environment variable JAVA_HOME=C:\Program Files\Java\jdk1.8.0_66.

Syntax

tcman.bat service [general_options]alias_name { register | unregister | start | stop | status }

Parameters

general_options
Specify one or more of the general TCMAN options. Run tcman.bat help service to see which general options are appropriate.
alias_name
A required parameter that specifies the name of a PAS instance that was created using tcman create.
register
Create a new Windows service that runs the named PAS instance alias_name..
Set the PR_DISPLAYNAME and/or PR_DESCRIPTION variables to change the display name and description of the PAS instance service that appears in the Windows Service utility (Services tab of the Task Manager). The defaults for these variables are:
Variable
Default
PR_DISPLAYNAME
Progress Application Server alias_name
PR_DESCRIPTION
Progress Application Server (Tomcat 7) – http://www.progress.com
Set these variables before you register the instance. For example, if you wanted to change the defaults for oepas1:
set PR_DISPLAYNAME=PAS ROOT Server
set PR_DESCRIPTION=Progress Application Server
tcman service oepas1 register
unregister
Delete the Windows service that runs the named PAS instance alias_name
start
Start the Windows service that corresponds to the named PAS instance alias_name. The Windows service may also be started using the Windows service console or the SC command line utility.
stop
Stop the Windows service that corresponds to the named PAS instance alias_name. The Windows service may also be stopped using the Windows service console or the SC command line utility.
status
The registration status of the Windows service corresponding to the named PAS instance alias_name. The Windows service's status may be monitored using the Windows service console or SC command line utility

Example

Register the default instance oepas1 as a Windows, then start, check status, stop, and unregister:
tcman service oepas1 register
oepas1 service is registered

tcman service oepas1 start
oepas1 started

tcman service oepas1 status
Service oepas1 is running

tcman service oepas1 stop
oepas1 is stopped

tcman service oepas1 unregister
oepas1 is unregistered

Note

Be sure that the instance is not running before you attempt to register/unregister it.