Contents

Title and Copyright Information

Send Us Your Comments

Preface

Intended Audience

Documentation Accessibility

Structure

Related Documents

Conventions

Part I Preparing Your Environment

1 Understanding the OracleAS Reports Services Architecture

1.1 Overview of OracleAS Reports Services

1.2 OracleAS Reports Services Components

1.3 OracleAS Reports Services Runtime Process

1.4 Things to Consider When You Set Up Your System

1.4.1 Choosing the Types of Requests You Will Service

1.4.2 Choosing Servlet, JSP, or CGI

1.4.3 Choosing Single- Or Multiple-Machine Configurations

1.4.4 Choosing Whether to Cluster Multiple Servers

1.5 Maintaining High Availability

2 Starting and Stopping OracleAS Reports Services

2.1 Starting and Stopping the Reports Server

2.1.1 Starting, Stopping, and Restarting Reports Servers from Oracle Enterprise Manager

2.1.2 Starting, Stopping, and Restarting Reports Servers from the Oracle Process Manager and Notification Server

2.1.3 Alternative Methods of Starting and Stopping the Reports Server

2.2 Verifying that the Oracle HTTP Server Is Running

2.3 Verifying that the Reports Servlet and Server Are Running

3 Configuring OracleAS Reports Services

3.1 OracleAS Reports Services Configuration Files

3.2 Configuring Reports Server

3.2.1 Reports Server Configuration Elements (rwserverconf.dtd)

3.2.2 Dynamic Environment Switching

3.2.3 Connecting to OracleAS Portal

3.3 Configuring the Reports Servlet

3.3.1 Specifying the Location of the Key Map File

3.3.2 Reloading the Key Map File

3.3.3 Hiding Web Command Output

3.3.4 Selecting Login Dialog Boxes

3.3.5 Setting Up Trace Options for the Reports Servlet and JSPs

3.3.6 Specifying the character encoding for reports output using rwservlet

3.3.7 Disallowing HTML code specified in the URL from being executed in a browser

3.3.8 Specifying the pool size for concurrent connections to rwservlet

3.3.9 Customizing the Appearance of Server Error Messages

3.3.10 Specifying an In-Process Server

3.3.11 Identifying the Default Reports Server

3.3.12 Pointing to Dynamically Generated Images

3.3.13 Setting Expiration for Database and System Authentication Cookies

3.3.14 Setting an Encryption Key for the Database and System Authentication Cookies

3.3.15 Adding Formatting to Diagnostic/Debugging Output

3.3.16 Defining the rwservlet Help File

3.3.17 Specifying the Use of OracleAS Single Sign-On

3.4 Configuring the URL Engine

3.5 Entering Proxy Information

3.6 Configuring Reports Server with the Oracle Process Manager and Notification Server and Oracle Enterprise Manager

3.6.1 opmn.xml

3.7 DISPLAY and Printer Dependencies on UNIX

3.7.1 ScreenPrinter

3.7.2 Advanced Imaging Support

3.8 Setting the default printer for an in-process server

4 Managing Fonts in Oracle Reports

4.1 Using Fonts

4.1.1 Fonts in Reports Builder

4.1.2 Fonts in Report Output

4.1.3 Fonts in the User Interface

4.2 Adding Fonts

4.2.1 Adding Fonts to Reports Builder

4.2.2 Adding New Fonts for Report Output

4.3 Font Configuration Files

4.3.1 File Searching

4.4 Font Aliasing

4.4.1 Specify Aliasing Information

4.4.2 Font Aliasing Mechanism

4.4.3 Font Alias File Sections

4.4.4 Font Aliasing File Verification

4.5 Troubleshooting Font Issues

4.6 Font Types

4.6.1 Character Sets

4.6.2 Unicode

4.6.3 Type1 Fonts

4.6.4 TrueType Fonts

4.6.5 Barcode Fonts

4.6.6 CID Fonts

