Oracle Business Intelligence Publisher Administrator's and Developer's Guide Release 10.1.3.4 Part Number E12188-01

Contents

Previous

Next

Setting System Maintenance Options

Setting System Maintenance Options

Under System Maintenance, you can perform the following administration tasks:

• Define Your Report Repository

• Set Server Configuration Options

• Configure the Scheduler

• Refresh Metadata

Refresh Metadata

If you copy reports as files or folders directly to the file system or XML database repository, you must refresh the metadata to make these reports available via the user interface.

Defining Your Report Repository

Defining Your Report Repository

The report repository can be set up in either the file system or the database.

Defining a File-Based Repository

BI Publisher will set a default file-based repository. The default is ${oracle.home}/xdo/repository

If the "oracle.home" Java system property is set to a valid path, BI Publisher replaces ${oracle.home} with that value.

When BI Publisher is deployed on OC4J, ${oracle.home} is automatically set to a directory path where OC4J is installed. For example, in an OC4J deployment in which the OC4J home is C:\oc4j, the BI Publisher repository is automatically set to:

C:\oc4j\xdo\repository

If you wish to choose another location for your repository, do so as follows:

1. Under Report Repository, select File System as the Repository Type.

2. Enter the absolute Path.

   For example: /home/repository/xmlp

3. Apply your changes and restart your BI Publisher application.

Defining a Database-Based Repository

Important: If you stop and start or restart the database that contains your BI Publisher repository, you must restart you BI Publisher Enterprise server.

1. Under Report Repository, select XML DB as the Repository Type.

2. Enter the absolute Path. For example: /public/Reports

3. Select the Connection Type: JDBC or JNDI.

   Important: Connection type JDBC is not recommended for the repository.

   • If you select JNDI, enter the JNDI connection pool Name (for example: jdbc/Oracle10gRepository).

   • If you select JDBC (not recommended), enter the following:

     • URL

       Example: jdbc:oracle:thin:@rpts.mycompany.com:1525:ora10g

     • Username

     • Password

     • Database Driver Class

       Example: oracle.jdbc.driver.oracleDriver

Setting Server Configuration Options

Use the Server Configuration tab to define

• General properties for the server

• Caching specifications

Defining General Properties

• Debug Level - Controls the amount of debug information generated by the system. It set to Exception (the default setting), only error information is generated. If set to Debug, all system output is generated.

• Report Viewer Height - sets the size of the report viewing frame in your browser. Enter a value in pixels. The default is 600.

• Report Scalable Threshold - sets the threshold at which data is cached on the disk. When the data volume is very large, caching the data will save memory, but will result in slower processing. Enter a value in kilobytes. The default is 10000000 (10 megabytes).

• Output Formats - select the formats that you want displayed to the user by default for every RTF template-based report. This server-level setting is overridden by the Output Format types selected in the report definition. See Adding Layouts to the Report Definition, Oracle Business Intelligence Publisher Report Designer's Guide.

Setting Cache Specifications

Set the following properties to configure the BI Publisher cache:

• Cache Expiration - Enter the expiration period for the dataset cache in minutes. The default is 30.

  For datasets returned by a SQL query, HTTP, or Oracle BI Answers, you have the option of caching the dataset returned by the query. The returned dataset will remain in cache for the period specified by this property. For more information about setting this property, see Defining the Data Model, Oracle Business Intelligence Publisher Report Designer's Guide.

• Cache Size Limit - Enter the maximum number of datasets to maintain in the cache. The default is 1000.

• Maximum Cached Reports - Enter the maximum number of reports to maintain in the cache. The default is 50.

Installing the Scheduler Schema

BI Publisher uses Quartz, an open-source job-scheduling system. To set up the BI Publisher scheduler you must install the scheduler tables to your database. To set up the scheduler database tables, use the BI Publisher Scheduler Configuration tab to define a JDBC connection to your database, then BI Publisher will install the tables to your database.

BI Publisher includes the Hyperion-branded DataDirect Connect for JDBC drivers that you can use to set up connection to your BI Publisher scheduler database. These drivers can be used as an alternative to the native JDBC drivers provided by your database vendor. When you choose a database for which a DataDirect driver is available, BI Publisher automatically enters the database driver class information in the setup screen for you. There is no additional setup required for the driver files.

If you choose to use the native driver for any database other than Oracle or if you choose to use a DataDirect driver not provided by BI Publisher, you must download, install, and configure the driver manually.

Important: If you stop and start or restart the database that contains your BI Publisher Scheduler tables, you must restart you BI Publisher Enterprise server.

Recommendations for Using DataDirect Connect or Native Database Drivers

DataDirect Connect for JDBC drivers are provided for the following databases:

• IBM DB2 v8.1, v9.1

• Microsoft SQL Server 2000, 2005

• Sybase Adaptive Server Enterprise

• Oracle 9i, Oracle 10g, Oracle 11g,

The following table displays the driver recommendations for the supported scheduler databases:

Set Up a User on Your Scheduler Database

To set up the connection to your scheduler database, you must ensure you have created a user on your selected database. BI Publisher will use this user to connect to the database. Depending on your database type, this user may require specific privileges. These are detailed in the database-specific sections below.

Entering Connection Information for Your Scheduler Database and Installing the Schema

Following are the general steps for setting up the Scheduler database. Please also refer to the subsequent section that is specific to your database.

1. Log in to BI Publisher with Administrator credentials and select the Admin tab.

2. Under System Maintenance, select Scheduler Configuration.

3. Enter the following fields for the Database Connection:

   • Database Type - select your database from the list. After you make a selection, the Database Driver Class field will automatically update with the recommended driver class.

   • Connection String - enter the connection string for your selected database. Sample strings are provided in the database-specific sections that follow.

   • Username and Password - enter the scheduler user you set up for your database. The user must have permissions to connect to the database and create tables. Other permissions may be required depending on your database type. Please see the appropriate database-specific section below.

   • Database Driver Class - when you select the database type this field is automatically updated with the recommended driver. If you wish to use another driver, specify it in this field.

     Note: The Oracle database drivers and the DataDirect drivers are installed with BI Publisher and no further setup is required. Note that for other databases, even though the recommended native drivers are automatically populated in this field, additional setup is required to make the drivers available to BI Publisher.

4. Click Test Connection to ensure that BI Publisher can connect to the database. If the connection fails, ensure that you have entered the fields as shown and set up your database appropriately.

5. Click Install Schema to install the BI Publisher scheduler schema to your database.

Entering Connection Information for an Oracle Database

Prerequisite: Ensure that the database user you enter has "connect" or "create session" and "create table" privileges and that the user has been assigned a quota (otherwise the quota will be 0).

For example, the following sample creates the user "bipubsched":

SQL> CREATE USER bipubsched
   2  IDENTIFIED BY welcome
   3  DEFAULT TABLESPACE USERS
   4  TEMPORARY TABLESPACE TEMP
   5  QUOTA 20G ON USERS
   6  QUOTA 1M ON TEMP;
  
User created. 

 SQL> GRANT CREATE SESSION TO bipuser; -- or "GRANT CONNECT TO bipuser;"

 Grant succeeded. 

 SQL> grant create table to bipublisher; 
 
 Grant succeeded.

Enter the following to use the Oracle native driver to connect to your Oracle database:

Entering Connection Information for IBM DB2

Prerequisite: Ensure that the user that you enter to configure the scheduler has been set up with a 32 K page size tablespace. If not, create the table and assign it to the user. The user must also have "Connect to database" and "Create tables" privileges.

Enter the following to use the DataDirect driver to connect to an IBM DB2 v8 or IBM DB2 v9 database:

Entering Connection Information for Microsoft SQL Server

Prerequisite: Ensure that your Microsoft SQL Server is set up with mixed mode authentication. Also ensure that the user you enter to configure the scheduler has the "db_owner" role.

Enter the following to use the DataDirect driver to connect to a Microsoft SQL Server 2000 or 2005 database:

Entering Connection Information for a Sybase Adaptive Server Enterprise Database

Prerequisite: Ensure that you set the "ddl in tran" mode to true in the database. Consult the Sybase documentation or contact your database administrator for instruction how to enable this option.

Enter the following to use the DataDirect driver to connect to your Sybase Adaptive Server Enterprise database:

Entering Connection Information for a MySQL Database

Prerequisite: You must download the MySQL JDBC driver and register it with the application server where BI Publisher is running.

The MySQL JDBC driver can be downloaded from: http://www.mysql.com/products/connector/j/

See your application server documentation for information on registering the driver.

Enter the following if your scheduler database is MySQL 4.1 or MySQL 5.0

Copyright © 2004, 2008, Oracle and/or its affiliates. All rights reserved.