A Command Line Keywords

This appendix contains descriptions and examples of command line keywords that can be used with the Oracle Reports executables: rwclient, rwrun, rwbuilder, rwconverter, rwservlet, rwcgi, and rwserver. Each keyword description includes a table that indicates which executables can use the keyword.

Note:

For examples of using command line keywords in your runtime URL, see Chapter 13, "Running Report Requests".

The following topics are discussed in this appendix:

Using the Command Line
Oracle Reports Executables Overview
Command Line Keywords

The information in this appendix is also documented in the Oracle Reports online Help, which is available in Reports Builder or hosted on the Oracle Technology Network (OTN), as described in the Preface under "Related Documentation".

A.1 Using the Command Line

An Oracle Reports command on the command line generally has the following form:

executable_name keyword=value, keyword=value, ...

where each keyword=value pair is called a command line option.

Keywords must be specified and can be used in any order following the executable name.

A.1.1 General Usage Notes

No spaces should be placed before or after the equal sign of an option.
Separate options with one or more spaces; do not use commas to separate options.
Values may be in single or double quotes. The effect of single or double quotes is operating system-specific.
The keyword= part of all options is not case-sensitive. The value portion may be case-sensitive, depending on your operating system.
To pass a single quote from the command line, you must enter two quotes (one quote as an escape and one as the actual quote). For example:
```
rwrun REPORT=myrep DESTYPE=file DESNAME=run.out BATCH=yes p_value="Roy''s Batch Report"
```
Full pathnames are supported for all file refreences (for example, DESNAME=/revenues/q1/nwsales). If you do not specify the full path name, the Oracle Reports file searching method is used to find the file. If you do not specify a path for a keyword value that includes a file name, the Reports Server will try to find the file from the REPORTS_PATH environment variable.
All file names and paths specified in the client command line refer to files and directories on the server machine, except for any file specified for the following command line keywords:
- CMDFILE=filename. In this case, the CMDFILE specified is read and appended to the original command line (of which CMDFILE is a part) before being sent to the Reports Server. The runtime engine does not reread the command file
- DESNAME=filename DESTYPE=LOCALFILE. In this case, DESNAME refers to files on the client machine.

A.1.2 Rules

Values entered on the Runtime Parameter Form override those entered on the command line. For example, if you specify rwrun on the command line with COPIES=1, but in the Runtime Parameter Form, specify COPIES=2, then two copies of the report are generated.
Values entered on the command line override those specified in command files. For example, if you specify rwrun on the command line with COPIES=1 and CMDFILE=RUNONE (a command file), but the command file RUNONE, includes rwrun COPIES=2, only one copy of the report is generated.
You can specify values for DESTYPE, DESNAME, DESFORMAT, ORIENTATION, and COPIES in a number of different places. The following list shows the decreasing order of precedence for the places where you specify these values:
1. Print Job dialog box
2. Runtime Parameter Form
3. Runtime Parameters/Settings tab of Preferences dialog box
4. Keywords on the command line
5. Values specified in the report definition
6. Choose Printer dialog box

A.2 Oracle Reports Executables Overview

This section provides a brief description of the Oracle Reports executables and the keywords that each executable can use.

Keyword Usage Summary
rwclient
rwrun
rwbuilder
rwconverter
rwservlet
rwcgi
rwserver
rwbridge

A.2.1 Keyword Usage Summary

Table A-1 provides an alphabetical summary list of all the Oracle Reports command line keywords and specifies the Oracle Reports executables with which each keyword can be used.

* maintained for backward compatibility with Oracle9iAS Portal Release 1 and Oracle WebDB Release 2.2.

Table A-1 Keywords and the Executables With Which Each Can Be Used

Kewords	rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver	rwbridge
ACCESSIBLE	yes	yes	yes	no	yes	yes	no	no
ARRAYSIZE	yes	yes	yes	no	yes	yes	no	no
AUTHID	yes	yes	no	no	yes	yes	yes	yes
AUTOCOMMIT	yes	yes	yes	no	yes	yes	no	no
BACKGROUND	yes	no	no	no	yes	yes	no	no
BATCH	no	no	no	yes	no	no	yes	no
BCC	yes	yes	no	no	yes	yes	no	no
BLANKPAGES	yes	yes	yes	no	yes	yes	no	no
BUFFERS	yes	yes	yes	no	yes	yes	no	no
CACHELOB	yes	yes	yes	no	yes	yes	no	no
CC	yes	yes	no	no	yes	yes	no	no
CELLWRAPPER	yes	yes	no	no	yes	yes	no	no
CMDFILE	yes	yes	yes	yes	no	no	no	no
CMDKEY	no	no	no	no	yes	no	no	no
COLLATE	yes	yes	no	no	yes	yes	no	no
CONTAINSHTMLTAGS	yes	yes	yes	no	yes	yes	no	no
CONTAINSOLE	yes	yes	yes	no	yes	yes	no	no
CONTENTAREA*	yes	yes	no	no	yes	yes	no	no
COPIES	yes	yes	no	no	yes	yes	no	no
CUSTOMIZE	yes	yes	no	yes	yes	yes	no	no
DATEFORMATMASK	yes	yes	no	no	yes	yes	no	no
DELAUTH	no	no	no	no	yes	yes	no	no
DELIMITED_HDR	yes	yes	no	no	yes	yes	no	no
DELIMITER	yes	yes	no	no	yes	yes	no	no
DESFORMAT	yes	yes	no	no	yes	yes	no	no
DESNAME	yes	yes	no	no	yes	yes	no	no
DEST	no	no	no	yes	no	no	no	no
DESTINATION	yes	yes	no	no	yes	yes	no	no
DESTYPE	yes	yes	no	no	yes	yes	no	no
DISTRIBUTE	yes	yes	no	no	yes	yes	no	no
DTYPE	no	no	no	yes	no	no	no	no
DUNIT	no	no	no	yes	no	no	no	no
ENGINERESPONSETIMEOUT	yes	no	no	no	yes	yes	no	no
ENVID	yes	no	no	no	yes	yes	no	no
EXPIRATION	yes	no	no	no	yes	yes	no	no
EXPIREDAYS	no	no	no	no	yes	yes	no	no
EXPRESS_SERVER	yes	yes	yes	no	yes	yes	no	no
FORMSIZE	no	no	no	yes	no	no	no	no
FROM	yes	yes	no	no	yes	yes	no	no
GETJOBID	no	no	no	no	yes	yes	no	no
GETSERVERINFO	no	no	no	no	yes	no	no	no
HELP	no	no	no	no	yes	yes	no	no
ITEMTITLE	yes	yes	no	no	yes	yes	no	no
JOBNAME	yes	no	no	no	yes	yes	no	no
JOBTYPE	yes	no	no	no	yes	yes	no	no
JVMOPTIONS	no	yes	yes	yes	no	no	yes	no
KILLENGINE	no	no	no	no	yes	no	no	no
KILLJOBID	no	no	no	no	yes	yes	no	no
LONGCHUNK	yes	yes	yes	no	yes	yes	no	no
MIMETYPE	no	no	no	no	yes	yes	no	no
MODE	yes	yes	no	no	yes	yes	no	no
MODULE\|REPORT	yes	yes	yes	no	yes	yes	no	no
NAME	no	no	no	no	no	no	no	yes
NONBLOCKSQL	yes	yes	yes	no	yes	yes	no	no
NOTIFYFAILURE	yes	yes	no	no	yes	yes	no	no
NOTIFYSUCCESS	yes	yes	no	no	yes	yes	no	no
NUMBERFORMATMASK	yes	yes	no	no	yes	yes	no	no
OLAP_CON	yes	yes	yes	no	yes	yes	no	no
ONFAILURE	yes	yes	yes	no	yes	yes	no	no
ONSUCCESS	yes	yes	yes	no	yes	yes	no	no
ORIENTATION	yes	yes	no	no	yes	yes	no	no
OUTPUTFOLDER*	yes	yes	no	no	yes	yes	no	no
OUTPUTIMAGEFORMAT	yes	yes	yes	no	yes	yes	no	no
OUTPUTPAGE	yes	yes	no	no	yes	yes	no	no
OVERWRITE	no	no	no	yes	no	no	no	no
P_AVAILABILITY	no	no	no	yes	no	no	no	no
P_DESCRIPTION	no	no	no	yes	no	no	no	no
P_FORMATS	no	no	no	yes	no	no	no	no
P_JDBCPDS	yes	yes	yes	no	yes	yes	no	no
P_NAME	no	no	no	yes	no	no	no	no
P_OWNER	no	no	no	yes	no	no	no	no
P_PFORMTEMPLATE	no	no	no	yes	no	no	no	no
P_PRINTERS	no	no	no	yes	no	no	no	no
P_PRIVILEGE	no	no	no	yes	no	no	no	no
P_SERVERS	no	no	no	yes	no	no	no	no
P_TRIGGER	no	no	no	yes	no	no	no	no
P_TYPES	no	no	no	yes	no	no	no	no
PAGEGROUP	yes	yes	no	no	yes	yes	no	no
PAGESIZE	yes	yes	yes	yes	yes	yes	no	no
PAGESTREAM	yes	yes	no	no	yes	yes	no	no
PARAMFORM	no	no	no	no	yes	yes	no	no
PARSEQUERY	no	no	no	no	yes	yes	no	no
PDFCOMP	yes	yes	no	no	yes	yes	no	no
PDFEMBED	yes	yes	no	no	yes	yes	no	no
PFACTION	yes	no	yes	no	no	no	no	no
PRINTJOB	no	no	yes	no	no	no	no	no
READONLY	yes	yes	yes	no	yes	yes	no	no
RECURSIVE_LOAD	yes	yes	no	yes	yes	yes	no	no
REPLYTO	yes	yes	no	no	yes	yes	no	no
REPORT\|MODULE	yes	yes	yes	no	yes	yes	no	no
ROLE	yes	yes	no	no	yes	yes	no	no
RUNDEBUG	yes	yes	yes	no	yes	yes	no	no
SAVE_RDF	no	yes	yes	no	no	no	no	no
SCHEDULE	yes	no	no	no	yes	yes	no	no
SERVER	yes	no	no	no	yes	yes	yes	no
SHOWAUTH	no	no	no	no	yes	yes	no	no
SHOWENV	no	no	no	no	yes	yes	no	no
SHOWJOBID	no	no	no	no	yes	no	no	no
SHOWJOBS	no	no	no	no	yes	yes	no	no
SHOWMAP	no	no	no	no	yes	yes	no	no
SHOWMYJOBS	no	no	no	no	yes	no	no	no
SHUTDOWN	no	no	no	no	no	no	yes	yes
SITENAME*	yes	yes	no	no	yes	yes	no	no
SOURCE	no	no	no	yes	no	no	no	no
SQLTRACE	yes	yes	yes	no	yes	yes	no	no
SSOCONN	no	no	no	no	yes	no	no	no
STATUSFOLDER*	yes	yes	no	no	yes	yes	no	no
STATUSFORMAT	no	no	no	no	yes	no	no	no
STATUSPAGE	yes	yes	no	no	yes	yes	no	no
STYPE	no	no	no	yes	no	no	no	no
SUBJECT	yes	yes	no	no	yes	yes	no	no
SUPPRESSLAYOUT	yes	yes	yes	no	yes	yes	no	no
TOLERANCE	yes	no	no	no	yes	yes	no	no
TRACEFILE	no	yes	yes	no	no	no	yes	no
TRACEMODE	no	yes	yes	no	no	no	yes	no
TRACEOPTS	yes	yes	yes	no	yes	yes	yes	no
UPGRADE_PLSQL	no	no	no	yes	no	no	no	no
URLPARAMETER	yes	no	no	no	yes	yes	no	no
USEJVM	yes	no	no	no	no	no	no	no
USERID	yes	yes	yes	yes	yes	yes	no	no
USERSTYLES	yes	yes	yes	no	yes	yes	no	no
VALIDATETAG	no	no	yes	no	no	no	no	no
WEBSERVER_DEBUG	no	no	yes	no	no	no	no	no
WEBSERVER_DOCROOT	no	no	yes	no	no	no	no	no
WEBSERVER_PORT	no	no	yes	no	no	no	no	no

A.2.2 rwclient

rwclient (Reports Client) parses and transfers a command line to the specified Reports Server.

All file names and paths specified in the client command line refer to files and directories on the server machine, except for any file specified for the following command line keywords:

CMDFILE=filename. In this case, the CMDFILE specified is read and appended to the original command line (of which CMDFILE is a part) before being sent to the Reports Server. The runtime engine does not reread the command file
DESNAME=filename DESTYPE=LOCALFILE. In this case, DESNAME refers to files on the client machine.

Refer to Table A-1 for the keywords that can be used with rwclient.

Examples

Example 1: Running a paper report to cache

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf DESTYPE=cache

Example 2: Sending report output to a file

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf DESTYPE=file DESNAME=c:\mydir\test

Example 3: Sending report output to a printer

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf DESTYPE=printer DESNAME=myprinter

Example 4: Sending report output through e-mail

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf DESTYPE=mail DESNAME="emp1@comp.com, emp2@comp.com" cc="emp3@comp.com" bcc="mgr@comp.com" replyto="me@comp.com" from="me@comp.com"

Example 5: Sending report output to WebDAV (any WebDAV server or OracleAS Portal WebDAV)

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=htmlcss DESTYPE=webdav DESNAME="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

Example 6: Sending report output to OracleAS Portal

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb DESTYPE=oracleportal desformat=PDF PAGEGROUP=mypagegrp OUTPUTPAGE=reports_output ITEMTITLE=pushtoportal STATUSPAGE=result

Example 7: Sending XML PDS report output to a file

rwclient server=myrepserv report=myxmlpdstest.rdf DESTYPE=file desformat=PDF desname=c:\mydir\my.pdf

Example 8: Sending JDBC PDS report output to a file

rwclient server=myrepserv report=myjdbcpdstest.rdf DESTYPE=file desformat=PDF desname=c:\mydir\myxml.pdf p_jdbcpds=sybuser/sybpwd@server1.mydomain.com:1300

Example 9: Distributing a report output to multiple destinations:

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb DISTRIBUTE=yes DESTINATION=c:\mydistribute.xml

Example 10: Running scheduled reports

rwclient server=myrepserver report=test.rdf SCHEDULE="every first fri of month from 15:53 Oct 23, 1999 retry 3 after 1 hour" destype=file desformat=pdf desname=test.pdf

Example 11: Using a secured Reports Server

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf destype=file desname=test.pdf AUTHID=myadmin/myadmin

Example 12: Running a report with e-mail notification

rwclient server=myrepserver report=test.rdf userid=scott/tiger@mydb destype=file desformat=pdf desname=test.pdf NOTIFYSUCCESS="emp@comp.com" NOTIFYFAILURE="admin@comp.com"

Example 13: Running a report that specifies a URL to be fetched with the URL engine

rwclient server=myrepserver report=testExecutables That Use.rdf userid=scott/tiger@mydb destype=file desformat=pdf desname=test.pdf JOBTYPE=rwurl URLPARAMETER="http://www.oracle.com"

Example 14: Running a report with traces

rwclient server=myrepserver report=test.rdf userid=scott/tiger@mydb destype=file desformat=pdf desname=test.pdf TRACEOPTS=trace_all

A.2.3 rwrun

rwrun (Reports Runtime) runs a report using the OracleAS Reports Services in-process server.

Note:

It is recommended that you use rwrun for testing purposes only. Use rwservlet and rwclient in your production environment to take full advantage of the power of OracleAS Reports Services.

Refer to Table A-1 for the keywords that can be used with rwrun.

Examples

Example 1: Customizing a report

rwrun userid=scott/tiger@mydb report=emp.rdf CUSTOMIZE=empcustomize.xml destype=file desformat=pdf desname=emp.pdf

Example 2: Sending report output to a file

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf DESTYPE=file DESNAME=c:\mydir\test.pdf

Example 3: Sending report output to a printer

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf DESTYPE=printer DESNAME=myprinter

Example 4: Sending report output through e-mail

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf DESTYPE=mail DESNAME="emp1@comp.com, emp2@comp.com" cc="emp3@comp.com" bcc="mgr@comp.com" replyto="me@comp.com" from="me@comp.com"

Example 5: Sending report output to WebDAV (any WebDAV server or OracleAS Portal WebDAV)

rwrun report=test.rdf userid=scott/tiger@mydb desformat=htmlcss DESTYPE=webdav "DESNAME"="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

Example 6: Sending XML PDS report output to a file

rwrun report=myxmlpdstest.rdf destype=file desformat=PDF desname=c:\mydir\my.pdf

Example 7: Sending JDBC PDS report output to a file

rwrun report=myjdbcpdstest.rdf destype=file desformat=PDF desname=c:\mydir\myxml.pdf P_JDBCPDS=sybuser/sybpwd@server1.mydomain.com:1300

Example 8: Distributing report output to multiple destinations

rwrun report=test.rdf userid=scott/tiger@mydb DISTRIBUTE=yes DESTINATION=c:\mydistribute.xml

Example 9: Using a secured Reports Server

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf destype=file desname=test.pdf AUTHID=myadmin/myadmin

Example 10: Running a report with e-mail notification

rwrun report=test.rdf userid=scott/tiger@mydb destype=file desformat=pdf desname=test.pdf NOTIFYSUCCESS="emp@comp.com" NOTIFYFAILURE="admin@comp.com"

Example 11: Running a report with trace enabled

rwrun report=test.rdf userid=scott/tiger@mydb destype=file desformat=pdf desname=test.pdf TRACEOPTS=trace_prf TRACEMODE=trace_replace

A.2.4 rwbuilder

rwbuilder invokes Reports Builder. When you include a REPORT|MODULE keyword on the command line with rwbuilder, Reports Builder opens with the specified report highlighted in the Object Navigator. When no report is specified, Reports Builder opens with a Welcome dialog offering you the choice of opening an existing report or creating a new one.

Refer to Table A-1 for the keywords that can be used with rwbuilder.

Example

rwbuilder report=myrep.rdf userid=scott/tiger@mydb

A.2.5 rwconverter

rwconverter (Reports Converter) enables you to convert one or more report definitions or PL/SQL libraries from one storage format to another. For example, you can use rwconverter to:

Combine a report file with an XML file to create a new report
Convert a report stored in an .rdf file to a .rep,.rex,.jsp, or .tdf (template) file.

Note:
When a report is converted to a template, only objects in the report's header and trailer sections and margin area are used in the template. Objects in the main section are ignored.
Convert a report stored in a .rex file to an .rdf or a template (.tdf file)
Convert a library stored in the database to a .pld or .pll file
Convert a library stored in a .pld file into a database library or a .pll file
Convert a library stored in a .pll file into a database library of a .pld file

Note:
When you convert a report that has an attached library, convert the .pll files attached to the report before converting the .rdf/.rex file.
Create a PL/SQL script that batch registers reports in OracleAS Portal

In some cases, rwconverter automatically compiles the report's PL/SQL as part of the conversion process. Provided your conversion destination is not a .rex file, rwconverter automatically compiles PL/SQL under the following conditions:

Converting to a .rep file. If there are compile errors, rwconverter displays an error message and the .rep file is not created.
Using a .rex file as the source. If there are compile errors, rwconverter displays a warning, but the conversion continues.
Using a report created on another platform than the source. If there are compile errors, rwconverter displays a warning, but the conversion continues.

In all other situations, you must compile the report's PL/SQL yourself (for example, using Program > Compile > All in Reports Builder).

Note:

Fonts are mapped when a report is opened by Reports Builder or Reports Runtime, not during the conversion.

Refer to Table A-1 for the keywords that can be used with rwconverter.

Example:

rwconverter scott/tiger@mydb stype=rdffile source=inven1.rdf dtype=xmlfile dest=inven1_new.xml

A.2.6 rwservlet

rwservlet (Reports Servlet) translates and delivers information between either a Web server or a J2EE Container (for example, OC4J) and the Reports Server, allowing you to run a report dynamically from your Web browser. Optionally, it can use the in-process server, which reduces the maintenance and administration of the Reports Server by providing a means for starting the server automatically, whenever it receives the first request from the client.

Note:

When you use rwservlet to run a JSP, you can use all keywords applicable to rwservlet. For more information on running a JSP with rwservlet, see Section 13, "Running Report Requests".

Note:

The following keywords are commands rather than keyword=value pairs; that is, these keywords are entered by themselves without a corresponding value: SHOWENV, SHOWJOBS, SHOWMAP, SHOWMYJOBS, KILLJOBID, KILLENGINE, PARSEQUERY, DELAUTH, GETJOBID, and GETSERVERINFO.