5 Printing on UNIX with Oracle Reports

5.1 UNIX Printing Overview

5.1.1 General Printing Mechanism

5.1.2 Oracle Reports Printing Mechanism on UNIX and Windows

5.1.3 Printing Support

5.2 Setting Up a Printer on UNIX

5.2.1 Installing a Printer on UNIX

5.2.2 Verifying the Printer Setup for Oracle Reports

5.3 Configuring the Printing Environment

5.3.1 Editing uiprint.txt File

5.3.2 Environment Variables

5.3.3 Print Property Dialog Boxes

5.4 Printer-Related Files

5.4.1 Overview of Files

5.4.2 PPD Files

5.4.3 HPD Files

5.4.4 Font Metrics Files

5.4.5 uifont.ali

5.4.6 uiprint.txt

5.4.7 Editing the Printer-Related Files

5.5 NLS Support

5.5.1 Multibyte Character Set Printing

5.5.2 Overview of IX and PASTA

5.6 Debugging Options

5.6.1 DEBUG_SLFIND

5.6.2 TK_DEBUG_POSTSCRIPT

5.7 Frequently Asked Questions

5.7.1 Common Printing Error Messages

5.7.2 PCL Printing Issues

5.7.3 PostScript Printing Issues

5.7.4 Font-Related Printing Issues

5.7.5 Printed Output Issues

6 Using PDF in Oracle Reports

6.1 PDF Features Included in Oracle Reports

6.1.1 Compression

6.1.2 Font Related Features

6.1.3 Precedence of Execution

6.1.4 Accessibility

6.1.5 Taxonomy

6.1.6 Enhanced Graph Support

6.2 Resolving PDF Font Issues During Cross-Platform Deployment

6.2.1 Designing and Deploying the Report on the Same Platform

6.3 Generating a Unicode PDF File

6.3.1 Font Subsetting

6.4 Generating a BiDi PDF File

6.4.1 Font Subsetting

6.5 Generating a Multibyte PDF File

6.5.1 Font Aliasing

6.6 Generating a Barcode PDF File

6.6.1 Font Embedding

7 Configuring Destinations for OracleAS Reports Services

7.1 Overview of Output Processing

7.2 Registering Destination Types with the Server

7.2.1 Setting Up a Destination Section in the Server Configuration File

7.2.2 Entering Valid Values for a Destination

7.2.3 Example Destination

8 Configuring and Using the JDBC PDS

8.1 JDBC Configuration File

8.1.1 Verifying Pre-installed Driver Entries

8.1.2 Installing and Configuring Merant DataDirect Drivers

8.2 Defining and Running a JDBC Query

8.2.1 Sample Connection Information

8.3 Running a JDBC Report Using OracleAS Reports Services

8.4 Troubleshooting Information

8.4.1 Error Messages

8.4.2 Trace Information

8.5 Adding Your Own PDS

8.5.1 Registering the PDS

8.5.2 Configuring the jdbcpds.conf File

8.5.3 Installing Your PDS JAR Files

8.5.4 Installing the Driver's JAR Files

9 Securing OracleAS Reports Services

9.1 About OracleAS Reports Services Security

9.1.1 Resources Protected

9.1.2 Authorization and Access Enforcement

9.1.3 Leveraging Oracle Identity Management Infrastructure

9.2 Configuring OracleAS Reports Services Security

9.2.1 Configuring OracleAS Reports Services Security Options

10 Configuring and Administering OracleAS Single Sign-On

10.1 Prerequisites

10.2 Configuring Out-of-the-Box OracleAS Single Sign-On

10.3 Administering OracleAS Single Sign-On

10.3.1 Enabling and Disabling OracleAS Single Sign-On

10.3.2 Enabling and Disabling Reports Server Security

10.3.3 Enabling and Disabling Data Source Security

10.3.4 Connecting to the Oracle Internet Directory

