Customizing the Oracle Identity Manager Administrative Console

Purpose

This OBE tutorial describes and shows you how to use Oracle Identity Manager to customize its Administrative Console. As a result, you can tailor this console to meet your company's needs.

Time to Complete

Approximately two hours

Topics

This OBE tutorial covers the following topics:

 Overview
 Scenario
 Prerequisites
 Configuring an Oracle Identity Manager Environment
 Customizing the Overall Layout of a Web Page
 Adding Logos to the Administrative Console
 Modifying the Text and Labels of the Administrative Console
 Customizing the Colors, Font, and Alignment of Text Within the Administrative Console
 Customizing the Behavior of a Form Field
 Customizing Search Pages
 Summary
 Related information

Viewing Screenshots

 Place the cursor over this icon to load and view all the screenshots for this tutorial. (Caution: Because this action loads all screenshots simultaneously, response time may be slow depending on your Internet connection.)

Note: Alternatively, you can place the cursor over each individual icon in the following steps to load and view only the screenshot associated with that step.

The screenshots will not reflect the specific environment you are using. They are provided to give you an idea of where to locate specific functionality in Oracle Identity Manager.

Overview

Oracle Identity Manager is a highly flexible and scalable enterprise identity management system that controls user accounts and access privileges within enterprise IT resources centrally. It provides the functionalities of provisioning, identity and role administration, approval and request management, policy-based entitlement management, technology integration, and audit and compliance automation.

Features and benefits of Oracle Identity Manager include identity and role administration (user and group management, self-service functionalities for users, and delegated administration), provisioning (approval and request management, and configurable workflow models), policy-based entitlements, reconciliation, and attestation support (for audit and compliance purposes).

Back to Topic List

Scenario

Linda works as a network administrator for Mydo Main Corporation. For this company, Linda is responsible for performing identity and access management tasks on various users within the organization. One of these tasks is customizing the Administrative Console of the Oracle Identity Manager environment that is installed and configured for Mydo Main. By doing so, she can tailor this console to meet her company's needs.

There are two levels of customization that Linda can perform with the Administrative Console:

There are different ways by which Linda can brand the Administrative Console, including:
  • Customizing the overall layout of the Web pages of the console
  • Adding Mydo Main's corporate logo to the console
  • Modifying the descriptive text and labels that appear on the Web pages of the console
  • Changing the color, font, and alignment of text in the console
There are also various ways by which Linda can change the functionality of the Administrative Console without modifying the code, including:
  • Customizing the behavior of the form fields that appear on the Web pages of the console
  • Customizing the search pages of the console

In this OBE, Linda uses the methods listed in this section to customize the Oracle Identity Manager Administrative Console for Mydo Main Corporation.

Back to Topic List

Prerequisites

Before starting this tutorial, you should:

1.

Complete the OBE titled "Installing Oracle Identity Manager"

2.

Complete the OBE titled "Integrating Oracle Identity Manager with Oracle Database: Performing User Management and Provisioning"

3.

Complete the OBE titled "Integrating Oracle Identity Manager with Sun Java Directory Server: Performing Reconciliation"

4.

Complete the OBE titled "Creating, Managing, and Reviewing Reports and Attestation Processes"

5.

Complete the OBE titled "Integrating Oracle Identity Manager with Oracle Database: Modifying a User's Password"

Back to Topic List

Configuring an Oracle Identity Manager Environment

Linda wants to customize the Oracle Identity Manager Administrative Console for Mydo Main Corporation. However, before she can perform this action, she must configure her company's environment so that the console can be modified. This includes modifying two Oracle Identity Manager files that are packaged with the product: XellerateFull.ear and xlWebApp.war.

To configure an Oracle Identity Manager environment, perform the following steps:

1.

Shut down your Oracle Identity Manager Server, Administrative Console, and Design Console.

Note: For more information about stopping Oracle Identity Manager, refer to the OBE titled "Installing Oracle Identity Manager."

 

2.

Create the following directories in Windows Explorer:

  • E:\jboss-4.0.2_ear
  • E:\jboss-4.0.2_war

 

3.

Cut the XellerateFull.ear file, which can be found in the E:\jboss-4.0.2\server\default\deploy directory and paste it into the E:\jboss-4.0.2_ear directory.

 

4.

Create the XellerateFull.ear folder in the E:\jboss-4.0.2\server\default\deploy directory.

 

5.

Unzip the contents of the XellerateFull.ear file into the E:\jboss-4.0.2\server\default\deploy\XellerateFull.ear directory.

 

6.

Cut the xlWebApp.war file, which can be found in the E:\jboss-4.0.2\server\default\deploy\XellerateFull.ear directory and paste it into the E:\jboss-4.0.2_war directory.

 

7.

Create the xlWebApp.war folder in the E:\jboss-4.0.2\server\default\deploy\XellerateFull.ear directory.

 

8.

Unzip the contents of the xlWebApp.war file, which is contained in the E:\oracle\oim_server\xellerate\webapp directory, into the E:\jboss-4.0.2\server\default\deploy\XellerateFull.ear\xlWebApp.war directory.

Important: The xlWebApp.war file, which is contained in the E:\oracle\oim_server\xellerate\webapp directory, contains files that are specific to Oracle Identity Manager. For this reason, Linda is extracting this file (as opposed to the one located in the E:\jboss-4.0.2_war directory).

 

9.

Modify the desired files according to the instructions associated with the remaining procedures of this OBE.

Important: Before modifying any file that is contained in the xlWebApp.war file, Linda should back it up. The file she edits corresponds to a particular type of customization that she can perform with the Administrative Console.

As an example, the xlWebAdmin.properties file contains the text and labels that appear in the Administrative Console, while the Xellerate.css file is a style sheet that controls the color, font, point size, and alignment for these text and labels.

For more information about which files to modify, refer to the procedures in this OBE.

Linda configured the Oracle Identity Manager environment for Mydo Main Corporation. As a result, she can now customize the Administrative Console for her company.