Refer to Table A-1 for the keywords that can be used with rwservlet.

Examples

In the following examples, myias.mycomp.com is your Oracle Application Server instance, and 7779 is the port where rwservlet is running.

Example 1: Running a paper report to a browser (cache)

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+userid=scott/tiger@mydb+desformat=pdf+DESTYPE=cache

Example 2: Sending report output to a file

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+userid=scott/tiger@mydb+desformat=pdf+DESTYPE=file+DESNAME=c:\mydir\test

Example 3: Sending report output to a printer

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+userid=scott/tiger@mydb+desformat=pdf+DESTYPE=printer+DESNAME=myprinter

Example 4: Sending report output to e-mail

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rd

f+userid=scott/tiger@mydb+desformat=pdf+DESTYPE=mail+DESNAME="emp1@co

mp.com,emp2@comp.com"+CC="emp3@comp.com"+BCC="mgr@comp.com"+

REPLYTO="me@comp.com"+FROM=me@comp.com"

Example 5: Sending report output to WebDAV (any WebDAV server or OracleAS Portal WebDAV)

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rd

f+userid=scott/tiger@mydb+desformat=htmlcss+DESTYPE=webdav+DESNAME="h

ttp://myusername:mypassword@mywebdavserv.com/mydir/test.html"

Example 6: Sending report output to OracleAS Portal

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rd

f+userid=scott/tiger@mydb+destype=oracleportal+desformat=PDF+PAGEGROUP=

mypagegrp+OUTPUTPAGE=reports_

output+ITEMTITLE=pushtoportal+STATUSPAGE=result

Example 7: Sending XML PDS report output to a file

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=myxmlpdstest.rdf+destype=file+desformat=PDF+DESNAME=c:\mydir\my.pdf

Example 8: Sending JDBC PDS report output to a file

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=myjdb

cpdstest.rdf+destype=file+desformat=PDF+desname=c:\mydir\myxml.pdf+

P_JDBCPDS=sybuser/sybpwd@server1.mydomain.com:1300

Example 9: Distributing report output to multiple destinations

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+userid=scott/tiger@mydb+DISTRIBUTE=yes+DESTINATION=c:\mydistribute.xml

Example 10: Running scheduled reports

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserver+report=test.rdf+SCHEDULE="every first fri of month from 15:53 Oct 23, 1999 retry 3 after 1 hour"+destype=file+desformat=pdf+desname=test.pdf

Example 11: Using a secured Reports Server

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+userid=scott/tiger@mydb+desformat=pdf+destype=file+desname=test.pdf+AUTHID=myadmin/myadmin

Example 12: Using a key file

http://myias.mycomp.com:7779/report/rwservlet?key1

where

key1 is a key defined in the cgicmd.dat file (the keyname should be the first parameter)

http://myias.mycomp.com:7779/report/rwservlet?server=myrepserv+userparam=12+CMDKEY=keyname

Example 13: Running a report with a Parameter Form

http://myias.mycomp.com:7779/rwservlet?server=myrepserver+report=test.rdf+userid=scott/tiger@mydb+destype=cache+desformat=htmlcss+PARAMFORM=html

Example 14: Running a report with e-mail notification

http://myias.mycomp.com:7779/rwservlet?server=myrepserver+report=test.rdf+user

id=scott/tiger@mydb+destype=file+desformat=pdf+desname=test.pdf+

NOTIFYSUCCESS="emp@comp.com"+NOTIFYFAILURE="admin@comp"

Example 15: Running a report that specifies a URL to be fetched with the URL engine

http://myias.mycomp.com:7779/rwservlet?server=myrepserver+report=test.rdf+user

id=scott/tiger@mydb+destype=file+desformat=pdf+desname=test.pdf+JOBTYPE=rw

url+URLPARAMETER="http://www.oracle.com"

Example 16: Running a report with tracing enabled

http://myias.mycomp.com:7779/rwservlet?server=myrepserver+report=test.rdf+userid=scott/tiger@mydb+destype=file+desformat=pdf+desname=test.pdf+TRACEOPTS=trace_prf

Example 17: Showing the environment information for server myrepserver

http://myias.mycomp.com:7779/reports/rwservlet/SHOWENV?server=myrepserver+authid=myrepuser/myreppassword

Example 18: Viewing the past jobs information for server myrepserver

http://myias.mycomp.com:7779/reports/rwservlet/SHOWJOBS?server=myrepserver+authid=myrepuser/myreppassword+queuetype=past

Example 19: Viewing the cgicmd.dat key mappings

http://myias.mycomp.com:7779/reports/rwservlet/SHOWMAP?authid=myrepuser/myreppassword

Example 20: Viewing current jobs information for user myrepuser

http://myias.mycomp.com:7779/reports/rwservlet/SHOWMYJOBS?server=myrepserver+authid=myrepuser/myreppassword+queuetype=current

Example 21: Getting the status of a job with job ID 30

http://myias.mycomp.com:7779/reports/rwservlet/SHOWJOBID30?server=myrepserver+authid=myrepuser/myreppassword

Example 22: Cancelling a currently running job with job ID 122

http://myias.mycomp.com:7779/reports/rwservlet/KILLJOBID122?server=myrepserver+authid=myrepuser/myreppassword

Example 23: Viewing the parsed query of a command

http://myias.mycomp.com:7779/reports/rwservlet/PARSEQUERY?server=myrepserver+authid=myrepuser/myreppassword+report=test.rdf+userid=scott/tiger@db+destype=cache+desformat=htmlcss

Example 24: Showing DB authentication page

http://myias.mycomp.com:7779/reports/rwservlet/SHOWAUTH?server=myrepserver+authid=myrepuser/myreppassword+authtype=D

Example 25: Deleting cookies set by rwservlet

http://myias.mycomp.com:7779/reports/rwservlet/DELAUTH?server=myrepserver+authid=myrepuser/myreppassword

Example 26: Getting the output of job with job ID 87 from server myrepserver

http://myias.mycomp.com:7779/reports/rwservlet/GETJOBID87?server=myrepserver+authid=myrepuser/myreppassword

Example 27: Displaying server information for server myrepserver

http://myias.mycomp.com:7779/reports/rwservlet/GETSERVERINFO?server=myrepserver+authid=myrepuser/myreppassword

Example 28: Killing engine rwEng-1 in server myrepserver

http://myias.mycomp.com:7779/reports/rwservlet/KILLENGINE1?type=rwEng+server=myrepserver+authid=myrepuser/myreppassword

A.2.7 rwcgi

Like rwservlet, rwcgi (the Common Gateway Interface (CGI)) translates and delivers information between a Web server and the Reports Server, enabling you to run a report dynamically from your Web browser.

Note:

With Oracle Reports 10g, the Reports CGI (rwcgi) is deprecated (maintained only for backward compatibility); instead, use JSPs, rwservlet (Reports Servlet), or Web Services.

rwservlet is strongly recommended over rwcgi for performance reasons. For each request, rwcgi starts a new process, initializing a JVM and resulting in slow performance when running a large number of report requests. On the other hand, rwservlet is deployed on an OC4J instance and leverages servlet functionality, thereby providing better performance over rwcgi.

Refer to Table A-1 for the keywords that can be used with rwcgi.

Examples

http://mywebserver.com^Foot 1:7779^Foot 2/cgi-bin/rwcgi.exe^Foot 3?server=myrepserver+report=myrepo.rdf+desname=sample.pdf+desformat=pdf+destype=file

http://mywebserver.com:7779/cgi-bin/rwcgi.sh^Foot 4?server=myrepserver+authid^Foot 5=myrepuser/myreppassword+report=myrepo.rdf+desname=sample.pdf+desformat=pdf+destype=file

Example 1: Running a paper report to a browser (cache)

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+userid=scott/tiger@mydb+DESFORMAT=pdf+DESTYPE=cache

Example 2: Sending report output to a file

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+userid=scott/tiger@mydb+desformat=pdf+DESTYPE=file+DESNAME=c:\mydir\test

Example 3: Sending report output to a printer

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+userid=scott/tiger@mydb+desformat=pdf+DESTYPE=printer+DESNAME=myprinter

Example 4: Sending report output through e-mail

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+userid=scott/tiger@mydb+desformat=pdf+DESTYPE=mail+DESNAME="emp1@comp.com, emp2@comp.com+CC=emp3@comp.com"+BCC="mgr@comp.com"+REPLYTO="me@comp.com+from=me@comp.com"

Example 5: Sending report output to WebDAV (any WebDAV server or OracleAS Portal WebDAV)

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf

+userid=scott/tiger@mydb+desformat=htmlcss+DESTYPE=webdav+DESNAME="htt

p://myusername:mypassword@mywebdavserv.com/mydir/test.html"

Example 6: Sending report output to OracleAS Portal

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf

+userid=scott/tiger@mydb+DESTYPE=oracleportal+desformat=PDF+PAGEGROUP=

mypagegrp+OUTPUTPAGE=reports_

output+ITEMTITLE=pushtoportal+STATUSPAGE=result

Example 7: Sending XML PDS report output to a file

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=myxmlpdstest.rdf+DESTYPE=file+desformat=PDF+desname=c:\mydir\my.pdf

Example 8: Sending a JDBC PDS report output to a file

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=myjdbc

pdstest.rdf+destype=file+desformat=PDF+desname=c:\mydir\myxml.pdf+

P_JDBCPDS=sybuser/sybpwd@server1.mydomain.com:1300

Example 9: Distributing report output to multiple destinations

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+userid=scott/tiger@mydb+DISTRIBUTE=yes+DESTINATION=c:\mydistribute.xml

Example 10: Running scheduled reports

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserver+report=test.rdf+SCHEDULE="every first fri of month from 15:53 Oct 23, 1999 retry 3 after 1 hour"+destype=file+desformat=pdf+desname=test.pdf

Example 11: Using a secured Reports Server

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+userid=scott/tiger@mydb+desformat=pdf+destype=file+desname=test.pdf+AUTHID=myadmin/myadmin

Example 12: Using a key file

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?key1

where key1=key defined in the cgicmd.dat file (the keyname should be the first parameter)

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+userparam=12+CMDKEY=key1

*when used with cmdkey, it can be anywhere in the URL

Example 13: Running a report with a Parameter Form

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserver+report=test.rdf+userid=scott/tiger@mydb+destype=cache+desformat=htmlcss+PARAMFORM=yes

Example 14: Running a report with e-mail notification

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserver+report=test.rd

f+userid=scott/tiger@mydb+destype=file+desformat=pdf+desname=test.pdf+

NOTIFYSUCCESS="emp@comp.com"+NOTIFYFAILURE="admin@comp.com"

Example 15: Running a report that specifies a URL to be fetched with the URL engine

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserver+report=test.rd

f+userid=scott/tiger@mydb+destype=file+desformat=pdf+desname=test.pdf+

JOBTYPE=rwurl+URLPARAMETER="http://www.oracle.com"

Example 16: Running a report with tracing enabled

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserver+report=test.rdf+userid=scott/tiger@mydb+destype=file+desformat=pdf+desname=test.pdf+TRACEOPTS=trace_prf

A.2.8 rwserver

rwserver (Reports Server) processes client requests, which includes ushering them through its various services, such as authentication and authorization checking, scheduling, caching, and distribution (including distribution to pluggable output destinations). Reports Server also spawns runtime engines for generating requested reports, fetches completed reports from the reports cache, and notifies the client that the job is ready.

Refer to Table A-1 for the keywords that can be used with rwserver.

Example 1 (recommended):

The following commands start Reports Server if it was configured through the Oracle Process Manager and Notification Server (OPMN):

$ORACLE_HOME/opmn/bin/opmnctl startproc ias-component=reports_server_name
$ORACLE_HOME/opmn/bin/opmnctl startproc process-type=reports_server_name

For more information on starting Reports Server through OPMN, see Section 2.1.2, "Starting, Stopping, and Restarting Reports Servers from the Oracle Process Manager and Notification Server".

Example 2 (not recommended):

The following command starts Reports Server from the command line:

rwserver server=myrepserver batch=yes

A.2.9 rwbridge

rwbridge (Oracle Reports bridge) is used when Reports Server and Reports Client are in different subnets. Reports Client uses the default broadcast mechanism for server discovery, which sends packets that can travel only within a subnet. The Oracle Reports bridge can bridge two subnets in a network. It intercepts the packets broadcast by Reports Server and Reports Client and transfers them to the remote bridges configured in the bridge configuration file. For information on configuring the Oracle Reports bridge, refer to Section 3.3.2, "Bridge Configuration Elements (bridgeconf.dtd)".

For troubleshooting scenarios and diagnosis, see Section D.8, "Diagnosing Oracle Reports Bridge Problems".

The keywords that can be used with rwbridge are:

NAME
SHUTDOWN
AUTHID

Example 1: Starting the bridge

On UNIX: rwbridge.sh name=mybridge

On Windows: rwbridge.bat name=mybridge

Example 2: Stopping the bridge

On UNIX: rwbridge.sh name=mybridge shutdown=immediate authid=scott/tiger

On Windows: rwbridge.bat name=mybridge name=mybridge shutdown=immediate authid=scott/tiger

A.3 Command Line Keywords

This section describes each of the command line keywords that can be used in Oracle Reports.

A.3.1 ACCESSIBLE

Table A-2 indicates which executables can use the ACCESSIBLE keyword.

Table A-2 Executables That Use ACCESSIBLE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use ACCESSIBLE to specify whether accessibility-related features offered through Oracle Reports are enabled (YES) or disabled (NO) for PDF output.

Syntax ACCESSIBLE={YES|NO}

Values

YES Accessibility features are enabled for PDF output.
NO Accessibility features are not enabled for PDF output.

Default NO

A.3.2 ARRAYSIZE

Table A-3 indicates which executables can use the ARRAYSIZE keyword.

Table A-3 Executables That Use ARRAYSIZE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use ARRAYSIZE to specify the size (in kilobytes) for use with Oracle's array processing. Generally, the larger the array size, the faster the report will run.

Syntax ARRAYSIZE=n

Values

n A number from 1 through 9999 (no comma is used with thousands). This means that Reports Runtime can use this number of kilobytes of memory per query in your report.

Default 10

Usage Notes ARRAYSIZE can be used when running JSP-based Web reports from the command line.

A.3.3 AUTHID

Table A-4 indicates which executables can use the AUTHID keyword.

Table A-4 Executables That Use AUTHID

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver	rwbridge
yes	yes	no	no	yes	yes	yes	yes

Description

Use AUTHID to specify the user name and password to be used to authenticate users to the restricted Reports Server. User authentication ensures that the users making report requests have access privileges to run the requested report
With rwbridge: Use AUTHID to specify the user name and the password to authorize shutting down the Oracle Reports bridge. You can set the identifier element in the bridge configuration file to the administrator user name and password to secure the bridge. This ensures that only administrators can shut down the bridge.

Syntax AUTHID=username/password

Values

username/password Any valid user name and password created in OracleAS Portal. See your DBA to create new users accounts in OracleAS Portal.
With rwbridge:

username/password The user name and password specified in the identifier element in the bridge configuration file (rwbridge_bridgename.conf).

Default None

Usage Notes

AUTHID can be used when running JSP-based Web reports from the command line.
If you have a Single Sign-On environment, then the Oracle Application Server Single Sign-On Server will perform the authentication step and pass only the user name to the Reports Server in AUTHID.

A.3.4 AUTOCOMMIT

Table A-5 indicates which executables can use the AUTOCOMMIT keyword.

Table A-5 Executables That Use AUTOCOMMIT

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use AUTOCOMMIT to specify whether database changes (for example, CREATE) should be automatically committed to the database. Some non-Oracle databases (for example, SQL Server) require that AUTOCOMMIT=YES.

Syntax AUTOCOMMIT={YES|NO}

Values

YES Data changes are committed to the database automatically.
NO Data changes are not committed to the database until the COMMIT command runs or one of the PL/SQL commands that cause the data to be committed runs.

Default NO

Usage Notes AUTOCOMMIT can be used when running JSP-based Web reports from a URL.

A.3.5 BACKGROUND

Table A-6 indicates which executables can use the BACKGROUND keyword.

Table A-6 Executables That Use BACKGROUND

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	no	no	yes	yes	no

Description BACKGROUND specifies whether a report on the server should be run synchronously (NO) or asynchronously (YES).

Note:

The BACKGROUND system parameter is deprecated in Oracle Reports. BACKGROUND is used only on the command line.

Syntax BACKGROUND={YES|NO}

Values

YES Runs the report asynchronously. The client sends the call to the server, then continues with other processes without waiting for the report job to complete. If the client process is killed, the job is canceled.
NO Runs the report synchronously. The client waits for the report to queue, be assigned to a runtime engine, run, and finish.

Default NO

Usage Notes If BACKGROUND=YES is used with rwbuilder, a warning is issued and the keyword is ignored.

A.3.6 BATCH

Table A-7 indicates which executables can use the BATCH keyword.

Table A-7 Executables That Use BATCH

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	yes

Description Use BATCH when you want the server to run in no-UI mode. No user interface is displayed by the application when running from a command line that includes BATCH=YES. For example, for rwserver this allows the server to be run from scripts and remote agents so that no server dialog box displays while it is running.

With rwconverter, BATCH=YES suppresses all terminal input and output in order to convert reports and libraries without user intervention. With rwserver, BATCH turns the server dialog box off (YES) or on (NO) to display or suppress process messages.

Syntax BATCH={YES|NO}

Values

YES Suppresses all terminal input and output (report is run in the background). This is the default for rwrun.
NO Allows special terminal input and output. For rwconverter, the Convert dialog box is displayed, and when you accept the dialog box, the conversion is performed.

Default NO

Usage Notes

If BATCH=YES, error messages are sent to SYSOUT. For more information on SYSOUT, see DESTYPE.
If BATCH=YES, PARAMFORM=YES is invalid because it is not meaningful to have the Runtime Parameter Form appear in batch mode.

A.3.7 BCC

Table A-8 indicates which executables can use the BCC keyword.

Table A-8 Executables That Use BCC

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use BCC to specify e-mail recipient(s) of a blind courtesy copy (that is, one in which the names of specified recipients are not visible (published) to other recipients).

Note:

A blind copy is one in which the names of specified recipients are not visible (published) to other recipients.

Syntax BCC=emailid | ("emailid","emailid", ...)

Values

emailid A valid e-mail address in the form someone@foo.com.

Default None

Usage Notes

To specify more than one e-mail address, enclose the list of addresses in quotation marks and separate each address in the list with a comma.
Related keywords include BCC, CC, FROM, REPLYTO, and SUBJECT. Note that DESNAME is used to specify the main recipient(s) of the e-mail.
BCC can be used when running JSP-based Web reports from the command line.

A.3.8 BLANKPAGES

Table A-9 indicates which executables can use the BLANKPAGES keyword.

Table A-9 Executables That Use BLANKPAGES

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use BLANKPAGES to specify whether to suppress blank pages when you print a report. Use this keyword when there are blank pages in your report output that you do not want to print.

Syntax BLANKPAGES={YES|NO}

Values

YES Prints all blank pages.
NO Does not print blank pages.

Default YES

Usage Notes BLANKPAGES is especially useful if your logical page spans multiple physical pages (or panels), and you wish to suppress the printing of any blank physical pages.

A.3.9 BUFFERS

Table A-10 indicates which executables can use the BUFFERS keyword.

Table A-10 Executables That Use BUFFERS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use BUFFERS to specify the size of the virtual memory cache in kilobytes. You should tune this setting to ensure that you have enough space to run your reports, but not so much that you are using too much of your system's resources.

Syntax BUFFERS=n

Values

n A number from 1 through 9999 (note that thousands are not expressed with any internal punctuation, for example, a comma or a decimal point). For some operating systems, the upper limit might be lower.

Default 640

Usage Notes

If this setting is changed in the middle of your session, then the change does not take effect until the next time the report is run.
BUFFERS can be used when running JSP-based Web reports from the command line.

A.3.10 CACHELOB

Table A-11 indicates which executables can use the CACHELOB keyword.

Table A-11 Executables That Use CACHELOB

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use CACHELOB to specify whether to cache retrieved ORACLE large object or objects in the temporary file directory on the Reports Server (specified in the environment variable REPORTS_TMP or by the tempDir property of the engine element in the Reports Server configuration file, server_name.conf; note that a tempDir setting overrides a REPORTS_TMP setting.).

Syntax CACHELOB={YES|NO}

Values

YES The LOB will be cached in the temporary file directory.
NO The LOB will not be cached in the temporary file directory.

Default YES

Usage Notes

You can only set this option on the command line.
If the location of the temporary file directory on the server does not have sufficient available disk space, then it is preferable to set this value to NO. Setting the value to NO, however, might decrease performance, as the LOB might need to be fetched from the database multiple times.
CACHELOB can be used when running JSP-based Web reports from the command line.

A.3.11 CC

Table A-12 indicates which executables can use the CC keyword.

Table A-12 Executables That Use CC

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use CC to specify e-mail recipient(s) of a courtesy copy.

Syntax CC=emailid | ("emailid","emailid", ...)

Values

emailid A valid e-mail address in the form someone@foo.com.

Default None

Usage Notes

To specify more than one e-mail address, enclose the list of addresses in quotation marks and separate each address in the list with a commPa.
Related keywords include BCC, CC, FROM, REPLYTO, and SUBJECT. Note that DESNAME is used to specify the main recipient(s) of the e-mail.

A.3.12 CELLWRAPPER

Table A-13 indicates which executables can use the CELLWRAPPER keyword.

Table A-13 Executables That Use CELLWRAPPER

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use CELLWRAPPER to specify the character or characters that displays around the delimited cells in your report output.

Syntax CELLWRAPPER=value

Values

value Any alphanumeric character or string of alphanumeric characters.

Table A-14 Valid Values - General

Value	Description
`"`	A double quotation mark displays on each side of the cell
`'`	A single quotation mark displays on each side of the cell

Table A-15 Valid Values - Reserved

Value	Description
`tab`	A tab displays on each side of the cell
`space`	A single space displays on each side of the cell
`return`	A new line displays on each side of the cell
`none`	No cell wrapper is used

Table A-16 Valid Values - Escape Sequences Based on the ASCII Character Set

Value	Description
`\t`	A tab displays on each side of the cell
`\n`	A new line displays on each side of the cell

Default None

Usage Notes

This keyword can only be used if you have specified DESFORMAT=DELIMITED or DESFORMAT=DELIMITEDDATA.
The cell wrapper is different from the actual delimiter. The cell wrapper specifies what character appears around delimited data. The delimiter indicates the boundary or break point between two pieces of data.

A.3.13 CMDFILE

Table A-17 indicates which executables can use the CMDFILE keyword.

Table A-17 Executables That Use CMDFILE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	yes	no	no	no

Description Use CMDFILE to call a file that contains one report's command line options. The file called must be an ASCII file, either .txt or any other ASCII-type file.

CMDFILE differs from the cgicmd.dat file, in that CMDFILE can contain one command line for one report, where the cgicmd.dat file can contain multiple key-identified commands for multiple reports. Additionally, the CMDFILE keyword can be used along with other arguments in a command line; while, when you use the key argument associated with cgicmd.dat, it is the only argument that appears in the command line.

The CMDFILE keyword enables you to run a report without specifying a large number of options each time you invoke a run command.

Syntax CMDFILE=filename

Values

filename Any valid command file name.

Default None

Usage Notes

With rwservlet and rwcgi, use the CMDKEY keyword to refer to a key in the cgicmd.dat file in lieu of using the CMDFILE keyword.
A command file can reference another command file.
The syntax for a command line you specify in the command file is identical to that used on the command line.
Values entered on the command line override values specified in command files. For example, suppose you specify rwclient from the command line with COPIES set to 1 and CMDFILE set to RUNONE (a command file). The RUNONE file also specifies a value for COPIES, but it is set to 2. The value specified for COPIES in the command line (1) overrides the value specified for COPIES in the RUNONE file (2). Only one copy of the report will be generated.
The value for this keyword might be operating system-specific.

A.3.14 CMDKEY

Table A-18 indicates which executables can use the CMDKEY keyword.

Table A-18 Executables That Use CMDKEY

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	no	no

Description Use CMDKEY to call a key-identified command line in the cgicmd.dat file. For example:

http://your_webserver/reports/rwservlet?cmdkey=key& ...

Syntax CMDKEY=key

Values

key The name of any key associated with a command line specified in the cgicmd.dat file.

Default None

Usage Notes

When you use CMDKEY with rwservlet, you can use it in any order in the command line (or the URL, following the question mark). With rwservlet, you can use additional command line keywords along with CMDKEY.
CMDKEY can be used when running JSP-based Web reports from the command line.

A.3.15 COLLATE

Table A-19 indicates which executables can use the COLLATE keyword.

Table A-19 Executables That Use COLLATE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use COLLATE to control the collating behavior when a report is output to a printer.

For example, printing three copies of a three page document with COLLATE set to YES would result in output similar to the following:

1 2 3|1 2 3| 1 2 3

The order specified is the page numbers being printed. This behavior is similar to selecting the Collate check box in the Print dialog box.

Printing three copies of a three page document with COLLATE set to NO would result in output similar to the following:

1 1 1| 2 2 2| 3 3 3

Syntax COLLATE={YES|NO}

Values

YES Collates the pages when output to a printer.
NO Does not collate the pages when output to a printer.

Default YES

A.3.16 CONTAINSHTMLTAGS

Table A-22 indicates which executables can use the CONTAINSHTMLTAGS keyword.

Table A-20 Executables That Use CONTAINSHTMLTAGS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Oracle Reports 10g Release 2 (10.1.2) introduces text formatting enhancements that allow you to use a defined set of HTML formatting tags to format text style (bold, italics, underline, and strikethrough) and text attributes (font name, font color, and font size), and generate formatted text objects in all bitmap output formats supported by Oracle Reports when the objects' Contains HTML Tags property is set to Yes.

Use CONTAINSHTMLTAGS to specify whether Oracle Reports should interpret the HTML formatting tags for all the supported output formats.

Syntax CONTAINSHTMLTAGS=YES|NO

Values

YES Oracle Reports interprets the HTML formatting tags for all objects whose Contains HTML Tags property is set to Yes.
NO Oracle Reports does not interpret the HTML tags for the report, regardless of the object's Contains HTML Tags property setting. For HTML and HTMLCSS ouput, the browser will interpret the HTML formatting tags; for other output formats, the HTML tags themselves will appear as is in the report output.

Default YES

Usage Notes

The supported output formats are: PDF, RTF, HTML, HTMLCSS, spreadsheet, and PostScript.
Oracle Reports' interpretation of inline HTML tags may be different from the browser's interpretation. As a result, a report designed with inline HTML tags in Oracle Reports 6i, Oracle9i Reports, or Oracle Reports 10g Release 1 (9.0.4) may generate a different HTML or HTMLCSS output in Oracle Reports 10g Release 2 (10.1.2). If you do not wish for Oracle Reports to interpret HTML formatting tags, and instead retain the behavior of prior releases, set the REPORTS_CONTAINSHTMLTAGS environment variable to NO.
If you set the REPORTS_CONTAINSHTMLTAGS environment variable to NO, you can still specify CONTAINSHTMLTAGS=YES on the command line for selected reports to have Oracle Reports interpret the HTML formatting tags for all the supported output formats. In other words, the value specified by this command line keyword overrides the REPORTS_CONTAINSHTMLTAGS environment variable.

A.3.17 CONTAINSOLE

Note:

With Oracle Reports 10g Release 1 (9.0.4), OLE support is obsolete (OLE is a client/server feature that is not applicable in a Web-based environment). Instead, use mime types with associated plug-ins and hyperlinks.

Table A-22 indicates which executables can use the CONTAINSOLE keyword.

Table A-21 Executables That Use CONTAINSOLE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description For backward compatibility, use CONTAINSOLE to specify whether the program units or attached libraries for the report contain any OLE (Object Linking and Embedding) calls. If CONTAINSOLE=YES, the OLE system is initialized at the start of report execution and terminated at the end of that report execution.

Syntax CONTAINSOLE=YES|NO

Values

YES The report includes OLE calls in program units or attached libraries.
NO The report does not contain any OLE calls in program units or attached libraries.

Default NO

A.3.18 CONTENTAREA

Table A-22 indicates which executables can use the CONTENTAREA keyword.

Table A-22 Executables That Use CONTENTAREA

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use CONTENTAREA to specify the Oracle9iAS Portal Release 1 content area to which report output should be pushed. This keyword is maintained for backward compatibility with Oracle9iAS Portal Release 1; for backward compatibility with Oracle WebDB Release 2.2, see SITENAME. Beginning with OracleAS Portal 10g Release 1 (9.0.4), use PAGEGROUP.

Syntax CONTENTAREA=name

Values

name The name (internal name) of any valid Oracle9iAS Portal Release 1 content area.

Default None

Usage Notes

Use of this keyword is required to push Oracle Reports output to Oracle9iAS Portal Release 1.
The CONTENTAREA name should be the internal name and not the display name. The internal name is used to uniquely identify the Oracle9iAS Portal Release 1 component instance.
Relevant keywords include CONTENTAREA*, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER*, OUTPUTPAGE, PAGEGROUP, SITENAME*, STATUSFOLDER*, STATUSPAGE.

* maintained for backward compatibility with Oracle9iAS Portal Release 1 and Oracle WebDB Release 2.2.

A.3.19 COPIES

Table A-23 indicates which executables can use the COPIES keyword.

Table A-23 Executables That Use COPIES

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use COPIES to specify the number of copies of the report output to print.

Syntax COPIES=n

Values

n Any valid integer from 1 through 9999 (note that thousands are not expressed with any internal punctuation, for example, a comma or a decimal point).

Default Taken from the Initial Value property of the COPIES parameter (the Initial Value was defined in Reports Builder at design time).

Usage Notes

This keyword is ignored if DESTYPE is not PRINTER.
If COPIES is left blank on the Runtime Parameter Form, then it defaults to 1.

A.3.20 CUSTOMIZE

Table A-24 indicates which executables can use the CUSTOMIZE keyword.

Table A-24 Executables That Use CUSTOMIZE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	yes	yes	yes	no

Description Use CUSTOMIZE to specify an Oracle Reports XML file to be run against the current report. The XML file contains customizations (for example, changes to the layout or data model) that change the report definition in some way.

Syntax CUSTOMIZE=filename.xml | (filename1.xml, filename2.xml, ...)

Values

filenamen.xml The names of the files that contain a valid XML report definition, with path information prefixed to the name(s) if necessary. (if the files are not located in a path specified in the REPORTS_PATH registry or SourceDir property of the engine element).

Note:

For more information on customizing reports at runtime with XML customization files, see Chapter 16, "Customizing Reports with XML".

Default None

Usage Notes

Typically, the file extension of an XML report definition is .xml, but it does not have to be when it is used with the CUSTOMIZE keyword.
CUSTOMIZE can be used when running JSP-based Web reports from the command line.
In some cases, Microsoft Internet Explorer ignores the mimetype of a URL's return stream and instead sets the type by looking at the URL. This can be a problem when you include CUSTOMIZE as the last keyword when specified in a URL; for example:

...REPORT=emp.rdf CUSTOMIZE=c:\myreports\emp.xml

In this scenario, your URL ends with the extension .xml and Internet Explorer treats the return stream as XML, when in fact it is HTML. As a result, you will receive a browser error. To work around this issue, you should never use recognized file extensions at the end of a URL. In the preceding example, you could switch the positions of the REPORT and CUSTOMIZE parameters in your URL.

A.3.21 DATEFORMATMASK

Table A-25 indicates which executables can use the DATEFORMATMASK keyword.

Table A-25 Executables That Use DATEFORMATMASK

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use DATEFORMATMASK to specify how date values display in your delimited report output.

Syntax DATEFORMATMASK=mask

Values

mask Any valid date format mask.

Default None

Usage Notes

This keyword can only be used if you have specified DESFORMAT=DELIMITED or DESFORMAT=DELIMITEDDATA.

Note:
For valid DATEFORMATMASK values see the Oracle Reports online Help topic, "Date and Time Format Mask Syntax."
DATEFORMATMASK can be used when running JSP-based Web reports from the command line.

A.3.22 DELAUTH

Table A-26 indicates which executables can use the DELAUTH keyword.

Table A-26 Executables That Use DELAUTH

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	yes	no

Description Use DELAUTH to delete rwservlet or rwcgi user ID cookies.

Syntax http://your_webserver/reports/rwservlet/delauth[?][server=server_name][&authid=username/password]

Values See Syntax

Default None

Usage Notes

This keyword is a command that does not require a value; that is, commands are entered by themselves without a corresponding value.
Related keywords are SERVER and AUTHID.

A.3.23 DELIMITED_HDR

Table A-27 indicates which executables can use the DELIMITED_HDR keyword.

Table A-27 Executables That Use DELIMITED_HDR

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use DELIMITED_HDR to turn off boilerplate text (such as the report header) when running a report with DESFORMAT=DELIMITED or DESFORMAT=DELIMITEDDATA.

Syntax DELIMITED_HDR={YES|NO}

Values

YES Leave boilerplate text as is in the delimited output file.
NO Turn off all boilerplate text in the delimited output file.

Default YES

Usage Notes This keyword can be used only if you have specified DESFORMAT=DELIMITED or DESFORMAT=DELIMITEDDATA.

A.3.24 DELIMITER

Table A-28 indicates which executables can use the DELIMITER keyword.

Table A-28 Executables That Use DELIMITER

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use DELIMITER to specify the character or characters to use to separate the cells in your report output.

Syntax DELIMITER=value

Values

value Any alphanumeric character or string of alphanumeric characters, such as:

Table A-29 Valid Values - General

Values	Description
`,`	A comma separates each cell
`.`	A period separates each cell

Any of these reserved values:

Table A-30 Valid Values - Reserved

Values	Description
tab	A tab separates each cell
space	A space separates each cell
return	A new line separates each cell
none	No delimiter is used

Table A-31 Valid Values - Escape Sequence based on the ASCII Character set

Values	Description
`\t`	A tab separates each cell
`\n`	A new line separates each cell

Default Tab

Usage Notes This keyword can be used only if you have specified DESFORMAT=DELIMITED or DESFORMAT=DELIMITEDDATA.

A.3.25 DESFORMAT

Table A-32 indicates which executables can use the DESFORMAT keyword.

Table A-32 Executables That Use DESFORMAT

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use DESFORMAT to specify either the output format for the report, or the printer defintion to use when formatting the report when DESTYPE=FILE and DESNAME=filename.

Syntax DESFORMAT=desformat

Values Any valid destination format not to exceed 1K in length. Examples of valid values for this keyword are listed and described in Table A-33.

Table A-33 Valid Values for DESFORMAT

Value	Description
`DFLT`	The report output is sent to a file that uses the default printer driver to format the report (for example, a PostScript driver generates PostScript output format).
`DELIMITED`	The report output is sent to a file that can be read by standard spreadsheet utilities, such as Microsoft Excel. If you do not specify a delimiter (through the `DELIMITER` keyword), the default delimiter is a tab. See Usage Notes.
`DELIMITEDDATA`	Provides similar functionality as `DELIMITED`, and is used when you have problems running large volume reports with `DESFORMAT=DELIMITED`. See Usage Notes.
`HTML`	The report output is sent to a file that is in HTML format. See Usage Notes.
`HTMLCSS`	The report output is sent to a file that includes style sheet extensions. See Usage Notes.
`PDF`	The report output is sent to a file that is in PDF format and can be read by a PDF viewer, such as Adobe Acrobat. PDF output is based upon the currently configured printer for your system. The drivers for the currently selected printer are used to produce the output; you must have a printer configured for the machine on which you are running the report.
`printer definition`	The printer definition to use when formatting the report when `DESTYPE=FILE` and `DESNAME=filename`: If MODE`=BITMAP`, this is the name of the printer. A value of `DFLT` means the default printer driver is used. If MODE`=CHARACTER`, this is the name of a printer definition file (.`prt` file), such as `hpl`, `hplwide`, `dec`, `decwide`, `decland`, `dec180`, `dflt`, or `wide`. Ask your System Administrator for a list of valid printer definitions.
`RTF`	The report output is sent to a file that can be read by word processors (such as Microsoft Word). When you open the file in Microsoft Word, you must choose View > Page Layout to view all the graphics and objects in your report. See Usage Notes.
`SPREADSHEET`	(Command line only) The report output is sent to an HTML file that can be directly opened with Microsoft Excel 2000. You can generate spreadsheet output from the paper layout of reports saved in any format (`.rdf`, `.jsp`, `.xml`). See Usage Notes.
`XML`	The report output is saved as an XML file. This report can be opened and read in an XML-supporting browser, or your choice of XML viewing application.

Default Taken from the Initial Value property of the DESFORMAT system parameter (defined in Reports Builder at design time). When you run a report through Reports Builder and DESFORMAT is blank or DFLT, then the current printer driver (specified in File > Printer ) is used. If a Printer Name has not been selected, then Reports Builder defaults to PostScript output format.

Usage Notes

The value(s) for this keyword might be case-sensitive, depending on your operating system.
When DESFORMAT=HTML or DESFORMAT=HTMLCSS, spaces are replaced with  . This default behavior eliminates alignment issues for number values that are right-aligned. If you do not want spaces replaced with   in your HTML and HTMLCSS output, then you must set REPORTS_NO_HTML_SPACE_REPLACE to YES. This removes the functionality of the DELIMITER command line keyword for HTML and HTMLCSS output (DELIMITER is still valid when DESFORMAT=DELIMITED).
DESFORMAT=DELIMITED is not supported in a .dst file. In this case, Oracle Reports displays an error:

REP-34305: Invalid keyword setting for the destid='DEST1'

The DELIMITED functionality also honors the DELIMITER, CELLWRAPPER, NUMBERFORMATMASK, and DATEFORMATMASK command line keywords.
When DESFORMAT=DELIMITEDDATA, the DelimitedData driver runs off the report data model and operates in much the same way as the XML driver. Since the driver runs off the data model, any formatting defined in the layout are not reflected in the DelimitedData output.

You can set the following column properties to alter column names and exclude columns from the DelimitedData output file:
- The XML Tag property can be used to enter a column alias.
- The Exclude from XML Output property can be used to exclude the column from the DelimitedData output.
The DELIMITEDDATA functionality also honors the DELIMITER, CELLWRAPPER, NUMBERFORMATMASK, and DATEFORMATMASK command line keywords just as DELIMITED does.

For more information on delimited output, see "About delimited output" in the Oracle Reports online Help (and also in the "Advanced Concepts" chapter in the Oracle Reports Building Reports manual).
When DESFORMAT=SPREADSHEET, the report output preserves the rich layout formatting such as colors, fonts, conditional formatting, graphs, and images. For detailed information about how different report objects are generated in a report run to DESFORMAT=SPREADSHEET, see "About Spreadsheet Output" in the Oracle Reports online Help (and also in the "Advanced Concepts" chapter in the Oracle Reports Building Reports manual).
When you open RTF output generated by Oracle Reports in Microsoft Word 95 for Japanese, you may encounter anomalies in the output, such as dashes not appearing correctly. These issues are specific to Microsoft Word 95 and do not occur in Microsoft Word 97 for Japanese.

A.3.26 DESNAME

Table A-34 indicates which executables can use the DESNAME keyword.

Table A-34 Executables That Use DESNAME

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use DESNAME to specify the name of the cache, file, printer, WebDAV server, or e-mail ID (or distribution list) to which the report output will be sent.

Syntax DESNAME=desname

Values

desname Any valid cache destination, file name, printer name, e-mail ID, or WebDAV server, not to exceed 1K in length. For printer names, you can optionally specify a port. For example:

DESNAME=printer,LPT1:DESNAME=printer,FILE:

Default Taken from the Initial Value property of the DESNAME parameter (the Initial Value was defined in Reports Builder at design time). If DESTYPE=FILE and DESNAME is an empty string, then it defaults to reportname.lis at runtime.

Usage Notes

The value(s) for this keyword might be case-sensitive, depending on your operating system.
To send the report output by e-mail, specify the e-mail ID as you do in your e-mail application (any SMTP-compliant application). You can specify multiple user names by separating them with commas, and without spaces. For example:

name,name,name
In some cases, this keyword may be overridden by your operating system.

Examples

Example 1: Sending report output to a file

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf destype=file
desname=c:\mydir\test.pdf

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=file+desname=c:\mydir\test.pdf

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=file+desname=c:\mydir\test.pdf

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf
destype=file desname=c:\mydir\test.

Example 2: Sending report output to a printer

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf destype=printer
desname=myprinter

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=printer+desname=myprinter

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=printer+desname=myprinter

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf
destype=printer desname=myprinter

