User Console Design Guide › Identity Manager Localization › Resource Bundles

Resource Bundles

A resource bundle is an Identity Manager file that associates user interface elements with locale-specific text strings. In this file, a user interface element is assigned a key ID, which is paired to a locale-specific text string.

When CA Identity Manager encounters an element with a key ID on a user interface screen, such as an admin task profile screen, it displays the paired value from the resource bundle.

For example, the entry for a Submit button in an CA Identity Manager resource bundle is as follows:

global.button.submit=Submit 

The key ID is global.button.submit and the value is Submit. When CA Identity Manager encounters the global.button.submit key ID in a user interface screen definition, it displays the word Submit, as shown in the following screen:

Note the following about key IDs:

• Elements in the User Console can have only one key ID, and the key ID must be unique for a particular resource bundle.
• Key IDs are case sensitive, must contain only US-ASCII characters, and cannot contain spaces. However, key IDs may contain multiple strings separated by periods (.). For example, the key ID for the Department field name may resemble the following:

  attribute.displayname.department

• CA Identity Manager supports two formats for specifying key IDs in admin task screens:
  • Using a syntax that includes the resource bundle name

    This method allows you to specify the name of a custom resource bundle. You can use a custom resource bundle to separate custom mappings from the default resource bundle.

    The format for this syntax is as follows:

    ${bundle=ResourceBundle:key=keyID}

    In this syntax example:

    bundle=ResourceBundle

    Identifies the resource bundle that includes the text string mapping for the key ID, if you are using a custom resource bundle.

    Note: Create the custom resource bundles in iam_im.ear/custom/resourceBundles and then refer to it as resourceBundles.MyResourceBundle.

    Bundle names use standard Java localization syntax. The bundle name does not need to include the .properties extension, but must be fully qualified, relative to iam_im.ear/custom.

    This name/value pair is optional. You do not need to specify a resource bundle if the key ID is defined in the base resource bundle, IMSResources.properties. In this case, the key ID in the admin task screen would be:

    ${key=keyID}

    key=keyID

    Identifies the key ID that maps to the text string to display. The mapping must exist in a resource bundle.

    A completed key ID entry resembles the following:

    ${bundle=resourceBundles.MyResourceBundle:key=attribute.displayname.department}

  • Using the prefix imstask.label as follows:

    imstask.label.elementname

    For example:

    imstask.label.attribute.displayname.department

    When you use this method, attribute.displayname.department must appear in the resource bundle.

Note: If you are creating custom localization files, you use a translation tool that changes the value mapped to a key ID for a different language. For example, to display the Submit button in French, the translation tool changes the value paired with the global.button.submit key ID in the French resource bundle as follows:

global.button.submit=Enter