How Web Agent Properties Are Discussed in this Guide

When this guide discusses editing a property, the emphasis is on the property as set in OpenSSO Enterprise Console. For a description of how to access the Web agent properties using OpenSSO Enterprise Console, see To Navigate in the OpenSSO Enterprise 8.0 Console to the Web Agent Properties.

To set a property in OpenSSO Enterprise Console, the name of the Console tab in which the property is located is useful as well as the property label. The property name is not usually as important when using OpenSSO Enterprise Console, but can still be of some use and is therefore included in this guide whenever a property is mentioned.

Example 4–1 The Method Used for Discussing Web Agent Properties in This Guide

Most agent properties mentioned in this guide are presented using a format that is most useful for those configuring properties using OpenSSO Enterprise Console. However, that format is not used when the property is in the OpenSSOAgentBootstrap.properties file since the bootstrap file is not accessible using OpenSSO Enterprise Console. The following example illustrates the format usually used in this guide to mention an agent property:

Example: The property labeled Login Form URI (Tab: Application, Name: com.sun.identity.agents.config.login.form).

Every time you change a property using OpenSSO Enterprise Console, you must click Save on that page for the change to take place. Furthermore, if the property is not hot-swappable, you must restart the Policy Agent container for the new value to take effect.

The above example provides the following details about the property:

Property label used in OpenSSO Enterprise Console:

Login Form URI

The name of the OpenSSO Enterprise Console tab within which the property is located:

Application

The property name:

com.sun.identity.agents.config.login.form

Since the emphasis of this guide is on the use of OpenSSO Enterprise Console, other methods of editing properties are not consistently mentioned. If you are configuring agent properties using the ssoadm utility, the explanations provided in this guide about the purpose of the agent properties are still applicable, however for details on configuring the agent properties using the ssoadm utility, see Appendix D, Using the ssoadm Command-Line Utility With Agents.

If the agent is configured locally, therefore using the OpenSSOAgentConfiguration.properties file, you cannot use OpenSSO Enterprise Console. For such a scenario, descriptions of the properties provided in this guide are still applicable and some limited information about setting the property in the OpenSSOAgentConfiguration.properties file is provided. However. for the most part, you should consult the OpenSSOAgentConfiguration.properties file itself for information about setting the properties.