10.4 Choosing the connecting entity for the Oracle Internet Directory

10.5 OracleAS Forms Services Security Considerations

11 Deploying Reports in OracleAS Portal

11.1 Creating Reports Users and Named Groups in OracleAS Portal

11.1.1 Default Reports-related Groups

11.1.2 Creating Users and Groups

11.2 Registering Oracle Reports Components in OracleAS Portal

11.2.1 Creating an Availability Calendar

11.2.2 Registering a Printer

11.2.3 Registering a Reports Server

11.2.4 Registering a Report

11.2.5 The Manage Portlet

12 Clustering Reports Servers

12.1 Cluster Overview

12.2 Setting Up a Cluster

12.2.1 Renaming a Reports Server

12.2.2 Generating New Public and Private Keys

12.2.3 Entering Public and Private Keys in the Server Configuration File

12.2.4 Restarting the Reports Server

12.2.5 Submitting a Request to a Cluster

Part II Sending Requests to the Server

13 Running Report Requests

13.1 The Reports URL Syntax

13.1.1 Servlet

13.1.2 JSP

13.1.3 CGI

13.2 Report Request Methods

13.3 Deploying Your Reports

13.3.1 Deploying a Report with a Paper Layout

13.3.2 Running a Report with a Paper Layout

13.3.3 Deploying a JSP report to the Web and to Paper

13.3.4 Running a JSP-Based Web Report from a Browser

13.3.5 Running a JSP report with a Paper Layout

13.3.6 Running with the WE8MSWIN1252 character set on Solaris

13.4 Publishing a Report in OracleAS Portal

13.4.1 Creating a Provider for Your Reports

13.4.2 Creating the Report Definition File Access

13.4.3 Adding the Report Portlet to a Page

13.4.4 Adding the Reports Component as an Item to a Page

13.5 Specifying a Report Request from a Web Browser

13.6 Sending a Request to the URL Engine

13.7 Running Reports through a Web Service

13.8 Scheduling Reports to Run Automatically

13.9 Additional Parameters

13.10 Reusing Report Output from Cache

13.10.1 Usage Notes

13.11 Using a Key Map File

13.11.1 Enabling Key Mapping

13.11.2 Adding Key Mapping Entries to a Key Map File

13.11.3 Using a Key with Everything but JSPs

13.11.4 Using a Key with a Report Run as a JSP

14 Using the Oracle Reports Web Service

14.1 Overview

14.2 Getting Started

14.2.1 Invoking the rwwebservice servlet

14.2.2 Viewing the WSDL

14.2.3 Oracle Reports Web Service Operations

14.3 Installing and Using the Sample Proxy and Java Client

15 Creating Advanced Distributions

15.1 Distribution Overview

15.2 Introduction to Distribution XML Files

15.2.1 The distribution.dtd File

15.2.2 Using Variables Within Attributes

15.3 Elements of a Distribution XML File

15.3.1 destinations

15.3.2 foreach

15.3.3 mail

15.3.4 body

15.3.5 attach

15.3.6 include

15.3.7 file

15.3.8 printer

15.3.9 destype

15.3.10 property

15.4 Distribution XML File Examples

15.4.1 foreach Examples

15.4.2 mail Examples

15.4.3 file Examples

15.4.4 printer Examples

15.5 Using a Distribution XML File at Runtime

15.6 Defining Custom/Pluggable Destinations

15.7 Limitations with using distribution

15.7.1 destype=oraclePortal

15.7.2 XML and delimited outputs

16 Customizing Reports with XML

16.1 Customization Overview

16.2 Creating XML Customizations

16.2.1 Required XML Tags

16.2.2 Changing Styles

16.2.3 Changing a Format Mask

16.2.4 Adding Formatting Exceptions

16.2.5 Adding Program Units and Hyperlinks

16.2.6 Adding a New Query and Using the Result in a New Header Section

16.2.7 Encoding the URL

16.3 Creating XML Data Models

16.3.1 Creating Multiple Data Sources

16.3.2 Linking Between Data Sources

16.3.3 Creating Group Hierarchies within Each Data Source

16.3.4 Creating Cross-product (Matrix) Groups

16.3.5 Creating Formulas, Summaries, and Placeholders at Any Level

16.3.6 Creating Parameters

16.4 Using XML Files at Runtime

16.4.1 Applying an XML Report Definition at Runtime

16.4.2 Running an XML Report Definition by Itself

16.4.3 Performing Batch Modifications

16.5 Debugging XML Report Definitions

16.5.1 XML Parser Error Messages

16.5.2 Tracing Options

16.5.3 rwbuilder

16.5.4 Writing XML to a File for Debugging

17 Using Event-Driven Publishing

17.1 The Event-Driven Publishing API

17.1.1 Elements of the API

17.1.2 Creating and Manipulating a Parameter List

17.1.3 How to Submit a Job

17.1.4 How to Check for Status

17.1.5 Using the Servers' Status Record

17.2 Debugging Applications that Use the Event-Driven Publishing API

17.3 Invoking a Report From a Database Event

17.4 Integrating with Oracle Advanced Queuing

17.4.1 Creating a Queue That Holds Messages of Type SRW_PARAMLIST

17.4.2 Creating the Enqueuing Procedure

17.4.3 Creating the Dequeuing Procedure

Part III National Language Support and Bidirectional Support

18 Implementing NLS and Bidirectional Support

18.1 NLS Architecture

18.1.1 Language-Independent Functions

18.1.2 Language-Dependent Data

18.2 NLS Environment Variables

18.2.1 NLS_LANG Environment Variable

18.2.2 DEVELOPER_NLS_LANG and USER_NLS_LANG Environment Variables

18.3 Specifying a Character Set in a JSP or XML File

18.4 Bidirectional Support

18.5 Unicode

18.5.1 Unicode Support

18.5.2 Unicode Font Support

18.5.3 Enabling Unicode Support

18.5.4 Using ALTER SESSION

18.6 Translating Applications

Part IV Performance

19 Managing and Monitoring OracleAS Reports Services

19.1 Configuring the Reports Server for Oracle Enterprise Manager

19.2 Navigating to the Reports Server Page

19.2.1 Navigating to the Reports Server Page in the Application Server Control

19.3 Starting, Stopping, and Restarting Reports Servers

19.4 Viewing and Managing Job Queues

19.4.1 Viewing and Managing Job Queues in the Application Server Control

19.5 Monitoring Server Performance

19.5.1 Oracle Enterprise Manager Application Server Control

19.6 Viewing and Changing the Reports Server Configuration Files

19.6.1 Configuring Selected Parameters

19.6.2 Configuring the server_name.conf File

19.7 Viewing and Linking to Server Cluster Members

19.8 Viewing Port Numbers

19.9 Changing Your Middle-Tier

20 Tuning Oracle Reports

20.1 Methodology

20.1.1 Performance Analysis Tools

20.1.2 Accessing the Data

20.1.3 Formatting the Data

20.1.4 General Layout Guidelines

20.1.5 Calling Oracle Reports from Forms

20.1.6 Running the Report

Part V Appendices

A Command Line Options

A.1 Command Overview

A.1.1 rwclient

A.1.2 rwrun

A.1.3 rwbuilder

A.1.4 rwconverter

A.1.5 rwservlet

A.1.6 rwcgi

A.1.7 rwserver

A.2 Command Line Syntax

A.3 General Usage Notes

A.4 Command Line Keywords

A.4.1 ACCESSIBLE

A.4.2 ARRAYSIZE

A.4.3 AUTHID

A.4.4 AUTOCOMMIT

A.4.5 AUTOSTART

A.4.6 BACKGROUND

A.4.7 BATCH

A.4.8 BCC

A.4.9 BLANKPAGES

