Installing the Agent for Java EE/JMX (Standalone)

The JMX agent can be run outside of an application server. This installation guide describes the required steps.

As of this version, the Automation Engine and the Windows, UNIX, and Java Agents communicate using TLS. These agents establish a connection with the Java communication process (JCP), which uses trusted certificates to prove their identity to other communication partners.

You can use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters in the respective INI file to point to the relevant certificates. If the trustedCertFolder= parameter is not set, the certificates should be installed in the respective store; that is the Java trust store for Java Agents, the Windows OS store for Windows Agents, or the SSL store for UNIX Agents. UNIX agents additionally require you to define the SSLCertDir= and SSLCertFile= parameters to load the certificates from the SSL store.

For more information, see TLS Configuration.

Notes:

• The following guide describes how to install an agent in an AE system in which authentication is not used. Additional installation steps are required before the agent can be started and used if you intend to use one of the available authentication methods. For more information, see Agent Authentication.
• It is best to install the agent in a separate directory (such as UC4/Agent/jmx or C:\AUTOMIC\Agent\jmx).
• Before you start the installation, make sure that the Java agents can only connect to JCP port numbers that are lower than 65536. If they use a higher port number, the agent cannot start and aborts with an error message. This limitation is caused by Java and affects the agents for JMX, Databases, SAP and Rapid Automation.

Installing the Agent for Java EE/JMX

1. Install Java Standard Edition (admin and / or user computer).

   This installation step can be omitted if the required version of Java Standard Edition is already available.

   • Check the current version of your system's Java Virtual Machine (VM) using the following command:

   java -version

   Note that the order of the indicated directories is relevant when specifying %PATH% or $PATH if several versions of JRE or Java SDK are installed on your computer. The Java Runtime Environment listed first is used.

   • Download the required Java Runtime Environment from http://java.sun.com and install it.

2. Set up the agent (host).

   • Create a separate folder for the JMX agent and copy the supplied files and the sub-folder "Logs" to it. Instead, you can also use the program SETUP.EXE for the installation. It is available in the supplied directory (Agent).
   • Several settings are available for adjusting the JMX agent to your system environment. Of note are the agent and computer name, and the port of the Java communication process to which the agent should connect. Configure these settings using the INI file of the JMX agent. For more information, see Agent JMX.

3. Start the agent.

   • Use the following command to start the agent from the command line (UNIX and Windows): 

   java -jar -Xrs -Xmx1G ucxjjmx.jar

   The agent can also be started by using the ServiceManager. For more information, see ServiceManager.

4. Important notes for creating jobs (host).

   • Select the option "Local Java VM" in the Job object's JMX tab.
   • Activate the sub-items "Use existing MBean Server" and "Create new instance..."