Linda is now ready to brand the Administrative Console. One way to brand this console is by customizing the overall layout of its Web pages. This can include modifying the width of banners, changing the alignment and orientation of images, and adding links (for example, inserting a link from the corporate logo to Mydo Main's home page).

In the next section of this OBE, Linda learns how to customize the general layout of a Web page by displaying the product logo of Oracle Identity Manager at the right side of the header banner.

Back to Topic List

Customizing the Overall Layout of a Web Page

In the previous section of this OBE, Linda configured the Oracle Identity Manager environment for Mydo Main Corporation so that she can customize the Administrative Console. Linda is now ready to modify the look and feel of this console (that is, brand it). One way to brand this console is by customizing the overall layout of its Web pages. 

In this section, Linda is to customize the general layout of a Web page so that the product logo of Oracle Identity Manager appears at the right side of the header banner. To perform this action, she must access the   tjspHeader.jsp file. Then, she needs to swap the reference to the product logo (that is, global.image.clientlogo ) with the reference for a spacer (or a graphic that occupies a designated amount of horizontal space in the header banner, thereby �pushing� the product logo to the right). The reference for this spacer is global.image.xelleratelogo .

To customize the overall layout of a Web page, perform the following steps:

1.

Using a text editor, open the tjspHeader.jsp file. This file can be found in the E:\jboss-4.0.2\server\ default\deploy\XellerateFull.ear\xlWebApp.war\tiles\common directory.

The   tjspHeader.jsp file appears. 

 

2.

In this file, locate the reference to the product logo ( global.image.clientlogo ).

 

3.

Replace this reference with the one for a spacer (or a graphic that occupies a designated amount of horizontal space in the header banner, thereby �pushing� the product logo to the right). The reference for the spacer is global.image.xelleratelogo .

 

4.

Repeat steps 2 and 3, swapping the spacer for the product logo.

 

5.

Save the changes to the tjspHeader.jsp file. Close the file. 

 

6.

Restart the Oracle Identity Manager Server and Administrative Console. The Home page of the console appears, with the product logo now appearing at the right side of the header banner.

Note: For more information about starting Oracle Identity Manager, refer to the OBE titled "Installing Oracle Identity Manager."

Linda customized the general layout of a Web page so that the product logo of Oracle Identity Manager appears at the right side of the header banner.

In the next section of this OBE, Linda learns another way to brand the Administrative Console. She is to add a logo to the header banner of this console. This logo represents the company logo for Mydo Main Corporation.

Back to Topic List

Adding Logos to the Administrative Console

In the previous section of this OBE, Linda customized the overall layout of a Web page so that the product logo of Oracle Identity Manager appears at the right side of the header banner.

Linda is now ready to brand the Administrative Console in a different way. For this OBE, she is to add a logo to the header banner of this console. This logo represents the company logo for Mydo Main Corporation. The reference for this logo is mydomain.gif .

To perform this action, she must access the   xlWebAdmin.properties file. Then, she needs to assign the company logo to the property, which represents the spacer (that is, global.image.xelleratelogo ).

To add a logo to the Administrative Console, perform the following steps:

1.

Shut down your Oracle Identity Manager Server and Administrative Console.

 

2.

From the Desktop, copy the mydomain.gif file (which represents the company logo for Mydo Main Corporation).

 

3.

Paste this file in the E:\jboss-4.0.2\server\default\deploy\XellerateFull.ear\xlWebApp.war\images directory.

 

4.

Using a text editor, open the xlWebAdmin.properties file. This file can be found in the E:\jboss-4.0.2\server\default\deploy\XellerateFull.ear\xlWebApp.war\WEB-INF\classes directory.

The  xlWebAdmin.properties file appears. 

 

5.

In this file, locate the GLOBAL images section.

 

6.

Locate the global.image.xelleratelogo property. Then, set the value of this property to be equivalent to the full path and name of the image file that contains the company logo for Mydo Main Corporation (that is, /images/mydomain.gif).

 

7.

Save the changes to the xlWebAdmin.properties file. Close the file. 

8.

Restart the Oracle Identity Manager Server and Administrative Console. The company logo for Mydo Main Corporation appears on the Home page of the console.

Linda added the company logo for Mydo Main Corporation to the header banner of the Administrative Console. In the next section of this OBE, Linda learns another way to brand this console. She is to modify its text and labels.

Back to Topic List

Modifying the Text and Labels of the Administrative Console

In the previous section of this OBE, Linda added the company logo for Mydo Main Corporation to the header banner of the Administrative Console.

Linda is now ready to brand this console in a different way. For this OBE, she is to modify the explanatory text and the label of the Search User button that appear on the Manage User form of the Administrative Console.

To perform this action, she must access the   xlWebAdmin.properties file. This file contains all of the text and labels that appear in the Administrative Console. Then, she needs to assign new values to the properties, which represent the explanatory text and the label of the Search User button that appear on the Manage User form. These properties are located in the section of the xlWebAdmin.properties file titled Start of MANAGE USER Properties .

To modify the text and labels of the Administrative Console, perform the following steps:

1.

Shut down your Oracle Identity Manager Server and Administrative Console.

 

2.

Using a text editor, open the xlWebAdmin.properties file.

 

3.

In this file, locate the Start of MANAGE USER Properties section.

 

4.

Modify the explanatory text and the label of the Search User button that appear on the Manage User form of the Administrative Console as follows:

Property Old Value New Value
manageUser.message.searchUserDesc Please type in search criteria to search for users. Here, you can enter what you need to find whom you need.
manageUser.button.searchUser Search User Search Oracle User

The Start of MANAGE USER Properties section of the xlWebAdmin.properties file should appear as follows:

 

5.

Save the changes to the xlWebAdmin.properties file. Close the file. 

6.

Restart the Oracle Identity Manager Server and Administrative Console.

7.

Log in to the Administrative Console with the "superuser" account for Oracle Identity Manager (that is, enter xelsysadm in the User ID field and abcd1234 in the Password field).

 

8.

Open the Manage User form in the Users folder.

The Manage User form appears.

The label of the Search User button and the explanatory text, which appear in this form, now reflect the changes Linda made to the xlWebAdmin.properties file. As a result, she modified the text and label of the Administrative Console.

In the next section of this OBE, Linda learns another way to brand this console. She is to customize the colors, font, and alignment of text that appears within the Administrative Console.

Back to Topic List

Customizing the Colors, Font, and Alignment of Text Within the Administrative Console

In the previous section of this OBE, Linda modified explanatory text and a button label of the Administrative Console.

Linda is now ready to brand this console in a different way. For this OBE, she is to customize the color, font face, and alignment of the text that appears within the footer banner of the Administrative Console.

To perform this action, she must access the Xellerate.css file. This file is a style sheet that controls the properties of the text, which appear in the Administrative Console (such as the color, font, and alignment of the text). Because Linda is modifying the text that is displayed in the footer banner, she needs to access the FOOTER section of the Xellerate.css file.

To customize the colors, font, and alignment of text within the Administrative Console, perform the following steps:

1.

Shut down your Oracle Identity Manager Server and Administrative Console.

 

2.

Using a text editor, open the Xellerate.css file. This file can be found in the E:\jboss-4.0.2\server\default\deploy\XellerateFull.ear\xlWebApp.war\css directory.

The  Xellerate.css file appears. 

 

3.

In this file, locate the FOOTER section.

 

4.

Modify the text that appears in the footer banner of the Administrative Console as follows:

Attribute Old Value New Value
Color White Yellow (represented by the ffff00 hexadecimal code)
Font Face Arial Times New Roman
Alignment Right Left

The FOOTER section of the Xellerate.css file should appear as follows:

 

5.

Save the changes to the Xellerate.css file. Close the file. 

6.

Restart the Oracle Identity Manager Server and Administrative Console. The text that appears in the footer banner of this console reflects Linda's changes to the Xellerate.css file .

Linda customized the color, font face, and alignment of the text that appears within the footer banner of the Administrative Console.

In the next section of this OBE, she learns about the other level of customization she can perform with this console (that is, changing the functionality of the Administrative Console without modifying the Oracle Identity Manager code) . Specifically, she is to customize the behavior of a form field that appears on a Web page of this console.

Back to Topic List

Customizing the Behavior of a Form Field

In the previous section of this OBE, Linda customized the color, font face, and alignment of the text that appears within the footer banner of the Administrative Console.

Linda is now ready to learn about the other level of customization she can perform with this console (that is, changing the functionality of the Administrative Console without modifying the Oracle Identity Manager code) .

For this OBE, she is to set the Email Address field of the Create User form to be required. That is, this field must be populated for the corresponding user record to be saved to the database. As a result, by learning this, she can tailor the behavior of any form field, which appears on the Web pages of the Administrative Console, to meet her company's needs.

To perform this action, she must access the   FormMetaData.xml file. This file controls the behavior of all fields that compose the Web pages of the Administrative Console. Because Linda is setting the Email Address field of the Create User form to be required, she needs to access the User Management section of the FormMetaData.xml file.

To customize the behavior of a form field within the Administrative Console, perform the following steps:

1.

Shut down your Oracle Identity Manager Server and Administrative Console.

 

2.

Using a text editor, open the FormMetaData.xml file. This file can be found in the E:\oracle\oim_server\xellerate\config directory.

The  FormMetaData.xml file appears. 

 

3.

In this file, locate the User Management section.

 

4.

For this OBE, Linda is setting the Email Address field of the Create User form to be required. Therefore, modify the code for this field as follows:

Field Attribute Old Value New Value
Email optional true false

Note: By setting the optional parameter to false, the Email Address field of the Create User form must be populated for the associated user record to be saved to the database.

The User Management section of the FormMetaData.xml file should appear as follows:

 

5.

Save the changes to the FormMetaData.xml file. Close the file. 

6.

Restart the Oracle Identity Manager Server and Administrative Console.

7.

Log in to the Administrative Console with the "superuser" account for Oracle Identity Manager (that is, enter xelsysadm in the User ID field and abcd1234 in the Password field).

 

8.

Open the Create User form in the Users folder.

The Create User form appears.

The Email Address field of the Create User form is now required. Linda's change to the FormMetaData.xml file is reflected in the form. As a result, she customized the behavior of this form field.

In the next section of this OBE, Linda learns another way to change the functionality of the Administrative Console without modifying the Oracle Identity Manager code. She is to customize the search pages of this console.

Back to Topic List

Customizing Search Pages

In the previous section of this OBE, Linda customized the behavior of a form field within the Administrative Console.

Linda is now ready to change the functionality of this console in a different way. For this OBE, she is to customize its search pages. Specifically, she is to increase the maximum number of search results that can appear on a Web page of the Administrative Console, from 10 to 15.

To perform this action, Linda must access the xlWebAdmin.properties file. She is increasing the maximum number of search results from 10 to 15. Therefore, she needs to modify the value of the global.displayrecordNum.value property, which controls this setting, accordingly (that is, change the value from 10 to 15).

To customize the search pages of the Administrative Console, perform the following steps:

1.

Shut down your Oracle Identity Manager Server and Administrative Console.

 

2.

Using a text editor, open the xlWebAdmin.properties file.

 

3.

In this file, locate the global.displayrecordNum.value property.

Note: The current value for the global.displayrecordNum.value property is set to 10. This value represents the number of search results that can appear on a Web page of the Administrative Console, by default.

 

4.

For this OBE, Linda is increasing the maximum number of search results that can appear on a Web page of the Administrative Console (from 10 to 15). Therefore, modify the value of the global.displayrecordNum.value property as follows:

Property Old Value New Value
global.displayrecordNum.value 10 15

The global.displayrecordNum.value property of the xlWebAdmin.properties file should appear as follows:

 

5.

Save the changes to the xlWebAdmin.properties file. Close the file. 

6.

Restart the Oracle Identity Manager Server and Administrative Console.

7.

Log in to the Administrative Console with the "superuser" account for Oracle Identity Manager (that is, enter xelsysadm in the User ID field and abcd1234 in the Password field).

 

8.

Open the Manage User form in the Users folder.

The Manage User form appears.

Note: Linda opens the Manage User form because this form contains more records than can appear on a single Web page. That is, the number of records is greater than the value Linda set for the global.displayrecordNum.value property .

Linda is now ready to perform a query for this form. By doing so, she can confirm that her modification to the global.displayrecordNum.value property is reflected within the Manage User form.

 

9.

Select User ID from the combo box that appears within this form. Then, within the text box that appears to the right of the combo box, enter * . This value represents a "wildcard" character. Lastly, click Search Oracle User.

The results of Linda's query appear.

The modification to the global.displayrecordNum.value property is reflected within the Manage User form. That is, the maximum number of search results that appear on this Web page is now 15 instead of 10. As a result, Linda customized the search pages of the Administrative Console.

Back to Topic List

Summary

In this lesson, you learned how to:

 Configure an Oracle Identity Manager environment
 Customize the overall layout of a Web page
 Add logos to the Administrative Console
 Modify the text and labels of the Administrative Console
 Customize the colors, font, and alignment of text within the Administrative Console
 Customize the behavior of a form field
 Customize search pages

Back to Topic List

Related Information

 To ask a question about this OBE tutorial, post a query on the OBE Discussion Forum.

Back to Topic List

 Place the cursor over this icon to hide all screenshots.

 

Left Curve
Popular Downloads
Right Curve
Untitled Document