Customizing OIM for Button Labels
Overview
This example is used to demonstrate customization of OIM UI for button label changes.
Objective
OIM has different consoles (Unauthenticated self service, authenticated self service, advanced
administration and administration) deployed through the iam-consoles-faces.war and admin.war. The
out of the box labels displayed on the buttons might not be preferred in certain cases. In such scenarios,
this example can be used to learn how to change them.
The labels on the buttons are referred from localized properties files. Within the web applications, there
are a number of properties files and based on the end user’s locale, the label from the appropriate
localized properties file is picked up.
This example will demonstrate how to determine the appropriate location and to change the labels on
the buttons effectively.
Scenario
Linda works as a network administrator for Mydo Main Corporation. She is responsible for performing
identity and access management tasks on users within the company. One such task is customizing the
labels on the buttons in Self Service, Advanced Administration and Identity Administration consoles for
Mydo Main. By doing so, she can tailor this console to meet her company's requirements.
Prerequisites
Before starting this tutorial, you should install and configure Oracle Identity Manager 11g. From here
download the zip file that contains the files that are required to complete the button label
customization. These should be downloaded to the OIM server machine.
In addition to customized properties file, the example provides README files with the instructions, the
corresponding original file and Diff images to show the differences between the original and customized
versions.
Following are the files in the example:
/Advanced Administration
-
Agent_en.properties
/Identity Administration
-
IdentityUIBundle_en.properties
/Self Service
-
Agent_en.properties
Location of properties files
Most of the properties files in unauthenticated self service, authenticated self service and advanced
administration consoles are either in iam-consoles-faces.war/WEB-INF/lib/iam-consoles-faces.jar or
iam-consoles-faces.war/WEB-INF/lib/OIMUI.jar. Most of the properties in the Administration UI are in
one of the jar files located at admin.war/WEB-INF/lib. The exact jar file and the location of a properties
file depend on the feature and the console. The names of the jar file and the locations to the properties
file can help in identifying the appropriate file. For example, the scheduler UI uses the properties file
located in OIMUI.jar at oracle/iam/features/scheduler/agentry/resources.
How to customize button labels
Following are general instructions to customize button:
1. Identify the properties file having the button label.
2. Unpackage the jar file having the properties file.
3. Make changes to the properties file. Note that for English language the _en.properties files are
used. Make changes to the file corresponding to the required locale.
4. Repackage the jar file and replace the old one with the new one.
5. Restart the server.
Following are the instructions on using the files provided in the example to achieve button label
customization:
/Advanced Administration
-
Agent_en.properties
Purpose:
Contains the Agent_en.properties for request feature with the button label change. The
Agent_en_original.properties is provided only for identifying the changes with the original file. Using the
new file the following change on the UI will be seen:
On Advanced console, navigate to Policies -> Approval Policies tab. Click on 'Create' in Actions to create
a new Approval policy. The buttons on the form are changed from "Cancel" and "Next" to "Abort" and
"Go" respectively.
How to apply:
Replace the Agent_en.properties at the following location:
iam-consoles-faces.war/WEB-INF/lib/OIMUI.jar/oracle/iam/request/agentry/resources
For this:
1. Unjar the OIMUI.jar
2. Replace the new properties file at the above location (oracle/iam/request/agentry/resources).
3. Repackage the jar and put it at the above location (iam-consoles-faces.war/WEB-INF/lib).
4. Restart the server.
/Identity Administration
-
IdentityUIBundle_en.properties
Purpose:
Contains the IdentityUIBundle_en.properties for user administration feature with the button label
change. The IdentityUIBundle_en_original.properties is provided only for identifying the changes with
the original file. Using the new file the following change on the UI will be seen:
On Administration console, create User screen in Administration UI will have the labels "Save" and
"Cancel" on the buttons replaced with "Submit" and "Clear".
How to apply:
Replace the following existing file with the new one:
admin.war/WEBINF/lib/IdentityTaskFlow.jar/oracle/iam/identitytaskflow/resources/IdentityUIBundle_en.properties
1. Unpack the IdentityTaskFlow.jar in admin.war.
2. Replace with the new properties file.
3. Repackage the jar file.
4. Restart the server.
/Self Service
-
Agent_en.properties
Purpose:
Contains the Agent_en.properties for self service with the button label change. The
Agent_en_original.properties is provided only for identifying the changes with the original file. Using the
new file the following change on the UI will be seen:
On Self service console, navigate to Profile -> My Profile -> Security tab. The buttons on the Challenge
Questions form are changed from "Apply" and "Revert" to "Submit" and "Cancel".
How to apply:
Replace the Agent_en.properties at the following location:
iam-consoles-faces.war/WEB-INF/lib/OIMUI.jar/oracle/iam/selfservice/self/agentry/resources
For this:
1. Unjar the OIMUI.jar
2. Replace the new properties file at the above location (oracle/iam/selfservice/self/agentry/resources).
3. Repackage the jar and put it at the above location (iam-consoles-faces.war/WEB-INF/lib).
4. Restart the server.
The README file for each of the console gives the instructions on using these files.
NOTE: Although this example demonstrates button label changes, the usage of properties
files as shown here holds true for other text and label changes. Similar steps can be
performed to customize those changes.
Expected Results
Following images show the expected results after the customizations are applied:
Advanced Administration console:
Change of buttons labels from
“Cancel” and “Next” to “Abort”
and “Go” respectively.
Identity Administration console:
Button labels changed from
“Save” and “Cancel” to
“Submit” and “Clear”
respectively.
Self Service console:
Button labels changed from
“Save” and “Cancel” to
“Submit” and “Clear”
respectively.