External Java Management

Control-M Automation API requires an external Java installation, similar to other Control-M components, and does not deliver a Java library during installation. This reduces installation size and enables you to use the libraries that are common within your organization. It also ensures that Java remains updated.

By default, Control-M Automation API uses the same Java used by Control-M/EM. However, in certain cases when the Control-M Automation API version is different from the Control-M/EM version (for example, after an upgrade of Control-M Automation API), you might need to change the Java package for Control-M Automation API.

For a list of Java vendors supported by Control-M components, see Control-M Compatibility with External Java Vendors.

Control-M Automation API no longer supports Java 11 as of version 9.0.21.325, the monthly release of October 2024. Starting with this version of Control-M Automation API, Java 17 or higher is required.

Changing the JRE Package for Automation API

This procedure describes how to change the JRE package in Control-M Automation API.

Begin

  1. On the Control-M/EM machine, do one of the following:

    • Control-M/EM 9.0.21.xxx:Navigate to the following file and open it for editing:

      • (UNIX)<HOME>/BMCINSTALL/external_java_path_9.0.21.x00.dat

      • (Windows)<EM_HOME>\BMCINSTALL\external_java_path_9.0.21.x00.dat

    • Control-M/EM 9.0.21:Navigate to the following file and open it for editing:

      • (UNIX)<HOME>/BMCINSTALL/external_java_path.dat

      • (Windows)<EM_HOME>\BMCINSTALL\external_java_path.dat

    • Control-M/EM 9.0.20.xxx:Create the following file in the specified location and open it for editing:

      • (UNIX)<HOME>/BMCINSTALL/external_java_path_9.0.20.000.dat

      • (Windows)<EM_HOME>\BMCINSTALL\external_java_path_9.0.20.000.dat

  2. Define an alternative Java home directory by setting the value of the parameter AAPI_JAVA_HOME to the external Java path, as follows:

    AAPI_JAVA_HOME={new JRE Path}

    • A relative path is not supported.

    • The path can only include alphanumeric characters, periods (.), underscores (_), hyphens (-), and plus signs +.

      On Windows, the path can also include spaces.

    • (Windows) A network path is not supported.

    • (Windows) The path must be enclosed with quotation marks.

  3. Stop the Control-M Automation API server and Configuration API server using the following commands:

    emrestsrv stop

    emconfigrestsrv stop

    The servers restart automatically.