16 Working with the Diagnostic Dashboard

This chapter describes the Diagnostic Dashboard utility shipped with Oracle Identity Manager and includes the following topics:

• Introduction to the Diagnostic Dashboard

• Installing the Diagnostic Dashboard

• Using the Diagnostic Dashboard

• Test Details and Parameters

Introduction to the Diagnostic Dashboard

You use the Diagnostic Dashboard to validate some of the Oracle Identity Manager prerequisites and to verify the installation.

You must have the appropriate system administrator permissions for your Application Server and Oracle Identity Manager environments to use this tool. Some database-related tests require DBA-level permissions.

The list of tests available and displayed depends on whether or not Oracle Identity Manager is installed and on what application server this tool and Oracle Identity Manager will be or are installed on.

The Diagnostic Dashboard utility and Oracle Identity Manager should be installed on the same application server.

Installation Tests

You use the Diagnostic Dashboard utility before installing Oracle Identity Manager, right after Oracle Identity Manager installation to verify that the installation is fine, and subsequently to check the status of the installation.

The following tests are performed before Oracle Identity Manager installation:

Note:

Microsoft SQL Server is not supported in Oracle Identity Manager release 9.1.0. See ÒCertified ComponentsÓ in Oracle Identity Manager Release Notes for information about certified components

• Microsoft SQL Server JDBC Libraries Availability Check

• Microsoft SQL Server Prerequisites Check

• Oracle Prerequisites Check

• Embedded JMS Server Status

In addition, the following reports are available:

• Java VM System Properties Report

• WebSphere Version Report

The following tests are available only after the Oracle Identity Manager installation is available on the application server:

• Database Connectivity Check

• Account Lock Status

• Data Encryption Key Verification

• Scheduler Service Status

• Remote Manager Status

• JMS Messaging Verification

• Target System SSL Trust Verification

• SSL Diagnostic Information

The following reports are also available only after an Oracle Identity Manager installation is available:

• Oracle Identity Manager Libraries and Extensions Version Report

• Oracle Identity Manager Libraries and Extensions Manifest Report

You can run the following tests at any time to check the status of the Oracle Identity Manager installation:

• Display Version Number

• JVM Version Verification

• Fresh Oracle Identity Manager Installation Verification

• Database Verification

• WebSphere Embedded JMS Installation Verification

• Database Encryption Key Generation

Postinstallation Tests

The following are postinstallation tests:

• Database Encryption Key Verification

• Truststore verification

• SSO Diagnostics or Verification

• JMS Server availability on IBM WebSphere Application Server

• Messaging Verification

• Scheduler Verification

• Remote Manager Verification

• Reporting Version numbers

• Packaging

Installing the Diagnostic Dashboard

The Diagnostic Dashboard utility is distributed on the installation CD with the Oracle Identity Manager Installer. It is available as a WAR file in the Diagnostic Dashboard directory on the CD-ROM.

Oracle recommends that you deploy the Diagnostic Dashboard utility on the application server before installing Oracle Identity Manager.

Installing the Diagnostic Dashboard on Oracle Application Server

This section describes how to install the Diagnostic Dashboard on Oracle Application Server.

Note:

For clustered installations, you must install Diagnostic Dashboard on each node in the cluster.

To install the Diagnostic Dashboard on Oracle Application Server:

1. Log in to the Administrative and User Console.

2. Click Log on to Oracle Enterprise Manager 10g Application Server Control.

3. Log in by using your Oracle Application Server administrator account.

4. For nonclustered deployments, click Home under the Oracle Application Server instance column under Groups. For clustered deployments, select the instance name of the cluster node.

5. Click Application on the Oracle Application Server home page.

6. Click Deploy.

7. Select the Archive is present on local host. Upload the archive to the server where Application Server Control is running: option.

8. Click Browse and select XIMDD.war from the following directory:

   installer_home/dashboard/

   Click Next.

9. In Step 2 of the wizard, specify a name for the application (for example, XIMDD), and then click Deploy in Step 3 of the wizard.

   You can access the Diagnostic Dashboard at the following location:

   http://OIM_server_host_ip:port/XIMDD
   

   Note:

   If you want the Scheduler test to run successfully, you must access XIMDD from each node of the cluster. However, if you try to access XIMDD from the Web server, it will fail.

Deploying on JBoss Application Server

To deploy the Diagnostic Dashboard on JBoss Application Server, copy the XIMDD.WAR file to the following location:

JBOSS_HOME/server/default/deploy

Deploying on IBM WebSphere Application Server

To deploy the Diagnostic Dashboard on IBM WebSphere Application Server:

1. Log in to the administrator console for the application server.

2. On the WebSphere main page, click Applications on the left menu pane, and then click Install New Application.

   The Preparing for the Application Installation page is displayed.

3. Specify the location of the WAR file as the value of the Path attribute and XIMDD as the Context root.

4. Click Next to proceed, and then click Next on the Generate Default Bindings page.

   The Install New Application page is displayed.

5. Change the application name to XIMDD. Click Next twice.

6. Select the cluster or server, select XIMDD.war, and then click Apply.

7. Confirm that the selected cluster or server is displayed under the Server column, and then click Next.

8. Click Finish.

   The Installing page is displayed. After the application installs successfully, the following message is displayed:

   Application XIMDD installed successfully

9. Click Save to Master Configuration, then click Save.

10. Click Applications > Enterprise Applications in the left menu pane.

11. Select XIMDD, and then click Start.

    A status is displayed, for example, whether or not the installed application has been started successfully.

Deploying on BEA WebLogic Server

To deploy the Diagnostic Dashboard on BEA WebLogic Server:

1. Log in to the Administrative and User console.

2. In the left navigation pane, click Deployments, and then click Web Application Modules.

3. Click Deploy a new Web Application Module, then click Upload your file(s) to upload the XIMDD.war file.

4. Navigate to the location for uploading the WAR file. Typically, the WAR file should be in the following directory:

   WL_HOME/user_projects/domains/your-domain-name /your-adminserver-name/upload
   

5. Click Upload.

   Select XIMDD.war, and then click Target Module.

6. Click Deploy.

   The next page displays the successful deployment of the application.

You can now use a browser and connect to the Diagnostic Dashboard.

Launching the Diagnostic Dashboard

After the Diagnostic Dashboard is deployed, you can access it by using a URL of the following format:

http://host:port/XIMDD

In a clustered installation, you must connect to the individual cluster members directly with their corresponding host and port numbers. Click the Diagnostic Dashboard link on the left menu pane to display the main Diagnostic Dashboard main page.

The Diagnostic Dashboard utility indicates on which application server the tool is deployed. It also indicates whether or not Oracle Identity Manager is already installed on that application server. The tests displayed in the following table may vary, depending on whether or not Oracle Identity Manager is installed and which application server is used. Table 16-1 also shows the availability of these tests.

Note:

Microsoft SQL Server is not supported in Oracle Identity Manager release 9.1.0. See ÒCertified ComponentsÓ in Oracle Identity Manager Release Notes for information about certified components

Table 16-1 Diagnostic Dashboard Tests

Test	Availability When Oracle Identity Manager Is Not Installed	Application Servers
Microsoft SQL Server JDBC Libraries Availability Check	Yes	JBoss Application Server
Microsoft SQL Server Prerequisites Check	Yes	JBoss Application Server
Oracle Prerequisites Check	Yes	All
WebSphere Embedded JMS Server Status	Yes	IBM WebSphere Application Server
Database Connectivity Check	No	All
Account Lock Status	No	All
Data Encryption Key Verification	No	All
Scheduler Service Status	No	All
Remote Manager Status	No	All
JMS Messaging Verification	No	All
Target System SSL Trust Verification	No	All
Java VM System Properties Report	Yes	All
WebSphere Version Report	Yes	IBM WebSphere Application Server
Oracle Identity Manager Libraries and Extensions Version Report	No	All
Oracle Identity Manager Libraries and Extensions Manifest Report	No	All
SSO Diagnostic Information	No	All
Test Basic Connectivity	No	All
Test Provisioning	No	All
Test Reconciliation	No	All

Using the Diagnostic Dashboard

The Diagnostic Dashboard main page includes the sections listed in the following table:

Section	Description
System Information Application Server	Displays the name of the application server
Oracle Identity Manager Installation	Displays installation details such as product version, build number, host, and location of the product
Test Details Test Name	Displays the test name
Description	Displays the description of the test
Test Parameters	Displays testing parameters if required for verifying the test

To run a test:

1. Select the test by selecting the option on the Diagnostic Dashboard main page.

2. Enter the required parameters.

3. Click Verify to see the result.

   The Diagnostic Dashboard Test Result page is displayed with the status information listed in the following table.

