2 Install and Configure Advanced Management Console

This topic describes how to install and configure Advanced Management Console (AMC). How to set up Java Usage Tracker to gather information on applications that are run in your enterprise is also described.

This topic contains the following sections:

Install Advanced Management Console

Advanced Management Console is available as part of Oracle Java SE Advanced, see Java SE Products for information. You can download Advanced Management Console from the Java Advanced Management Console Downloads page.

Advanced Management Console is supported on the following platforms:

  • Windows 7

  • Windows 8

  • OS X 10.8

  • OS X 10.9

A single instance of Advanced Management Console is all that is needed on a central server that is used to collect the usage information for applications being run in your enterprise. You can also install additional instances to provide administrators with convenient access to the AMC UI for creating rules and rule sets. Download the installer package to each machine that you will use.

Tip:

To avoid conflicting changes, have only one administrator at a time work with the AMC UI.

To install Advanced Management Console, run the installer package that you downloaded. On Windows, an MSI file is provided, and the tool is installed in the %PROGRAMFILES%\JavaAMC directory. On OS X, a DMG file is provided, and the tool is installed in the Applications folder.

The following items are included with Advanced Management Console:

  • JRE - Version used to run Advanced Management console. You do not need to install a JRE separately.

  • Database -JavaDB is included for the AMC Database. You do not need to install a database separately.

Start and Stop Advanced Management Console

On Windows, the installation process creates a desktop shortcut for Advanced Management Console labeled JavaAMC. JavaAMC is also added to the Start menu. On OS X, an entry for JavaAMC is added to the Applications folder. Double-click the JavAMC icon to show the UI.

The first time the tool is started, the run mode defaults to Basic, and the AMC UI and AMC Collector are started and stopped together and run in the same process. You can change the relationship between the AMC UI and AMC Collector by setting the run mode, as described in Choose the Run Mode.

Start and Stop the AMC UI

For all run modes, use the JavaAMC icon to start the AMC UI. On Windows, this icon is available on the desktop and in the Start menu. On OS X, this icon is available in the Applications folder.

If the run mode is set to run the AMC UI and AMC Collector separately, then you are prompted to enter the password for the server.

To stop the AMC UI, close the Java Advanced Management Console window.

Start and Stop the AMC Collector

If the run mode is set to run the AMC Collector and the AMC UI together, starting and stopping the AMC UI also starts and stops the AMC Collector. See Start and Stop the AMC UI.

If the run mode is set to run the AMC Collector and the AMC UI independently, use the runCollector command to start the AMC Collector. Run the command on the machine where you want the AMC Collector to run. This command is available in the following locations:

  • Windows: %PROGRAMFILES%\JavaAMC\app\bin\runCollector.cmd

  • OS X: /Applications/JavaAMC.app/Contents/Java/bin/runCollector.sh

To stop the collector, kill the JavaAMC process.

Configure Advanced Management Console

Advanced Management Console provides different ways of connecting the AMC UI to the AMC Collector, options for configuring the AMC Collector, and the ability to use a proxy for network connections. Advanced Management Console can also be set up to sign the rule set when it is exported.

Use the Settings option in the File menu to set up Advanced Management Console for your environment.

Note:

Advanced Management Console must be configured locally. If you are running instances of the Advanced Management Console on multiple machines, the AMC UI must be run on each machine to configure the tool.

Choose the Run Mode

The run mode determines the relationship between the AMC UI and the AMC Collector.

To set the run mode, follow these steps:

  1. From the File menu, select Settings, then select System Settings.

    The System Settings window is shown.

  2. In the System Settings window, select the Run Mode tab, if it is not showing.

  3. Select the mode for the AMC UI on the machine on which you are running.

    The following options are available:

    • Run the AMC console and server together

      In this mode, the AMC UI and AMC Collector run locally in the same process and are started and stopped together. This is Basic mode, which is the default mode.

    • Run the console separately from the AMC server

      In this mode, the AMC UI and AMC Collector run locally, but are started and stopped independently. This mode enables you to run the AMC Collector without requiring the AMC UI to be active.

      If this mode is selected, you must define the password for the AMC Collector that is running on this machine. The next time that the AMC UI is started on this machine, you are prompted to enter the password. Users who start the AMC UI on another machine and connect to the AMC Collector on this machine are also prompted for this password.

    • Connect the console to a remote AMC server

      In this mode, the AMC UI and AMC Collector run on different machines. This mode enables you to run the AMC Collector on a central server and run the UI on a different machine. For example, an administrator can run the UI on a local machine and connect to the AMC Collector on the central server.

      If this mode is selected, you must provide the host name and port number for the remote server in the Remote Database URL field, and the path to the database in the Remote Database Path field. Use 1527 for the port number. The next time that the UI is started on the local machine, you are prompted to enter the password for the AMC Collector that is running on the remote server.

    Tip:

    If the option that you want to select is disabled, select Run the AMC console and server together, then click Apply. This action enables all options.

    If you plan to have the AMC Collector running on a central server and the AMC UI connecting to that server from a different machine, first configure the instance of Advanced Management Console on the central server. Set the run mode to run the console separately from the AMC server and set the password. Remote users cannot connect to the AMC Collector if it is running together with the AMC UI.

    After you configure the server instance, configure the instance on the machine where the UI will run. Set the run mode to connect the console to a remote AMC server, and provide the host name, port number (1527), and path for the central server.

  4. Click OK to save your changes and close the System Settings window.

    Click Apply if you want to save your changes leave the System Settings window open.

  5. Restart the AMC UI for the changes to take effect.

