Monday, 9 December 2019

EPM Cloud - Integration Agent update - Running as a Windows service

Back with a very quick update for the EPM Integration Agent. From the EPM Cloud 19.12 release, the agent can be run as a Windows service.

If you have a look at the agent bin directory of the 19.12 release compared to a prior version, you will notice a few differences.


EPMAgentService.exe” will install/uninstall and run the agent from a Windows service.

startagent.bat” has been removed. To continue starting the agent from command line you can just call "epmagent.bat" instead.

startagent.sh” has been updated so the agent is started as a background process.

stopagent.sh” has been added for Linux/Unix type systems. The script will basically find the process the agent is running under and then kill it.

To update the agent to the latest release is very simple. I suggest renaming the existing agent directory and replace with the latest version. Remember to copy the EPM Cloud SSL certificate back to the cert directory and any custom jar files to the lib directory.

If “EPMAgentService.exe” is executed, it will display details on how to install/uninstall the agent as a Windows service.


To install the service, the syntax is:

EPMAgentService.exe -install “service name” “location of agent initialisation file”


Once the command has been executed, a window will open confirming whether the service was installed successfully.


A log will be created with more details around the creation of the windows service.


If successful, the agent should be available as a Windows service.


The display name will be generated with same as the service name. The services is set to manual and the account which runs the service will be local system, so you may want to update the service configuration to fit your requirements.


Once the agent has been started, there will be “EPMAgentService.exe” as a process which will have the agent Java process running as a child process.


In the agent log directory, there will be an additional log for the agent. The naming convention for the log is:

<windows_service_name>_<agent_name>_Service_<date>.log

The log will contain the same information that was displayed when running the agent from command line.


When the agent is stopped, there will be entries in the log to confirm whether it was stopped successfully.


It is possible to run multiple agents as Windows services on the same machine.


Multiple services will now be available.


There will be a separate agent log for each Windows service.


If you want to update the display name for the Windows service, this can be achieved easily through command line.


The display name will be updated.


To remove an agent as a Windows service, the following syntax can be used:

EPMAgentService -uninstall <windows_service_name>


This will open a new window confirming whether the agent was uninstalled successfully.


A log will have been generated with further details.


So there we go, nice and simple. :)

No comments: