Displaying Information about your Oracle9i Business Intelligence Beans Client Configuration Skip Headers

Oracle9i Business Intelligence Beans - Displaying Information about your Oracle9i Business Intelligence Beans Client Configuration
Release 9.0.3.4 or later


Copyright © 2002, Oracle International Corporation. All Rights Reserved.

Oracle is a registered trademark and Oracle9i is a trademark or registered trademark of Oracle Corporation. Other names may be trademarks of their respective owners.

Oracle9i Business Intelligence Beans

Displaying Information about your Oracle9i Business Intelligence Beans Client Configuration

Release 9.0.3.4 (or later)

December 2002

Contents

Using the configuration diagnostic utility
Requirements for the configuration diagnostic utility
Installing the configuration diagnostic utility
Running the utility (includes syntax and an example)
Four forms of output from the utility
Console output from the utility

Using the configuration diagnostic utility

Oracle9i Business Intelligence Beans (hereinafter referred to as "BI Beans") includes a utility that examines and reports on the configuration of your client environment. The utility reports on the success or failure of two diagnostic tests: whether it was able to connect to the database and retrieve metadata, and whether it was able to create sample queries. The purpose of the configuration diagnostic utility is to gather the information about your configuration that will help you and Oracle Support Services diagnose problems.

Output from the utility includes information that is written to the console, a file that lists the metadata that the utility found in the database, and a log of errors. The utility also produces an XML file that contains the console output and metadata. This XML file provides an easy way to send information to Oracle Support Services to help you diagnose problems.

This document explains how to install and run the utility and describes the various forms of output. It also provides some basic help with diagnosing your own problems.

Requirements for the configuration diagnostic utility

In order to run the BI Beans configuration diagnostic utility, you must be running JDeveloper 9.0.3 with BI Beans 9.0.3.4 (or higher) on a supported Windows or UNIX platform. The utility presents information on what database version you are trying to connect to. Check the BI Beans installation guide for complete information on the supported versions, which are 9.0.1.x and 9.2.0.2 or higher for the current BI Beans version.

Installing the configuration diagnostic utility

Complete the following steps to install the configuration diagnostic utility.

  1. Copy the bi_checkconfig.zip file from Oracle Technology Network (/products/bib/index.html) to a local directory and upzip it. The directory contains the following files: bi_checkconfig.bat (Windows), bi_checkconfig.csh (UNIX), BICheckConfig.class, BICheckConfig$1.class, BICheckConfig$2.class, and bi_error_messages.html.
  2. Copy these files to the JDEV_ORACLE_HOME/bibeans/bin directory.
  3. On UNIX platforms, change the permissions on the bi_checkconfig.csh file so that you can run it, using a command such as the following one:

    chmod u+x bi_checkconfig.csh

Running the utility

Before trying to run the utility, ensure that no folders or JAR files have been renamed or removed in the native JDeveloper installation. If such folders or JAR files are missing or renamed, then the utility might not function properly.

Complete the following steps to run the configuration diagnostic utility.

  1. Open a command prompt on the computer where JDeveloper and BI Beans are installed.
  2. Set the JDEV_ORACLE_HOME environment variable to the full path name of the directory where JDeveloper is installed.
  3. Ensure that the JAVA_HOME environment variable is set correctly, if you are using a JDK that is different from the JDeveloper default (which is JDK 1.3.1_02) or if the platform is UNIX. On UNIX platforms, you should always set this variable.
  4. At the command prompt, change to the JDEV_ORACLE_HOME/bibeans/bin directory.
  5. Type the command that invokes the utility, using the appropriate syntax.
  6. Review the output from the utility.

Syntax for running the utility

To run the utility, use the bi_checkconfig.bat command (or simply bi_checkconfig) on Windows or the bi_checkconfig.csh command on UNIX. The following line shows the arguments, using the Windows command as an example. The arguments are the same on the supported Windows and UNIX platforms.

bi_checkconfig -h host -po port -sid sid -u user -p password -o olapservice [-q]

The arguments identify the database to the utility and are described in the following table. The [-q] argument is optional, while the others are required. The -o argument is required only if you are running against an Oracle9i Release 1 database.

Argument Description
-h Host -- The name of the host computer (for example, myhost).
-po Port -- The port identifier for the host computer (for example, 1521).
-sid SID -- The system identifier of the database instance (for example, orcl).
-u User -- The name by which the user is known to the database (for example, BIBDEMO).
-p Password -- The user's password (for example, BIBDEMO).
-o Olapservice -- The name of the OLAP Service to which you are connecting. This argument is required only if you are connecting to an Oracle9i Release 1 database.
-q (Optional) Run sample queries. If this option is specified, then the utility runs a set of sample queries against each measure and dimension that it finds through MetadataManager. These queries are the same as the sample queries that are run by default in QueryBuilder. The utility retrieves data, but does not display it.

Example: Running the utility

The following example shows a command for running the utility on a Windows platform.

bi_checkconfig -h mypc -po 1521 -sid orcl -u BIBDEMO -p BIBDEMO -o myolapservice -q

Four forms of output from the utility

The utility produces four forms of output, as described in the following list:

  • Output that is written directly to the console -- For details, see Console output from the utility.
  • bi_metadata.txt -- A file that contains a list of the folders, measures, and dimensions that were found in the database (that is, the metadata). This list is similar to the one that appears in the Items panel of the QueryBuilder.
  • bi_error.log -- If an error occurred, then this file contains a detailed stack trace of the error. Use the bi_error_messages.html file, which is installed with the utility, to read more detailed descriptions of any BI Beans error messages that appear in the output. BI Beans error messages use the prefix "BIB." If you specify the -q option when you run the utility, then this file also contains the result (Successful or Unsuccessful) of running the sample queries against the measures and dimensions in the database.
  • bi_checkconfig.xml -- This file combines the output to the console with the contents of bi_metadata.txt in XML format. You can send this file to Oracle Support Services as an e-mail attachment for help in diagnosing the problem.

Console output from the utility

The following labels describe the items that the utility displays on the console. These labels are listed according to the sequence in which the utility performs the various checks.

JDEV_ORACLE_HOME

The full path name to the directory where JDeveloper is installed. This is the value of the JDEV_ORACLE_HOME environment variable.

JAVA_HOME

The full path name to the directory that contains the JDK to use. This is the value of the JAVA_HOME environment variable.

JDeveloper version

The version of JDeveloper that is installed. This version should be 9.0.3.1035 or higher. See the BI Beans installation guide for more information.

BI Beans version

The version of BI Beans that is installed. This version should be 9.0.3.4.0 or higher. See the BI Beans installation guide for more information.

BI Beans internal version

The internal version of BI Beans that is installed. This version should be 2.7.0.11.3 or higher.

Connect to database

Whether the utility was able to establish a database connection. If a connection was established, then the result is "Successful." Otherwise, the result is "Unsuccessful." If the utility cannot connect to the database, then you can:

  • Examine the errors on the console and in the bi_error.log file, and consult the bi_error_messages.html file for more information.
  • Verify that the connection information (such as user name and password) are correct.
  • Verify that the database is running and accepting connections.

JDBC driver version

The version of the JDBC driver that is on your computer. This version should be 9.0.1.x for the 9.0.1.x database version and 9.2.0.2.0 or higher for the 9.2.0.2 database version. If there is a JDBC driver mismatch, then reinstall BI Beans and choose the appropriate database version on the Choose Oracle Database page.

JDBC JAR file location

The full path name to the directory that contains the JDBC driver JAR file.

Database version

The version of the Oracle9i database, which should be 9.0.1.x or 9.2.0.2 or higher. See the BI Beans installation guide for more information.

OLAP Catalog version, OLAP AW Engine version, OLAP API Server version

The versions for various OLAP pieces. If these versions are returned as 9.2.0.1, then install the 9.2.0.2 patch, because the current version of the BI Beans does not support 9.2.0.1. These versions should match the "Database version." If you are connecting to 9.0.1 or to certain UNIX versions of the database, then versions are returned as "N/A," which is not a problem that you must resolve.

BI Beans Catalog version

The version of the BI Beans Catalog that is installed. This version should match the BI Beans internal version number. If the Catalog is not installed, then this value is NA; not installed in schema-name.

OLAP API JAR file version

The version of the OLAP API client JAR file, which should be 9.0.1 for the 9.0.1.x database version and 9.2 for the 9.2.0.2 database version.

OLAP API JAR file location

The full path name to the directory in your JDeveloper installation that contains the OLAP API client JAR files.

Load OLAP API metadata

Whether the utility was able to load the metadata from the database. If the metadata was loaded, then the result is "Successful." Otherwise, the result is "Unsuccessful."

The database administrator must define appropriate metadata in the Oracle database to support business intelligence applications. For information about defining OLAP metadata for Oracle9i Release 1, see the Oracle9i OLAP Services Concepts and Administration Guide; for information about defining OLAP metadata for Oracle9i Release 2, see the Oracle9i OLAP Release 2 - User's Guide. You can also refer to the Help system for the OLAP management tool in Oracle Enterprise Manager, which is the tool that you use to create the metadata. You can also use Oracle Warehouse Builder to create appropriate metadata.

If the metadata was not loaded, then verify that the metadata is correct. If you continue to have problems, then consult the OLAP forum on Oracle Technology Network or contact Oracle Support Services.

Number of metadata folders

The number of folders that were detected in the metadata from the database.

Number of metadata measures

The number of measures that were detected in the metadata from the database.

Number of metadata dimensions

The number of dimensions that were detected in the metadata from the database.

Metadata output location

The full path name to the TXT file that is produced by the configuration diagnostic utility. This file contains a full description of all the metadata from the database.


Oracle Logo
Copyright © 2002 Oracle Corporation.

All Rights Reserved.
E-mail this page
Printer View Printer View
Oracle Is The Information Company About Oracle | Oracle RSS Feeds | Careers | Contact Us | Site Maps | Legal Notices | Terms of Use | Privacy