Running RTC as a Windows service

Sep 26

ErinLaboratory No Comments

I need to run the Rational Team Concert Jazz Build Engine as a Windows service as we need it to run non-stop as part of the continuous integration service. The catches though are

  • it (theoretically) wouldn’t stop as it keeps on waiting for build requests from the RTC server. This makes it as an unlikely candidate for scheduled tasks unless I will cookup a script for terminating it before the actual run. Messy if I still have to check if there is a build in progress.
  • the machine hosting it is not a dedicated machine so a couple of admins usually login to do some stuff which kills any running processes executed by the currently logged-in user.

Windows provides the sc.exe utility for creating and removing Windows services but it only accepts executables and not scripts. I have to set some environment properties and parameters so this is out of the running. The Java Service Wrapper is a good alternative but I misread the instructions so ended up using the AutoExnt utility in the Win2003 Resourse Kit. The files are still usable in Windows XP.

Only three files are needed from the kit namely Autoexnt.exe, instexnt.exe and servmess.dll. These files are to be dropped in the %SYSTEMROOT%\system32 directory.. The next step is to create the %SYSTEMROOT%\system32\autoexnt.bat (the file needs to be named like that) with the commands to be executed. My script looked something like this:


@echo off
setlocal
REM
REM Workstation specific settings.
REM
set JBE_Eclipse_Dir=C:\Apps\IBM\jazz\buildsystem\buildengine\eclipse
set JBE_Repository_URL=https:///jazz
set JBE_EngineID=ToolingBuilder
set JBE_user=kerberos
set JBE_password=

REM
REM If proxy is not needed, switch the JBE_VMArgs_OPTS to use the empty one
REM
set proxyHost=
set proxyPort=3128

set JBE_VMArgs_OPTS=-vmargs -DhttpsproxyHost=%proxyHost% -Dhttps.proxyPort=%proxyPort%
REM set JBE_VMArgs_OPTS=

REM
REM Set the JVM to use to the IBM J9 VM otherwise the compilation will fail.
REM
set java_home=C:\Apps\IBM\SDP70\jdk
set classpath=.;%java_home%\lib
set path=%java_home%\bin;%path%

REM
REM Invoke the Jazz Build Engine client.
REM
pushd %JBE_Eclipse_Dir%
jbe.exe -repository %JBE_Repository_URL% -userId %JBE_user -pass %JBE_password% -engineId %JBE_EngineID% -sleeptime 1 %JBE_VMArgs_OPTS%

endlocal

The next step is invoking the command instexnt install to install the service. The only final thing to do is to go inside the Services console of Windows and reconfigure the AutoExNT service to start automatically at boot up. Of course, it needs to be started as well if you want to use the service immediately. 🙂

There are a few more help in the Windos 2003 Resource Kit help but the only thing of interest is using instexnt install /interactive to install the service. This will cause the service to pop out a command window wherein the user can view the console output. The downside is that the user can close the window which will terminate the service.

I have thought about migrating the system to use the Java Service Wrapper but using the AutoExNT separates the service component which allows JBE implementors to replace/delete the JBE installation directory without going through the setup process again.

[edit 20081002] Dom Weinand posted this link in the RTC user forum on how to use the Java Service Launcher to run JBE as a Windows service[/edit]

ciao!

Leave a Reply