Java Desktop System Configuration Manager Release 1.1 Installation Guide

Chapter 6 Installing Desktop Components on Microsoft Windows

All necessary components for the central configuration feature are shipped and installed as part of the Java Desktop System. In general, you can use the central configuration management on other systems. However, in this case you must perform the necessary installation steps yourself. To ease the setup under Microsoft Windows systems, a GUI-based installer is provided, which guides you through the installation steps.

Configuration Agent Installation

Note –

The installer, as well as the Configuration Agent, requires an installed JavaTM Runtime Environment (JRE) 1.4 or higher. The JRE is not part of the installation. If you are unsure about the installed Java version, execute java -version. This command tells you whether the correct Java version is available and properly configured on your system.

The installer is started by a batch file, setup.bat. This can be found on the Java Desktop System management tools CD. You must start the script as a user with sufficient administrative privileges (local administrator). Otherwise, the installation and startup of the Configuration Agent as new system service will fail.

Start the installer by typing

		[-saveState filename][-no]
		[-noconsole][-state filename]

The following options are recognized by the installer:


Display this help text. 


Writes input from an interactive installation session to the specified file. The default file name is statefile.out.


Uses the specified state file as input for silent installation. Use this option with -noconsole.


Start the installer without any user interface. Use with -state and to initiate a silent installation.


Starts the installer in command line mode without launching the graphical user interface. 


Runs the installer without installing software. This option is useful together with -saveState for preparing a silent installation 


After the Configuration Agent Install Wizard has been called, a Welcome page appears. The Welcome page provides you with information regarding the installation process.

Figure 6–1 Configuration Agent, Welcome page

Welcome page

Click the Next button to proceed to the next page in the wizard.

License Agreement

The Software License Agreement page contains licensing information for the Configuration Agent.

Figure 6–2 Configuration Agent, Software License Agreement

License Agreement

Read the License agreement, and click the Yes (Accept License) button to accept and to continue the installation process.

Installation Type

The installer provides three installation types. These types only differ in the number of configuration settings that can be defined during the installation process.

Figure 6–3 Configuration Agent, installation type page

Installation type page

After selecting the desired installation type, click Next. Depending on the selected installation type, several configuration settings pages are displayed. The following section provides a description for these settings.

Note –

If you have selected the Express or Minimal options, then not all of the following configuration settings pages are applicable.

Note –

To start the Configuration Agent, some bootstrap information is required, such as the host name and port of the LDAP server. In addition, you can also define several advanced settings, such as the logging level or data directory. All these settings can be specified during the installation process. This information is maintained in a set of properties files, such as,, These files are stored locally in the Program Files\Sun\Apoc\lib directory. You can manually edit these properties files, or you can use the configuration wizard for the Configuration Agent.

Configuration Agent Wizard and Settings Information

This section provides an exact description of all of the configuration settings available for the Configuration Agent.

The configuration wizard offers a graphical user interface that guides you through the necessary settings of the Configuration Agent. For each page of the wizard, a corresponding help screen is available.

Bootstrap Information

Figure 6–4 Configuration Agent, Configuration Repository

Configuration Agent, Configuration Repository

Note –

Associated property file keys are indicated in parentheses, where appropriate.

Figure 6–5 Configuration Agent, Authentication Mechanism

Configuration Agent, Authentication Mechanism

Port Settings

The Configuration Agent uses two ports:

Figure 6–6 Configuration Agent, Port Settings

Configuration Agent, Port Settings

Change Detection Interval

The Configuration Agent periodically checks for any changes in the configuration data using the following two intervals:

You can use the general detection interval to tune the propagation of remote configuration data changes to client side applications. The value provided for this setting is the maximum length of time in minutes that elapses before remotely made changes are reflected in the client applications.

Smaller values result in increased Configuration Agent and LDAP server activity. As a result, use caution when you adjust the value of the settings. For example, in an initial deployment phase, you can set the value to one minute so that you can easily test the impact of remote configuration on client applications. After you complete the testing, return this setting to the initial value.

Operational Settings

Figure 6–7 Configuration Agent, Data Directory

Configuration Agent, Data Directory

The following settings can be configured:

Figure 6–8 Configuration Agent, Request Handling and Logging

Configuration Agent, Request Handling and Logging

Note –

Most of the operational settings, with the exception of the Data Directory and Connection Timeout settings, can also be maintained centrally through corresponding policies stored in the LDAP server. If you want to use this feature, do not adapt the corresponding settings by means of the wizard. Instead, use the Configuration Agent policies within the Configuration Manager to centrally specify operational settings.

Agent Settings Summary

With the exception of "Data Directory" and "Connection Timeout", operational settings that have been stored on the LDAP server by means of the Configuration Manager take effect automatically at the next change detection cycle for the agent configuration (see DaemonChangeDetectionInterval).

Figure 6–9 Configuration Agent, Summary Page

Configuration Agent, Summary Page

All other settings changed locally require a reload or restart of the Configuration Agent. The reload or restart is performed automatically if you use the configuration wizard.

Note –

To manually restart the Configuration Agent, ensure that no related client applications are running, log in as Administrator, and type the command Program Files\Sun\Apoc\bin\apocd restart. Alternatively, you can start the “Service Controller”, available in the Control Panel under Administrative Tools. Select Configuration Agent from the list of available services and click Restart.

Ready To Install

The Ready to Install page shows you what items for the Configuration Agent are to be installed.

Figure 6–10 Configuration Agent, ready to install page

Ready to Install

At this point, no changes have yet been made on your system. The actual installation starts when you click the Install Now button.

Installation Summary

The Installation Summary page of the wizard shows the status of the installed items. Click the Details button next to the corresponding item to provide more information about that item.

Figure 6–11 Configuration Agent, installation summary page

Installation summary

The installer stores the Configuration Agent binaries in your default program files directory (usually C:\Program Files) under Sun\apoc. The installer also automatically creates a new Java Desktop System folder in the Start–All Programs–Sun menu. This folder contains two shortcuts that allow you to further configure or to uninstall the Configuration Agent.

Changing Configuration Agent Settings

As mentioned previously, you can modify the Configuration Agent settings at any time after the installation. You can start the wizard as Administrator by means of the Program Files\Sun\Apoc\bin\apoc-config.bat script. Alternatively, you can choose the Configuration Agent entry in the Start menu under All Programs–Sun–Java Desktop System to start the Configuration Agent wizard.

Note –

The wizard can also be started without launching the graphical interface. For example, execute Program Files\Sun\Apoc\bin\apoc-config -nodisplay to start the wizard in console mode.

Uninstalling the Configuration Agent

To uninstall the Configuration Agent, choose All Programs–Sun–Java Desktop System–Configuration Agent–Uninstall Configuration Agent from the Start menu.