Test Result	Description
Result Summary	Shows all the selected tests with icons (pass or fail) indicating the result. The test name is a Web link that allows the user to jump to the result details directly.
Test Name	Displays the name of the test
Description	Displays the description of the test
Input Parameters	Displays the parameters of the test
Result	Displays the outcome of the test
Details	Displays details about the outcome of the test

4. Click Diagnostic Dashboard on the left menu pane to return to the previous test page.

Test Details and Parameters

The following tests are available for different application servers:

• Microsoft SQL Server JDBC Libraries Availability Check

• Microsoft SQL Server Prerequisites Check

• Oracle Database Prerequisites Check

• WebSphere Embedded JMS Server Status

• Database Connectivity Check

• Account Lock Status

• Data Encryption Key Verification

• Scheduler Service Status

• Remote Manager Status

• JMS Messaging Verification

• Target System SSL Trust Verification

• Java VM System Properties Report

• WebSphere Version Report

• Oracle Identity Manager Libraries and Extensions Version Report

• Oracle Identity Manager Libraries and Extensions Manifest Report

• SSO Diagnostic Information

• Test Basic Connectivity

• Test Provisioning

• Test Reconciliation

Microsoft SQL Server JDBC Libraries Availability Check

Note:

Microsoft SQL Server is not supported in Oracle Identity Manager release 9.1.0. See ÒCertified ComponentsÓ in Oracle Identity Manager Release Notes for information about certified components

Prerequisite: None

Description: Oracle Identity Manager needs JDBC drivers in the CLASSPATH to work with Microsoft SQL Server. This test verifies if the drivers are available in the CLASSPATH.

Result: Microsoft SQL Server Driver should be found.

Microsoft SQL Server Prerequisites Check

Note:

Microsoft SQL Server is not supported in Oracle Identity Manager release 9.1.0. See ÒCertified ComponentsÓ in Oracle Identity Manager Release Notes for information about certified components

Application Server: JBoss Application Server

Prerequisite: The following are the prerequisites for running this test:

Prerequisite	Description
Database Server	Enter the location for the database server.
Port	Enter the port number.
Database Name	Enter the database name.
Oracle Identity Manager Database User Name	Enter the Oracle Identity Manager database user name.
Oracle Identity Manager Database User Password	Enter the Oracle Identity Manager database user password.

Description: Checks if the specified Microsoft SQL server instance meets the prerequisites for Oracle Identity Manager installation

Result: It will display the following information:

• Necessary permissions for user

• XA support should be enabled

• Microsoft SQL Server Version

Oracle Database Prerequisites Check

Application Server: JBoss Application Server or IBM WebSphere Application Server / BEA WebLogic Server / Oracle Application Server

Prerequisite: The following are the prerequisites for running this test:

Prerequisite	Description
Database Server	Enter the location of the database server.
Port	Enter the port number.
Database Name (SID)	Enter the database name (SID).
Oracle Identity Manager Database User Name	Enter the Oracle Identity Manager database user name.
System User Name	Enter the system user name.
System User Password	Enter system user password.

Description: Checks if the specified Oracle instance meets the prerequisites for Oracle Identity Manager installation. This test requires SYSTEM permissions.

Result: It will display the following information:

• Necessary permissions for user

• XA support enabled

• JVM enabled

• Oracle version Information

WebSphere Embedded JMS Server Status

Application Server: IBM WebSphere Application Server

Prerequisite: The following are the prerequisites for running this test:

Prerequisite	Description
Host	Enter the host name.
Port	Enter the port number.
User Name	Enter the user name.
Password	Enter the password.

Description: Checks the status of JMS Server. This test is valid for IBM WebSphere Application Server only and requires Oracle Identity Manager to be installed.

Result: Displays the status of JSM Server.

Database Connectivity Check

Application Server: All

Prerequisite: None

Description: Run this test to verify whether or not Oracle Identity Manager is able to connect to the database. This test verifies the direct database connection as well as the J2EE data sources (XA and non-XA).

Result: It will display the following information:

• Direct database connectivity

• XA and non-XA execution

Account Lock Status

Application Server: All

Prerequisite: The following is the prerequisite for verifying this test:

Prerequisite	Description
User Name	Enter the user name.

Description: Oracle Identity Manager locks an account when there are successive multiple invalid login attempts. This test checks whether or not a specified account is locked.