Example 3: Sending report output to e-mail

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf destype=mail
desname="emp1@comp.com, emp2@comp.com" cc="emp3@comp.com" bcc="mgr@comp.com"
replyto="me@comp.com" from="me@comp.com"

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=mail+
desname="emp1@comp.com, emp2@comp.com"+cc="emp3@comp.com"+bcc="mgr@comp.com"+
replyto="me@comp.com"+from="me@comp.com"

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=mail+
desname="emp1@comp.com, emp2@comp.com"+cc="emp3@comp.com"+bcc="mgr@comp.com"+
replyto="me@comp.com"+from="me@comp.com"

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf
destype=mail desname="emp1@comp.com, emp2@comp.com" cc="emp3@comp.com"
bcc="mgr@comp.com" replyto="me@comp.com" from="me@comp.com"

Example 4: Sending report output to WebDAV (any WebDAV server or OracleAS Portal WebDAV)

Note:

Currently there is no support for FTP and WebDAV destinations from the Reports Builder environment. However, they are supported from the Reports Runtime and the Reports Server environments.

rwrun report=test.rdf userid=scott/tiger@mydb desformat=htmlcss destype=webdav
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=htmlcss+destype=webdav+
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=htmlcss+destype=webdav+
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydbdesformat=htmlcss
destype=webdav
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.htm"

A.3.27 DEST

Table A-35 indicates which executables can use the DEST keyword.

Table A-35 Executables That Use DEST

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use DEST to specify the name(s) of the converted reports or libraries.

Syntax DEST={dest_name|(dest_name1, dest_name2, …)|pathname}

Values

dest_name Any valid report/library name or filename, or a list of valid report/library names of filenames enclosed in parentheses and separated by commas (for example, (qanda,text,dmast)).

Default If the DEST keyword is not specified, rwconverter uses the following default names:

If DTYPE is PLDFILE, then the DEST default name is source.pld.
If DTYPE is PLLFILE, then the DEST default name is source.pll.
If DTYPE is RDFFILE, then the DEST default name is source.rdf.
If DTYPE is REPFILE, then the DEST default name is source.rep.
If DTYPE is REXFILE, then the DEST default name is source.rex.
If DTYPE is XMLFILE, then the DEST default name is source.xml.
If DTYPE is REGISTER, then the DEST default name is the name of the SQL*Plus script output file (for example, output.sql).

Usage Notes

A list of report/library names of filenames must be enclosed in parentheses with commas separating each entry. For example:

(qanda,test,dmast) or (qanda, test, dmast)

If you have more destination names than there are source names, the extra destination names are ignored. If you have fewer destination names than there are source names, default names will be used after the destination names run out.
The value(s) for the DEST keyword may be operating system-specific.
When DTYPE=REGISTER, multiple destinations are not required. If you list more than one SQL*Plus script file name for DEST, only the first one is recognized. The others are ignored.

A.3.28 DESTINATION

Table A-36 indicates which executables can use the DESTINATION keyword.

Table A-36 Executables That Use DESTINATION

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use the DESTINATION keyword to specify the name of an XML file that defines the distribution for the current run of the report.

Note:

XML based distribution files must have the.xml extension.

Syntax DESTINATION=filename.xml

Values

filename.xml The name of an XML file that defines a report or report section distribution.

Default None

Usage Notes

To enable the DESTINATION keyword, you must specify DISTRIBUTE=YES on the command line. If both these keywords are specified, DESTYPE, DESNAME, and DESFORMAT are ignored if they are also specified.
In some cases, Microsoft Internet Explorer ignores the mimetype of a URL's return stream and instead sets the type by looking at the URL. This can be a problem when you are defining the distribution for a report because your URL might end with the DESTINATION keyword. For example:

...DISTRIBUTE=yes DESTINATION=c:\oracle\reports\dist\mydist.xml

In this scenario, your URL ends with the extension .xml and Internet Explorer treats the return stream as XML, when in fact it is HTML. As a result, you will receive a browser error. To work around this issue, you should never use recognized file extensions at the end of a URL. In the preceding example, you could switch the positions of the DISTRIBUTE and DESTINATION parameters in your URL.

Note:

For more information on creating advanced distributions, see Chapter 15, "Creating Advanced Distributions".

A.3.29 DESTYPE

Table A-37 indicates which executables can use the DESTYPE keyword.

Table A-37 Executables That Use DESTYPE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use DESTYPE to specify the type of device that will receive the report output for paper-based reports. If you have created your own pluggable destination through the Oracle Reports Destination API, this is how the destination you created gets called.

Syntax DESTYPE={CACHE|LOCALFILE|FILE|PRINTER|SYSOUT|MAIL|ORACLEPORTAL|FTP|WEBDAV|name_of_pluggable_destination}

Values Table A-38 lists and describes the valid values for the DESTYPE keyword.

Table A-38 Valid Values for DESTYPE

Value	Description
`CACHE`	Valid only for `rwclient`, `rwcgi`, and `rwservlet`. Sends the output directly to the Reports Server cache.
`LOCALFILE`	Valid only for `rwclient`, `rwcgi`, and `rwservlet`. Sends the output to a file on the client machine, synchronously or asynchronously.
`FILE`	Sends the output to the file on the server named in `DESNAME`.
`PRINTER`	Sends the output to the printer on the server named in DESNAME. You must have a printer that the OracleAS Reports Services can recognize installed and running. See Usage Notes, below.
`SYSOUT`	Valid only for `rwcgi`. Sends the output to the client machine's default output device and forces a synchronous call.
`MAIL`	Sends the output to the mail users specified in `DESNAME`. You can send mail to any mail system that works with SMTP. Note: The configuration file `server_name.conf` must include the outgoing mail server name. This applies in both Windows and UNIX environments.
`ORACLEPORTAL`	Valid for `rwservlet`, `rwcgi,` and `rwclient`. Sends the output to OracleAS Portal. Relevant keywords include CONTENTAREA, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER, OUTPUTPAGE, PAGEGROUP, SCHEDULE, SITENAME,STATUSFOLDER,STATUSPAGE. * maintained for backward compatibility with Oracle9iAS Portal Release 1 and Oracle WebDB Release 2.2. See Usage Notes, below.
`FTP`	Sends the output to the specified FTP server. See Usage Notes, below.
`WEBDAV`	Sends the output to the specified WebDAV server so that the report can be published directly. See Usage Notes, below.
`name_of_pluggable_destination`	If you have created your own pluggable destination through the Oracle Reports Destination API, this is what you use to call the destination you created.

Default Taken from the Initial Value property of the DESTYPE system parameter (defined in Reports Builder at design time).

Usage Notes

With Oracle Reports 10g Release 2 (10.1.2), DESTYPE values of SCREEN and PREVIEW are no longer valid because the Reports Runtime (rwrun) user interface is obsolete. In Reports Builder, you can still set the DESTYPE system parameter to SCREEN to format a report to display screen fonts in the Previewer in the Reports Builder user interface.
DESTYPE=PRINTER: On Windows the hardware-based left margin is ignored, by default. The printing origin starts from the top left corner (0,0) of the physical paper and not the printable area. This is to facilitate the design of printer hardware-based margin independent reports. Printing reports without hardware-based left margins on Windows You must ensure that your report's layout contains enough margin spacing such that your data falls within the printable area. Margin fields in the Page Setup dialog have been disabled to ensure consistency with OracleAS Reports Services. To revert to the old behavior of including the hardware margin, set the REPORTS_ADD_HWMARGIN environment variable to YES.

DESTYPE=ORACLEPORTAL:The ORACLEPORTAL destination cannot be used with distribution. Instead, you can use DESTYPE=WEBDAV for advanced XML based distribution to OracleAS Portal. Ensure that the OracleAS Portal instance is WebDAV-enabled. Refer to the OracleAS Portal online Help for more information on how to enable WebDAV.

For more information on how to use WebDAV for distribution to OracleAS Portal, refer to Note 241821.1 on Oracle MetaLink at http://metalink.oracle.com: How to Send and Distribute Reports 9i Output to Oracle Portal?

Note:

The DESTYPE=ORACLEPORTAL command line keyword cannot be used with the rwrun executable. Use this destination only with rwservlet, rwclient, or rwcgi.

Before you push Oracle Reports output to OracleAS Portal, ensure that you have created the following:

A valid OUTPUTPAGE containing at least one item region.
A valid PAGEGROUP containing at least one item region.

Additionally, you need to edit the Reports Server configuration file as follows:

Uncomment the destype=oraclePortal element.

<destination
   destype="oraclePortal"
   class="oracle.reports.server.DesOraclePortal">
   <!--property name="portalUserid"
             value="%PORTAL_DB_USERNAME%/%PORTAL_DB_
                     PASSWORD%@%PORTAL_DB_TNSNAME%" 
             confidential="yes"
             encrypted="no"/--> 
</destination>

Note:

In Oracle9i Reports Release 2 (9.0.2), by default, the portalUserid property is uncommented and the connection string in the property points to the infrastructure database. To be able to push your reports output to OracleAS Portal, the portalUserid must remain uncommented.

In Oracle Reports 10g, by default, the portalUserid is commented out. Reports Server will determine the connection string and push the report to OracleAS Portal. You need to uncomment this only if you are using a different OracleAS Portal instance.

Substitute the values in the portalUserid property with your OracleAS Portal connection information if you do not want to push Oracle Reports output to the default OracleAS Portal instance.

Note:
If you do not substitute the values or uncomment the destype entry, you will get the following error:
REP-56092: No class defined for destination type oracleportal

Running the request is very similar to any other out-of-the-box destinations. For example:

http://your_server:port/reports/rwservlet?

report=test.rdf&userid=scott/tiger@repportal&authid=

pushportal/trial&destype=oracleportal&desformat=PDF&pagegroup

=PORTAL_REPORTS&outputpage=reports_output&itemtitle=

pushtoportal&statuspage=result

DESTYPE=FTP: Running the request is very similar to any other out-of-the-box pluggable destinations. You need to specify the complete FTP URL location along with the file name. If the FTP server needs an authentication, that also needs to be part of the URL as shown in the following example:

http://your_server:port/reports/rwservlet?report=rep.jsp&destype=FTP&desname=ftp://user:pwd@ftpServer/dir/myreport.pdf&desformat=pdf

In this example, the DESTYPE is FTP and the DESNAME value is a complete FTP URL location along with the report name myreport.pdf.

To use a proxy server, edit the destination element (configured for FTP out-of-the-box) in the server configuration file:

<destination destype="ftp" class="oracle.reports.plugin.destination.ftp.DesFTP">  </destination>

To specify the proxy information, edit the proxyinfo.xml file available in the default location (ORACLE_HOME\reports\conf). Then, uncomment the proxy property in the server configuration file and specify the complete path to the proxyinfo.xml file as the value.

For example, if your ORACLE_HOME is located in D:\oracle, then the default location for proxyinfo.xml can be specified as:

<destination destype="ftp" class="oracle.reports.plugin.destination.ftp.DesFTP"> <property name="proxy" value="D:\\oracle\\reports\\conf\\proxyinfo.xml"/> </destination>

Note:

The proxy server specified for the FTP destination must support the SOCKS protocol. This check is performed during initialization. If the proxy server does not support the SOCKS protocol, then the server raises the following error:

REP-62352: FTP Proxy Server specified is not responding

DESTYPE=WEBDAV: Running the request is very similar to any other out-of-the-box plyuggable destinations. You need to specify the complete WebDAV URL location along with the file name. If the WebDAV server needs an authentication, that also needs to be part of the URL as shown in the following example:

http://your_server:port/reports/rwservlet?report=rep.jsp&destype=webdav&desname=http://user:pwd@webdavserver/myreport.pdf&desformat=pdf

In this example, the DESTYPE is WEBDAV and the DESNAME value is a complete WebDAV URL location along with the report name myreport.pdf.

To use a proxy server, edit the destination element (configured for WebDAV out-of-the-box) in the server configuration file:

<destination destype="webdav" class="oracle.reports.plugin.destination.webdav.DesWebDAV">  </destination>

To specify the proxy information, edit the proxyinfo.xml file available in the default location (ORACLE_HOME\reports\conf). Then, uncomment the proxy property in the server configuration file and specify the complete path to the proxyinfo.xml file as the value.

For example, if your ORACLE_HOME is located in D:\reports, then the default location for proxyinfo.xml can be specified as:

<destination destype="webdav" class="oracle.reports.plugin.destination.webdav.DesWebDAV"> <property name="proxy" value="D:\\reports\\reports\\conf\\proxyinfo.xml"/> </destination>

Examples

Example 1: Running a paper report to a browser (cache)

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=cache

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=cache

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf
destype=cache

Example 2: Sending report output to a file

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf destype=file
desname=c:\mydir\test.pdf

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=file+desname=c:\mydir\test.pdf

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=file+desname=c:\mydir\test.pdf

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf
destype=file desname=c:\mydir\test.pdf

Example 3: Sending report output to a printer

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf destype=printer
desname=myprinter

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=printer+desname=myprinter

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=printer+desname=myprinter

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf
destype=printer desname=myprinter

Example 4: Sending report output to e-mail

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf destype=mail
desname="emp1@comp.com, emp2@comp.com" cc="emp3@comp.com" bcc="mgr@comp.com"
replyto=me@comp.com" from="me@comp.com"

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=mail+
desname="emp1@comp.com,emp2@comp.com"+cc="emp3@comp.com"+bcc="mgr@comp.com"+
replyto="me@comp.com"+from="me@comp.com"

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=mail+
desname="emp1@comp.com, emp2@comp.com"+cc="emp3@comp.com"+bcc="mgr@comp.com"+
replyto="me@comp.com"+from="me@comp.com"

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf
destype=mail desname="emp1@comp.com, emp2@comp.com" cc="emp3@comp.com"
bcc="mgr@comp.com" replyto="me@comp.com" from="me@comp.com"

Example 5: Sending report output to WebDAV (any WebDAV server or OracleAS Portal WebDAV)

rwrun report=test.rdf userid=scott/tiger@mydb desformat=htmlcss destype=webdav
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=htmlcss+destype=webdav+
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=htmlcss+destype=webdav+
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb
desformat=htmlcss destype=webdav
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

Example 6: Sending report output to OracleAS Portal

rwrun report=test.rdf userid=scott/tiger@mydb destype=oracleportal desformat=PDF
pagegroup=mypagegrp outputpage=reports_output itemtitle=pushtoportal
statuspage=result

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+destype=oracleportal+desformat=PDF+pagegroup=mypagegrp+
outputpage=reports_output+itemtitle=pushtoportal+statuspage=result

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+destype=oracleportal+desformat=PDF+pagegroup=mypagegrp+
outputpage=reports_output+itemtitle=pushtoportal+statuspage=result

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb
destype=oracleportal desformat=PDF pagegroup=mypagegrp outputpage=reports_output
itemtitle=pushtoportal statuspage=result

A.3.30 DISTRIBUTE

Table A-39 indicates which executables can use the DISTRIBUTE keyword.

Table A-39 Executables That Use DISTRIBUTE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use DISTRIBUTE to enable or disable distributing the report output to multiple destinations, as specified by the distribution list defined in the report distribution definition (defined in Reports Builder at design time) or a distribution XML file.

Syntax DISTRIBUTE={YES|NO}

Values

YES Distribute the report to the distribution list.
NO Ignore the distribution list and output the report as specified by the DESNAME, DESTYPE, and DESFORMAT parameters. This is fundamentally a debug mode to allow running a report set up for distribution without actually executing the distribution.

Default NO

Usage Notes The DISTRIBUTE keyword works in close association with the DESTINATION keyword. DISTRIBUTE must have a value of YES for the DESTINATION keyword to take effect. If both these keywords are specified, DESTYPE, DESNAME, and DESFORMAT are ignored if they are also specified.

Note:

For more information on creating advanced distributions, see Chapter 15, "Creating Advanced Distributions".

A.3.31 DTYPE

Table A-40 indicates which executables can use the DTYPE keyword.

Table A-40 Executables That Use DTYPE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use DTYPE to specify the format to which to convert the reports or libraries.

Syntax DTYPE={PLDFILE|PLLFILE|RDFFILE|REPFILE|REXFILE|TDFFILE|XMLFILE|JSPFILE|REGISTER}

Values The following values apply:

PLDFILE The converted PL/SQL libraries will be stored in files in ASCII format.
PLLFILE The converted PL/SQL libraries will be stored in files containing source code and P-code (compiled PL/SQL).
RDFFILE The converted report(s) will be stored in one or more report definition files (files with the .rdf extension).
REPFILE The converted report(s) will be stored in one or more binary runfiles (files with the .rep extension).
REXFILE The converted report(s) will be stored in one or more text files (files with the .rex extension).
TDFFILE The report will be converted to a template file (files with the .tdf extension).
XMLFILE The converted report(s) will be stored in an XML file (files with the .xml extension).
JSPFILE The converted report(s) will be stored in a JSP file (files with the .jsp extension).
REGISTER A script file is created to load each report specified by SOURCE into OracleAS Portal with the RWWWVREG.REGISTER_REPORT function. Each load function is populated with the necessary information to register the report in OracleAS Portal. By running the resulting script file in SQL*Plus against the Oracle Application Server DB Provider, you can batch register multiple reports in OracleAS Portal. For more information, see Appendix C, "Batch Registering Reports in OracleAS Portal".

Default REPFILE

Usage Notes

When you try to create a .rep file using rwconverter, the source report's PL/SQL is automatically compiled. If there are compile errors, an error message is displayed and the .rep file is not created. To avoid this problem, ensure that you compile the source report's PL/SQL using Program > Compile in Reports Builder, before you try to create a .rep file.
When converting a report to a template, only objects in the report's header and trailer sections and the margin area are used in the template. Objects in the main section are ignored.

A.3.32 DUNIT

Table A-41 indicates which executables can use the DUNIT keyword.

Table A-41 Executables That Use DUNIT

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use DUNIT to specify the destination unit of measurement to which the report should be converted. If specified, DUNIT must differ from the SOURCE report's unit of measurement. If unspecified, the SOURCE report's unit of measurement is used.

Syntax DUNIT={CENTIMETER|CHARACTER|INCH|POINT}

Values

CENTIMETER The converted reports will initially use centimeters as the unit of measurement
CHARACTER The converted reports will initially use characters as the unit of measurement.
INCH The converted reports will initially use inches as the unit of measurement.
POINT The converted reports will initially use points as the unit of measurement

