LibertyProfileAsService < Deployment

<div id="header-title" style="padding: 10px 15px; border-width:1px; border-style:solid; border-color:#FFD28C; background-image: url(<nop>https://jazz.net/wiki/pub/Deployment/WebPreferences/TLASE.jpg); background-size: cover; font-size:120%">
---+!! Running Engineering Lifecycle Management Applications as Microsoft Windows services <img src="https://jazz.net/wiki/pub/Deployment/WebPreferences/new.png" alt="new.png" width="50" height="50" align="right"> 
%DKGRAY% Authors: Main.JohnVasta (current version); Main.ShubjitNaik, Main.ShradhaSrivastav (historical versions) <br>
Build basis: IBM CLM Version 6.0.6
%ENDCOLOR%</div></sticky>

<!-- Page contents top of page on right hand side in box -->
<sticky><div style="float:right; border-width:1px; border-style:solid; border-color:#DFDFDF; background-color:#F6F6F6; margin:0 0 15px 15px; padding: 0 15px 0 15px;">
%TOC{title="Page contents"}%
</div></sticky>

<sticky><div style="margin:15px;"></sticky>
%BR% The next release of Engineering Lifecycle Management (ELM) after 7.0 (currently designated 7.0.1) will include support for [[https://jazz.net/jazz/resource/itemName/com.ibm.team.workitem.WorkItem/495556][running ELM applications as Windows services]]. Prior to that release, it is possible to update a 6.0.6 or later release with the scripts attached to this wiki page to get the same capability. The scripts use the [[http://commons.apache.org/proper/commons-daemon/procrun.html][Apache Procrun]] tool that is included with the Liberty server image.

%BR%%BR% 
=DISCLAIMER: These scripts should be considered "pre-release", since they are not yet available in any existing release. They have not undergone the level of testing that will be done when they are in a release.= </br>

---+++ Prerequisites and Assumptions
   * CLM/ELM version 6.0.6 or later is installed on Windows.
   * The CLM/ELM applications are deployed in a Liberty profile. The Distributed Cache Microservice (DCM) is also supported; it is always deployed in a Jetty server.
   * This topic assumes that there are no existing Windows services for CLM/ELM applications. If there are, they should be removed first.

The Jazz Authorization Server (JAS) is also supported.

---+++ Download the attached scripts

The scripts attached to this wiki page should be downloaded and then should replace the existing scripts in your installation.

%ICON{warning}% *NOTE:* If you have customized your existing server scripts, then the same customizations must be done to the downloaded replacement scripts (for example, to increase the Java heap size).

Replace the existing scripts with the downloaded scripts in these locations:

| *Script name* | *Installed location* |
| [[%ATTACHURL%/server.startup.bat][server.startup.bat]] | !JazzTeamServer\server |
| [[%ATTACHURL%/server.shutdown.bat][server.shutdown.bat]] | !JazzTeamServer\server |
| [[%ATTACHURL%/liberty.server.bat][liberty.server.bat]] | !JazzTeamServer\server |
| [[%ATTACHURL%/start-jazz.bat][start-jazz.bat]] | !JazzAuthServer |
| [[%ATTACHURL%/stop-jazz.bat][stop-jazz.bat]] | !JazzAuthServer |
| [[%ATTACHURL%/distributedCache.start.bat][distributedCache.start.bat]] | cache |
| [[%ATTACHURL%/distributedCache.stop.bat][distributedCache.stop.bat]] | cache |

<BR>
Notes:

   1. *JazzTeamServer* refers to the installation root for a CLM/ELM deployment (e.g. C:\Program Files\IBM\JazzTeamServer)
   1. *JazzAuthServer* refers to the installation root for a JAS deployment (e.g. C:\Program Files\IBM\JazzAuthServer)
   1. *cache* refers to the installation root for a DCM deployment. By default, it is the *JazzTeamServer\server\clustering\cache* folder in the JTS installation, but it can be relocated.

If DCM is being used and its installation has been moved from the default location (*server\clustering\cache* under the JTS install root), then the Apache Procrun tool (*prunsrv.exe*) that is included in the JTS Liberty image must be copied to the new DCM location:

   1. In the new DCM install root folder (corresponding to the *server\clustering\cache* default location), create a folder named "tools", then a folder named "win" under it.
   1. Copy the *JazzTeamServer\server\liberty\wlp\bin\tools\win\prunsrv.exe* file to your new *tools\win" folder in your DCM installation
   
---+++ Register Windows services

The [[Main.ELMAsWindowsServices][Running Engineering Lifecycle Management Applications as Windows Services]] topic describes the command line options for the new scripts. Use the *-registerWinService* option to define Windows services for all the CLM/ELM, JAS, and DCM servers you wish to run as services.

By default, services are registered to start manually. They can be started and stopped by running the scripts with the appropriate options, or by using the Windows Services application. You can also modify the service definitions to change the startup type to *Automatic* or *Automatic (Delayed Start)*, so that the services are started whenever Windows is restarted.

<BR>

---+++++!! Related topics: [[DeploymentInstallingUpgradingAndMigrating][Deployment Install Upgrade and Migrating]], [[DeploymentWebHome][Deployment web home]]

</div>

Attachments

Topic attachments
I	Attachment	Action	Size	Date	Who	Comment
bat	distributedCache.start.bat	manage	2.9 K	2020-01-12 - 14:11	Jrvasta	DCM startup script
bat	distributedCache.stop.bat	manage	1.9 K	2020-01-12 - 14:12	Jrvasta	DCM shutdown script
bat	liberty.server.bat	manage	4.3 K	2020-01-12 - 14:13	Jrvasta	Liberty control script for ELM
bat	server.shutdown.bat	manage	0.9 K	2020-01-12 - 14:13	Jrvasta	ELM shutdown script
bat	server.startup.bat	manage	5.6 K	2020-01-12 - 14:13	Jrvasta	ELM startup script
bat	start-jazz.bat	manage	3.7 K	2020-01-12 - 14:14	Jrvasta	JAS startup script
bat	stop-jazz.bat	manage	1.1 K	2020-01-12 - 14:14	Jrvasta	JAS shutdown script

This topic: Deployment > RwattsSandbox > DeploymentInstallingUpgradingAndMigrating > LibertyProfileAsService

History: r8 - 2020-01-12 - 14:17:00 - Main.Jrvasta

Copyright © by IBM and non-IBM contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use. Please read the following disclaimer.
Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.