Result: Checks for locked or unlocked accounts in the database.

Data Encryption Key Verification

Application Server: All

Prerequisite: None

Description: The data encryption key in an Oracle Identity Manager installation should be the same as the one used to encrypt the data in the Oracle Identity Manager database. This may not be the case when an Oracle Identity Manager installation is pointed to a database schema created for a different Oracle Identity Manager installation. This can also happen when a database dump from one Oracle Identity Manager installation is imported for a different Oracle Identity Manager installation without copying the corresponding key.

Result: Checks if the database key is present in the Oracle Identity Manager configuration directory.

Scheduler Service Status

Application Server: All

Prerequisite: None

Description: Checks the status of the Oracle Identity Manager Scheduler Service running on the server.

Result: Displays the status of the scheduler service.

Remote Manager Status

Application Server: All

Prerequisite: None

Description: Reports the status of the Remote Managers that this Oracle Identity Manager installation is set to work with.

Result: Displays the status of the Remote Manager.

JMS Messaging Verification

Application Server: All

Prerequisite: None

Description: The purpose of this test is to verify that Oracle Identity Manager will be able to submit a JMS message and process it.

Result: Displays if Oracle Identity Manager is able to submit and process a JMS message.

Target System SSL Trust Verification

Application Server: All

Prerequisite: The following are the prerequisites for running this test:

Prerequisite	Description
Host	Enter the host name.
Port	Enter the port number.
Truststore Location	Enter the location for storage.
Truststore Password	Enter the password for storage.

Description: Oracle Identity Manager must be set up to trust the target system certificates if the connectivity is over Secure Sockets Layer (SSL). Enter the host name and the port where a target system is listening for SSL connections.

Result: It displays the following information:

• Valid and invalid host and port address

• Trusted certificates

Java VM System Properties Report

Application Server: All

Prerequisite: None

Description: Displays all the Java VM system properties.

Result: Displays all the Java VM system properties.

WebSphere Version Report

Application Server: IBM WebSphere Application Server

Prerequisite: None

Description: Obtains the IBM WebSphere Application Server version information along with a list of all the installed fix packs and components of the application server.

Result: Displays WebSphere version information

Oracle Identity Manager Libraries and Extensions Version Report

Application Server: All

Prerequisite: None

Description: Reports all the versions of the Oracle Identity Manager libraries and extensions.

Result: Displays the versions of the Oracle Identity Manager libraries and extensions.

Oracle Identity Manager Libraries and Extensions Manifest Report

Application Server: All

Prerequisite: None

Description: Reports the manifest information of the Oracle Identity Manager libraries and extensions.

Result: Displays the manifest information of the Oracle Identity Manager libraries and extensions.

SSO Diagnostic Information

Application Server: All

Prerequisite: None

Description: Provides information pertaining to SSO setup. In addition, provides instructions needed for setting up Oracle Identity Manager to enable retrieving run-time diagnostic information related to SSO logins.

Result: Displays whether or not the SSO setup is enabled for the Oracle Identity Manager installation.

Test Basic Connectivity

Application Server: All

Prerequisite: IT resource type and IT resource name

Description: Tests the connection to the target system by using the IT resource for the target system.

Note:

If the specified IT resource type was created when you deployed a predefined connector, then see the Oracle Identity Manager Connector Pack release notes and documentation to determine whether or not this test can be applied for the release of the connector that you deployed.

Result: Displays the results of the connectivity test. If the test fails, then the cause of the error is also displayed.

Test Provisioning

Application Server: All

Prerequisite: IT resource type and IT resource name

Description: Performs a basic Create User operation on the target system.

Note:

If the specified IT resource type was created when you deployed a predefined connector, then see the Oracle Identity Manager Connector Pack release notes and documentation to determine whether or not this test can be applied for the release of the connector that you deployed.

Result: Displays the results of the provisioning test. Test data created on the target system during the test is deleted at the end of the test.

Test Reconciliation

Application Server: All

Prerequisite: IT resource type and IT resource name

Description: Performs a basic reconciliation operation on the target system.

Note:

If the specified IT resource type was created when you deployed a predefined connector, then see the Oracle Identity Manager Connector Pack release notes and documentation to determine whether or not this test can be applied for the release of the connector that you deployed.

Result: Displays the results of the reconciliation test. Test data reconciled into Oracle Identity Manager during the test is deleted at the end of the test.