Running StarTeam Notification Agent as a Service

Many customers run both the StarTeam Server and StarTeam Notification Agent as services.

When running the StarTeam Server and StarTeam Notification Agent on the same computer, the StarTeam Server process must start before the StarTeam Notification Agent attempts to start. The best way to accomplish this is to set up a service dependency within Microsoft Windows.

If you are running the StarTeam Server as a service and StarTeam Notification Agent as a dependent service, you cannot shut down the StarTeam Server unless the StarTeam Notification Agent service is shut down first.

To avoid dependent servers, some customers run the StarTeam Server and StarTeam Notification Agent on different computers. When using two computers, you must first synchronize the times on both computers. If StarTeam Notification Agent returns a View Configuration exception, the two computers are probably not synchronized.

To run an instance of StarTeam Notification Agent as a service, do one of the following:

• Modify the command stored in the NotificationAgentService.bat file and then run the batch file.
• Copy the updated command to the command line.

The example initially in this file is:

JavaService.exe -install NotificationAgent "C:\Program Files\Micro Focus\Java\
Sun1.4.1_02\bin\client\jvm.dll" -Djava.class.path="C:\Program Files\Micro Focus\
StarTeam Notification Agent\agent.jar";"C:\Program Files\Micro Focus\StarTeam
Notification Agent\starteamxx.jar" -Djava.library.path="C:\Program Files\Micro Focus\
StarTeam Notification Agent";"C:\Program Files\Micro Focus\StarTeam SDK x.x\lib"
-start com.starbase.starteam.workflow.NARuntime. NotificationAgentFrame -
params -service "C:\Program Files\Micro Focus\StarTeam Notification Agent\
localhost_49201.nac" -stop com.starbase.starteam.workflow.NARuntime.
NotificationAgentFrame -method stopAgent -out "C:\Program Files\Micro Focus\
StarTeam Notification Agent\NAService.log" -err "C:\Program Files\Micro Focus\
StarTeam Notification Agent\NAService.log" -current "C:\Program Files\Micro Focus\
StarTeam Notification Agent"
pause

This file contains several complete paths that you may need to replace with appropriate path names from your system. Most of these paths are delimited by double-quotation marks. These paths represent:

• The path to the Java Runtime Environment on your computer. The .bat file uses the following path as an example: C:\Program Files\Micro Focus\Java\Sun1.4.1_02\bin\client\jvm.dll.
• The class path, which requires two paths:
  • The path to the StarTeam Notification Agent .jar file (agent.jar). If you used the default installation location for StarTeam Notification Agent, this is "C:\Program Files\Micro Focus\ Notification Agent\agent.jar" and does not need to be changed.
  • The path to the StarTeam runtime .jar file (starteamxx.jar). If you used the default installation location for StarTeam Notification Agent, this is "C:\Program Files\Micro Focus\Notification Agent\starteamxx.jar" and does not need to be changed.
• The library path, which requires two paths:
  • The first is very similar to the path to the folder that contains agent.jar. If you used the default installation location for StarTeam Notification Agent, this is "C:\Program Files\Micro Focus\Notification Agent\agent" and does not need to be changed.
  • The second is the path to the folder that stores the Java version of the StarTeam runtime file (starteam-sdk.jar). For example, if you used the default installation folders, this would be "C:\Program Files\Micro Focus\StarTeam SDK x.x\lib" as found in the .bat file.
• The service path, which is the complete path to the .nac file (StarTeam Notification Agent configuration file) for the instance of the agent being run as a service. This is usually similar to the path already in the .bat file ("C:\Program Files\Micro Focus\Notification Agent\localhost_49201.nac"). The .nac file contains options for a specific instance of the agent and its naming convention identifies both the computer and the port used by StarTeam Notification Agent.
• The err and out paths, which are the paths to an output log file. If you used the default path, this would be “C:\Program Files\Micro Focus\StarTeam Notification Agent\ NAService.log” as found in the .bat file following both -out and -err.
• The current path, which is the path to the StarTeam Notification Agent installation folder. This is usually "C:\Program Files\Micro Focus\StarTeam Notification Agent", as in the batch file.

After running NotificationAgentService.bat, this instance of StarTeam Notification Agent runs as an automatic service and can be managed as any other automatic service.

JavaService.exe -uninstall NotificationAgent