Changing the Functionality of the Administrative and User Console

Purpose

This OBE tutorial describes and shows you how to change the functionality of the Oracle Identity Manager Administrative and User Console without modifying Oracle Identity Manager code.

Time to Complete

Approximately 1 hour

Topics

This OBE tutorial covers the following topics:

 Overview
 Scenario
 Prerequisites
 Customizing the Behavior of Form Fields
 Changing the "Quick Status" Counts
 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 component of the suite of Oracle Identity and Access Management products. It administers and selectively automates tasks to manage user access privileges across a company’s resources throughout the identity management life cycle. Specifically, Oracle Identity Manager handles tasks for creating user access privileges, modifying these privileges dynamically (based on changes to user and business requirements), and removing user access privileges. As a result, Oracle Identity Manager handles user identity information across multiple identity data stores to maintain data accuracy.

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, regulatory, and compliance purposes).

Back to Topic List

Scenario

Linda works as a network administrator for Mydo Main Corporation. She is responsible for performing identity and access management tasks for users in the company. One such task is customizing the Administrative and User Console for the Oracle Identity Manager environment installed and configured for Mydo Main. By doing so, she can tailor this console to meet her company's requirements.

One type of customization to perform with the Administrative and User Console is modifying the functionality of the console without editing Oracle Identity Manager code.

There are different ways Linda can change the functionality of the Administrative and User Console without touching code, including:

In this OBE, Linda uses the methods listed in this section to change the functionality of the Administrative and User Console for Mydo Main Corporation.

Back to Topic List

Prerequisites

Before starting this tutorial, you should:

1.

Complete the OBE titled Installing, Configuring, and Launching Oracle Identity Manager.

2.

Complete the OBE titled Preparing to Customize the Administrative and User Console.

3.

Complete the OBE titled Branding the Administrative and User Console.

Back to Topic List

Customizing the Behavior of Form Fields

In the OBE titled Branding the Administrative and User Console, Linda learned how to modify the look and feel of the console (that is, brand it).

Linda is ready to learn about another other type of customization to perform with this console. Specifically, she is to change the functionality of the Administrative and User Console without modifying Oracle Identity Manager code.

In this section, she is to set the Email field of the Create User form to be required. This field must be populated for the corresponding user record to be saved to the database. By learning this, she can tailor the behavior of any form field that appears on the Web pages of the Administrative and User Console to meet her company's requirements.

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 and User Console. Because Linda is setting the Email 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 and User Console, perform the following steps:

1.

Shut down Oracle Identity Manager Server, and the Administrative and User Console.

 

2.

Using a text editor, open the FormMetaData.xml file (found in the C:\OIM91_server\xellerate\config folder).

 

3.

Locate the section called <!-- User Management section -->. This section contains information about fields of the Create User form with attributes to modify.

 

4.

For this OBE, Linda is setting the Email 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 field of the Create User form must be populated for the associated user record to be saved to the database.

 

5.

Save and close the FormMetaData.xml file. 

 

6.

Restart Oracle Identity Manager Server, and the Administrative and User Console.

 

7.

Populate the fields of the Oracle Identity Manager Administrative and User Console login page, as follows (and click Login):

Field Value
User ID xelsysadm
Password abcd1234

 

8.

Open the Create User form (found in the Users folder of the Oracle Identity Manager Explorer).

 

9.

Verify the Email field is required.

Note: For more information about starting and stopping Oracle Identity Manager, refer to the OBE titled Installing, Configuring, and Launching Oracle Identity Manager.

Linda's change to the FormMetaData.xml file is reflected in the Create User form. She customized the behavior of the Email form field. By learning this, she can tailor the behavior of any form field that appears on the Web pages of the Administrative and User Console to meet her company's requirements.

In the next section of this OBE, Linda learns another way to change the functionality of the Administrative and User Console without modifying Oracle Identity Manager code. She is to change the "Quick Status" counts that appear on the Home page of this console.

Back to Topic List

Changing the "Quick Status" Counts

After an administrator logs into the Administrative and User Console, Oracle Identity Manager:

Mydo Main Corporation has many pending approvals and open provisioning tasks to be completed manually. After these tasks are completed, Oracle Identity Manager can create user access privileges, modify these privileges dynamically (based on changes to user and business requirements), and remove user access privileges for the company's resources.

However, displaying these counts results in Oracle Identity Manager requiring additional time to render the Home page of its Administrative and User Console. Because of this, it is better for Oracle Identity Manager not to show the counts, and instead, provide a link to each count.