Default Null (the report's unit of measurement is used).

A.3.33 ENGINERESPONSETIMEOUT

Table A-42 indicates which command can use the ENGINERESPONSETIMEOUT keyword.

Table A-42 Executables That Use ENGINERESPONSETIMEOUT

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	no	no	yes	yes	no

Description Use ENGINERESPONSETIMEOUT to specify the maximum amount of time (in minutes) for an engine to update the status of the job while running a report in your environment. If it takes longer than this amount of time to update the job status for some reason (for example, due to the engine hanging or a long blocking SQL query), then Reports Server terminates the job.

This parameter overrides the engineResponseTimeOut attribute of the engine element in the Reports Server configuration file. Refer to Section 3.2.1.4, "engine" for information about the engine element.

Syntax ENGINERESPONSETIMEOUT=number

Values

number A number of minutes (for example, 5).

Default None

A.3.34 ENVID

Table A-42 indicates which command can use the ENVID keyword.

Table A-43 Executables That Use ENVID

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	no	no	yes	yes	no

Description Use ENVID to specify the environment required for the current job request. This keyword allows for dynamic enviroment switching, as described in Section 3.2.2, "Dynamic Environment Switching".

Syntax ENVID=id

Values

id An identifier that corresponds to an environment element id in the configuration file. The matching environment element defines environment variables that will be used for the current job request. For examples, see Section 3.2.2, "Dynamic Environment Switching".

Default None

A.3.35 EXPIRATION

Table A-44 indicates which command can use the EXPIRATION keyword.

Table A-44 Executables That Use EXPIRATION

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	no	no	yes	yes	no

Description Use EXPIRATION to define how long report output can exist in cache before it is deleted.

See Section 13.11, "Reusing Report Output from Cache" for more information on duplicate job detection. See Section 20.2, "Tuning Reports Server Configuration" and Section 20.8, "Running the Report" for tuning considerations in relation to maxQueueSize and cacheSize values.

Syntax EXPIRATION=time_string

Values

time_string Is in one of two formats:

n{unit}, for a number with an optional unit. The unit can be minute(s), hour(s), or day(s). The default unit is minute(s) if no unit is specified.
{Mon DD, YYYY} hh:mi:ss am|pm {timezone}, for a date/time format. Date information is optional. If it isn't specified, today is assumed. Time zone is also optional. If it isn't specified, the Reports Server's time zone is used. The date/time is always in a US locale. This format is the same as defined in the Java DateFormat.MEDIUM type.

Default None

A.3.36 EXPIREDAYS

Table A-45 indicates which executables can use the EXPIREDAYS keyword.

Table A-45 Executables That Use EXPIREDAYS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	yes	no

Description Use EXPIREDAYS to specify the number of days after which the Oracle Reports output pushed to OracleAS Portal should be expired.

Syntax EXPIREDAYS={PERMANENT|1 day|2 days|3 days|7 days|14 days|31 days|60 days|90 days|120 days}

Values

PERMANENT Does not expire.
n days Expires after n days.

Default None

Usage Notes

Use of this keyword is optional to push Oracle Reports output to OracleAS Portal.
Relevant keywords include CONTENTAREA*, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER*, OUTPUTPAGE, PAGEGROUP, SITENAME*, STATUSFOLDER*, STATUSPAGE.

* maintained for backward compatibility with Oracle9iAS Portal Release 1 and Oracle WebDB Release 2.2.

A.3.37 EXPRESS_SERVER

Table A-46 indicates which executables can use the EXPRESS_SERVER keyword.

Table A-46 Executables That Use EXPRESS_SERVER

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use EXPRESS_SERVER to specify the Express Server to which you want to connect.

Syntax EXPRESS_SERVER="server=server/domain=domain/user=userid/password=passwd"

Syntax with RAM EXPRESS_

SERVER="server=server/domain=domain/user=userid/password=passwd

/ramuser=ramuserid/rampassword=rampasswd/ramexpressid=ramexpid/

ramserverscript=ramsscript/rammasterdb=ramdb/ramconnecttype=

reamconn"

Values A valid connect string enclosed in double quotes (") where:

Table A-47 Connect String Values

Values	Description
`server`	The Express Server string (for example, `ncacn_ip_tcp:olap2-pc/sl=x/st=x/ct=x/sv=x/`). See below for more details on the server string.
`domain`	The Express Server domain.
`userid`	The user ID to log on to the Express Server.
`passwd`	The password for the user ID.
`ramuserid`	The user ID to log in to the RDBMS.
`rampasswd`	The password for the RDBMS.
`ramexpid`	The Oracle Sales Analyzer database user ID. This is required for Oracle Sales Analyzer databases only.
`ramsscript`	The complete file name (including the full path) of the remote database configuration file (RDC) on the server. This file specifies information such as the location of code and data databases. Using UNC (Universal Naming Convention) syntax allows multiple users to use the same connection to access the data without having to map the same drive letter to that location. UNC syntax is `\\ServerName\ShareName\` followed by any subfolders or files.
`ramdb`	The name of the Relational Access Manager database to attach initially. You must specify only the database file name. This database must reside in a directory that is included in the path list in ServerDBPath for Express Server. You can check the ServerDBPath in the File I/O tab of the Express Configuration Manager dialog box.
`ramconn`	The type of Express connection. Always specify 0 for a direct connection.

Parameters The server value contains four parameters that correspond to settings that are made in the Oracle Express Connection Editor and stored in connection (XCF) files. All four parameters are required and can be specified in any order. Table A-48 describes the parameters and their settings:

Table A-48 Settings for Parameters Used With EXPRESS_SERVER's server Value

Parameter	Description	Setting
`sl`	Server Login	-2: Host (Domain Login) -1: Host (Server Login) 0: No authentication required 1: Host (Domain Login) and Connect security 2: Host (Domain Login) and Call security 3: Host (Domain Login) and Packet security 4: Host (Domain Login) and Integrity security 5: Host (Domain Login) and Privacy security Note: Windows uses all the settings. UNIX systems use only the settings 0, -1, and -2. See the Express Connection Editor Help system for information on these settings.
`st`	Server Type	:1: Express Server
`ct`	Connection Type	0: Express connection
`sv`	Server Version	1: Express 6.2 or greater

Default None

Usage Notes

You can have spaces in the string if necessary (for example, if the user ID is John Smith) because the entire string is enclosed in quotes.
If a forward slash (/) is required in the string, then you must use another forward slash as an escape character. For example, if the domain were tools or reports, then the command line should be as follows:

EXPRESS_SERVER="server=ncacn_ip_tcp:olap2-pc/sl=0/st=1/ct=0/sv=1/domain=tools//reports"
You can use single quotes within the string. They are not treated specially because the entire string is enclosed in double quotes.

A.3.38 FORMSIZE

Table A-49 indicates which executables can use the FORMSIZE keyword.

Table A-49 Executables That Use FORMSIZE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use FORMSIZE to specify the size of the Runtime Parameter Form for the converted report in terms of the destination unit of measurement (specified using DUNIT).

Syntax FORMSIZE=width x height

Values

width/height Any valid values in the specified unit of measurement.

Default None

Usage Notes

For non-character DUNITs, you can use a decimal to specify fractions (for example, 8.5 x 11).
For more information on the Runtime Parameter Form, see the PARAMFORM keyword.

A.3.39 FROM

Table A-50 indicates which executables can use the FROM keyword.

Table A-50 Executables That Use FROM

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use FROM to specify the e-mail address of the sender of an e-mail.

Syntax FROM=emailid

Values

emailid Any valid e-mail address in the form someone@foo.com.

Default loginid@machine_name

Usage Notes Related keywords include BCC,CC, FROM, REPLYTO SUBJECT, and . Note that DESNAME is used to specify the main recipient(s) of the e-mail.

A.3.40 GETJOBID

Table A-51 indicates which executables can use the GETJOBID keyword.

Table A-51 Executables That Use GETJOBID

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	yes	no

Description Use GETJOBID to retrieve the result output of the Reports Server job with job ID n.

Syntax http://your_webserver/reports/rwservlet/getjobid n[?][server=server_name][&authid=username/password]

Values See Syntax

Default None

Usage Notes

This keyword is a command that does not require a value; that is, commands are entered by themselves without a corresponding value.
Job must be successfully finished and present in the Reports Server cache. Use SHOWJOBS to see the current list of jobs.
Related keywords are SERVER and AUTHID.

A.3.41 GETSERVERINFO

Table A-52 indicates which executables can use the GETSERVERINFO keyword.

Table A-52 Executables That Use GETSERVERINFO

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	no	no

Description Use GETSERVERINFO to display Reports Server information. You can choose the format (HTML or XML) in which the information is returned through statusformat.

Syntax http://your_webserver/reports/rwservlet/getserverinfo[?][server=server_name][&authid=username/password][&statusformat={html|xml}]

Values See Syntax

Default None

Usage Notes

This keyword is a command that does not require a value; that is, commands are entered by themselves without a corresponding value.
Related keywords are SERVER and AUTHID.

A.3.42 HELP

Table A-53 indicates which executables can use the HELP keyword.

Table A-53 Executables That Use HELP

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	yes	no

Description Use HELP to display a help topic that lists the keywords you can use with the rwservlet command. For example:

http://your_webserver/reports/rwservlet/help?command=keyword

Syntax http://yourwebserver/reports/rwservlet/help

http://your_webserver/reports/rwservlet/help?command=keyword

Values See Syntax

Default None

A.3.43 ITEMTITLE

Table A-54 indicates which executables can use the ITEMTITLE keyword.

Table A-54 Executables That Use ITEMTITLE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use ITEMTITLE to specify the display name OracleAS Portal should use for Oracle Reports output. The name will display in OracleAS Portal and link to Oracle Reports output.

Syntax ITEMTITLE=title

Values

title Any text. Put quotation marks around the value if the value has any character spaces in it or you are specifying the option in the cgicmd.dat file.

Default The report file name

Usage Notes

Use of this keyword is optional to push Oracle Reports output to OracleAS Portal.
Relevant keywords include CONTENTAREA*, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER*, OUTPUTPAGE, PAGEGROUP, SITENAME*, STATUSFOLDER*, STATUSPAGE.

* maintained for backward compatibility with Oracle9iAS Portal Release 1 and Oracle WebDB Release 2.2.

A.3.44 JOBNAME

Table A-55 indicates which executables can use the JOBNAME keyword.

Table A-55 Executables That Use JOBNAME

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	no	no	yes	yes	no

Description Use JOBNAME to specify the name for a job to appear in Reports Queue Manager. It is treated as a comment and has nothing to do with running the job. If JOBNAME is not specified, then Reports Queue Manager shows the report name as the job name.

Syntax JOBNAME=string

Values

string Any job name.

Default None

Usage Notes JOBNAME can be used when running JSP-based Web reports from the command line.

A.3.45 JOBTYPE

Table A-56 indicates which executables can use the JOBTYPE keyword.

Table A-56 Executables That Use JOBTYPE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	no	no	yes	yes	no

Description Use JOBTYPE to specify the type of job to be processed by the server. You can enter any type of job, as long as Reports Server has an engine to process it.

Syntax JOBTYPE=jobtype

Values

jobtype A job for which Reports Server has an engine. For example: report (for rwEng engine) or rwurl (for rwURLEng engine).

Default report

Usage Notes The database authentication functionality provided in Oracle Reports is available only when JOBTYPE=report. This is the job type of the default engine (rwEng) provided with OracleAS Reports Services. The database authentication functionality is not available when JOBTYPE specifies a different value (for example, for a custom engine that you develop yourself). This is because a custom engine may require a different format for the connect string, while the Oracle Reports database authentication functionality limits the connect string to the Oracle Reports format user/password@dbname used for the default engine.

A.3.46 JVMOPTIONS

Table A-57 indicates which executables can use the JVMOPTIONS keyword.

Table A-57 Executables That Use JVMOPTIONS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	yes	yes	yes	no	no	yes

Description Use JVMOPTIONS to set options for the Java Virtual Machine (JVM).

Syntax

JVMOPTIONS={options in the Reports Runtime, Reports Builder, Reports Converter, or Reports Server's JVM}

For example, you could use the following command line to start the Reports Server (rwserver) with a 512MB heap space:

rwserver server=servername jvmoptions=-Xmx512M

You could also use the following command line to start Reports Builder (rwbuilder) with a 512MB heap space:

rwbuilder jvmoptions=-Xmx512M

If multiple options are passed, they must be enclosed in quotes:

rwserver server=servername jvmoptions="-Xmx256M -Xms=128M"

Usage Notes

The default value -Xmx256M specifies the JVM heap size of 256 MB to avoid the Out Of Memory error when running reports with large graphs or running big reports.
When the Reports Engine starts up, it checks for JVM options specified in the server_name.conf file in the jvmoptions attribute of the engine element. For more information, see Section 3.2.1.4, "engine". If specified, the JVM options set in server_name.conf override the value of the REPORTS_JVM_OPTIONS environment variable. If not specified in server_name.conf, Oracle Reports uses the JVM options specified by the REPORTS_JVM_OPTIONS environment variable. For more information, see Section B.1.47, "REPORTS_JVM_OPTIONS".
When running reports with Reports Server, JVM options cannot be set using the REPORTS_JVM_OPTIONS environment variable. For Reports Server, set JVM options on the command line using the JVMOPTIONS command line keyword.
When running reports with Reports Builder, Reports Runtime, and Reports Converter, JVM options specified on the command line with the JVMOPTIONS command line keyword override JVM options specified by the REPORTS_JVM_OPTIONS environment variable.

A.3.47 KILLENGINE

Table A-58 indicates which executables can use the KILLENGINE keyword.

Table A-58 Executables That Use KILLENGINE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	no	no

Description Use KILLENGINE to stop a Reports Server engine with the specified engine ID and engine type. For a secured Reports Server, only users with Adminstrator privileges can use this keyword. For an unsecured Reports Server, the user ID and password values for the AUTHID keyword must match the user ID and password specified by the identifier tag in the server.conf configuration file.

Syntax http://your_webserver/reports/rwservlet/killengine[?][server=server_name][&authid=username/password][&type=engine_type]

For example, to kill an engine rwEng-0

http://yourwebserver/reports/rwservlet/killengine0?server=myserver&authid=mydb/password&type=rwEng

Values See Syntax

Default None

Usage Notes

The engine must currently exist in the Reports Server.
Use GETSERVERINFO to see the current engines existing in the server.
Related keywords are GETSERVERINFO, SERVER, and AUTHID.

A.3.48 KILLJOBID

Table A-59 indicates which executables can use the KILLJOBID keyword.

Table A-59 Executables That Use KILLJOBID

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	yes	no

Description Use KILLJOBID to kill a Reports Server job with the specified job ID n.

Syntax http://your_webserver/reports/rwservlet/killjobidn[?][server=server_name][&authid=username/password][&statusformat={html|xml|xmldtd}]

Values See Syntax

Default None

Usage Notes

The job must be current (enqueued or scheduled).
Use SHOWJOBS to see the current list of jobs. The STATUSFORMAT can be set to html (default), xml , or xmldtd to return status in that format. The status information is generated in HTML, XML, or XMLDTD (with an internal DTD subset).
Related keywords are SHOWJOBS, SERVER, AUTHID, and STATUSFORMAT.
The STATUSFORMAT parameter is only valid for rwservlet, not for rwcgi.

A.3.49 LONGCHUNK

Table A-60 indicates which executables can use the LONGCHUNK keyword.

Table A-60 Executables That Use LONGCHUNK

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description LONGCHUNK is the size (in kilobytes) of the increments in which Reports Builder retrieves a LONG column value. When retrieving a LONG value, you might want to retrieve it in increments rather than all at once because of memory size restrictions. LONGCHUNK applies only to Oracle databases.

Syntax LONGCHUNK=n

Values

Default 10

Usage Notes LONGCHUNK can be used when running JSP-based Web reports from the command line.

A.3.50 MIMETYPE

Table A-61 indicates which executables can use the MIMETYPE keyword.

Table A-61 Executables That Use MIMETYPE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	yes	no

Description Use MIMETYPE to override the MIME type assigned by the Reports Server when it returns output for the Web. In most cases, the default MIME type is correct, but, in cases where it is not, you can override it with this keyword. For example:

mimetype=application/vnd.ms-excel

Syntax MIMETYPE=string

Values

string A valid MIME type specification.

Default None

Usage Notes OracleAS Reports Services does not verify the string you enter for MIMETYPE. You must ensure yourself that the string is correct for the returned report output.

A.3.51 MODE

Table A-62 indicates which executables can use the MODE keyword.

Table A-62 Executables That Use MODE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use MODE to specify whether to run the report in character mode or bitmap. This enables you to run a character-mode report from Reports Builder.

Syntax MODE={BITMAP|CHARACTER|DEFAULT}

Values

BITMAP Run the report in bitmap mode.
DEFAULT Run the report in the mode of the current executable being used.
CHARACTER On Windows - the Reports Builder ASCII driver will be used to produce editable ASCII output.

Default DEFAULT

A.3.52 MODULE|REPORT

Table A-63 indicates which executables can use the MODULE|REPORT keyword.

Table A-63 Executables That Use MODULE|REPORT

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use MODULE or REPORT to specify the name of the report to run.

Syntax REPORT|MODULE=runfile

Values

runfile Any valid runfile (that is, a file with an extension of .rep,.rdf,.jsp, or .xml).

Default None

Usage Notes

If you specify a character-mode report, Reports Builder displays a warning, then opens the report using a page size of 8.5" x 11" and a form size of 7" x 6".
To run the report (for example, display it in the Paper Design View), it must be a complete report definition (that is, contain its own data model and layout definition). You cannot run a partial report definition.
An XML report definition must have an .xml file extension when specified with the MODULE|REPORT keyword.
If you do not enter a file extension, the executable searches first for a file with extension .rep, then extension .rdf, then .jsp, and then no extension, using the file path search order to find the file.

A.3.53 NAME

The NAME keyword is used only by the rwbridge executable.

Description Use NAME to specify the name of the Oracle Reports bridge. The Oracle Reports bridge executable (rwbridge) searches for the bridge configuration file, repbrg_bridgename.conf, in ORACLE_HOME/reports/conf. If not found, a new configuration file is created in ORACLE_HOME/reports/conf.

Syntax NAME=bridgename

Values

bridgename Any alphanumeric string.

Default None

A.3.54 NONBLOCKSQL

Table A-64 indicates which executables can use the NONBLOCKSQL keyword.

Table A-64 Executables That Use NONBLOCKSQL

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use NONBLOCKSQL to specify whether to allow other programs to execute while data is fetched from the database.

Syntax NONBLOCKSQL={YES|NO}

Values

YES Other programs can execute while data is being fetched.
NO Other programs cannot execute while data is being fetched.

Default YES

Usage Notes NONBLOCKSQL can be used when running JSP-based Web reports from the command line.

A.3.55 NOTIFYFAILURE

Table A-65 indicates which executables can use the NOTIFYFAILURE keyword.

Table A-65 Executables That Use NOTIFYFAILURE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use NOTIFYFAILURE to specify the recipient(s) of a notification e-mail should a report request fail. Use this keyword when you configure your Reports Server to use the notification class. For more information, see the notification discussion in Configuring OracleAS Reports Services.

Syntax NOTIFYFAILURE=emailid|(emailid,emailid,...)

Values

emailid A valid e-mail address in the form someone@foo.com.

Default None

Usage Notes

The default notification e-mail templates that are used for the body of the notification e-mail are included with your installation of Oracle Application Server. The NOTIFYFAILURE template is named failnote.txt, and is located at ORACLE_HOME\reports\template.
NOTIFYFAILURE can be used when running JSP-based Web reports from the command line.

A.3.56 NOTIFYSUCCESS

Table A-66 indicates which executables can use the NOTIFYSUCCESS keyword.

Table A-66 Executables That Use NOTIFYSUCCESS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use NOTIFYSUCCESS to specify the recipient(s) of a notification e-mail should a report request succeed. Use this keyword when you configure your Reports Server to use the notification class. For more information, see the notification discussion in Configuring OracleAS Reports Services.

Syntax NOTIFYSUCCESS=emailid|(emailid,emailid,...)

Values

emailid A valid e-mail address in the form someone@foo.com.

Default None

Usage Notes

The default notification e-mail templates that are used for the body of the notification e-mail are included with your installation of Oracle Application Server. The NOTIFYSUCCESS template is named succnote.txt, and is located at ORACLE_HOME\reports\template.
NOTIFYSUCCESS can be used when running JSP-based Web reports from the command line.

A.3.57 NUMBERFORMATMASK

Table A-67 indicates which executables can use the NUMBERFORMATMASK keyword.

Table A-67 Executables That Use NUMBERFORMATMASK

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use NUMBERFORMATMASK to specify how number values display in your delimited report output.

Syntax NUMBERFORMATMASK=mask

Values Any valid number format mask.

Default None

Usage Notes

This keyword can only be used if you have specified DESFORMAT=DELIMITED or DESFORMAT=DELIMITEDDATA.

Note:
For valid NUMBERFORMATMASK values see the Oracle Reports online Help topic, "Number Format Mask Syntax."
NUMBERFORMATMASK can be used when running JSP-based Web reports from the command line.

A.3.58 OLAP_CON

Table A-68 indicates which executables can use the OLAP_CON keyword.

Table A-68 Executables That Use OLAP_CON

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use OLAP_CON to specify the Oracle OLAP (on-line analytical processing) connection string to connect to a database that contains multidimensional Oracle OLAP data.

Syntax OLAP_CON=userid/password/hostname/SID/portnumber

Values A valid OLAP connection string where:

userid The user ID for connecting to Oracle OLAP.
password The password for the user ID.
hostname The host name for the database.
SID The system identifier (SID) for connecting to the database.
portnumber The port number for connecting to the database.

For example:

OLAP_Con="user1/secret1/mypc.us.oracle.com/mySID/9201

A.3.59 ONFAILURE

Table A-69 indicates which executables can use the ONFAILURE keyword.

Table A-69 Executables That Use ONFAILURE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use ONFAILURE to specify whether you want a COMMIT or ROLLBACK performed if an error occurs and the report fails to complete.

Syntax ONFAILURE={COMMIT|ROLLBACK|NOACTION}

Values

COMMIT Perform a COMMIT if the report fails.
ROLLBACK Perform a ROLLBACK if the report fails.
NOACTION Do nothing if the report fails.

Default

ROLLBACK, if a USERID is provided.
NOACTION, if called from an external source (for example, OracleAS Forms Services) with no USERID provided.

Usage Notes

The COMMIT or ROLLBACK for ONFAILURE is performed after the report fails. Other COMMITs and ROLLBACKs can occur prior to this one. For more information, see the READONLY command.
ONFAILURE can be used when running JSP-based Web reports from the command line.

A.3.60 ONSUCCESS

Table A-70 indicates which executables can use the ONSUCCESS keyword.

Table A-70 Executables That Use ONSUCCESS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use ONSUCCESS to specify that either a COMMIT or ROLLBACK should be performed when a report is finished running.

Syntax ONSUCCESS={COMMIT|ROLLBACK|NOACTION}

Values

COMMIT Perform a COMMIT when a report is done.
ROLLBACK Perform a ROLLBACK when a report is done.
NOACTION Do nothing when a report is done.

Default

COMMIT, if a USERID is provided.
NOACTION, if called from an external source (for example, OracleAS Forms Services) with no USERID provided.

Usage Notes

The COMMIT or ROLLBACK for ONSUCCESS is performed after the after-report trigger fires. Other COMMITs and ROLLBACKs can occur prior to this one. For more information, see the READONLY command.
ONSUCCESS can be used when running JSP-based Web reports from the command line.

A.3.61 ORIENTATION

Table A-71 indicates which executables can use the ORIENTATION keyword.

Table A-71 Executables That Use ORIENTATION

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description ORIENTATION specifies the direction in which the pages of the report will print.

Syntax ORIENTATION={DEFAULT|LANDSCAPE|PORTRAIT}

Values

DEFAULT Use the current printer setting for orientation.
LANDSCAPE Landscape orientation (long side at top and bottom).
PORTRAIT Portrait orientation (short side at top and bottom).

Default DEFAULT

Usage Notes

The ORIENTATION command line keyword is effective only when DESTYPE=PRINTER. For PDF and RTF report output, change the report orientation by setting the Width property, Height property, and Orientation property for the Main, Header, and Trailer sections under the Paper Layout node in the Object Navigator:
- For landscape orientation, Width will be greater than Height (for example, 11 x 8.5).
- For portrait orientation, Height will be greater than Width (for example, 8.5 x 11).
If ORIENTATION=LANDSCAPE for a character-mode report, then you must ensure that your printer definition file contains a landscape clause.
This keyword is not supported when output to a PCL printer on UNIX.

A.3.62 OUTPUTFOLDER

Table A-72 indicates which executables can use the OUTPUTFOLDER keyword.

Table A-72 Executables That Use OUTPUTFOLDER

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use OUTPUTFOLDER to specify the name of the Oracle WebDB Release 2.2 or Oracle9iAS Portal Release 1 folder to which to report output should be pushed. This keyword is maintained for backward compatibility with Oracle WebDB Release 2.2 and Oracle9iAS Portal Release 1. Beginning with OracleAS Portal 10g Release 1 (9.0.4), use OUTPUTPAGE.

Syntax OUTPUTFOLDER=folder

Values

folder Any valid folder name (internal name) used in Oracle WebDB Release 2.2 or Oracle9iAS Portal Release 1.

Default Oracle_Reports_Output

Usage Notes

The value for this keyword is case sensitive.
Use of this keyword is optional to push Oracle Reports output to Oracle WebDB Release 2.2 or Oracle9iAS Portal Release 1.
Relevant keywords include CONTENTAREA*, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER*, OUTPUTPAGE, PAGEGROUP, SITENAME*, STATUSFOLDER*, STATUSPAGE.

* maintained for backward compatibility with Oracle9iAS Portal Release 1 and Oracle WebDB Release 2.2.

A.3.63 OUTPUTIMAGEFORMAT

Table A-73 indicates which executables can use the OUTPUTIMAGEFORMAT keyword.

Table A-73 Executables That Use OUTPUTIMAGEFORMAT

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use OUTPUTIMAGEFORMAT to specify the format for images in report output.

Syntax OUTPUTIMAGEFORMAT={PNG|JPEG|JPG|GIF|BMP}

Values

PNG,JPEG (default),JPG

Supported image formats when DESFORMAT value is PDF, HTML, HTMLCSS, RTF, or SPREADSHEET.
GIF

Supported image format when DESFORMAT value is PDF, HTML, HTMLCSS, or SPREADSHEET.
BMP

Supported image formats when DESFORMAT value is RTF.

Usage Notes

This command line keyword overrides the setting of the REPORTS_OUTPUTIMAGEFORMAT environment variable.
This command line keyword is not supported if the REPORTS_DEFAULT_DISPLAY environment variable is explicitly set to NO (default is YES). In this case, image rendering defaults to GIF for HTML, HTMLCSS, and PDF output, and BMP for RTF output.
You must ensure the format that you specify matches the output type. For example, BMP only works for RTF output. It will not work for HTML, HTMLCSS or PDF output.
A report containing images and run to DESFORMAT=SPREADSHEET using a secured Reports Server is not supported. This is due to Microsoft Excel's limitation on cookie support. Alternatively, you can write the Excel output from a secure Reports Server to a URL using WebDAV.

Examples

Example 1

The following command lines generate PNG images with HTML output:

rwclient server=my_rep_server report=images.rdf destype=file desformat=html desname=images.html userid=user_id outputimageformat=PNG

rwrun report=images.rdf destype=file desformat=html desname=images.html userid=user_id outputimageformat=PNG

Similarly when DESFORMAT=pdf, images are embedded in PNG format in the generated PDF document.

Example 2

An error is displayed if an invalid value is specified for the OUTPUTIMAGEFORMAT. The following command lines generate an error message:

rwclient server=my_rep_server report=images.rdf destype=file desformat=html desname=images.html userid=user_id outputimageformat=ABCD

rwrun report=images.rdf destype=file desformat=html desname=images.html userid=user_id outputimageformat=ABCD

The invalid image format ABCD generates the following error message:

REP-35000: The image output format specified is not supported.

A.3.64 OUTPUTPAGE

Table A-74 indicates which executables can use the OUTPUTPAGE keyword.

Table A-74 Executables That Use OUTPUTPAGE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use OUTPUTPAGE to specify the name of the OracleAS Portal page to which report output should be pushed. For backward compatibility with earlier versions (Oracle WebDB Release 2.2 and Oracle9iAS Portal Release 1), see OUTPUTFOLDER.

Syntax OUTPUTPAGE=page

Values

page Any valid page name (internal name) used in OracleAS Portal.

Default Oracle_Reports_Output

Usage Notes

Use of this keyword is optional to push Oracle Reports output to OracleAS Portal:
- If you do not specify an output page, OracleAS Portal will create a default page named Oracle_Reports_Output.
- If you specify an output page, use the internal name and not the display name. The internal name is used to uniquely identify the OracleAS Portal component instance.
The value for this keyword is case-sensitive.
The page should contain at least one item region when used with DESTYPE=ORACLEPORTAL.
Relevant keywords include CONTENTAREA*, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER*, OUTPUTPAGE, PAGEGROUP, SITENAME*, STATUSFOLDER*, STATUSPAGE.

* maintained for backward compatibility with Oracle9iAS Portal Release 1 and Oracle WebDB Release 2.2.

A.3.65 OVERWRITE

Table A-75 indicates which executables can use the OVERWRITE keyword.

Table A-75 Executables That Use OVERWRITE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use OVERWRITE to specify whether to overwrite existing files with the converted files.

Syntax OVERWRITE={YES|NO|PROMPT}

Values

YES Automatically overwrite any existing files of the same name.
NO Do not to convert reports if there are existing files of the same name and display a warning message
PROMPT Prompt you before overwriting any existing files.

Default NO

A.3.66 P_AVAILABILITY

Table A-76 indicates which executables can use the P_AVAILABILITY keyword.

Table A-76 Executables That Use P_AVAILABILITY

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use P_AVAILABILITY to specify the name of the availability calendar that determines when the reports specified will be available for processing. This keyword is only used when DTYPE=REGISTER.

Syntax P_AVAILABILITY=calendar_name

Values

calendar_name Any valid availability calendar name.

Default None

Usage Notes The availability calendar must exist in OracleAS Portal before running the SQL*PLUS script. If it does not, an invalid package may be created.

A.3.67 P_DESCRIPTION

Table A-77 indicates which executables can use the P_DESCRIPTION keyword.

Table A-77 Executables That Use P_DESCRIPTION

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use P_DESCRIPTION to specify the text that provides additional information about the report. This keyword is only used when DTYPE=REGISTER.

Syntax P_DESCRIPTON=description_text

Values

description_text Any text string.

Default None

A.3.68 P_FORMATS

Table A-78 indicates which executables can use the P_FORMATS keyword.

Table A-78 Executables That Use P_FORMATS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use P_FORMATS to specify the allowable destination formats for the specified reports. This keyword is only used when DTYPE=REGISTER.

Syntax P_FORMATS=destination_format|(destination_format1,destination_format2,...)

Values

destination_format Any valid destination format (for example, HTML) or a list of valid destination formats enclosed by parentheses with a comma separating the names (for example: HTMLCSS, PDF, RTF).

Usage Notes If the destination format for the report is DELIMITEDDATA, it may not be possible to batch register the report in OracleAS Portal. As a workaround, you can define a different destination format, then batch register the report, and later manually edit the report to DESFORMAT=DELIMITEDDATA. For more information about batch registering reports, see Appendix C, "Batch Registering Reports in OracleAS Portal"

Default None

A.3.69 P_JDBCPDS

Table A-79 indicates which executables can use the P_JDBCPDS keyword.

Table A-79 Executables That Use P_JDBCPDS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use P_JDBCPDS to specify the JDBC pluggable data source (PDS) connection string to connect to a database for running a report containing a JDBC query.

Syntax P_JDBCPDS=userid/password@database

Values A valid JDBC PDS connection string where:

userid The user ID for connecting to the JDBC pluggable data source.
password The password for the user ID.
database The database connection information, specific to the particular data source, as detailed in Section 9.2.1, "Sample Connection Information".

For example, to connect to a Sybase data source:

P_JDBCPDS=sybuser/sybpwd@server1.mydomain.com:1300

Usage Notes P_JDBCPDS is the default sign-on name for connecting to a JDBC PDS. You can change this name in Reports Builder when defining the JDBC query in the Report Wizard. The new sign-on name can be used on the command line as the value for the P_JDBCPDS command line keyword. For more information on defining your JDBC query in Reports Builder, see Section 9.2, "Defining and Running a JDBC Query".

A.3.70 P_NAME

Table A-80 indicates which executables can use the P_NAME keyword.

Table A-80 Executables That Use P_NAME

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use P_NAME to specify the report name displayed in OracleAS Portal. This keyword is only used when DTYPE=REGISTER.

Syntax P_NAME=report_name

Values

report_name Any report name.

Default If P_NAME is not specified, the PL/SQL function is populated with the report definition file name.

Usage Notes

If P_NAME is not specified, the PL/SQL function is populated with the report definition file name.
Specify P_NAME only when you want to use the same report name for each report definition file being registered in OracleAS Portal. This option is typically left blank.
The report name cannot be prefaced with numeric characters (for example, 401K_ report is an invalid file name and my_401K_report is valid).

A.3.71 P_OWNER

Table A-81 indicates which executables can use the P_OWNER keyword.

Table A-81 Executables That Use P_OWNER

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use P_OWNER to specify the OracleAS Portal DB Provider that owns a report's package, which is created when the report definition files are registered. This keyword is only used when DTYPE=REGISTER.

Syntax P_OWNER=portal_dbprovider

Values

portal_dbprovider Any valid OracleAS Portal DB Provider name.

Default The name of the OracleAS Portal DB Provider to which you are connected when you run the SQL*PLUS script file.

A.3.72 P_PFORMTEMPLATE

Table A-82 indicates the Executables That Use the P_PFORMTEMPLATE keyword.

Table A-82 Executables That Use P_PFORMTEMPLATE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use P_PFORMTEMPLATE to specify the name of the OracleAS Portal template that determines the style of the Runtime Parameter Form. This keyword is only used when DTYPE=REGISTER.

Syntax P_PFORMTEMPLATE=template_name

Values

template_name Any valid OracleAS Portal template name.

Default None

A.3.73 P_PRINTERS

Table A-83 indicates the Executables That Use the P_PRINTERS keyword.

Table A-83 Executables That Use P_PRINTERS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use P_PRINTERS to specify the allowable printers for the specified reports. This keyword is only used when DTYPE=REGISTER.

Syntax P_PRINTERS=printer_name

Values

printer_name Any valid printer (for example, PRT1), or a list of valid printers enclosed by parentheses with a comma separating the names (for example, (PRT1,PRT2,PRT3)).

Default None

Usage Note Access to the printer(s) should already exist in OracleAS Portal before running the SQL*Plus script.

A.3.74 P_PRIVILEGE

Table A-84 indicates which executables can use the P_PRIVILEGE keyword.

Table A-84 Executables That Use P_PRIVILEGE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use P_PRIVILEGE to specify the users or roles who have access privileges to run the specified reports. This keyword is only used when DTYPE=REGISTER.

Syntax P_PRIVILEGE=user_name

Values

user_name Any user name or role that OracleAS Portal can recognize (for example, SCOTT), or a list of user names or roles enclosed by parentheses with a comma separating the names (for example, (SCOTT,JABERS,PMARTIN)).

Default None

A.3.75 P_SERVERS

Table A-85 indicates which executables can use the P_SERVERS keyword.

Table A-85 Executables That Use P_SERVERS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use P_SERVERS to specify the names of the restricted Reports Servers that can run the report. This keyword is only used when DTYPE=REGISTER.

Syntax P_SERVERS=tnsname

Values

tnsname Any valid TNS name of the Reports Server (for example, repserver), or a list of valid Reports Server TNS names enclosed by parentheses with a comma separating the names (for example, repserver, acct_server, sales_server).

Default None

Usage Notes Access to the Reports Server(s) should already exist in OracleAS Portal.

A.3.76 P_TRIGGER

Table A-86 indicates the Executables That Use the P_TRIGGERS keyword.

Table A-86 Executables That Use P_TRIGGER

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use P_TRIGGER to specify the PL/SQL function that is executed when parameter values are specified on the command line and when users accept the Runtime Parameter Form. The function must return a boolean value (TRUE or FALSE). For example:

P_TRIGGER="Is begin IF UPPER(DESTYPE) = ''PRINTER'' AND EMPNAME = ''SMITH'' THEN RETURN(TRUE); ELSE RETURN(FALSE); END IF; end;"

This keyword is only used when DTYPE=REGISTER.

Syntax P_TRIGGER=plsql_function

Values

plsql_function Any valid PL/SQL function that returns a boolean value.

Default None

A.3.77 P_TYPES

Table A-87 indicates which executables can use the P_TYPES keyword.

Table A-87 Executables That Use P_TYPES

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use P_TYPES to specify the allowable destination types for the specified reports. This keyword is only used when DTYPE=REGISTER.

Syntax P_TYPES=destination_type

Values

destination_type Any valid destination type (for example, CACHE), or a list of valid destination types enclosed by parentheses with a comma separating the names (for example, CACHE,MAIL,PRINTER).

Default None

A.3.78 PAGEGROUP

Table A-88 indicates which executables can use the PAGEGROUP keyword.

Table A-88 Executables That Use PAGEGROUP

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use PAGEGROUP to specify the name of the OracleAS Portal page group to which report output should be pushed. For backward compatibility with earlier releases, see SITENAME (for Oracle WebDB Release 2.2) and CONTENTAREA (for Oracle9iAS Portal Release 1). The page group must be created in OracleAS Portal before you can use this keyword.

Syntax PAGEGROUP=pagegroup

Values

pagegroup Any valid page group name (internal name) used in OracleAS Portal.

Default None

Usage Notes

Use of this keyword is required to push Oracle Reports output to OracleAS Portal.
The page group name should be the internal name and not the display name. The internal name is used to uniquely identify the OracleAS Portal page instance.
Relevant keywords include CONTENTAREA*, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER*, OUTPUTPAGE, PAGEGROUP, SITENAME*, STATUSFOLDER*, STATUSPAGE.

* maintained for backward compatibility with Oracle9iAS Portal Release 1 and Oracle WebDB Release 2.2.

A.3.79 PAGESIZE

Table A-89 indicates which executables can use the PAGESIZE keyword.

Table A-89 Executables That Use PAGESIZE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	yes	yes	yes	no

Description Use PAGESIZE to set the dimensions of the physical page (that is, the size of the page that the printer outputs). The page must be large enough to contain the report. For example, if a frame in a report expands to a size larger than the page dimensions, then the report is not run.

Syntax PAGESIZE=width x height

Values Any valid page dimensions of the form: page width x page height, where page width and page height are more than zero. The maximum width and height depends which unit of measurement was set in Reports Builder (Edit > Preferences > General tab). For inches, the maximum width and height is 512 inches. For centimeters, it is 1312 centimeters. For picas, it is 36,864 picas.

Default For bitmap, 8.5 x 11 inches. For character mode, 80 x 66 characters. If the report was designed for character mode and is being run or converted on bitmap, then the following formula is used to determine page size if none is specified: (default page size * character page size)/default character page size. For example, if the character page size is 80 x 20, then the bit-mapped page size would be: ( (8.5 * 80)/80) x ((11 * 20)/66) = (680/80) x (220/66) = 8.5 x 3.33.

Usage Notes

On some printers the printable area of the physical page is restricted. For example, the sheet of paper a printer takes might be 8.5 x 11 inches, but the printer might only be able to print on an area of 8 x 10.5 inches. If you define a page width x page height in Reports Builder that is bigger than the printable area your printer allows, then clipping might occur in your report output. To avoid clipping, you can either increase the printable area for the printer (if your operating system allows it), or you can set the page width x page height to be the size of the printable area of the page.
Letter size is 8.5 inches x 11 inches. A4 size is 210mm x 297mm, or 8.25 inches x 11.75 inches.
If you use the PAGESIZE keyword, then its value overrides the page dimensions of the report definition.
A PAGESIZE value entered on the Runtime Parameter Form overrides any PAGESIZE value entered on the command line.

A.3.80 PAGESTREAM

Table A-90 indicates which executables can use the PAGESTREAM keyword.

Table A-90 Executables That Use PAGESTREAM

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description PAGESTREAM enables or disables page streaming (pagination) for the report when formatted as HTML or HTMLCSS output, using the navigation controls set by either of the following:

The Page Navigation Control Type and Page Navigation Control Value properties in the Report Property Palette.
PL/SQL in a BEFORE REPORT trigger (SRW.SET_PAGE_NAVIGATION_HTML)

Syntax PAGESTREAM={YES|NO}

Values

YES Paginate the report output.
NO Output the report without pagination.

Default NO

A.3.81 PARAMFORM

Table A-91 indicates which executables can use the PARAMFORM keyword.

Table A-91 Executables That Use PARAMFORM

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	yes	no

Description Use PARAMFORM to specify whether to display the Runtime Parameter Form when you execute a report through CGI or a servlet. PARAMFORM is used only to supply parameters to paper layout reports, not JSP-based Web reports.

Syntax PARAMFORM=YES|NO|HTML

Values

YES Display the Parameter Form.
NO Do not display the Parameter Form.
HTML Display the Parameter Form in HTML format.

Default NO

Usage Notes

PARAMFORM=YES is incompatible with BATCH=YES because it is not meaningful to have the Runtime Parameter Form appear in batch mode.
Do not use this keyword when running a report in an OracleAS Portal environment. This is because OracleAS Portal enables you to set up a Report Runtime Parameter Form, which would conflict with a Parameter Form you specify with the PARAMFORM keyword.

Examples

http://myias.mycomp.com:7779/rwservlet?server=myrepserver+report=test.rdf 
+userid=scott/tiger@mydb+destype=cache+desformat=htmlcss+paramform=html

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserver+report=test.rdf
+userid=scott/tiger@mydb+destype=cache+desformathtmlcss=+paramform=yes

A.3.82 PARSEQUERY

Table A-92 indicates which executables can use the PARSEQUERY keyword.

Table A-92 Executables That Use PARSEQUERY

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	yes	no

Description Use PARSEQUERY to parse an rwservlet query and display the constructed Reports Server command line.

Syntax http://your_webserver/reports/rwservlet/parsequery[?][server=server_name][&authid=username/password]

Values See Syntax

Default None

Usage Notes

This keyword is a command that does not require a value; that is, commands are entered by themselves without a corresponding value.
Related keywords are SERVER and AUTHID.

A.3.83 PDFCOMP

Table A-93 indicates which executables can use the PDFCOMP keyword.

Table A-93 Executables That Use PDFCOMP

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use PDFCOMP to specify whether PDF output should be compressed.

Syntax PDFCOMP=value|{YES|NO}

Values

value Any value 0 though 9. A value of 0 means PDF output will not be compressed. A value of 1 through 9 will compress the PDF output and permit users to control the compression level.
YES Compresses output at compression level 6.
NO Compresses output at compression level 0 (no compression).

Default 6

A.3.84 PDFEMBED

Table A-94 indicates which executables can use the PDFEMBED keyword.

Table A-94 Executables That Use PDFEMBED

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use PDFEMBED to specify whether Oracle Reports will embed the Type1 PostScript font file(s) specified in the uifont.ali file into PDF output.

Syntax PDFEMBED={YES|NO}

Values

YES The PDF driver will embed the font(s) specified in the [PDF:Embed] header of the uifont.ali file into the PDF output.
NO The font(s) will not be added to PDF output.

Default YES

A.3.85 PFACTION

Table A-95 indicates which executables can use the PFACTION keyword.

Table A-95 Executables That Use PFACTION

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	no	no	no	no	no

Note:

PFACTION is also used with the OracleAS Forms Services keyword RUN_REPORT_OBJECT, which is the most secure approach for calling Oracle Reports from Oracle Forms on the Web. For detailed information about using RUN_REPORT_OBJECT to call Oracle Reports from Oracle Forms, refer to the Oracle Application Server 10g Integrating Oracle Reports in Oracle Forms Services Applications white paper on OTN (http://otn.oracle.com/products/forms/pdf/10g/frm10gsrw10g.pdf). Also refer to the Oracle Application Server Forms Services Deployment Guide.

Description Use PFACTION to specify the action string for a Parameter Form. When a request is submitted through rwclient or the OracleAS Forms Services RUN_REPORT_OBJECT keyword to run a report that has a Parameter Form, the Parameter Form generated cannot be used unless PFACTION is included in the command line. The unusable Parameter Form is caused by an empty action attribute (because rwclient and RUN_REPORT_OBJECT call Oracle Reports directly on the server, Oracle Reports cannot access the Web environment to obtain the information required to populate the action attribute when generating the HTML Parameter Form).

The action attribute is part of the standard HTML form tag that defines the action that is performed when the end user clicks Submit. The action attribute in the Oracle Reports Parameter Form should contain hidden runtime parameters that are required to process the Oracle Reports request after the end user clicks Submit.

Syntax PFACTION=request_URL_to_rwservlet?_hidden_encoded_original_url_string

Values

request_URL_to_rwservlet The http://host:port/reports/rwservlet URL.
encoded_original_url_string The query string to run the report.

Example rwclient.exe report=pform.rdf destype=cache desformat=pdf paramform=yes PFACTION="http://mymachine.mycompany.com:7777/reports/rwservlet?_hidden_report=pform.rdf%20destype=cache%20desformat=pdf"

A.3.86 PRINTJOB

Table A-96 indicates which executables can use the PRINTJOB keyword.

Table A-96 Executables That Use PRINTJOB

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	yes	no	no	no	no

Description Use PRINTJOB to specify whether the Print Job dialog box should be displayed before running a report.

Syntax PRINTJOB={YES|NO}

Values

YES The Print Job dialog box is displayed before the report is run.
NO The report is run without displaying the Print Job dialog box.

Default YES

Usage Notes

When a report is run as a spawned process (that is, one executable, such as rwrun, is called from within another executable, such as rwbuilder), the Print Job dialog box does not appear, regardless of PRINTJOB.
When DESTYPE=MAIL, the print Job dialog box does not appear, regardless of PRINTJOB.

A.3.87 READONLY

Table A-97 indicates which executables can use the READONLY keyword.

Table A-97 Executables That Use READONLY

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use READONLY to request read consistency across multiple queries in a report. When accessing data from an Oracle database, read consistency is accomplished by a SET TRANSACTION READ ONLY statement (refer to your Oracle database documentation for more information on SET TRANSACTION READ ONLY).

Note:

Refer to the Oracle SQL documentation (available on the Oracle Technology Network, (http://www.oracle.com/technology/index.html) for more information on SET TRANSACTION READ ONLY.

Syntax READONLY={YES|NO}

Values

YES Requests read consistency.
NO Do not provide read consistency.

Default NO

Usage Notes

READONLY is only useful for reports using multiple queries. An Oracle database automatically provides read consistency, without locking, for single-query reports.
In the report trigger order of execution, SET TRANSACTION READ ONLY must be set up before the data fetch occurs.
READONLY can be used when running JSP-based Web reports from the command line.

A.3.88 RECURSIVE_LOAD

Table A-98 indicates which executables can use the RECURSIVE_LOAD keyword.

Table A-98 Executables That Use RECURSIVE_LOAD

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	yes	yes	yes	no

Description Use RECURSIVE_LOAD to specify whether to validate external references in program units when running a report. If any of the references become invalid, the program unit is automatically recompiled. Setting RECURSIVE_LOAD to NO is useful when running your report against a different database than the one against which its PL/SQL was originally compiled.

Syntax RECURSIVE_LOAD={YES|NO}

Values

YES Validates external references when running a report. If any of the references become invalid, the program unit is recompiled (whether it be in .rdf or .pll).
NO Does not validate external references when running a report. This setting is useful when running a report against a different database than the one against which its PL/SQL was originally compiled.

Default YES

A.3.89 REPLYTO

Table A-99 indicates which executables can use the REPLYTO keyword.

Table A-99 Executables That Use REPLYTO

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use REPLYTO to specify the e-mail address to which replies should be sent when the sender wants replies to go to someone other than the sender (specified by the FROM keyword).

Syntax REPLYTO=emailid

Values

emailid A valid e-mail address in the form of someone@foo.com.

Default None

Usage Notes Related keywords include BCC,CC,FROM,REPLYTO, and SUBJECT. Note that DESNAME is used to specify the main recipient(s) of the e-mail.

A.3.90 REPORT|MODULE

See MODULE|REPORT.

A.3.91 ROLE

Table A-100 indicates which executables can use the ROLE keyword.

Table A-100 Executables That Use ROLE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use ROLE to specify the database role to be checked for the report at runtime. This keyword is useful for giving you the ability to run reports that query database tables to which you would not normally have access privileges.

Syntax ROLE={rolename[/rolepassword]}

Values

rolename A valid role.

rolepassword (Optional) The matching role password.

Default None

Usage Notes ROLE can be used when running JSP-based Web reports from the command line.

A.3.92 RUNDEBUG

Table A-101 indicates which executables can use the RUNDEBUG keyword.

Table A-101 Executables That Use RUNDEBUG

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use RUNDEBUG to specify that you want extra runtime checking for logical errors in the report. RUNDEBUG checks for things that are not errors but might result in undesirable output, and displays these as warnings at runtime, before displaying the report output. Using RUNDEBUG to run a report in debug mode is not the same as debugging a report using the PL/SQL Interpreter.

RUNDEBUG checks for the following:

Frames or repeating frames that overlap but do not enclose another object. This can lead to objects overwriting other objects in the output.
Layout objects with page-dependent references that do not have fixed sizing. Such objects will be fixed in size regardless of the Vertical Elasticity and Horizontal Elasticity property settings.
Bind variables referenced at the wrong frequency in PL/SQL.

Syntax RUNDEBUG={YES|NO}

Values

YES Perform extra runtime error checking.
NO Do not perform extra runtime error checking.

Default YES

Usage Notes RUNDEBUG can be used when running JSP-based Web reports from the command line.

A.3.93 SAVE_RDF

Table A-102 indicates which executables can use the SAVE_RDF keyword.

Table A-102 Executables That Use SAVE_RDF

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	yes	yes	no	no	no	no

Description Use SAVE_RDF to specify a filename for a combined RDF file and XML customization file. This keyword is useful when you combine an existing RDF file with a Oracle Reports XML customization file using the CUSTOMIZE keyword, and you wish to save the combination to a new RDF file.

Syntax SAVE_RDF=filename.rdf

Values Any valid file name.

Default None

Usage Notes You can use SAVE_RDF with a JSP file, but only the paper layout part, not the Web source.

A.3.94 SCHEDULE

Table A-103 indicates which executables can use the SCHEDULE keyword.

Table A-103 Executables That Use SCHEDULE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	no	no	yes	yes	no

Description Use SCHEDULE to set the day, time, and frequency a report should be run. The default is to run the report once, now. Time values are expressed according to a 24-hour day (that is, one o'clock is expressed 13:00). To eliminate the need for quoting the scheduling command, use underscores (_) instead of spaces. You can also specify an expiration for a report job after a number of runs or on a particular date/time. For example, use:

SCHEDULE=every_first_fri_of_month_from_15:53_Oct_23,_1999_retry_3_after_1_hour_expires_on_15:53_Oct_23,_2003

SCHEDULE=last_weekday_before_15_from_15:53_Oct_23,_1999_retry_after_1_hour_expires_after_100

Or:

SCHEDULE="every first fri of month from 15:53 Oct 23, 1999 retry 3 after 1 hour expires on 15:53 Oct 23, 2003"

SCHEDULE="last weekday before 15 from 15:53 Oct 23, 1999 retry after 1 hour expires after 100"

Syntax SCHEDULE=string

where string is:

[FREQ from] TIME [retry {n} after LEN expires {on|after} time|n]

Table A-104 lists and explains the values used in this string.

Table A-104 Values for string used with the SCHEDULE keyword

FREQ	hourly \| daily \| weekly \| monthly \| {every {LEN \| DAYREPEAT}} \| {last {WEEKDAYS \| weekday \| weekend} before {n}+}
LEN	{n}+ {minute[s] \| hour[s] \| day[s] \| week[s] \| month[s]}
DAYREPEAT	{first \| second \| third \| fourth \| fifth} WEEKDAYS of month
WEEKDAYS	mon \| tue \| wed \| thu \| fri \| sat \| sun
TIME	now \| CLOCK [DATE]
CLOCK	h:m \| h:mm \| hh:m \| hh:mm
DATE	today \| tomorrow \| {MONTHS {d \| dd} [,year]}
MONTHS	jan \| feb \| mar \| apr \| may \| jun \| jul \| aug \| sep \| oct \| nov \| dec
EXPIRES	on {today \| tomorrow \| {MONTHS {d \| dd} [,year]}}\|after n

Default None

A.3.95 SERVER

Table A-105 indicates which executables can use the SERVER keyword.

Table A-105 Executables That Use SERVER

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	no	no	yes	yes	yes

Description Use SERVER to specify the name of the Reports Server you want to use to run this report.

Syntax SERVER=server_name

Values See Syntax

Default The server name specified in the REPORTS_SERVER environment variable for rwcgi.

Usage Notes

For jobs run with rwcgi, you can set the REPORTS_SERVER environment variable on your Web server machine and omit the SERVER keyword to process requests using the default server, or you can include the SERVER keyword to override the default. For jobs run with rwservlet or as a JSP, you can omit the SERVER keyword if you have specified a default server in the servlet configuration file, rwservlet.properties; or you can include the SERVER keyword to override the default.
SERVER can be used when running JSP-based Web reports from the command line.

A.3.96 SHOWAUTH

Table A-106 indicates which executables can use the SHOWAUTH keyword.

Table A-106 Executables That Use SHOWAUTH

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	yes	no

Description Use SHOWAUTH to display the Reports Server logon page and runs the report.

Syntax http://your_webserver/reports/rwservlet/showauth[?][server=server_name][&authid=username/password][&nextpage=run_report_URL][&authtype={s|d}]

Values See Syntax

Default None

Usage Notes

This keyword is a command that does not require a value; that is, commands are entered by themselves without a corresponding value.
When authtype=s the Reports System User Authentication dialog box is displayed. The Reports Database User Authentication dialog box is displayed when authtype=d.
Related keywords are SERVER and AUTHID.

A.3.97 SHOWENV

Table A-107 indicates which executables can use the SHOWENV keyword.

Table A-107 Executables That Use SHOWENV

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	yes	no

Description Use SHOWENV to display the rwservlet configuration file (rwservlet.properties).

Syntax http://your_webserver/reports/rwservlet/showenv[?][server=server_name][&authid=username/password]

Values See Syntax

Default None

Usage Notes

This keyword is a command that does not require a value; that is, commands are entered by themselves without a corresponding value.
Related keywords are SERVER and AUTHID.

A.3.98 SHOWJOBID

Table A-108 indicates which executables can use the SHOWJOBID keyword.

Table A-108 Executables That Use SHOWJOBID

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	no	no

Description SHOWJOBID shows the status of the Reports Server job with job ID n.

Syntax http://your_webserver/reports/rwservlet/showjobidn[?][server=server_name][&authid=username/password][&statusformat={html|xml|xmldtd}]

Values See Syntax

Default None

Usage Notes

This keyword is a command that does not require a value; that is, commands are entered by themselves without a corresponding value.
The job must be current (enqueued or scheduled).
Use SHOWJOBS to see the current list of jobs. The STATUSFORMAT can be set to html (default), xml , or xmldtd to return status in that format. The status information is generated in HTML, XML, or XMLDTD (with an internal DTD subset).
Related keywords are SHOWJOBS, SERVER, AUTHID, and STATUSFORMAT.
The STATUSFORMAT parameter is only valid for rwservlet, not for rwcgi.

A.3.99 SHOWJOBS

Table A-109 indicates which executables can use the SHOWJOBS keyword.

Table A-109 Executables That Use SHOWJOBS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	yes	no

Description Use SHOWJOBS to display a Web view of Reports Server queue status.

Syntax http://your_webserver/reports/rwservlet/showjobs[n][?][server=server_name][&authid=username/password][&queuetype={current|past|future}][&startrow=start_position_in_job_queue][&count=number_of_jobs_to_display][&statusformat={html|xml|xmldtd}]

Values See Syntax

Default None

Usage Notes

This keyword does not require a value; that is, keywords are entered by themselves without a corresponding value.
The name of the Reports Server must be specified implicitly by environment variable or servlet configuration file, or explicitly in the URL request. The refresh number n is optional. When it is specified, the report's queue status will be updated every n seconds.
The STATUSFORMAT can be set to html (default), xml , or xmldtd to return status in that format. The status information is generated in HTML, XML, or XMLDTD (with an internal DTD subset).
The QUEUETYPE,STARTROW,COUNT, and STATUSFORMAT parameters are valid only for rwservlet and not for rwcgi.
Related keywords are SERVER, AUTHID, and STATUSFORMAT.

A.3.100 SHOWMAP

Table A-110 indicates which executables can use the SHOWMAP keyword.

Table A-110 Executables That Use SHOWMAP

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	yes	no

Description Use SHOWMAP to display rwservlet key mappings.

Syntax http://your_webserver/reports/rwservlet/showmap[?][server=server_name][&authid=username/password]

Values See Syntax

Default None

Usage Notes:

This keyword is a command that does not require a value; that is, commands are entered by themselves without a corresponding value.
Related keywords are SERVER and AUTHID.

A.3.101 SHOWMYJOBS

Table A-111 indicates which executables can use the SHOWMYJOBS keyword.

Table A-111 Executables That Use SHOWMYJOBS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	no	no

Description Use SHOWMYJOBS to display the Reports Server queue status for a particular user.

Syntax http://your_webserver/reports/rwservlet/showmyjobs[?][server=server_name][&authid=username/password][&statusformat={html|xml|xmldtd}]

Values See Syntax

Default None

Usage Notes

This keyword is a command that does not require a value; that is, commands are entered by themselves without a corresponding value.
The STATUSFORMAT can be set to html (default), xml , or xmldtd to return status in that format. The status information is generated in html, xml, or xmldtd (with an internal dtd subset).
Related keywords are SERVER, AUTHID, and STATUSFORMAT.
The STATUSFORMAT parameter is only valid for rwservlet, not for rwcgi.

A.3.102 SHUTDOWN

Table A-112 indicates which executables can use the SHUTDOWN keyword.

Table A-112 Executables That Use SHUTDOWN

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver	rwbridge
no	no	no	no	no	no	yes	yes

Description Use SHUTDOWN to shut down a previously running server, or to shut down the Oracle Reports bridge. When used with rwserver, you must also use AUTHID to supply a user name and password. When used with rwbridge, you must also use AUTHID to supply a user name and password if the bridge is secured (the identifier element is set in the bridge configuration file).

Syntax SHUTDOWN={NORMAL|IMMEDIATE}

Values

NORMAL Shuts the server or bridge down gracefully, using normal shutdown procedures.
IMMEDIATE Shuts the server or bridge down immediately, without waiting for other processes to complete running.

Default NORMAL

Usage Notes The user of the SHUTDOWN keyword must be an Oracle Reports Administrative user. If the server has security enabled, it will query the security API to determine the user's role eligibility to execute the shutdown (in other words, the user must be an Oracle Reports Administrative user). If security is not enabled, then the user must nonetheless be an Oracle Reports Administrative user defined for that server.

A.3.103 SITENAME

Table A-113 indicates which executables can use the SITENAME keyword.

Table A-113 Executables That Use SITENAME

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use SITENAME to specify the name of the Oracle WebDB Release 2.2 site to which report output should be pushed. This keyword is maintained for backward compatibility with Oracle WebDB Release 2.2; for backward compatibility with Oracle9iAS Portal Release 1, see CONTENTAREA. Begining with OracleAS Portal 10g Release 1 (9.0.4), use PAGEGROUP.

Syntax SITENAME=name

Values

name Any valid site name used in Oracle WebDB Release 2.2.

Default None

Usage Notes

Use of this keyword is required to push Oracle Reports output to Oracle WebDB Release 2.2.
Relevant keywords include CONTENTAREA*, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER*, OUTPUTPAGE, PAGEGROUP, SITENAME*, STATUSFOLDER*, STATUSPAGE.

* maintained for backward compatibility with Oracle9iAS Portal Release 1 and Oracle WebDB Release 2.2.

A.3.104 SOURCE

Table A-114 indicates which executables can use the SOURCE keyword.

Table A-114 Executables That Use SOURCE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use SOURCE to specify the report/library or list of reports/libraries to be converted. The rwconverter command requires that you specify a source report or library.

Syntax SOURCE={source_name|(source_name1, source_name2, ...)}

Values Any valid report/library name or filename, or a list of valid report/library names or filenames enclosed in parentheses and separated by commas (for example, (qanda, test, dmast)).

Default None

Usage Notes

SQL wildcard characters (% and _) may be used for reports or libraries that are stored in the database. For example, R% would fetch all reports stored in the database that begin with R. All reports that match will be converted.
A list of report/library names or filenames must be enclosed in parentheses, with commas separating the names. For example:

(qanda,test,dmast) OR (qanda, test, dmast)
Wildcard characters are invalid for reports/libraries stored in files (that is, with extensions of .rdf, .rep, .rex, .pld, .pll, or .xml).
The value(s) for the SOURCE keyword may be operating system-specific.
If you are using user-owned Reports Builder tables, reports/libraries from multiple users must be converted for each user individually.
To convert reports/libraries, you must have created them or been granted access to the ones you did not create. If no USERID string is prefixed to the report/library name, the USERID string is assumed to be that the current user.
When DTYPE=REGISTER, you may only want to list report definition files with common parameters, such as destination types and formats, user access, and availability calendars.

A.3.105 SQLTRACE

Table A-115 indicates which executables can use the SQLTRACE keyword.

Table A-115 Executables That Use SQLTRACE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use SQLTRACE to specify whether to perform SQL tracing on your report without modifying the report definition.

Syntax SQLTRACE=[YES|NO]

Values

YES SQL tracing will be performed on the report.
NO SQL tracing will not be performed on the report.

Default NO

A.3.106 SSOCONN

Table A-116 indicates which executables can use the SSOCONN keyword.

Table A-116 Executables That Use SSOCONN

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	no	no

Description Use SSOCONN to specify one or more connect strings to use to connect to one or more data sources in a Single Sign-On environment.

Syntax SSOCONN=key[/type[/conn_string_parameter]][,key[/type[/conn_string_parameter]]]

Values The following information describes the variable values expressed in the SSOCONN syntax:

key refers to a connection string value stored in Oracle Internet Directory.
type is the kind of data source to which you are connecting, to identify the format in the string associated with key. The type value must be a valid resource type stored in the Oracle Internet Directory. Oracle Reports provides default resource types for the following:
- Oracle database (OracleDB)
- JDBC (JDBCPDS)
- Oracle Express (EXPRESSPDS)
conn_string_parameter is the name of the Oracle Reports system or user parameter to be used to pass the connection string to rwservlet to run the report. For example, in the case of the OracleDB data source, Oracle Reports receives the connection string through the USERID parameter and uses it to connect to the specified Oracle database. Similarly, for EXPRESSPDS, the EXPRESS_SERVER parameter is used, and for JDBCPDS, P_JDBCPDS is used. If you have your own custom pluggable data sources, you would need to define your own user parameter for passing the connection string to Oracle Reports and specify it as conn_string_parameter for SSOCONN.

For example:

SSOCONN=mykey/OracleDB/USERID

Default None

Usage Notes

If multiple data sources are used in the report, use a comma to separate data source connection strings. For example:

ssoconn=key1/type1/conn_str,key2/type2/conn_str2,key3/type3/conn_str3
When you use SSOCONN in a command line, you cannot:
- Specify AUTHID in the same command line.
- Run against a Reports Server that is not secure.
- Have SINGLESIGNON=NO in rwservlet.properties.
Simplified versions of SSOCONN are also available, as shown in Table A-117.

Table A-117 Simplified Versions of the SSOCONN Option

Option	Description
`ssoconn=mkey`	When only the key name is specified, the default values for `type` and `conn_string_parameter` are: `OracleDB` and `USERID`.
`ssoconn=mkey/PDSApp`	When both key name and data source type are specified, the default value for `conn_string_parameter` is `USERID`.

SSOCONN can be used when running JSP-based Web reports from the command line. If you are using the SSOCONN keyword with a report run as a JSP, use an ampersand (&) to separate connection strings. For example:

http://...:8888/myjsp/foo.jsp?name1=value1&name2=value2 …

Note:
For more information on Oracle Reports and Single Sign-On (SSO), see Chapter 11, "Configuring and Administering OracleAS Single Sign-On".

A.3.107 STATUSFOLDER

Table A-118 indicates which executables can use the STATUSFOLDER keyword.

Table A-118 Executables That Use STATUSFOLDER

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use STATUSFOLDER to specify the name of the Oracle WebDB Release 2.2 or Oracle9iAS Portal Release 1 folder to which job status information should be pushed. If this is omitted, a new folder is created called Oracle_Reports_Status. This keyword is maintained for backward compatibility with Oracle WebDB Release 2.2 and Oracle9iAS Portal Release 1. Beginning with OracleAS Portal 10g Release 1 (9.0.4), use STATUSPAGE.

Syntax STATUSFOLDER=folder

Values

folder Any valid folder name (internal name) used in Oracle WebDB Release 2.2 or Oracle9iAS Portal Release 1.

Default Oracle_Reports_Status

Usage Notes

Use of this keyword is optional to push Oracle Reports output to Oracle WebDB Release 2.2 or Oracle9iAS Portal Release 1.
The value for this keyword is case sensitive.
Relevant keywords include CONTENTAREA*, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER*, OUTPUTPAGE, PAGEGROUP, SITENAME*, STATUSFOLDER*, STATUSPAGE.

* maintained for backward compatibility with Oracle9iAS Portal Release 1 and Oracle WebDB Release 2.2.

A.3.108 STATUSFORMAT

Table A-119 indicates which executables can use the STATUSFORMAT keyword.

Table A-119 Executables That Use STATUSFORMAT

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	no	yes	no	no

Description Use STATUSFORMAT to specify the format for the Web view of the Reports Server queue status.

Syntax http://yourwebserver/rwservlet/showjobs?server=server_name&statusformat={html|xml|xmldtd}

Values

html Outputs the Reports Server queue status in HTML format.
xml Outputs the Reports Server queue status in XML format.
xmldtd Outputs the Reports Server queue status in XML format with in-line Data Type Definition information.

Default html

Usage Notes Use STATUSFORMAT in conjunction with the SHOWJOBS and SHOWMYJOBS keywords.

A.3.109 STATUSPAGE

Table A-120 indicates which executables can use the STATUSPAGE keyword.

Table A-120 Executables That Use STATUSPAGE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use STATUSPAGE to specify the name of the OracleAS Portal page to which job status information should be pushed. If this is omitted, a new page is created called Oracle_Reports_Status. For backward compatibility with earlier releases (Oracle WebDB Release 2.2 and Oracle9iAS Portal Release 1), see STATUSFOLDER.

Syntax STATUSPAGE=page

Values

page Any valid page name (internal name) used in OracleAS Portal.

Default Oracle_Reports_Status

Usage Notes

Use of this keyword is optional to push output to OracleAS Portal.
The value for this keyword is case sensitive.
Relevant keywords include CONTENTAREA*, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER*, OUTPUTPAGE, PAGEGROUP, SITENAME*, STATUSFOLDER*, STATUSPAGE.

* maintained for backward compatibility with Oracle9iAS Portal Release 1 and Oracle WebDB Release 2.2.

A.3.110 STYPE

Table A-121 indicates which executables can use the STYPE keyword.

Table A-121 Executables That Use STYPE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use STYPE to specify the format of the report(s) or libraries to be converted.

Syntax STYPE={PLDFILE|PLLFILE|RDFFILE|REXFILE|XMLFILE|JSPFILE}

Values Use any one of the following values:

PLDFILE Source PL/SQL libraries are stored in files in ASCII format.
PLLFILE Source PL/SQL libraries are stored in files containing source code and P-code (compiled PL/SQL).
RDFFILE Source report(s) are stored in one or more report definition files (files with the rdf extension).
REXFILE Source report(s) are stored in one or more text files (files with the rex extension).
XMLFILE Source report(s) are stored in one or more XML files.
JSPFILE Source report(s) are stored in one or more JSP files.

Default RDFFILE

Usage Notes When DTYPE=REGISTER, choose RDDFILE,REXFILE,XML, or JSPFILE for STYPE.

A.3.111 SUBJECT

Table A-122 indicates which executables can use the SUBJECT keyword.

Table A-122 Executables That Use SUBJECT

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	no	no	yes	yes	no

Description Use SUBJECT to specify the subject line of an e-mail.

Syntax SUBJECT=string

Values Any text string.

Default None

Usage Notes

Enclose subjects that contain character spaces in quotation marks (" "). Single-word subjects do not require quotation marks.
Related keywords include BCC, CC, FROM, REPLYTO, and SUBJECT. Note that DESNAME is used to specify the main recipient(s) of the e-mail.

A.3.112 SUPPRESSLAYOUT

Table A-123 indicates which executables can use the SUPPRESSLAYOUT keyword.

Table A-123 Executables That Use SUPPRESSLAYOUT

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use SUPPRESSLAYOUT to specify whether to suppress the formatting of the paper layout at runtime. The keyword allows users to control whether the paper layout in a report is executed at runtime. The most common use of this keyword is to increase the performance of JSP reports. Since a JSP report may have a paper layout and reference objects in it through an <rw:include> tag, Oracle Reports formats the paper layout before running the JSP section of the report. To improve the performance of single source JSP reports that store both paper and Web layouts but do not reference paper layout objects, set SUPPRESSLAYOUT=YES on the command line.

Note:

If there is an <rw:include> tag, then no output will be created for the tag.

Syntax SUPPRESSLAYOUT=[YES|NO]

Values

YES Paper layout objects will not be formatted at runtime
NO Paper layout objects will be formatted at runtime.

Default NO

A.3.113 TOLERANCE

Table A-124 indicates which executables can be used with the TOLERANCE keyword.

Table A-124 Executables That Use TOLERANCE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	no	no	yes	yes	no

Description Use TOLERANCE to set the maximum acceptable time (in minutes) for reusing a report's cached output when a duplicate job is detected. Setting the time tolerance on a report reduces the processing time when duplicate jobs are found.

See Reusing Report Output from Cache for more information on duplicate job detection.

Syntax TOLERANCE=time_string

Values

time_string Can be in one of two formats:

n{unit}, for a number with an optional unit. The unit can be minute(s), hour(s), or day(s). The default unit is minute(s) if no unit is specified.
{Mon DD, YYYY} hh:mi:ss am|pm {timezone}, for a date/time format. Date information is optional. If it isn't specified, today is assumed. Time zone is also optional. If it isn't specified, the Reports Server's time zone is used. The date/time is always in a US locale. This format is the same as defined in the Java DateFormat.MEDIUM type.

Default None

Usage Notes

If TOLERANCE is not specified, then OracleAS Reports Services reruns the report even if a duplicate report is found in the cache.
If a report is being processed (that is, in the current job queue) when an identical job is submitted, then OracleAS Reports Services reuses the output of the currently running job even if TOLERANCE is not specified or is set to zero.

A.3.114 TRACEFILE

Table A-125 indicates which executables can use the TRACEFILE keyword.

Table A-125 Executables That Use TRACEFILE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	yes	yes	no	no	no	yes

Description TRACEFILE is the name of the file in which trace information is logged.

Note:

Report tracing can be specified in numerous ways, as described in the Usage Notes below and in Section 20.1.2, "Report Trace".

Syntax TRACEFILE=tracefile

Values Any valid file name.

Default rwserver.trc or rwEng-x.trc (see Usage Notes)

Usage Notes

Tracing options specified on the command line override configuration file settings.

For Reports Builder (rwbuilder) and Reports Runtime (rwrun), tracing options (described in Section 3.2.1.13, "trace") can be configured in the builder configuration file (rwbuilder.conf), or specified on the command line.

Note:

The location of the trace file is relative to the Oracle Reports log directory (ORACLE_HOME\reports\logs\rep_machinename-rwbuilder\) or absolute if a full path name is specified. If you do not specify a trace file name, the default builder trace file name is rwserver.trc.

For Reports Server (rwserver), tracing options (described in Section 3.2.1.13, "trace") can be configured in the server configuration file (server_name.conf), or specified on the command line when starting the server.

Note:

The location of the trace file is relative to the server log directory (ORACLE_HOME\reports\logs\server_name) or absolute if a full path name is specified. If you do not specify a trace file name, the default server trace file name is rwserver.trc and the default engine trace file name is rwEng-x.trc (where x is the engine ID).

For Reports Servlet (rwservlet), tracing options are configured in the servlet configuration file (rwservlet.properties), as described in Section 3.4.5, "Setting Up Trace Options for Reports Servlet and JSPs".
Whether an existing file will be overwritten or appended to depends on the TRACEMODE setting.

A.3.115 TRACEMODE

Table A-126 indicates which executables can use the TRACEMODE keyword.

Table A-126 Executables That Use TRACEMODE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	yes	yes	no	no	no	yes

Description TRACEMODE specifies whether to append new trace information to existing information in the file specified by TRACEFILE, or overwrite the entire file.

Note:

Report tracing can be specified in numerous ways, as described in Section 20.1.2, "Report Trace".

Syntax TRACEMODE={TRACE_APPEND|TRACE_REPLACE}

Values

TRACE_APPEND Adds the new information to the end of the file.
TRACE_REPLACE Overwrites the file.

Default TRACE_APPEND

Usage Notes

See Usage Notes under Section A.3.114, "TRACEFILE".

A.3.116 TRACEOPTS

Table A-127 indicates which executables can use the TRACEOPTS keyword.

Table A-127 Executables That Use TRACEOPTS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	yes

Description TRACEOPTS specifies the tracing information that you want to be logged in the file specified by TRACEFILE.

Note:

Report tracing can be specified in numerous ways, as described in Section 20.1.2, "Report Trace".

Syntax TRACEOPTS={TRACE_ALL|TRACE_APP|TRACE_BRK|TRACE_

TMS|TRACE_WRN}

Values The following values apply:

TRACE_ALL Log all possible trace information in the trace file.
TRACE_APP Log trace information on all the report objects in the trace file.
TRACE_BRK List all breakpoints in the trace file.
TRACE_DBG Log debug information.
TRACE_DST List distribution lists in the trace file. You can use this information to determine which section was sent to which destination.
TRACE_ERR List error messages and warnings in the trace file.
TRACE_EXC List Reports Server exceptions.
TRACE_INF Dumps any information not covered by the other options into the trace file.
TRACE_LOG Duplicate log information in your trace file. If you have specified a log element in addition to a trace element in your server configuration file, this value will cause information that is sent to the log file to also be sent to the trace file.
TRACE_PLS Log trace information on all the PL/SQL objects in the trace file.
TRACE_PRF Log performance statistics in the trace file.
TRACE_SQL Log trace information on all the SQL in the trace file.
TRACE_STA Provide server and engine state information, such as initialize, ready, run, and shut-down.
TRACE_TMS Enter a timestamp for each entry in the trace file.
TRACE_WRN List server warning messages.

Default TRACE_ALL

Usage Notes

See Usage Notes under Section A.3.114, "TRACEFILE".
To use multiple options, list the options in parentheses. For example, TRACEOPTS=(TRACE_APP, TRACE_PRF) means you want both TRACE_APP and TRACE_PRF applied.

A.3.117 UPGRADE_PLSQL

Table A-128 indicates which executables can use the UPGRADE_PLSQL keyword.

Table A-128 Executables That Use UPGRADE_PLSQL

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	no	yes	no	no	no

Description Use UPGRADE_PLSQL to specify whether to upgrade any PL/SQL code in the report to the latest release required by Oracle Reports.

Syntax UPGRADE_PLSQL=[YES|NO]

Values

YES PL/SQL code will be upgraded automatically if necessary.
NO PL/SQL code will not be updated.

Default YES

A.3.118 URLPARAMETER

Table A-129 indicates which executables can use the URLPARAMETER keyword.

Table A-129 Executables That Use URLPARAMETER

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	no	no	yes	yes	no

Description Use URLPARAMETER to specify the URL that is to be fetched with the URL engine.

Syntax URLPARAMETER=http://your_webserver/page_name.html

Values Any valid URL.

Default None

Usage Notes This keyword is relevant when jobType=rwurl in the job element in the Reports Server configuration file, and a URL engine is in place.

A.3.119 USEJVM

Table A-130 indicates which executables can use the USEJVM keyword.

Table A-130 Executables That Use USEJVM

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	no	no	no	no	no

Description Use USEJVM to specify whether or not rwclient should use J ava Virtual Machine (JVM) to communicate with Reports Server.

Syntax USEJVM=YES|NO

Values

YES rwclient starts JVM and tries to connect to Reports Server using CORBA; if this fails, then it will attempt to connect using SQLNet, which is available for backward compatibility.
NO rwclient does not start JVM; instead, it uses SQLNet to communicate with Reports Server (either rwproxy or Oracle Reports 6i Server).

Default YES

A.3.120 USERID

Table A-131 indicates which executables can use the USERID keyword.

Table A-131 Executables That Use USERID

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	yes	yes	yes	no

Description Use USERID only if you are not using Single Sign-On to specify your Oracle user name and password, with an optional database name for accessing a remote database. If the password is omitted, then a database logon form opens automatically before the user is allowed to run the report.

If you want users to log on to the database, then omit the password portion of the USERID keyword from the report request. If you want users to log on every time they run report requests, then use the Oracle Reports key mapping file, cgicmd.dat, to specify the runtime command, and include the %D option in the relevant key mapping entry.

Note:

For information on using the cgicmd.dat file, see Chapter 13, "Running Report Requests".

Syntax userid=username[/password][@database]

Values

username Username assigned by the database administrator.
password Password for the username. See "Usage Notes", below.
database The name of the database you are accessing.

Default None

Usage Notes

The logon definition cannot exceed 512 bytes in length.
USERID can be used when running JSP-based Web reports from the command line.
It is strongly recommended that you do not include the password when using USERID with rwbuilder, rwrun, rwclient, or rwconverter. On many operating systems, this information can become available to any user (for example, with the ps command on UNIX). Instead, use the SSOCONN keyword.

A.3.121 USERSTYLES

Table A-132 indicates which executables can use the USERSTYLES keyword.

Table A-132 Executables That Use USERSTYLES

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	yes	yes	no	yes	yes	no

Description Use USERSTYLES to specify whether an external style sheet file (.css) is associated with a report when generating HTMLCSS output. The style sheets to be applied to the report are specified by the report's Style Sheets property. The value is set to YES by default, and will override any design-time styles included in the Paper Design layout.

See Also:

Oracle Reports Building Reports for more information on inline HTML formatting.

Syntax USERSTYLES=YES|NO

Values

YES Associates your report with one or more external style sheets, as specified by the report's Style Sheets property, when generating HTMLCSS output.
NO Associates your report with the formatting applied during the design of the report. External style sheets will be ignored.

Default YES

Usage Notes

If you specify a value other than YES or NO, Oracle Reports defaults to YES.
If you find that your report is not associated with an external style sheet, ensure the following:
- You have specified the correct path to the style sheet in the Style Sheets property.
- The styles specified by the CSS Class Name and the CSS ID properties are defined in the specified style sheets.
  
  See Also:
  Oracle Reports online Help for more information on the Style Sheets, CSS Class Name, and CSS ID properties.
- USERSTYLES is set to YES.

Example

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.jsp+us
erid=scott/tiger@mydb+desformat=HTMLCSS+DESTYPE=cache+userstyles=yes

A.3.122 VALIDATETAG

Table A-132 indicates which executables can use the VALIDATETAG keyword.

Table A-133 Executables That Use VALIDATETAG

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	yes	no	no	no	no

Description VALIDATETAG specifies whether to enforce JSP tag validation and check for items such as duplicate field identification or malformed attributes when designing or deploying a JSP-based Web report.

See Also:

Section 20.8, "Running the Report" for more information about using VALIDATETAG to tune the performance of your report.

Syntax VALIDATETAG=YES|NO

Values

YES Enforces tag validation and checks for items such as duplicate field identification or malformed attributes.
NO Turns tag validation off.

Default

YES At design time, when running a JSP-based Web report from Reports Builder.
NO At run time, when deploying a JSP-based Web report.

Usage notes

This feature is useful only during the design phase, but not in the production environment. By default, VALIDATETAG=YES in Reports Builder during report design, and VALIDATETAG=NO in OracleAS Reports Services for report deployment. To turn this option on when deploying a report, specify VALIDATETAG=YES in your http request (for example, http://my.server.com/myreport.jsp?VALIDATETAG=YES).
Using VALIDATETAG=YES when deploying a report slows performance.
If you start Reports Builder from the command line with rwbuilder VALIDATETAG=NO, you run the risk of designing a report with invalid JSP tag structure.

A.3.123 WEBSERVER_DEBUG

Table A-134 indicates which executables can use the WEBSERVER_DEBUG keyword.

Table A-134 Executables That Use WEBSERVER_DEBUG

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	yes	no	no	no	no

Description Use WEBSERVER_DEBUG for JSP debugging. It creates the stderr.log and stdout.log files under the docroot/port# directory, and leaves temporary JSP files under docroot/port#/default and log files under docroot/port#/log for your inspection.

Syntax WEBSERVER_DEBUG={YES|NO}

Values

YES Creates debugging files.
NO Does not create debugging files.

Default NO

Usage Notes

Use this keyword only when you're running a job as a JSP.
Relevant keywords include WEBSERVER_DEBUG,WEBSERVER_DOCROOT,WEBSERVER_PORT.

A.3.124 WEBSERVER_DOCROOT

Table A-135 indicates which executables can use the WEBSERVER_DOCROOT keyword.

Table A-135 Executables That Use WEBSERVER_DOCROOT

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	yes	no	no	no	no

Description Use WEBSERVER_DOCROOT to set the Reports Builder document root directory. All files you reference in your JSP, such as images, HTML, and the like, should be relative to this directory. By setting the document root to your working directory, you avoid having to copy these files around.

Syntax WEBSERVER_DOCROOT=REPORTS_TMP/docroot

For example:

WEBSERVER_DOCROOT=c:/temp/docroot

Values The directory to the document root folder in your Oracle Reports temporary folder.

Default None

Usage Notes

Use this keyword only when you're running a job as a JSP.
Relevant keywords include WEBSERVER_DEBUG,WEBSERVER_DOCROOT,WEBSERVER_PORT.

A.3.125 WEBSERVER_PORT

Table A-136 indicates which executables can use the WEBSERVER_PORT keyword.

Table A-136 Executables That Use WEBSERVER_PORT

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
no	no	yes	no	no	no	no

Description Use WEBSERVER_PORT to specify the port number an internal Web server listens to. You can specify a port number (for example, 3002) or a range of port numbers (for example, 3100-3200). If a single port number is specified, Oracle Reports tries to start the internal Web server listening on that port. If that port is in use, it tries to get the next available port. If a range of port numbers is specified, Oracle Reports tries to look for a free port in that range.

Syntax WEBSERVER_PORT=port_num

Values

port_num Any valid port number or range of port numbers.

Default

Port = 3000

Range of ports = 3000-3010.

Usage Notes

Use this keyword only when you're running a job as a JSP.
Relevant keywords include WEBSERVER_DEBUG,WEBSERVER_DOCROOT,WEBSERVER_PORT.

Footnote Legend

Footnote 1: Web server running the CGI scripts
Footnote 2: Web server listener port
Footnote 3: Web server installed on the Windows operating system
Footnote 4: Web server installed on any UNIX operating system
Footnote 5: Secured server only