25 Using the Properties Editor

Oracle Adaptive Access Manager provides properties out-of-the-box and a Properties Editor that enables you to create new database properties according to your requirement, modify existing database and file properties, and create and edit enumerations.

Note: not all roles have permissions to access the Properties Editor.

This chapter focuses on properties management using the OAAM Administration Console. It includes the following topics:

25.1 Navigating to the Properties Search Page

The Properties Search page is the starting place for managing your property definitions.

To open the Properties Search page:

  1. In the Navigation tree, double-click Properties under Environment.

    Alternatively, you can:

    • Right-click Properties in the Navigation tree and select List Properties from the context menu.

    • Select Properties in the Navigation tree and then choose List Properties from the Actions menu.

    • Click the List Properties button in the Navigation tree toolbar.

    The Properties Search page is displayed.

  2. Click Search to view a list of properties in the system.

25.2 Searching for a Property

In the Properties Search page you can view a list of all properties in the system and search for a property based on the name, load type, and value.

Figure 25-1 Properties Page

The Properties search page is shown.

To view a list of the properties present in the system, click Search. All available properties are displayed in the Results table.

To search for a property:

  1. Specify the criteria in the search fields in the Properties Search page to locate the property.

    The search filter criteria are described in Table 25-1, "Search Filter Criteria".

    Table 25-1 Search Filter Criteria

    Field Description

    Name

    The property name.

    Load Type

    The property's load type. If the property is available in the database, its load type is database; if the property is in a property file, its load type is properties, and if the property is a system property, its load type is systems. By default the load type is set to "all."

    Value

    The value for the property.


  2. Click Search.

    If you want to reset the search parameters to the default setting, use the Reset button.

The Results Table displays a summary of the properties that match the criteria specified.

By default, properties are sorted on Property Name, but you can sort properties on the Load Type.

25.3 Viewing the Value of a Property

To view the value of a property, select the property in the Results table. The name, load type, and value for the property is displayed in the bottom panel.

25.4 Viewing Enumerations

Enumerations can be viewed and edited using the Properties Editor.

For the enumerations to be listed in the Properties Editor, you must set the following property to false:

bharosa.config.ui.list.filter.enum=false

25.5 Creating a New Database Type Property

To create a new database type property:

  1. From the Properties Search page, click the New Property button or Create new Property icon.

    A New Property dialog is displayed.

  2. In the New Property dialog, type in the property name and value.

    An error message appears for the following:

    • Duplicate name

    • Special characters

    • Blank value

    • Name or value that is more than the maximum length of 4000 ASCII characters or 1333 UTF-8 characters

    The property name cannot be edited after the property has been created.

  3. Click Save.

All properties created using the properties editor can be of the "Database" type only. They are created in the server database.

A system and file type properties cannot be created from the user interface.

If you do not want to create the new property, click Cancel instead of Save.

25.6 Editing the Values for Database and File Type Properties

You can easily edit the values for database and file type properties and save them.

System properties are read only and cannot be edited.

To edit a database or file type property, follow these steps:

  1. In the Results table, select the property.

    The name, load type, and value is shown in the details panel.

    If multiple properties are selected, details for the last selected property are shown in the details panel.

  2. In the details panel, edit the value of the property.

    Name and Type are read-only in the details panel.

  3. Click Save.

    The modified property detail are saved successfully.

    When a file load type property is edited, it changes to a database type property. The existing file type property will no longer be shown in the Results table.

    If you do not want to save the modified property, click Cancel instead of Save to revert the changes to the original value.

25.7 Deleting Database Type Properties

System and file properties are not allowed to be deleted.

To delete a database type property or properties:

  1. In the Results table, select the properties.

    A confirmation dialog appears.

  2. Click the Delete button. The selected properties are deleted successfully.

If you delete a database type property that had been changed from a file type property, the selected property is deleted and the old file type property is restored.

25.8 Exporting Database and File Type Properties

To export file properties, follow these steps:

Note:

System properties will not be exported. Only file and database type properties will be exported.

  1. In the Navigation tree, open Properties under Environment.

    The Properties Search page is displayed.

  2. Click Search to view a list of properties in the system.

  3. Select the properties you want to export.Select Export Selected from the Actions menu.

    An Export Properties dialog appears with options to select the export type and provide a name.

  4. Enter a name for your ZIP file.

  5. Choose Java Properties or XML Properties as the Export Type.

  6. Click Export.

    If you do not want to export the files, click Cancel instead of Save.

  7. Click Save and then OK.

    A ZIP file for the selected properties in XML or Java format is exported.

25.9 Importing Database Type Properties

To import database type properties, follow these steps:

  1. In the Navigation tree, open Properties under Environment.

    The Properties Search page is displayed.

  2. Click the Import Properties button.

    An Import Properties dialog appears.

  3. In the Import Groups dialog box, type the path and name of the file; or use the Browse (...) button to locate the ZIP file that contains the properties, and then select the file.

  4. Click Open and then click OK.

    Updates are saved to the database. Updates occur only if the value of the property changed.

  5. Click OK.

    If you try to import properties in an invalid format, an error will be displayed.

25.10 Editing Enums in the Property Editor

User-defined enums are a collection of properties that represent a list of items. Each element in the list may contain several different attributes. The definition of a user-defined enum begins with a property ending in the keyword ".enum" and has a value describing the use of the user-defined enum. Each element definition then starts with the same property name as the enum, and adds on an element name and has a value of a unique integer as an ID. The attributes of the element follow the same pattern, beginning with the property name of the element, followed by the attribute name, with the appropriate value for that attribute.

The following is an example of an enum defining credentials displayed on the login screen of an OAAM Server implementation:

bharosa.uio.default.credentials.enum = Enum for Login Credentials
bharosa.uio.default.credentials.enum.companyid=0
bharosa.uio.default.credentials.enum.companyid.name=CompanyID
bharosa.uio.default.credentials.enum.companyid.description=Company ID
bharosa.uio.default.credentials.enum.companyid.inputname=comapanyid
bharosa.uio.default.credentials.enum.companyid.maxlength=24
bharosa.uio.default.credentials.enum.companyid.order=0 
bharosa.uio.default.credentials.enum.username=1
bharosa.uio.default.credentials.enum.username.name=Username
bharosa.uio.default.credentials.enum.username.description=Username
bharosa.uio.default.credentials.enum.username.inputname=userid
bharosa.uio.default.credentials.enum.username.maxlength=18
bharosa.uio.default.credentials.enum.username.order=1

In case of enums, to override non translatable core properties set it in oaam_custom.properties and the locale specific properties should be set in client_resource_<locale>.properties. To disable any already defined element in a user-defined enum, simply add an "enabled" attribute with a value of "false".