In this section, Linda reconfigures the Home page of the Administrative and User Console to replace the "Quick Status" counts for the Pending Approvals and Open Provisioning Tasks fields with links to these counts.

To modify the Quick Status region of the Home page of the Administrative and User Console, perform the following steps:

1.

Shut down Oracle Identity Manager Server, and the Administrative and User Console.

 

2.

Using a text editor, open the xlDefaultAdmin.properties file (found in the C:\product\10.1.3.1\OracleAS_1\j2ee\home\applications\Xellerate\xlWebApp\WEB-INF\classes folder).

 

3.

Locate the webadminhome.message.skipPendingApprovalsOpenTasksCounter property.

 

4.

For this OBE, Linda is replacing the "Quick Status" counts for the Pending Approvals and Open Provisioning Tasks fields with links to these counts (that is, she is "skipping" the displaying of these counts). Therefore, modify the value for this property, as follows:

Property Old Value New Value
webadminhome.message.skipPendingApprovalsOpenTasksCounter false true

Note: By setting the value of the webadminhome.message.skipPendingApprovalsOpenTasksCounter property to true, the "Quick Status" counts for the Pending Approvals and Open Provisioning Tasks fields do not appear when an administrator logs into the Home page of the Administrative and User Console. Instead, links to these counts are displayed.

 

5.

Save and close the xlDefaultAdmin.properties file. 

 

6.

Restart Oracle Identity Manager Server, and the Administrative and User Console.

 

7.

Populate the fields of the Oracle Identity Manager Administrative and User Console login page, as follows (and click Login):

Field Value
User ID xelsysadm
Password abcd1234

 

8.

Verify that the Quick Status region of the Home page does not display counts in the Pending Approvals and Open Provisioning Tasks fields. Instead, a link appears for each count.

Linda's change to the xlDefaultAdmin.properties file is reflected in the Home page of the Administrative and User Console. She reconfigured the Quick Status region of the Home page to replace the "Quick Status" counts for the Pending Approvals and Open Provisioning Tasks fields with links to these counts.

In the next section of this OBE, Linda learns another way to change the functionality of the Administrative and User Console without modifying 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 reconfigured the Home page of the Administrative and User Console to replace the "Quick Status" counts for the Pending Approvals and Open Provisioning Tasks fields with links to these counts.

Linda is 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 reduce the maximum number of search results to appear on a Web page of the console, from 10 to 2.

To perform this action, Linda must access the xlDefaultAdmin.properties file. This file controls the general layout of Web pages that compose the Administrative and User Console (including the maximum number of search results to appear on a Web page).

Linda is decreasing the maximum number of search results from 10 to 2. Therefore, she must modify the value of the global.displayrecordNum.value property, which controls this setting, accordingly (that is, change the value of the property from 10 to 2).

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

1.

Shut down Oracle Identity Manager Server, and the Administrative and User Console.

 

2.

Using a text editor, open the xlDefaultAdmin.properties file (found in the C:\product\10.1.3.1\OracleAS_1\j2ee\home\applications\Xellerate\xlWebApp\WEB-INF\classes folder).

 

3.

Locate the global.displayRecordNum.value property.

 

4.

For this OBE, Linda is reducing the maximum number of search results to appear on a Web page of the Administrative and User Console, from 10 to 2. Therefore, modify the value for this property, as follows:

Property Old Value New Value
global.displayRecordNum.value 10 2

 

5.

Save and close the xlDefaultAdmin.properties file. 

6.

Restart Oracle Identity Manager Server, and the Administrative and User Console.

 

7.

Populate the fields of the Oracle Identity Manager Administrative and User Console login page, as follows (and click Login):

Field Value
User ID xelsysadm
Password abcd1234

 

8.

Open the Manage User form (found in the Users folder of the Oracle Identity Manager Explorer).

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 ready to use this form to perform a query. By doing so, she confirms that her modification to the global.displayrecordNum.value property is reflected within the form.

 

9.

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

Verify that the modification to the xlDefaultAdmin.properties file is reflected in this form (that is, the maximum number of search results on a Web page should now be 2 instead of 10):

Linda customized the search pages of the Administrative and User Console. In this OBE, she learned how to change the functionality of this console without modifying Oracle Identity Manager code.

Back to Topic List

Summary

In this lesson, you learned how to:

 Customize the behavior of form fields
 Change the "Quick Status" counts
 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