Skip Headers
Oracle9
i
AS Reports Services Publishing Reports to the Web
Release 9.0
Part Number A92102-01
Home
Solution Area
Index
Contents
Title and Copyright Information
Send Us Your Comments
Preface
Intended Audience
Documentation Accessibility
Accessibility of Code Examples in Documentation
Structure
Related Documents
Notational Conventions
Part I Preparing Your Environment
1 Oracle9iAS Reports Services Architecture
1.1 Overview of Oracle9
i
AS Reports Services
1.2 Oracle9
i
AS Reports Services Components
1.3 Oracle9
i
AS 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
2 Starting and Stopping Oracle9
i
AS Reports Services
2.1 Starting the Reports Server
2.1.1 Installing and Starting the Reports Server as a Service (Windows NT/2000)
2.1.2 Starting the Reports Server as a Servlet (Windows and UNIX)
2.1.3 Starting the Reports Server from a Command Line (Windows and UNIX)
2.2 Verifying the Reports Servlet and Server Are Running
2.3 Verifying that the Oracle HTTP Server Is Running
2.4 Stopping the Reports Server
3 Configuring Oracle9
i
AS Reports Services
3.1 Oracle9
i
AS Reports Services Configuration Files
3.2 Configuring the Oracle9
i
AS Reports Server
3.2.1 Reports Server Configuration Elements (rwserverconf.dtd)
3.2.1.1 server
3.2.1.2 compatible
3.2.1.3 cache
3.2.1.4 engine
3.2.1.5 security
3.2.1.6 destination
3.2.1.7 job
3.2.1.8 notification
3.2.1.9 log
3.2.1.10 jobStatusRepository
3.2.1.11 trace
3.2.1.12 connection
3.2.1.13 queue
3.2.1.14 persistFile
3.2.1.15 identifier
3.2.1.16 pluginParam
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 Verbose Error Messages
3.3.4 Selecting Login Dialog Boxes
3.3.5 Setting up Trace Options for the Reports Servlet and JSPs
3.3.6 Customizing the Appearance of Server Error Messages
3.3.7 Specifying an In-Process Server
3.3.8 Identifying the Default Reports Server
3.3.9 Pointing to Dynamically Generated Images
3.3.10 Setting Expiration for DB Authentication and SYSAUTH Cookies
3.3.11 Setting an Encryption Key for the DB Authentication Cookie
3.3.12 Adding Formatting to Diagnostic/Debugging Output
3.3.13 Specifying an SSL Port Number
3.3.14 Defining the rwservlet Help File
3.3.15 Specifying the Use of Single Sign-On
3.4 Configuring the URL Engine
3.5 Entering Proxy Information
3.6 Configuring the Reports Server for Oracle Enterprise Manager
4 Configuring Destinations for Oracle9
i
AS Reports Services
4.1 Overview of Output Processing
4.2 Registering Destination Types with the Server
4.2.1 Setting Up a Destination Section in the Server Configuration File
4.2.2 Entering Valid Values for a Destination
4.2.2.1 Destination destypes and classes
4.2.2.2 Destination Property name/value Pairs
5 Controlling User Access
5.1 Introduction to Oracle9
i
AS Portal
5.2 Defining Portal-Based Security in the Server Configuration File
5.3 Creating Reports Users and Named Groups in Oracle9
i
AS Portal
5.3.1 Default Reports-Related Groups
5.3.1.1 RW_BASIC_USER
5.3.1.2 RW_POWER_USER
5.3.1.3 RW_DEVELOPER
5.3.1.4 RW_ADMINISTRATOR
5.3.2 Creating Users and Groups
5.4 Setting Up Access Controls
5.4.1 Creating an Availability Calendar
5.4.1.1 Creating a Simple Availability Calendar
5.4.1.2 Creating a Combined Availability Calendar
5.4.2 Registering a Printer
5.4.3 Registering a Reports Server
5.4.4 Registering a Report
6 Reports Server Clusters
6.1 Cluster Overview
6.2 Setting Up a Cluster
6.2.1 Renaming a Reports Server
6.2.2 Generating New Public and Private Keys
6.2.3 Entering Public and Private Keys in the Server Configuration File
6.2.4 Restarting the Reports Server
6.2.5 Submitting a Request to a Cluster
7 Data Source Single Sign-On
7.1 SSO Architecture
7.1.1 SSO Components
7.1.2 SSO Transactions
7.2 Methods for Setting Up User Connection Strings
7.2.1 Initial Requirements
7.2.2 Method 1: Giving Users Access to the OID
7.2.3 Method 2: Assigning Connection Strings and Letting Users Input at Login
Part II Sending Requests to the Server
8 Running Report Requests
8.1 The Reports URL Syntax
8.1.1 Servlet
8.1.2 JSP
8.1.3 CGI
8.2 Report Request Methods
8.3 Publishing a Report Portlet in Oracle9iAS Portal
8.3.1 Creating a Provider for Your Reports
8.3.2 Creating the Report Definition File Access
8.3.3 Adding the Report Portlet to a Page
8.4 Specifying a Report Request from a Web Browser
8.5 Sending a Request to the URL Engine
8.6 Scheduling Reports to Run Automatically
8.7 Additional Parameters
8.8 Reusing Report Output from Cache
8.8.1 Usage Notes
8.9 Using a Key Map File
8.9.1 Enabling Key Mapping
8.9.2 Adding Key Mapping Entries to a Key Map File
8.9.3 Using a Key with Everything but JSPs
8.9.4 Using a Key with a Report Run as a JSP
9 Creating Advanced Distributions
9.1 Distribution Overview
9.2 Introduction to Distribution XML Files
9.2.1 The distribution.dtd File
9.2.2 A Brief Word About Using Variables within Attributes
9.3 Elements of a Distribution XML File
9.3.1 destinations
9.3.2 foreach
9.3.3 mail
9.3.4 body
9.3.5 attach
9.3.6 include
9.3.7 file
9.3.8 printer
9.3.9 destype
9.3.10 property
9.4 Distribution XML File Examples
9.4.1 foreach examples
9.4.1.1 Single E-Mail with Report Groups as Separate Attachments
9.4.1.2 Separate E-Mail for Each Group Instance
9.4.1.3 Separate E-Mails with Separate Sections as Attachments
9.4.1.4 Separate File for Each Section
9.4.1.5 Separate Print Run for Each Report
9.4.1.5.1 Windows
9.4.1.5.2 UNIX
9.4.2 mail examples
9.4.2.1 E-Mail with a Whole Report as the Body
9.4.2.2 E-Mail with a Section of a Report as the Body
9.4.2.3 E-Mail with Two Report Sections as the Body
9.4.2.4 E-Mail with External File as Body and Report as Attachment
9.4.2.4.1 Windows
9.4.2.4.2 UNIX
9.4.2.5 E-Mail with Whole Report and Grouped Sections Attached
9.4.2.6 E-Mail to Relevant Manager and Department
9.4.3 file examples
9.4.3.1 File for Whole Report
9.4.3.1.1 Windows
9.4.3.1.2 UNIX
9.4.3.2 File for Combined Report Sections
9.4.3.3 File for Each Group of Combined Sections
9.4.3.4 File for Each Report Group Instance
9.4.4 printer examples
9.4.4.1 Print Whole Report
9.4.4.1.1 Windows
9.4.4.1.2 UNIX
9.4.4.2 Print Two Sections of a Report
9.4.4.2.1 Windows
9.4.4.2.2 UNIX
9.4.4.3 Print Grouped Report
9.4.4.3.1 Windows
9.4.4.3.2 UNIX
9.4.4.4 Print Combined Sections for Each Group Instance
9.4.4.4.1 Windows
9.4.4.4.2 UNIX
9.4.4.5 Print Relevant Instance of a Report to Its Relevant Printer
9.5 Using a Distribution XML File at Runtime
9.6 XSL Transformation for Custom/Pluggable Destinations
10 Customizing Reports with XML
10.1 Customization Overview
10.2 Creating XML Customizations
10.2.1 Required XML Tags
10.2.2 Changing Styles
10.2.3 Changing a Format Mask
10.2.4 Adding Formatting Exceptions
10.2.5 Adding Program Units and Hyperlinks
10.2.6 Adding a New Query and Using the Result in a New Header Section
10.3 Creating XML Data Models
10.3.1 Creating Multiple Data Sources
10.3.2 Linking Between Data Sources
10.3.3 Creating Group Hierarchies within Each Data Source
10.3.4 Creating Cross-Product (Matrix) Groups
10.3.5 Creating Formulas, Summaries, and Placeholders at any Level
10.3.6 Creating Parameters
10.4 Using XML Files at Runtime
10.4.1 Applying an XML Report Definition at Runtime
10.4.1.1 Applying One XML Report Definition
10.4.1.2 Applying Multiple XML Report Definitions
10.4.1.3 Applying an XML Report Definition in PL/SQL
10.4.1.3.1 Applying an XML Definition Stored in a File
10.4.1.3.2 Applying an XML Definition Stored in Memory
10.4.2 Running an XML Report Definition by Itself
10.4.3 Performing Batch Modifications
10.5 Debugging XML Report Definitions
10.5.1 XML Parser Error Messages
10.5.2 Tracing Options
10.5.3 RWBUILDER
10.5.4 Writing XML to a File for Debugging
11 Event-Driven Publishing
11.1 The Event-Driven Publishing API
11.1.1 Elements of the API
11.1.2 Creating and Manipulating a Parameter List
11.1.2.1 Add_Parameter
11.1.2.2 Remove_Parameter
11.1.2.3 Clear_Parameter_List
11.1.3 How to Submit a Job
11.1.4 How to Check for Status
11.1.5 Using the Servers' Status Record
11.2 Debugging Applications That Use the Event-Driven Publishing API
11.3 Invoking a Report From a Database Event
11.4 Integrating with Oracle9
i
Advanced Queuing
11.4.1 Creating a Queue That Holds Messages of Type SRW_PARAMLIST
11.4.2 Creating the Enqueuing Procedure
11.4.3 Creating the Dequeuing Procedure
Part III National Language Support and Bidirectional Support
12 NLS and Bidirectional Support
12.1 NLS Architecture
12.1.1 Language-Independent Functions
12.1.2 Language-Dependent Data
12.2 NLS Environment Variables
12.2.1 NLS_LANG Environment Variable
12.2.1.1 Defining the NLS_LANG Environment Variable
12.2.1.1.1 Windows
12.2.1.1.2 UNIX
12.2.1.2 Character Sets
12.2.1.2.1 Character Set Design Considerations
12.2.1.2.2 Font Aliasing on Windows Platforms
12.2.1.3 Language and Territory
12.2.2 DEVELOPER_NLS_LANG and USER_NLS_LANG Environment Variables
12.3 Specifying a Character Set in a JSP or XML File
12.4 Bidirectional Support
12.5 Unicode
12.5.1 Unicode Support
12.5.2 Unicode Font Support
12.5.3 Enabling Unicode Support
12.5.4 Using ALTER SESSION
12.6 Translating Applications
Part IV Performance
13 Managing and Monitoring Oracle9
i
AS Reports Services
13.1 Navigating to Reports Services Information in OEM
13.2 Starting, Stopping, and Restarting Reports Servers
13.3 Viewing and Managing Reports Job Queues
13.3.1 Viewing and Managing the Current Jobs Queue
13.3.1.1 Viewing a Report Server's Current Jobs Queue
13.3.1.2 Cancelling a Current Job
13.3.2 Viewing and Managing the Scheduled Jobs Queue
13.3.2.1 Viewing a Report Server's Scheduled Jobs Queue
13.3.2.2 Cancelling a Scheduled Job
13.3.3 Viewing and Managing the Finished Jobs Queue
13.3.3.1 Viewing a Report Server's Finished Jobs Queue
13.3.3.2 Viewing a Job's Trace File
13.3.3.3 Viewing a Result from Cache
13.3.3.4 Rerunning a Finished Job
13.3.4 Viewing and Managing the Failed Jobs Queue
13.3.4.1 Viewing a Report Server's Failed Jobs Queue
13.3.4.2 Viewing a Failed Job's Trace File
13.3.4.3 Rerunning a Failed Job
13.4 Monitoring Server Performance
13.5 Viewing and Changing Reports Server Configuration Files
13.6 Viewing and Linking to Server Cluster Members
13.7 Adding a Reports Server to OEM
14 Tuning Oracle9
i
AS Reports Services
14.1 Using the In-Process Server
14.2 Tuning the Reports Engine
14.2.1 initEngine
14.2.2 maxEngine
14.2.3 minEngine
14.2.4 engLife
14.2.5 maxIdle
14.2.6 callBackTimeOut
14.3 Clustering Multiple Servers
14.4 Optimizing Cache Strategies
14.4.1 Setting Up Cache in the Reports Server Configuration File
14.4.2 Specifying Cache-Related Options in the Command Line
14.4.2.1 TOLERANCE
14.4.2.2 EXPIRATION
14.4.3 Setting Up Caching Options in a JSP
14.5 Monitoring Performance
14.5.1 Monitoring Performance with Oracle Trace
14.5.1.1 Trace Overview
14.5.1.2 Additional Sources of Trace Information
14.5.2 The SHOWJOBS Command Keyword
14.5.3 Accessing the RW_SERVER_QUEUE table
14.5.4 Updating the Database with Queue Activity
Part V Appendices
A Command Line Arguments
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 Arguments
A.4.1 ACCESSIBLE
A.4.2 ARRAYSIZE
A.4.3 AUTHID
A.4.4 AUTOCOMMIT
A.4.5 AUTOSTART
A.4.6 BATCH
A.4.7 BCC
A.4.8 BLANKPAGES
A.4.9 BUFFERS
A.4.10 CACHELOB
A.4.11 CC
A.4.12 CELLWRAPPER
A.4.13 CMDFILE
A.4.14 CMDKEY
A.4.15 CONTENTAREA
A.4.16 COPIES
A.4.17 CUSTOMIZE
A.4.18 DATEFORMATMASK
A.4.19 DELAUTH
A.4.20 DELIMITED_HDR
A.4.21 DELIMITER
A.4.22 DESFORMAT
A.4.23 DESNAME
A.4.24 DEST
A.4.25 DESTINATION
A.4.26 DESTYPE
A.4.27 DISTRIBUTE
A.4.28 DTYPE
A.4.29 DUNIT
A.4.30 EXPIRATION
A.4.31 EXPIREDAYS
A.4.32 EXPRESS_SERVER
A.4.33 FORMSIZE
A.4.34 FROM
A.4.35 GETJOBID
A.4.36 GETSERVERINFO
A.4.37 HELP
A.4.38 IGNOREMARGIN
A.4.39 INSTALL
A.4.40 ITEMTITLE
A.4.41 JOBNAME
A.4.42 JOBTYPE
A.4.43 KILLJOBID
A.4.44 LONGCHUNK
A.4.45 MODE
A.4.46 MODULE|REPORT
A.4.47 NONBLOCKSQL
A.4.48 NOTIFYFAILURE
A.4.49 NOTIFYSUCCESS
A.4.50 NUMBERFORMATMASK
A.4.51 ONFAILURE
A.4.52 ONSUCCESS
A.4.53 ORIENTATION
A.4.54 OUTPUTFOLDER
A.4.55 OUTPUTPAGE
A.4.56 OVERWRITE
A.4.57 P_AVAILABILITY
A.4.58 P_DESCRIPTION
A.4.59 P_FORMATS
A.4.60 P_NAME
A.4.61 P_OWNER
A.4.62 P_PFORMTEMPLATE
A.4.63 P_PRINTERS
A.4.64 P_PRIVILEGE
A.4.65 P_SERVERS
A.4.66 P_TRIGGER
A.4.67 P_TYPES
A.4.68 PAGEGROUP
A.4.69 PAGESIZE
A.4.70 PAGESTREAM
A.4.71 PARAMFORM
A.4.72 PARSEQUERY
A.4.73 PDFCOMP
A.4.74 PDFEMBED
A.4.75 PRINTJOB
A.4.76 READONLY
A.4.77 REPLACEITEM
A.4.78 REPLYTO
A.4.79 REPORT|MODULE
A.4.80 ROLE
A.4.81 RUNDEBUG
A.4.82 SAVE_RDF
A.4.83 SCHEDULE
A.4.84 SERVER
A.4.85 SHOWENV
A.4.86 SHOWJOBS
A.4.87 SHOWMAP
A.4.88 SHOWMYJOBS
A.4.89 SHUTDOWN
A.4.90 SITENAME
A.4.91 SOURCE
A.4.92 SSOCONN
A.4.93 STATUSFORMAT
A.4.94 STATUSFOLDER
A.4.95 STATUSPAGE
A.4.96 STYPE
A.4.97 SSOCONN
A.4.98 SUBJECT
A.4.99 TOLERANCE
A.4.100 TRACEFILE
A.4.101 TRACEMODE
A.4.102 TRACEOPTS
A.4.103 URLPARAMETER
A.4.104 USERID
A.4.105 WEBSERVER_DEBUG
A.4.106 WEBSERVER_DOCROOT
A.4.107 WEBSERVER_PORT
B Reports-Related Environment Variables
C Batch Registering Reports in Oracle9iAS 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
Index
Copyright © 2002 Oracle Corporation.
All Rights Reserved.
Home
Solution Area
Index