Configure the AMC Collector

The AMC Collector gathers the information from Java Usage Tracker and stores it in the AMC database. The port number used by the AMC Collector to collect the information from Usage Tracker, and symbols used in the data can be configured.

To configure the AMC Collector, follow these steps:

  1. From the File menu, select Settings, then select System Settings.

    The System Settings window is shown.

  2. In the System Settings window, select the AMC Collector tab.

  3. Set the port number used to collect the data.

    The default is 19870. This port number must match the port number set in the configuration file for Java Usage Tracker. See Set Up Java Usage Tracker.

  4. Define the special characters used in the Java Usage Tracker data.

    The default separator is a comma (,), the default quote is a double-quote ("), and the default inner quote is a single quote ('). The strings provided must match the strings set in the configuration file for Java Usage Tracker. The strings can be more than one character long. See Set Up Java Usage Tracker.

    Note:

    The ability to define the quote and inner quote characters is available beginning with the JDK 8u20 release.

  5. Click OK to save your changes and close the System Settings window.

    Click Apply if you want to save your changes and leave the System Settings window open.

  6. Restart the collector for the changes to take effect.

Configure the AMC Collector in the instance of Advanced Management Console that is running on the machine where the AMC Collector is run.

Set HTTP Proxy Settings for Network Access

If your enterprise uses a proxy server, you can configure Advanced Management Console to use this proxy server any time it accesses the network.

To configure network access, follow these steps:

  1. From the File menu, select Settings, then select System Settings.

    The System Settings window is shown.

  2. In the System Settings window, select the Network tab.

  3. Enter the proxy information in the Proxy Host and Proxy Port fields.

  4. Click OK to save your changes and close the System Settings window.

    Click Apply if you want to save your changes and leave the System Settings window open.

  5. Restart the UI for the changes to take effect.

Set the proxy settings for Advanced Management Console on each machine where it is running.

Configure JAR Signing

The rule set that is distributed to users must be a signed JAR file. You can set up Advanced Management Console to create the JAR file and sign it when you export a rule set. If you do not configure JAR signing, you can export the rule set as an XML file and create and sign the rule set JAR file manually.

To configure JAR signing, follow these steps:

  1. From the File menu, select Settings, then select JAR Signing Settings.

    The JAR Signing Settings window is shown.

  2. Provide the following information:

    • Keystore Location

      Enter or browse to the location of the keystore that contains the certificate for signing the rule set.

    • Keystore Password

      Enter the password for the keystore.

    • PrivateKey Alias

      Enter the alias for the certificate to use for signing the rule set.

    • PrivateKey Password

      Enter the password for accessing the certificate.

    Note:

    Passwords are not stored by Advanced Management Console. They are used only to check that the keystore and PrivateKey are valid. If the option to sign a rule set is selected when a rule set is exported, you are prompted for the passwords.

  3. Click OK to save your changes and close the JAR Signing Settings window.

Configure JAR signing for Advanced Management Console on each machine that is used to export rule sets.

Set Up Java Usage Tracker

Java Usage Tracker is a tool that is available with the Java Runtime Environment (JRE). This tool logs information about the applications that are run and the JREs that are used on the machine where Usage Tracker is enabled.

To enable Usage Tracker, create a file named usagetracker.properties. Add the following property to the file:

com.oracle.usagetracker.logToUDP = hostname:port

Set the value for the com.oracle.usagetracker.logToUDP property to the host name of the machine where the AMC Collector is running and the port number on which the AMC Collector is listening. The port number must match the port number set for the AMC Collector in the AMC UI, which defaults to 19870. See Configure the AMC Collector.

Additional properties can be added to the file. See Java Usage Tracker Overview. The characters set for the separator (com.oracle.usagetracker.separator), quote (com.oracle.usagetracker.quote), or inner quote (com.oracle.usagetracker.innerquote) properties must match the characters set for the AMC Collector in the AMC UI. See Configure the AMC Collector.

Note:

The ability to define the quote and inner quote characters is available beginning with the JDK 8u20 release.

On each machine from which you want to collect data, place the usagetracker.properties file in the following location, depending on your platform:

  • On Windows, place the file in the <JRE directory>/lib/management directory for each JRE on the system.

  • On OS X, place the file in the lib/management directory under the directory used by the Java Plug-in, for example, /Library/Internet Plug-Ins/JavaAppletPlugin.plugin/Contents/Home/lib/management.