26 Using the OAAM Properties Editor

Oracle Adaptive Access Manager provides OAAM properties as standard and an OAAM Properties Editor that enables you to create new database OAAM 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 OAAM Properties Editor.

This chapter focuses on OAAM properties management using the OAAM Administration Console.

This chapter contains the following sections:

26.1 Navigating to the OAAM Properties Search Page

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

To open the OAAM 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 OAAM Properties Search page is displayed.

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

26.2 Searching for an OAAM Property

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

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

To search for an OAAM property:

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

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

    Table 26-1 Search Filter Criteria

    Field Description

    Name

    The OAAM property name.

    Load Type

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

    Value

    The value for the OAAM 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 OAAM properties that match the criteria specified.

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

26.3 Viewing the Value of an OAAM Property

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

26.4 Viewing Enumerations

Enumerations can be viewed and edited using the OAAM Properties Editor.

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

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

26.5 Creating a New Database Type OAAM Property

To create a database type OAAM property:

  1. From the OAAM 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 OAAM 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 OAAM property name cannot be edited after the OAAM property has been created.

  3. Click Save.

All OAAM properties created using the OAAM 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 OAAM property, click Cancel instead of Save.

26.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 OAAM property, follow these steps:

  1. In the Results table, select the OAAM property.

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

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

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

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

  3. Click Save.

    The modified OAAM property detail are saved successfully.

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

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

26.7 Deleting Database Type OAAM Properties

System and file OAAM properties are not allowed to be deleted.

To delete a database type OAAM property or OAAM properties:

  1. In the Results table, select the OAAM properties.

    A confirmation dialog appears.

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

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

26.8 Exporting Database and File Type OAAM Properties

To export file OAAM properties, follow these steps:

Note:

System properties will not be exported. Only file and database type OAAM properties will be exported.
  1. In the Navigation tree, open Properties under Environment.

    The OAAM Properties Search page is displayed.

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

  3. Select the OAAM 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 OAAM properties in XML or Java format is exported.

26.9 Importing Database Type OAAM Properties

To import database type OAAM properties, follow these steps:

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

    The OAAM 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 OAAM 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 OAAM property changed.

  5. Click OK.

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

26.10 Editing Enums in the OAAM Properties Editor

User-defined enums are a collection of OAAM properties that represent a list of items. Each element in the list may contain several attributes. The definition of a user-defined enum begins with an OAAM 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 OAAM properties set it in oaam_custom.properties and the locale specific OAAM 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".