A.4.10 BUFFERS

A.4.11 CACHELOB

A.4.12 CC

A.4.13 CELLWRAPPER

A.4.14 CMDFILE

A.4.15 CMDKEY

A.4.16 COLLATE

A.4.17 CONTENTAREA

A.4.18 COPIES

A.4.19 CUSTOMIZE

A.4.20 DATEFORMATMASK

A.4.21 DELAUTH

A.4.22 DELIMITED_HDR

A.4.23 DELIMITER

A.4.24 DESFORMAT

A.4.25 DESNAME

A.4.26 DEST

A.4.27 DESTINATION

A.4.28 DESTYPE

A.4.29 DISTRIBUTE

A.4.30 DTYPE

A.4.31 DUNIT

A.4.32 ENGINERESPONSETIMEOUT

A.4.33 EXPIRATION

A.4.34 EXPIREDAYS

A.4.35 EXPRESS_SERVER

A.4.36 FORMSIZE

A.4.37 FROM

A.4.38 GETJOBID

A.4.39 GETSERVERINFO

A.4.40 HELP

A.4.41 INSTALL

A.4.42 ITEMTITLE

A.4.43 JOBNAME

A.4.44 JOBTYPE

A.4.45 JVMOPTIONS

A.4.46 KILLJOBID

A.4.47 LONGCHUNK

A.4.48 MIMETYPE

A.4.49 MODE

A.4.50 MODULE|REPORT

A.4.51 NONBLOCKSQL

A.4.52 NOTIFYFAILURE

A.4.53 NOTIFYSUCCESS

A.4.54 NUMBERFORMATMASK

A.4.55 OLAP_CON

A.4.56 ONFAILURE

A.4.57 ONSUCCESS

A.4.58 ORIENTATION

A.4.59 OUTPUTFOLDER

A.4.60 OUTPUTIMAGEFORMAT

A.4.61 OUTPUTPAGE

A.4.62 OVERWRITE

A.4.63 P_AVAILABILITY

A.4.64 P_DESCRIPTION

A.4.65 P_FORMATS

A.4.66 P_NAME

A.4.67 P_OWNER

A.4.68 P_PFORMTEMPLATE

A.4.69 P_PRINTERS

A.4.70 P_PRIVILEGE

A.4.71 P_SERVERS

A.4.72 P_TRIGGER

A.4.73 P_TYPES

A.4.74 PAGEGROUP

A.4.75 PAGESIZE

A.4.76 PAGESTREAM

A.4.77 PARAMFORM

A.4.78 PARSEQUERY

A.4.79 PDFCOMP

A.4.80 PDFEMBED

A.4.81 PRINTJOB

A.4.82 READONLY

A.4.83 RECURSIVE_LOAD

A.4.84 REPLACEITEM

A.4.85 REPLYTO

A.4.86 REPORT|MODULE

A.4.87 ROLE

A.4.88 RUNDEBUG

A.4.89 SAVE_RDF

A.4.90 SCHEDULE

A.4.91 SERVER

A.4.92 SHOWAUTH

A.4.93 SHOWENV

A.4.94 SHOWJOBID

A.4.95 SHOWJOBS

A.4.96 SHOWMAP

A.4.97 SHOWMYJOBS

A.4.98 SHUTDOWN

A.4.99 SITENAME

A.4.100 SOURCE

A.4.101 SQLTRACE

A.4.102 SSOCONN

A.4.103 STATUSFOLDER

A.4.104 STATUSFORMAT

A.4.105 STATUSPAGE

A.4.106 STYPE

A.4.107 SUBJECT

A.4.108 SUPPRESSLAYOUT

A.4.109 TOLERANCE

A.4.110 TRACEFILE

A.4.111 TRACEMODE

A.4.112 TRACEOPTS

A.4.113 UNINSTALL

A.4.114 UPGRADE_PLSQL

A.4.115 URLPARAMETER

