Oracle® Identity Manager Administrative and User Console Guide Release 9.0 Part Number B32136-01 |
|
|
View PDF |
This chapter describes the Diagnostic Dashboard feature of Oracle Identity Manager.
This chapter discusses the following topics:
You use the Diagnostic Dashboard tool to validate some of the Oracle Identity Manager prerequisites and to verify the installation.You must have the appropriate system administrator privileges for your Application Server and Oracle Identity Manager environments to use this tool. Some database related tests need DBA privileges. If you do not have DBA privileges, give the URL to the test to a DBA and have the DBA send the results back to you.The list of tests available and displayed depends on whether Oracle Identity Manager is installed or not and on what application server this tool and Oracle Identity Manager will be or are installed on.The Diagnostic Dashboard tool and Oracle Identity Manager should be installed on the same application server.
You use this tool 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:
Microsoft SQL Server JDBC Libraries Availability Check
Microsoft SQL Server Prerequisites Check
Oracle Prerequisites Check
Embedded JMS Server Status
In addition, the following two reports are available:
Java VM System Properties Report
WebSphere Version Report
The following tests are only available after 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 two 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 these 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
The following are the post-installation tests:
Database Encryption Key Verification
Trust store verification
SSO Diagnostics/Verification
JMS Server availability on WebSphere
Messaging Verification
Scheduler verification
Remote Manager Verification
Reporting version numbers
Packaging
The Oracle Identity Manager Diagnostic Dashboard tool is distributed on the installation CD with the Oracle Identity Manager installer. It is available as a WAR file under the Diagnostic Dashboard directory on the CD-ROM.
Oracle recommends that you deploy the Diagnostic Dashboard tool on the application server before installing Oracle Identity Manager.
To install the Diagnostic Dashboard on the OC4J server:
Log in to the Oracle Administrative and User Console:
http://<
xlserver_host_ip
>:7777
Click Log on to Oracle Enterprise Manager 10g Application Server Control.
Log in with your OC4J admin user name and password.
Click Home under the OC4J instance column under Groups.
Click Application on the OC4J home page.
Click Deploy.
Select the Archive is present on local host. Upload the archive to the server where Application Server Control is running: option.
Click Browse and select XIMDD.war
from the following directory:
<
installer_home
>\dashboard\
Click Next
In step 2, specify a name for the application (for example, XIMDD
), and then click Deploy in step 3.
You should be able to access the Diagnostic Dashboard at the following location:
http://<xlserver_host_ip>:7777/XIMDD
To deploy Oracle Identity Manager Diagnostic Dashboard on JBoss, copy the XIMDD.WAR
file to the following location:
<
JBOSS_HOME
>/server/default/deploy
To deploy Oracle Identity Manager Diagnostic Dashboard on WebSphere:
Log in to the admin console.
Start the application server.
Type URL (http://localhost:9090/admin
) on Internet Explorer.
Click OK to proceed.
The WebSphere main screen appears.
Click Applications link on the left menu pane, then click the Install New Application link.
The Preparing for the Application Installation screen appears.
Specify the location of the WAR file as the value of the Path attribute & 'XIMDD' as the Context root.
Click Next to proceed, and then click Next on the Generate Default Bindings screen.
The Install New Application screen appears.
Change application name to XIMDD. Click Next twice.
Choose the cluster or server, check the XIMDD.war check box and click Apply.
Confirm that the chosen cluster/server appears under the Server column and click Next.
Click Finish.
The Installing... screen appears. After the application installs successfully, you see the following message: Application XIMDD installed successfully.
Click the Save to Master Configuration link, then click Save.
Click the Applications > Enterprise Applications link in the left menu pane.
Check XIMDD check box, then click Start.
It displays a status, for example, if the installed application has been started successfully.
To deploy Oracle Identity Manager Diagnostic Dashboard on WebLogic:
Log in to the administrative console.
Start the application server
In Internet Explorer, type the following URL:
http://localhost:7001/console
Click the Deployments link on the left menu pane, then click Web Application Modules link in the left menu pane.
Click the Deploy a new Web Application Module… link, then click Upload your file(s) link to upload the XIMDD.war file.
Navigate to the location for uploading the WAR file. Typically this should be under the following:
WL_HOME
\user_projects\domains\<your-domain-name> \<your-adminserver-name>\upload
.
Click the Upload button.
Select the XIMDD.war radio button and click Target Module.
Click Deploy button.
The next page displays the successful deployment of the application.
You can now use a browser and connect to the diagnostic dashboard.
Once deployed, you can access the Diagnostic Dashboard using the following URL template:
http://<host>:<port>/XIMDD
.
In a clustered installation, you need to 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 tool indicates on which application server the tool is deployed. It also illustrates if Oracle Identity Manager is already installed in that application server or not. The tests displayed in the following table may vary, depending on whether the Oracle Identity Manager is installed or not and which application server is used. The following table displays the availability of these tests:
Test Name | Availability when Oracle Identity Manager is not installed | Application Servers |
---|---|---|
SQL Server JDBC Libraries Availability Check | Yes | JBoss |
SQL Server Prerequisites Check | Yes | JBoss |
Oracle Prerequisites Check | Yes | WebSphere/WebLogic/JBoss |
WebSphere Embedded JMS Server Status | Yes | WebSphere |
Database Connectivity Check | No | WebSphere/WebLogic/JBoss |
Account Lock Status | No | WebSphere/WebLogic/JBoss |
Data Encryption Key Verification | No | WebSphere/WebLogic/JBoss |
Scheduler Service Status | No | WebSphere/WebLogic/JBoss |
Remote Manager Status | No | WebSphere/WebLogic/JBoss |
JMS Messaging Verification | No | WebSphere/WebLogic/JBoss |
Target System SSL Trust Verification | No | WebSphere/WebLogic/JBoss |
Java VM System Properties Report | Yes | WebSphere/WebLogic/JBoss |
WebSphere Version Report | Yes | WebSphere |
Oracle Identity Manager Libraries and Extensions Version Report | No | WebSphere/WebLogic/JBoss |
Oracle Identity Manager Libraries and Extensions Manifest Report | No | WebSphere/WebLogic/JBoss |
SSO Diagnostic Information | No | WebSphere/WebLogic/JBoss |
The Diagnostic Dashboard main screen includes the sections listed in the following table:
Items | Description |
---|---|
System Information
Application Server |
Displays the name of application server. |
Oracle Identity Manager Installation | Display installation details 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 | Display testing parameters if required for verifying the test. |
To get the result:
Select the tests by clicking on the check box on the Diagnostic Dashboard main screen.
Enter necessary parameters if required.
Click Verify to see the result.
The Diagnostic Dashboard Test Result screen appears and displays the status information listed in the following table:
Test Results | Description |
---|---|
Result Summary | The result summary shows all the selected test(s) with icons (pass/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 description of the test being verified. |
Input Parameters | Displays the test parameters of the test being verified. |
Result | Displays if the test has passed or failed. |
Details | Details about pass/fail of test. |
Back to Top | Takes you back to top of the page. |
Click Diagnostic Dashboard link on the left menu pane to get back to previous test page.
The following tests are available for different application servers:
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: SQL Server Driver should be found.
Application Server: JBoss
Prerequisite: The following are the prerequisite for verifying this test:
Prerequisite | Description |
---|---|
Database Server | Enter the location for database server. |
Port | Enter the Port number. |
Database Name | Enter the database name. |
Oracle Identity Manager Database User Name | Enter Oracle Identity Manager database user name. |
Oracle Identity Manager Database User Password | Enter Oracle Identity Manager database user password. |
Description: Checks if the specified SQL server instance satisfies the prerequisites necessary for Oracle Identity Manager installation
Result: It will display the following information:
Necessary privileges for user
XA support should be enabled.
SQL Server Version.
Application Server: JBoss/ WebSphere/WebLogic
Prerequisite:
Prerequisite | Description |
---|---|
Database Server | Enter the location for 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 System User Name. |
System User Password | Enter system user password. |
Description: Checks if the specified Oracle instance satisfies the prerequisites necessary for Oracle Identity Manager installation. This test requires SYSTEM privileges.
Result: It will display the following information:
Necessary privileges for user
XA support enabled.
JVM enabled.
Oracle Version Information.
Application Server: WebSphere
Prerequisite:
Prerequisite | Description |
---|---|
Host | Enter Host name. |
Port | Enter Port number. |
User Name | Enter User name. |
Password | Enter Password. |
Description: Checks the status of JMS Server. This test is valid for WebSphere only and requires Oracle Identity Manager to be installed.
Result: Displays the status of JSM Server.
Application Server: Jboss\ WebSphere\ WebLogic
Prerequisite: None
Description: Run this test to verify if Oracle Identity Manager is able to connect to the database or not. 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.
Application Server: Jboss\ WebSphere\ WebLogic
Prerequisite:
Prerequisite | Description |
---|---|
User Name | Enter User name |
Description: Oracle Identity Manager locks an account when there are successive multiple invalid login attempts. This test checks if a given account is locked or not.
Result: Checks for locked/unlocked accounts in database.
Application Server: Jboss\ WebSphere\ WebLogic
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 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 database key is present in Oracle Identity Manager configuration directory
Application Server: Jboss\ WebSphere\ WebLogic
Prerequisite: None
Description: Checks the status of the Oracle Identity Manager Scheduler Service running on this server.
Result: Displays the status of scheduler service.
Application Server: Jboss\ WebSphere\ WebLogic
Prerequisite: None
Description: Reports the status of the Remote Managers that this Oracle Identity Manager installation is all set to work.
Result: Displays the status of Remote manager.
Application Server: Jboss\ WebLogic
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 JMS message.
Application Server: Jboss\ WebSphere\ WebLogic
Prerequisite:
Prerequisite | Description |
---|---|
Host | Enter Host name |
Port | Enter Port number. |
Trust Store Location | Enter location for storage. |
Trust Store Password | Enter password for storage. |
Description: Oracle Identity Manager should be setup to trust the Target System certificates if the connectivity is over SSL. Enter the Host name and the port where a Target System is listening for SSL connections.
Result: It displays the following information:
Valid/Invalid Host and Port address
Trusted Certificates.
Application Server: WebSphere
Prerequisite: None
Description: Prints out all the Java VM system properties
Result: It displays all the Java VM system properties
Application Server: Jboss\WebSphere\WebLogic
Prerequisite: None
Description: Obtains the WebSphere Application Server version information along with a list of all the fix packs and components installed in the application server
Result: Displays WebSphere version information
Application Server: Jboss\WebSphere\WebLogic
Prerequisite: None
Description: Reports the version of the Oracle Identity Manager libraries and extensions
Result: Displays the versions of the Oracle Identity Manager libraries and extensions
Application Server: Jboss\WebSphere\WebLogic
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.
Application Server: Jboss\ WebSphere
Prerequisite: None
Description: Provides information pertaining to SSO setup. Also, provides instructions needed to setup Oracle Identity Manager to enable retrieving run-time diagnostic information related to SSO logins.
Result: Displays if the SSO setup is enabled for related Oracle Identity Manager installation.