Installing the Agent for Java EE/JMX (Standalone)

This page guides you through the installation of 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.

Tip! This page refers only to the manual installation process. If you want instructions on how to install a containerized Java agent, see Installing Containerized Java Agents.

The JMX Agent can run outside of an application server. It is best to install the Agent in a separate directory (such as UC4/Agent/jmx or C:\AUTOMIC\Agent\jmx).

This Agent supports sending emails using SMTP and SMTPS. For more information, see Setting Up Email Connections.

This page includes the following:

Connecting to the Automation Engine

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

Important! Make sure you are familiar with the TLS/SSL and certificate implementation before installing and/or upgrading the respective component. For more information, see:

When you used certificates signed by a CA, the certificates are stored in the respective Java or OS store by default; that is the Java trust store for Java components and Java Agents, the Windows OS store for Windows Agents, or the TLS/SSL store for UNIX Agents. In this case, you only have to check that the root certificates already are in the respective store.

If the relevant certificates are not there and you want to import them, you can use OS or Java specific tools for that purpose, such as Keytool, cert-manager, OpenSSL and such. For more information on how to use those tools, please refer to the respective product documentation.

If you do not want to use the default locations for the components and Agents listed above, make sure you use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters (if applicable) in the respective configuration (INI) file to define the path to the folder where the trusted certificates are stored.

Important! TLS/SSL Agents (in containers and on-premises) as well as the TLS Gateway, when used for the Automic Automation Kubernetes Edition, establish a connection to an ingress / HTTPS load balancer, which requires a certificate for authentication.

Make sure that address of the load balancer is defined on both sides: the Automation Engine and the Agent / TLS Gateway and that your HTTPS load balancer has the required certificates in place. For more information, see Connecting to AWI, the JCP and REST Processes Using an Ingress.

Installing the Agent for Java EE/JMX

  1. In the admin and/or user computer, install Java Standard Edition.

    You can skip this step if the required version of Java Standard Edition is already available.

    • Use the following command to check the current version of your system's Java Virtual Machine (VM):

      java -version

      Note: 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 the Java website and install it ,see https://java.com.

  2. On the host, set up the Agent.

    • Create a separate folder for the JMX Agent and copy the supplied files and the sub-folder Logs to it. Optionally, you can use the program SETUP.EXE for the installation. It is available in the supplied directory (Agent).

    • In the INI file of the JMX Agent, set the Agent name, computer name, and port of the JCP to which the Agent should connect. For more information, see Agent JMX.

    • When you used certificates signed by a CA, the certificates are stored in the respective Java or OS store by default. In this case, you only have to check that the root certificates already are in the respective store.

      If you do not want to use the default location for this component, make sure you use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters (if applicable) in the respective configuration (INI) file to define the path to the folder where the trusted certificates are stored.

      For more information, see Securing Connections to the AE (TLS/SSL).

  3. Use the following command to start the Agent from the command line (UNIX and Windows):

    java -jar [Windows:]-Xrs -Xmx2048m ucxjcitx.jar disable_cache

    You can also use the ServiceManager to start the Agent. For more information, see ServiceManager.

  4. On the host, consider the following when creating jobs:

    • 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...

See also:

Installing the Agents