A.4.116 USERID

A.4.117 WEBSERVER_DEBUG

A.4.118 WEBSERVER_DOCROOT

A.4.119 WEBSERVER_PORT

B Reports-Related Environment Variables

B.1 Environment Variables

B.1.1 CA_GPREFS

B.1.2 CA_UPREFS

B.1.3 DELIMITED_LINE_END

B.1.4 DOC

B.1.5 INTERRUPT

B.1.6 DEVELOPER_NLS_LANG

B.1.7 NLS_CALENDAR

B.1.8 NLS_CREDIT

B.1.9 NLS_CURRENCY

B.1.10 NLS_DATE_FORMAT

B.1.11 NLS_DATE_LANGUAGE

B.1.12 NLS_DEBIT

B.1.13 NLS_ISO_CURRENCY

B.1.14 NLS_LANG

B.1.15 NLS_LIST_SEPARATOR

B.1.16 NLS_MONETARY_CHARACTERS

B.1.17 NLS_NUMERIC_CHARACTERS

B.1.18 NLS_SORT

B.1.19 ORACLE_AFM

B.1.20 ORACLE_HOME

B.1.21 ORACLE_HPD

B.1.22 ORACLE_PATH

B.1.23 ORACLE_PPD

B.1.24 ORACLE_TFM

B.1.25 ORAINFONAV_DOCPATH

B.1.26 PRINTER

B.1.27 REMOTE

B.1.28 REPORTS_ADD_HWMARGIN

B.1.29 REPORTS_ARABIC_NUMERAL

B.1.30 REPORTS_BIDI_ALGORITHM

B.1.31 REPORTS_CGIDIAGBODYTAGS *

B.1.32 REPORTS_CGIDIAGHEADTAGS *

B.1.33 REPORTS_CGIHELP *

B.1.34 REPORTS_CGIMAP *

B.1.35 REPORTS_CGINODIAG *

B.1.36 REPORTS_CLASSPATH

B.1.37 REPORTS_COOKIE_EXPIRE *

B.1.38 REPORTS_DB_AUTH *

B.1.39 REPORTS_DEFAULT_DISPLAY

B.1.40 REPORTS_DEFAULT_PIXEL_SIZE

B.1.41 REPORTS_ENCRYPTION_KEY *

B.1.42 REPORTS_GRAPH_IMAGE_DPI

B.1.43 REPORTS_JVM_OPTIONS

B.1.44 REPORTS_NLS_XML_CHARSETS

B.1.45 REPORTS_NO_DUMMY_PRINTER

B.1.46 REPORTS_NO_HTML_SPACE_REPLACE

B.1.47 REPORTS_OUTPUTIMAGEFORMAT

B.1.48 REPORTS_PATH

B.1.49 REPORTS_RESOURCE

B.1.50 REPORTS_SERVER *

B.1.51 REPORTS_SPACE_BREAK

B.1.52 REPORTS_SSLPORT *

B.1.53 REPORTS_SYS_AUTH

B.1.54 REPORTS_TAGLIB_URI

B.1.55 REPORTS_TMP

B.1.56 REPORTS_USEREXIT

B.1.57 RW

B.1.58 TK_PRINT

B.1.59 TK_PRINT_STATUS

B.1.60 TK_PRINTER

B.1.61 TK90_AFM

B.1.62 TK90_HPD

B.1.63 TK90_PPD

B.1.64 TK90_TFM

B.1.65 USERNAME

B.1.66 USER_NLS_LANG

B.1.67 WIN_REMOTE_SESSIONS

B.1.68 XMMITR

C Batch Registering Reports in OracleAS Portal

C.1 Batch Registering Report Definition Files

C.1.1 Run rwconverter to Generate a SQL Script

C.1.2 Run the Script in SQL*Plus

C.2 Batch Removing Report Packages

C.3 PL/SQL Batch Registering Function

Glossary

Index