Skip Headers

Oracle Application Server Reports Services Publishing Reports to the Web
10g (9.0.4)

Part Number B10314-01
Go To Table Of Contents
Contents
Go To Index
Index

Go to previous page Go to next page

A
Command Line Options

This appendix contains descriptions and examples of command line options that can be used with one or more of the following commands: rwclient, rwrun, rwbuilder, rwconverter, rwservlet, rwcgi, and rwserver. Each option description includes a table that indicates which commands can use which option keywords.


Note:

For examples of using command line options in your runtime URL, see Running Report Requests.


The following topics are discussed in this appendix:

A.1 Command Overview

This section provides a brief description of the commands whose keywords/options are discussed in this appendix, including:

Each command description includes a list of the keywords that can be used with it. In the command line, you must use the keyword along with its option. When you enter a command line, you can use the keywords in any order.

A.1.1 rwclient

The rwclient command parses and transfers a command line to the specified (or default) Reports Server. All file names and paths specified in rwclient refer to files and directories on the server machine, except for files specified in the CMDFILE keyword. In this case, the CMDFILE specified will be read and appended to the original command line (of which CMDFILE is a part) before being sent to the Reports Server. The runtime engine will not re-read the CMDFILE.

Keywords used with rwclient

The brackets surrounding each keyword in this list are there to create a separation between keywords and has no other significance.

rwclient [ACCESSIBLE] [ARRAYSIZE] [AUTHID] [AUTOCOMMIT] [BACKGROUND] [BCC] 
[BLANKPAGES] [BUFFERS] [CACHELOB] [CC] [CELLWRAPPER] [CMDFILE][COLLATE] [COPIES] 
[CUSTOMIZE] [DATEFORMATMASK] [DELIMITED_HDR] [DELIMITER] [DESFORMAT] [DESNAME] 
[DESTINATION] [DESTYPE] [DISTRIBUTE] [ENGINERESPONSETIMEOUT] [EXPIRATION] 
[EXPRESS_SERVER] [FROM] [JOBNAME] [JOBTYPE] [LONGCHUNK] [MODE] [MODULE|REPORT] 
[NONBLOCKSQL] [NOTIFYFAILURE][NOTIFYSUCCESS][NUMBERFORMATMASK] [OLAP_CON] 
[ONFAILURE] [ONSUCCESS] [ORIENTATION] [OUTPUTIMAGEFORMAT] [PAGESIZE] [PDFCOMP] 
[PDFEMBED] [READONLY] [RECURSIVE_LOAD] [REPLYTO] [REPORT|MODULE] [ROLE] 
[RUNDEBUG] [SCHEDULE] [SERVER][SQLTRACE][SUBJECT][SUPPRESSLAYOUT][TOLERANCE] 
[TRACEFILE] [TRACEMODE] [TRACEOPTS] [USERID]

Examples

Example 1:

Running a paper report to a browser (cache)

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb DESFORMAT=pdf 
DESTYPE=cache
Example 2:

Sending a 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 a report output to a printer

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

Sending a report output via 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 a 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 a 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 an 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 a 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=test.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 the traceopts enabled

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

A.1.2 rwrun

The rwrun command runs a report using the OracleAS Reports Services in-process server. When you run a .rep file, the PL/SQL is already compiled and will not be recompiled. If you are running an .rdf file, the PL/SQL is automatically recompiled, if necessary. It becomes necessary if the report wasn't compiled and saved from Reports Builder or the platform or version on which you were running the report is incompatible with the platform on which it was last compiled and saved.

Keywords used with rwrun

The brackets surrounding each keyword in this list are there to create a separation between keywords and has no other significance.

rwrun [ACCESSIBLE] [ARRAYSIZE] [AUTHID] [AUTOCOMMIT] [BCC] [BLANKPAGES] 
[BUFFERS] [CACHELOB] [CC] [CELLWRAPPER] [CMDFILE] [COLLATE] [COPIES] [CUSTOMIZE] 
[DATEFORMATMASK] [DELIMITED_HDR] [DELIMITER] [DESFORMAT] [DESNAME] [DESTINATION] 
[DESTYPE] [DISTRIBUTE] [EXPRESS_SERVER] [FROM] [LONGCHUNK] [MODE] 
[MODULE|REPORT] [NONBLOCKSQL] [NOTIFYFAILURE][NOTIFYSUCCESS][OLAP_CON] 
[ONFAILURE] [ONSUCCESS] [ORIENTATION] [OUTPUTIMAGEFORMAT] [PAGESIZE] 
[PAGESTREAM] [PDFCOMP] [PDFEMBED] [PRINTJOB] [READONLY] [RECURSIVE_LOAD] 
[REPLYTO] [REPORT|MODULE] [ROLE] [RUNDEBUG] [SAVE_RDF] 
[SQLTRACE][SUBJECT][SUPPRESSLAYOUT][TRACEFILE] [TRACEMODE] [TRACEOPTS] [USERID]

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:

Running a paper report to a browser (cache)

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf destype=cache 
Example 3: Sending report output to a file
rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf DESTYPE=file 
DESNAME=c:\mydir\test.pdf
Example 4:

Sending a report output to a printer

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

Sending a report output via 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 6:

Sending a 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 7:

Sending a 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 
Example 8:

Sending an XML PDS report output to a file

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

Sending a 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 10:

Distributing a report output to multiple destinations

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

Using a secured Reports Server

rwrun 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

rwrun 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 with the traceopts enabled

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

A.1.3 rwbuilder

The rwbuilder command invokes Reports Builder. When you include a REPORT|MODULE keyword with the rwbuilder command at the command prompt, then press Enter, 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.

Keywords used with rwbuilder

The brackets surrounding each keyword in this list are there to create a separation between keywords and has no other significance.

rwbuilder [ACCESSIBLE] [ARRAYSIZE] [AUTOCOMMIT] [BLANKPAGES] [BUFFERS] 
[CACHELOB] [CMDFILE] [EXPRESS_SERVER] [LONGCHUNK] [MODULE|REPORT] [NONBLOCKSQL] 
[OLAP_CON] [ONFAILURE] [ONSUCCESS] [OUTPUTIMAGEFORMAT] [PAGESIZE] [PRINTJOB] 
[READONLY] [REPORT|MODULE] [RUNDEBUG] [SAVE_RDF][SQLTRACE] [SUPPRESSLAYOUT] 
[TRACEFILE] [TRACEMODE] [TRACEOPTS] [USERID] [WEBSERVER_DEBUG] [WEBSERVER_
DOCROOT] [WEBSERVER_PORT]

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

A.1.4 rwconverter

The rwconverter command 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:

In some cases, rwconverter will automatically compile 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:

In all other situations, you must compile the report's PL/SQL yourself (e.g., 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.


Keywords used with rwconverter

The brackets surrounding each keyword in this list are there to create a separation between keywords and has no other significance.

rwconverter [BATCH] [CMDFILE] [CUSTOMIZE] [DEST] [DTYPE] [DUNIT] [FORMSIZE] 
[NOTIFYFAILURE] [OVERWRITE] [PAGESIZE] [SOURCE] [STYPE] [USERID] [P_OWNER] [P_
SERVERS] [P_NAME] [P_DESCRIPTION] [P_PRIVILEGE] [P_AVAILABILITY] [P_TYPES] [P_
FORMATS] [P_PRINTERS] [P_PFORMTEMPLATE] [P_TRIGGER] [RECURSIVE_LOAD][UPGRADE_
PLSQL]

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

A.1.5 rwservlet

rwservlet translates and delivers information between either a Web server or a J2EE Container (for example, OC4J) and the Reports Server, enabling 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 the rwservlet command to run a JSP, you can use all keywords applicable to rwservlet. For more information on running a JSP with rwservlet, see Running Report Requests.


Keywords used with rwservlet

The brackets surrounding each keyword in this list are there to create a separation between keywords and has no other significance.

rwservlet [ACCESSIBLE] [ARRAYSIZE] [AUTHID] [AUTOCOMMIT] [BACKGROUND][BCC] 
[BLANKPAGES] [BUFFERS] [CACHELOB] [CC] [CELLWRAPPER] [CMDKEY] [CONTENTAREA*] 
[COLLATE] [COPIES] [CUSTOMIZE] [DATEFORMATMASK] [DELAUTH] [DELIMITED_HDR] 
[DELIMITER] [DESFORMAT] [DESNAME] [DESTINATION] [DESTYPE] [DISTRIBUTE] 
[ENGINERESPONSETIMEOUT] [EXPIRATION] [EXPIREDAYS] [EXPRESS_SERVER] [FROM] 
[GETJOBID] [GETSERVERINFO] [HELP] [ITEMTITLE] [JOBNAME] [JOBTYPE] [KILLJOBID] 
[LONGCHUNK] [MIMETYPE] [MODE] [MODULE|REPORT] [NONBLOCKSQL] [NOTIFYFAILURE] 
[NOTIFYSUCCESS] [OLAP_CON] [ONFAILURE] [ONSUCCESS] [ORIENTATION] [OUTPUTFOLDER*] 
[OUTPUTIMAGEFORMAT] [OUTPUTPAGE] [PAGEGROUP] [PAGESIZE] [PAGESTREAM] [PARAMFORM] 
[PARSEQUERY] [PDFCOMP] [PDFEMBED] [READONLY] [RECURSIVE_LOAD] [REPLACEITEM] 
[REPLYTO] [REPORT|MODULE] [ROLE] [RUNDEBUG] [SCHEDULE] [SERVER] [SHOWAUTH] 
[SHOWENV] [SHOWMAP][SHOWJOBID] [SHOWJOBS] [SHOWMYJOBS] 
[SITENAME*][SQLTRACE][STATUSFORMAT] [STATUSFOLDER*] [STATUSPAGE] [SSOCONN] 
[SUBJECT][SUPPRESSLAYOUT][TOLERANCE] [TRACEMODE] [TRACEOPTS] [URLPARAMETER] 
[USERID]

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


Note:

The following keywords are commands rather than keyword-value pairs, i.e., commands are entered by themselves without a corresponding value: SHOWENV, SHOWJOBS, SHOWMAP, SHOWMYJOBS, KILLJOBID, PARSEQUERY, DELAUTH, GETJOBID, and GETSERVERINFO.


Examples

http://myiasFoot 1.mycomp.com:7779Foot 2/reports/rwservlet?server=myrepserver+report=myrep
o.rdf+desname=sample.pdf+desformat=pdf+destype=file

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserver+authidFoot 3=myrepu
ser/myreppassword+report=myrepo.rdf+desname=sample.pdf+desformat=pdf+destype=fil
e
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 a 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 a 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 a report output via e-mail

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@c
omp.com"+CC="emp3@comp.com"+BCC="mgr@comp.com"+REPLYTO="me@comp.com"+FROM=me@com
p.com"
Example 5:

Sending a report output to WebDAV (any WebDAV server or OracleAS Portal WebDAV)

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=htmlcss+DESTYPE=webdav+DESNAME="http://myusern
ame:mypassword@mywebdavserv.com/mydir/test.html"
Example 6:

Sending a report output to OracleAS Portal

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+destype=oracleportal+desformat=PDF+PAGEGROUP=mypagegrp+O
UTPUTPAGE=reports_output+ITEMTITLE=pushtoportal+STATUSPAGE=result
Example 7:

Sending an XML PDS report output to a file

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

Sending a JDBC PDS report output to a file

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=myjdbcpds
test.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

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.rd
f+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=myadm
in/myadmin
Example 12:

Using a key file

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

where

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

or

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

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

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=yes
Example 14:

Running a report with e-mail notification

http://myias.mycomp.com:7779/rwservlet?server=myrepserver+report=test.rdf+userid
=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+userid
=scott/tiger@mydb+destype=file+desformat=pdf+desname=test.pdf+JOBTYPE=rwurl+URLP
ARAMETER="http://www.oracle.com"
Example 16:

Running a report with the traceopts 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+TRACEMODE=trace_replace

A.1.6 rwcgi

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


Note:

With Oracle Reports 10g, rwcgi is deprecated (maintained only for backward compatibility); instead, use JSPs or servlets (rwservlet).


Keywords used with rwcgi

The brackets surrounding each keyword in this list are there to create a separation between keywords and has no other significance.

rwcgi [ACCESSIBLE] [ARRAYSIZE] [AUTHID] [AUTOCOMMIT] [BACKGROUND][BCC] 
[BLANKPAGES] [BUFFERS] [CACHELOB] [CC] [CELLWRAPPER] [COLLATE] [CONTENTAREA*] 
[COPIES] [CUSTOMIZE] [DATEFORMATMASK] [DELAUTH][DELIMITED_HDR] [DELIMITER] 
[DESFORMAT] [DESNAME] [DESTINATION] [DESTYPE] [DISTRIBUTE] 
[ENGINERESPONSETIMEOUT] [EXPIRATION] [EXPIREDAYS] [EXPRESS_SERVER] 
[FROM][GETJOBID][ITEMTITLE] [JOBNAME] [JOBTYPE][KILLJOBID][LONGCHUNK] [MIMETYPE] 
[MODE] [MODULE|REPORT] [NONBLOCKSQL] [NOTIFYFAILURE] [NOTIFYSUCCESS] [OLAP_CON] 
[ONFAILURE] [ONSUCCESS] [ORIENTATION] [OUTPUTFOLDER*] [OUTPUTIMAGEFORMAT] 
[OUTPUTPAGE] [PAGEGROUP] [PAGESIZE] [PAGESTREAM] 
[PARAMFORM][PARSEQUERY][PDFCOMP][PDFEMBED] [READONLY] [RECURSIVE_LOAD] 
[REPLACEITEM] [REPLYTO] [REPORT|MODULE] [ROLE][RUNDEBUG][SCHEDULE][SERVER] 
[SHOWENV][SHOWMAP][SHOWJOBID][SHOWJOBS] [SHOWMYJOBS] [SHOWAUTH] [SITENAME*] 
[SQLTRACE] [STATUSFOLDER*] [STATUSPAGE] [SUBJECT][SUPPRESSLAYOUT][TOLERANCE] 
[TRACEMODE] [TRACEOPTS] [USERID]

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

Examples

http://mywebserver.comFoot 4:7779Foot 5/cgi-bin/rwcgi.exeFoot 6?server=myrepserver+report=myrepo
.rdf+desname=sample.pdf+desformat=pdf+destype=file

http://mywebserver.com:7779/cgi-bin/rwcgi.shFoot 7?server=myrepserver+authidFoot 8=myrepus
er/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+u
serid=scott/tiger@mydb+DESFORMAT=pdf+DESTYPE=cache
Example 2:

Sending a report output to a file

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

Sending a report output to a printer

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

Sending a report output via e-mail

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+u
serid=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+u
serid=scott/tiger@mydb+desformat=htmlcss+DESTYPE=webdav+DESNAME="http://myuserna
me:mypassword@mywebdavserv.com/mydir/test.html"
Example 6:

Sending a report output to OracleAS Portal

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+report=test.rdf+u
serid=scott/tiger@mydb+DESTYPE=oracleportal+desformat=PDF+PAGEGROUP=mypagegrp+OU
TPUTPAGE=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=myxmlpdste
st.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=myjdbcpdst
est.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+u
serid=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+u
serid=scott/tiger@mydb+desformat=pdf+destype=file+desname=test.pdf+AUTHID=myadmi
n/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)

or

http://mywebserver.com:7779/cgi-bin/rwcgi.exe?server=myrepserv+userparam=12+CMDK
EY=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.rdf
+userid=scott/tiger@mydb+destype=file+desformat=pdf+desname=test.pdf+NOTIFYSUCCE
SS="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.rdf
+userid=scott/tiger@mydb+destype=file+desformat=pdf+desname=test.pdf+JOBTYPE=rwu
rl+URLPARAMETER="http://www.oracle.com"
Example 16:

Running a report with the traceopts 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=t
race_prf+TRACEMODE=trace_replace

A.1.7 rwserver

The rwserver command invokes the Reports Server. The 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 custom or 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.

Keywords used with rwserver

The brackets surrounding each keyword in this list are there to create a separation between keywords and has no other significance.

rwserver[AUTHID] [AUTOSTART] [BATCH] [SERVER] [SHUTDOWN] [TRACEOPTS] [INSTALL] 
[UNINSTALL][JVMOPTIONS]

Example: rwserver -install myrepserver batch=yes autostart=yes

A.2 Command Line Syntax

Following is the syntax for a command line, where keyword=value is a valid command line option:

rwclient REPORT|MODULE=runfile USERID=username/password@database
[ [keyword=]value|(value1, value2, ...) ] SERVER=server_name

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

A.3 General Usage Notes

A.4 Command Line Keywords

A.4.1 ACCESSIBLE

Table A-1 indicates which commands can use the ACCESSIBLE keyword.

Table A-1 Commands that can 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

Default

NO

A.4.2 ARRAYSIZE

Table A-2 indicates which commands can use the ARRAYSIZE keyword.

Table A-2 Commands that can 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 Oracle9i 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.4.3 AUTHID

Table A-3 indicates which commands can use the AUTHID keyword.

Table A-3 Commands that can use AUTHID
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

yes

yes

no

no

yes

yes

yes

Description

Use AUTHID to specify the user name and the 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.

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.

Default

None

Usage Notes

A.4.4 AUTOCOMMIT

Table A-4 indicates which commands can use the AUTOCOMMIT keyword.

Table A-4 Commands that can 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

Default
Usage Notes

AUTOCOMMIT can be used when running JSP-based Web reports from the command line.

A.4.5 AUTOSTART

Table A-5 indicates which commands can use the AUTOSTART keyword.

Table A-5 Commands that can use AUTOSTART
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

no

no

no

no

no

no

yes

Description

Use AUTOSTART to specify that the Reports Server will automatically start after initial installation and after a reboot, without requiring a user logon.

Syntax

AUTOSTART={YES|NO}

Values

Default

NO

Usage Notes

The AUTOSTART keyword is only recognized on Microsoft Windows platforms.

A.4.6 BACKGROUND

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

Table A-6 Commands that can 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

Default

NO

Usage Notes

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

A.4.7 BATCH

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

Table A-7 Commands that can use BATCH
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

no

no

no

yes

no

no

yes

Description

For all relevant commands, the BATCH option tells the server to run in no-UI mode. How it is used across commands is similar in that no UI is produced 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 comes up while it is running.

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

Syntax

BATCH={YES|NO}

Values

Default

NO

Usage Notes

A.4.8 BCC

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

Table A-8 Commands that can 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

A.4.9 BLANKPAGES

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

Table A-9 Commands that can 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

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.4.10 BUFFERS

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

Table A-10 Commands that can 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, e.g., a comma or a decimal point). For some operating systems, the upper limit might be lower.

Default

640

Usage Notes

A.4.11 CACHELOB

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

Table A-11 Commands that can 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

Default

YES

Usage Notes

A.4.12 CC

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

Table A-12 Commands that can 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

A.4.13 CELLWRAPPER

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

Table A-13 Commands that can 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

A.4.14 CMDFILE

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

Table A-17 Commands that can 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

A.4.15 CMDKEY

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

Table A-18 Commands that can 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://yourwebserver/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

A.4.16 COLLATE

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

Table A-19 Commands that can 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

Default

YES

A.4.17 CONTENTAREA

Table A-20 indicates which commands can use the CONTENTAREA keyword.

Table A-20 Commands that can 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 Release 2, use PAGEGROUP.

Syntax

CONTENTAREA=name

Values

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

Default

None

Usage Notes

A.4.18 COPIES

Table A-21 indicates which commands can use the COPIES keyword.

Table A-21 Commands that can 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, e.g., 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

A.4.19 CUSTOMIZE

Table A-22 indicates which commands can use the CUSTOMIZE keyword.

Table A-22 Commands that can 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 for the engine element).


Note:

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


Default

None

Usage Notes

A.4.20 DATEFORMATMASK

Table A-23 indicates which commands can use the DATEFORMATMASK keyword.

Table A-23 Commands that can 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

A.4.21 DELAUTH

Table A-24 indicates which commands can use the DELAUTH keyword.

Table A-24 Commands that can 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://yourwebserver/reports/rwservlet/delauth[?][server=servername][&authid=use
rname/password]
Values

See Syntax.

Default

None

Usage Notes

A.4.22 DELIMITED_HDR

Table A-25 indicates which commands can use the DELIMITED_HDR keyword.

Table A-25 Commands that can 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

Default

YES

Usage Notes

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

A.4.23 DELIMITER

Table A-26 indicates which commands can use the DELIMITER keyword.

Table A-26 Commands that can 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:

a
Table A-27 Valid Values - General
Values Description

,

A comma separates each cell

.

A period separates each cell

Any of these reserved values:

Table A-28 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-29 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.4.24 DESFORMAT

Table A-30 indicates which commands can use the DESFORMAT keyword.

Table A-30 Commands that can use DESFORMAT
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

yes

yes

no

no

yes

yes

no

Description

Use DESFORMAT to specify the format for the job output. Use DESFORMAT to specify the printer driver to be used when DESTYPE is FILE and DESNAME=filename.

Syntax

DESFORMAT=desformat

Values

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

Table A-31 Valid values for DESFORMAT
Value Description

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 (via the DELIMITER keyword), the default delimiter is a TAB. See Usage Notes.

DELIMITEDDATA

Provides the same functionality as DELIMITED, and is used when you have problems running large volume reports with DESFORMAT=DELIMITED. See Usage Notes.

HTML

This report output is sent to a file that is in HTML format.

HTMLCSS

This report output is sent to a file that includes style sheet extensions.

PDF

This 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.

POSTSCRIPT

This report output is sent to a file that is in PostScript format.

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.

If MODE=CHARACTER, this is the character-mode 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.

XML

This 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 parameter (the Initial Value was defined in Reports Builder at design time). When you run a report via 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 using the drop down list, then Reports Builder defaults to PostScript.

Usage Notes

A.4.25 DESNAME

Table A-32 indicates which commands can use the DESNAME keyword.

Table A-32 Commands that can 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, OracleAS Portal, 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 OraclePortal, 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

A.4.26 DEST

Table A-33 indicates which commands can use the DEST keyword.

Table A-33 Commands that can 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 (e.g., (qanda,text,dmast)).

Default

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

Usage Notes

A.4.27 DESTINATION

Table A-34 indicates which commands can use the DESTINATION keyword.

Table A-34 Commands that can 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.


Note:

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


A.4.28 DESTYPE

Table A-35 indicates which commands can use the DESTYPE keyword.

Table A-35 Commands that can 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. If you have created your own pluggable destination via 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-36 lists and describes the valid values for the DESTYPE keyword.

Table A-36 Valid values for the DESTYPE keyword
Value Description

CACHE

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.

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 rwbuilder.conf must include the pluginParam mailServer with the outgoing mail server name. This applies in both Windows and Solaris environment

ORACLEPORTAL

Valid for rwservlet, rwcgi, and rwclient.

Sends the output to OracleAS Portal. Relevant keywords include CONTENTAREA*, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER*, OUTPUTPAGE, PAGEGROUP, REPLACEITEM, SCHEDULE, SITENAME*,STATUSFOLDER*,STATUSPAGE.

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

FTPFoot 1

Valid for rwservlet,rwclient,rwcgi,and rwrun. Sends the output to the specified FTP server.

WEBDAVFoot 2

Valid for rwservlet,rwclient,rwcgi,and rwrun. Sends the output to the specified WebDAV URL so that the report can be published directly.

name_of_pluggable_destination

If you have created your own pluggable destination via the Oracle Reports Destination API, this is what you use to call the destination you created.

1 For more information about this pluggable destination, see the Oracle Reports Plugin Exchange on OTN (http://otn.oracle.com/products/reports/pluginxchange/content.html)

2 For more information about this pluggable destination, see the Oracle Reports Plugin Exchange on OTN (http://otn.oracle.com/products/reports/pluginxchange/content.html)

Default

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

Usage Notes

A.4.29 DISTRIBUTE

Table A-37 indicates which commands can use the DISTRIBUTE keyword.

Table A-37 Commands that can 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

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 about creating advanced distributions, see Creating Advanced Distributions.


A.4.30 DTYPE

Table A-38 indicates which commands can use the DTYPE keyword.

Table A-38 Commands that can 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:

Default

REPFILE

Usage Notes

A.4.31 DUNIT

Table A-39 indicates which commands can use the DUNIT keyword.

Table A-39 Commands that can 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

Default

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

A.4.32 ENGINERESPONSETIMEOUT

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

Table A-40 Commands that can 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 (e.g., 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 engine for further information about the engine element.

Syntax

ENGINERESPONSETIMEOUT=number

Values

number A number of minutes (e.g., 5).

Default

None

A.4.33 EXPIRATION

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

Table A-41 Commands that can 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 Reusing Report Output from Cache for more information on duplicate job detection.

Syntax

EXPIRATION=time_string

Values

time_string Is in one of two formats:

Default

None

A.4.34 EXPIREDAYS

Table A-42 indicates which commands can use the EXPIREDAYS keyword.

Table A-42 Commands that can 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 Oracle9iAS Portal Release 1 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

Default

None

Usage Notes

A.4.35 EXPRESS_SERVER

Table A-43 indicates which commands can use the EXPRESS_SERVER keyword.

Table A-43 Commands that can 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=ramconn"

Values

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

Table A-44 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.

user

The user ID to log on to the Express Server.

password

The password for the user ID.

ramuser

The user ID to log into the RDBMS.

rampassword

The password for the RDBMS.

ramexpressid

The Oracle Sales Analyzer database user ID. This is required for Oracle Sales Analyzer databases only.

ramserverscript

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.

rammasterdb

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.

ramconnecttype

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-45 describes the parameters and their settings:

Table A-45 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 NT 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

A.4.36 FORMSIZE

Table A-46 indicates which commands can use the FORMSIZE keyword.

Table A-46 Commands that can 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

A.4.37 FROM

Table A-47 indicates which commands can use the FROM keyword.

Table A-47 Commands that can 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, and SUBJECT. Note that DESNAME is used to specify the main recipient(s) of the e-mail.

A.4.38 GETJOBID

Table A-48 indicates which commands can use the GETJOBID keyword.

Table A-48 Commands that can 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://yourwebserver/reports/rwservlet/getjobidn[?][server=server_
name][&authid=username/password]
Values

See Syntax.

Default

None

Usage Notes

A.4.39 GETSERVERINFO

Table A-49 indicates which commands can use the GETSERVERINFO keyword.

Table A-49 Commands that can 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 via &statusformat.

Syntax
http://yourwebserver/reports/rwservlet/getserverinfo[?][server=server_
name][&authid=username/password][&statusformat={html|xml}]
Values

See Syntax.

Default

None

Usage Notes

A.4.40 HELP

Table A-50 indicates which commands can use the HELP keyword.

Table A-50 Commands that can 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://yourwebserver/reports/rwservlet/help?command=keyword
Syntax

http://yourwebserver/reports/rwservlet/help

or

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

Values

See Syntax.

Default

None

A.4.41 INSTALL

Table A-51 indicates which commands can use the INSTALL keyword

Table A-51 Commands that can use INSTALL
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

no

no

no

no

no

no

yes

Description

Use INSTALL to configure an instance of the Reports Server on Microsoft Windows as a service. This keyword does not work on UNIX platforms.

Syntax

INSTALL reports_server_name

Values

reports_server_name A valid name for the Reports Server instance.

Default

None

Usage Notes

A.4.42 ITEMTITLE

Table A-52 indicates which commands can use the ITEMTITLE keyword.

Table A-52 Commands that can use ITEMTITLE
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

yes

yes

no

no

yes

yes

no

Description

Use ITEMTITLE to specify the display name Oracle9iAS Portal Release 1 should use for Oracle Reports output. The name will display in Oracle9iAS Portal Release 1 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

A.4.43 JOBNAME

Table A-53 indicates which commands can use the JOBNAME keyword.

Table A-53 Commands that can 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

Any job name.

Default

None

Usage Notes

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

A.4.44 JOBTYPE

Table A-54 indicates which commands can use the JOBTYPE keyword.

Table A-54 Commands that can 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 the Reports Server has an engine to process it.

Syntax

JOBTYPE=jobtype

Values

jobtype A job for which the Reports Server has an engine.

Default

REPORT

A.4.45 JVMOPTIONS

Table A-55 indicates which commands can use the JVMOPTIONS keyword.

Table A-55 Commands that can use JVMOPTIONS
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

no

yes

yes

yes

no

no

yes

Description:

Use JVMOPTIONS to set options for either Reports Runtime, Reports Builder, Reports Converter, or Reports Server's Java Virtual Machine (JVM). For example, you could use the following command line to start the Reports Server with a 512Mb heap space:

rwserver server= servername jvmoptions=-Xmx512M

You could also use the following command line to start Reports Builder with a 512Mb heap space:

rwbuilder jvmoptions=-Xmx512M

Multiple options can be passed, in which case the options must be enclosed in quotes:

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

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

Default
-Xmx256M


Note:

The value set using the jvmoptions keyword will override the value in the REPORTS_JVM_OPTIONS environment variable, if set.


A.4.46 KILLJOBID

Table A-56 indicates which commands can use the KILLJOBID keyword.

Table A-56 Commands that can 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://yourwebserver/reports/rwservlet/killjobidn[?][server=server_
name][&authid=username/password][&statusformat={html|xml|xmldtd}]
Values

See Syntax.

Default

None

Usage Notes

A.4.47 LONGCHUNK

Table A-57 indicates which commands can use the LONGCHUNK keyword.

Table A-57 Commands that can 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

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

Default

10

Usage Notes

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

A.4.48 MIMETYPE

Table A-58 indicates which commands can use the MIMETYPE keyword.

Table A-58 Commands that can 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.4.49 MODE

Table A-59 indicates which commands can use the MODE keyword.

Table A-59 Commands that can 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

The following values apply:

Default

DEFAULT

A.4.50 MODULE|REPORT

Table A-60 indicates which commands can use the MODULE|REPORT keyword.

Table A-60 Commands that can 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

A.4.51 NONBLOCKSQL

Table A-61 indicates which commands can use the NONBLOCKSQL keyword.

Table A-61 Commands that can 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

Default

YES

Usage Notes

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

A.4.52 NOTIFYFAILURE

Table A-62 indicates which commands can use the NOTIFYFAILURE keyword.

Table A-62 Commands that can 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

A.4.53 NOTIFYSUCCESS

Table A-63 indicates which commands can use the NOTIFYSUCCESS keyword.

Table A-63 Commands that can 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

A.4.54 NUMBERFORMATMASK

Table A-64 indicates which commands can use the NUMBERFORMATMASK keyword.

Table A-64 Commands that can 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

A.4.55 OLAP_CON

Table A-65 indicates which commands can user the OLAP_CON keyword.

Table A-65 Commands that can use OLAP_CON
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

yes

yes

yes

no

yes

yes

no

Description

OLAP_CON specifies 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:

For example:

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

A.4.56 ONFAILURE

Table A-66 indicates which commands can use the ONFAILURE keyword.

Table A-66 Commands that can 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

Default

Usage Notes

A.4.57 ONSUCCESS

Table A-67 indicates which commands can use the ONSUCCESS keyword.

Table A-67 Commands that can 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

Default

Usage Notes

A.4.58 ORIENTATION

Table A-68 indicates which commands can use the ORIENTATION keyword.

Table A-68 Commands that can use ORIENTATION
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

yes

yes

no

no

yes

yes

no

Description

ORIENTATION controls 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

A.4.59 OUTPUTFOLDER

Table A-69 indicates which commands can use the OUTPUTFOLDER keyword.

Table A-69 Commands that can 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 OracleAS Portal folder to push Oracle Reports output. This keyword is maintained for backward compatibility with Oracle WebDB Release 2.2 and Oracle9iAS Portal Release 1. Beginning with OracleAS Portal 10g (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

A.4.60 OUTPUTIMAGEFORMAT

Table A-70 indicates which commands can use the OUTPUTIMAGEFORMAT keyword.

Table A-70 Commands that can use OUTPUTIMAGEFORMAT
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

yes

yes

yes

no

yes

yes

no

Description

Use OUTPUTIMAGEFORMAT to choose the format for images in your report output.

Syntax

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

Values

Usage Notes

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.4.61 OUTPUTPAGE

Table A-71 indicates which commands can use the OUTPUTPAGE keyword.

Table A-71 Commands that can 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 Oracle Reports page to push a report output information to. 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 Oracle9iAS Portal Release 1.

Default

Oracle_Reports_Output

Usage Notes

A.4.62 OVERWRITE

Table A-72 indicates which commands can use the OVERWRITE keyword.

Table A-72 Commands that can 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

Default

NO

A.4.63 P_AVAILABILITY

Table A-73 indicates which commands can use the P_AVAILABILITY keyword.

Table A-73 Commands that can 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.4.64 P_DESCRIPTION

Table A-74 indicates which commands can use the P_DESCRIPTION keyword.

Table A-74 Commands that can 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.4.65 P_FORMATS

Table A-75 indicates which commands can use the P_FORMATS keyword.

Table A-75 Commands that can 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 (e.g., HTML), or a list of valid destination formats enclosed by parentheses with a comma separating the names (e.g., HTMLCSS,PDF,RTF).

Default

None

A.4.66 P_NAME

Table A-76 indicates which commands can use the P_NAME keyword.

Table A-76 Commands that can 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

A.4.67 P_OWNER

Table A-77 indicates which commands can use the P_OWNER keyword.

Table A-77 Commands that can 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.4.68 P_PFORMTEMPLATE

Table A-78 indicates the commands that can use the P_PFORMTEMPLATE keyword.

Table A-78 Commands that can 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.4.69 P_PRINTERS

Table A-79 indicates the commands that can use the P_PRINTERS keyword.

Table A-79 Commands that can 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 (e.g., PRT1), or a list of valid printers enclosed by parentheses with a comma separating the names (e.g., (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.4.70 P_PRIVILEGE

Table A-80 indicates which commands can use the P_PRIVILEGE keyword.

Table A-80 Commands that can 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 (e.g., SCOTT), or a list of user names or roles enclosed by parentheses with a comma separating the names (e.g., (SCOTT,JABERS,PMARTIN)).

Default

None

A.4.71 P_SERVERS

Table A-81 indicates which commands can use the P_SERVERS keyword.

Table A-81 Commands that can 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 (e.g., repserver), or a list of valid Reports Server TNS names enclosed by parentheses with a comma separating the names (e.g., repserver, acct_server, sales_server).

Default

None

Usage Notes

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

A.4.72 P_TRIGGER

Table A-82 indicates the commands that can use the P_TRIGGERS keyword.

Table A-82 Commands that can 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.4.73 P_TYPES

Table A-83 indicates which commands can use the P_TYPES keyword.

Table A-83 Commands that can 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 (e.g., CACHE), or a list of valid destination types enclosed by parentheses with a comma separating the names (e.g., CACHE,MAIL,PRINTER).

Default

None

A.4.74 PAGEGROUP

Table A-84 indicates which commands can use the PAGEGROUP keyword.

Table A-84 Commands that can 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 Oracle9iAS Portal Release 1 page group to which report output should be pushed. For backward compatibility with earlier versions, see SITENAME (for Oracle WebDB Release 2.2) and CONTENTAREA (for Oracle9iAS Portal Release 1). The page group must be created in Oracle9iAS Portal Release 1 before you can use this keyword.

Syntax

PAGEGROUP=pagegroup

Values

pagegroup Any valid page group name (internal name) used in Oracle9iAS Portal Release 1.

Default
Usage Notes

A.4.75 PAGESIZE

Table A-85 indicates which commands can use the PAGESIZE keyword.

Table A-85 Commands that can 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

A.4.76 PAGESTREAM

Table A-86 indicates which commands can use the PAGESTREAM keyword.

Table A-86 Commands that can 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:

Syntax

PAGESTREAM={YES|NO}

Values

Default

NO

A.4.77 PARAMFORM

Table A-87 indicates which commands can use the PARAMFORM keyword.

Table A-87 Commands that can 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 via CGI or a servlet. PARAMFORM is used only to supply parameters to paper layout reports, not Web source reports.

Syntax

PARAMFORM=YES|NO|HTML

Values

Default

NO

Usage Notes

A.4.78 PARSEQUERY

Table A-88 indicates which commands can use the PARSEQUERY keyword.

Table A-88 Commands that can 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://yourwebserver/reports/rwservlet/parsequery[?][server=servername][&authid=
username/password]
Values

See Syntax.

Default

None

Usage Notes

A.4.79 PDFCOMP

Table A-89 indicates which commands can use the PDFCOMP keyword.

Table A-89 Commands that can 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

Default

6

A.4.80 PDFEMBED

Table A-90 indicates which commands can use the PDFEMBED keyword.

Table A-90 Commands that can 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

Default

YES

A.4.81 PRINTJOB

Table A-91 indicates which commands can use the PRINTJOB keyword.

Table A-91 Commands that can 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

Default

NO

Usage Notes

A.4.82 READONLY

Table A-92 indicates which commands can use the READONLY keyword.

Table A-92 Commands that can 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 Oracle 9i, read consistency is accomplished by a SET TRANSACTION READ ONLY statement.


Note:

Refer to Oracle9i SQL documentation (available on the Oracle Technology Network, (http://otn.oracle.com) 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

A.4.83 RECURSIVE_LOAD

Table A-93 indicates which commands can use the RECURSIVE_LOAD keyword.

Table A-93 Commands that can 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

Default

YES

A.4.84 REPLACEITEM

Table A-94 indicates which commands can use the REPLACEITEM keyword.

Table A-94 Commands that can use REPLACEITEM
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

yes

yes

no

no

yes

yes

no

Description

Use REPLACEITEM to specify that the current report output being pushed to Oracle9iAS Portal Release 1 should replace an earlier version of the same item stored in the same output target.

Syntax

REPLACEITEM={YES|NO}

Values

Default

None

Usage Notes

A.4.85 REPLYTO

Table A-95 indicates which commands can use the REPLYTO keyword.

Table A-95 Commands that can 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.4.86 REPORT|MODULE

See MODULE|REPORT.

A.4.87 ROLE

Table A-96 indicates which commands can use the ROLE keyword.

Table A-96 Commands that can 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

Default

None

Usage Notes

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

A.4.88 RUNDEBUG

Table A-97 indicates which commands can use the RUNDEBUG keyword.

Table A-97 Commands that can 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:

Syntax

RUNDEBUG={YES|NO}

Values

Default

YES

Usage Notes

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

A.4.89 SAVE_RDF

Table A-98 indicates which commands can use the SAVE_RDF keyword.

Table A-98 Commands that can 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

filename.rdf 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.4.90 SCHEDULE

Table A-99 indicates which commands can use the SCHEDULE keyword.

Table A-99 Commands that can 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 (i.e., 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 the string is:

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

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

Table A-100 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.4.91 SERVER

Table A-101 indicates which commands can use the SERVER keyword.

Table A-101 Commands that can 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=servername
Values

The server name or a TNS service entry name if you're using a 6i compatible server.

Default

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

Usage Notes

A.4.92 SHOWAUTH

Table A-102 indicates which commands can use the SHOWAUTH keyword.

Table A-102 Commands that can 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://yourwebserver/reports/rwservlet/showauth[?][server=servername][&authid=us
ername/password]][&nextpage=run report URL][&authtype={s|d}]
Values

See Syntax.

Default

None

Usage Notes

A.4.93 SHOWENV

Table A-103 indicates which commands can use the SHOWENV keyword.

Table A-103 Commands that can 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://yourwebserver/reports/rwservlet/showenv[?][server=servername][&authid=use
rname/password]
Values

See Syntax.

Default

None

Usage Notes

A.4.94 SHOWJOBID

Table A-104 indicates which commands can use the SHOWJOBID keyword.

Table A-104 Commands that can 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://yourwebserver/reports/rwservlet/showjobidn[?][server=server_
name][&authid=username/password][&statusformat={html|xml|xmldtd}]
Values

See Syntax.

Default

None

Usage Notes

A.4.95 SHOWJOBS

Table A-105 indicates which commands can use the SHOWJOBS keyword.

Table A-105 Commands that can 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://yourwebserver/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

A.4.96 SHOWMAP

Table A-106 indicates which commands can use the SHOWMAP keyword.

Table A-106 Commands that can 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://yourwebserver/reports/rwservlet/showmap[?][server=servername][&authid=use
rname/password]
Values

See Syntax.

Default

None

Usage Notes:

A.4.97 SHOWMYJOBS

Table A-107 indicates which commands can use the SHOWMYJOBS keyword.

Table A-107 Commands that can 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://yourwebserver/reports/rwservlet/showmyjobs[?][server=server_
name][&authid=username/password][&statusformat={html|xml|xmldtd}]
Values

See Syntax.

Default

None

Usage Notes

A.4.98 SHUTDOWN

Table A-108 indicates which commands can use the SHUTDOWN keyword.

Table A-108 Commands that can use SHUTDOWN
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

no

no

no

no

no

no

yes

Description

Use SHUTDOWN to shut down a previously running server. You must also use AUTHID to supply a user name and password.

Syntax

SHUTDOWN={NORMAL|IMMEDIATE}

Values

NORMAL or IMMEDIATE

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.4.99 SITENAME

Table A-109 indicates which commands can use the SITENAME keyword.

Table A-109 Commands that can 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 WebDB site to push a report's output to. This keyword is maintained for backward compatibility with Oracle WebDB Release 2.2; for backward compatibility with Oracle9iAS Portal Release 1, see CONTENTAREA. Beginning with OracleAS Portal Release 2, use PAGEGROUP.

Syntax

SITENAME=name

Values

name Any valid site name used in Oracle WebDB Release 2.2.

Default
Usage Notes

A.4.100 SOURCE

Table A-110 indicates which commands can use the SOURCE keyword.

Table A-110 Commands that can 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 (e.g., (qanda, test, dmast)).

Default

None

Usage Notes

A.4.101 SQLTRACE

Table A-111 indicates which commands can use the SQLTRACE keyword.

Table A-111 Commands that can use SQL_TRACE
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

Default

NO

A.4.102 SSOCONN

Table A-112 indicates which commands can use the SSOCONN keyword.

Table A-112 Commands that can 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_str]][,key[/type[/conn_str]]]

For example:

ssoconn=mykey/OracleDB/userid
Values

The following information describes the variable values expressed in the SSOCONN syntax:

Default

None

Usage Notes

A.4.103 STATUSFOLDER

Table A-114 indicates which commands can use the STATUSFOLDER keyword.

Table A-114 Commands that can 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 push status information into. 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 Release 2, 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

A.4.104 STATUSFORMAT

Table A-115 indicates which commands can use the STATUSFORMAT keyword.

Table A-115 Commands that can 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 Reports Server queue status.

Syntax

http://yourwebserver/rwservlet/showjobs?server=server_name&statusformat={html|xml|xmldtd}

Values

Default
Usage Notes

Use STATUSFORMAT in conjunction with the SHOWJOBS and SHOWMYJOBS keywords.

A.4.105 STATUSPAGE

Table A-116 indicates which commands can use the STATUSPAGE keyword.

Table A-116 Commands that can 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 Oracle9iAS Portal Release 1 page to push job status information into. If this is omitted, a new page is created called Oracle_Reports_Status. For backward compatibility with earlier versions (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 Oracle9iAS Portal Release 1.

Default

Oracle_Reports_Status

Usage Notes

A.4.106 STYPE

Table A-117 indicates which commands can use the STYPE keyword.

Table A-117 Commands that can 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:

Default

RDFFILE

Usage Notes

When DTYPE=REGISTER, choose RDDFILE,REXFILE,XML, or JSPFILE for STYPE.

A.4.107 SUBJECT

Table A-118 indicates which commands can use the SUBJECT keyword.

Table A-118 Commands that can 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=any text

Values

Any text.

Default

None

Usage Notes

A.4.108 SUPPRESSLAYOUT

Table A-119 indicates which commands can use the SUPPRESSLAYOUT keyword.

Table A-119 Commands that can 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 via 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

Default

NO

A.4.109 TOLERANCE

Table A-120 indicates which commands can be used with the TOLERANCE keyword.

Table A-120 Commands that can 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:

Default

None

Usage Notes

A.4.110 TRACEFILE

Table A-121 indicates which commands can use the TRACEFILE keyword.

Table A-121 Commands that can use TRACEFILE
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

yes

yes

yes

no

no

no

no

Description

TRACEFILE is the name of the file in which trace information is logged.


Note:

See Report Trace for additional information about how tracing works with Oracle Reports.


Syntax

TRACEFILE=tracefile

Values

Any valid file name.

Default

None

Usage Notes

A.4.111 TRACEMODE

Table A-122 indicates which commands can use the TRACEMODE keyword.

Table A-122 Commands that can use TRACEMODE
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

yes

yes

yes

no

yes

yes

no

Description

TRACEMODE specifies whether to append new trace information to existing information in the file specified by TRACEFILE, or overwrite the entire file.

Syntax

TRACEMODE={TRACE_APPEND|TRACE_REPLACE}

Values

Default

TRACE_APPEND

Usage Notes

A.4.112 TRACEOPTS

Table A-123 indicates which commands can use the TRACEOPTS keyword.

Table A-123 Commands that can use TRACEOPTS
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

yes

yes

yes

no

yes

yes

yes

Description

TRACEOPTS indicates the tracing information that you want to be logged in the trace file when you run the report.

Syntax

TRACEOPTS={TRACE_ALL|TRACE_APP|TRACE_BRK|TRACE_DBG|TRACE_DST|TRACE_ERR|TRACE_EXC|TRACE_INF|TRACE_LOG|TRACE_PLS|TRACE_PRF|TRACE_SQL|TRACE_STA|TRACE_TMS|TRACE_WRN}

Values

The following values apply:

Default

TRACE_ALL

Usage Notes

A.4.113 UNINSTALL

Table A-124 indicates which commands can use the UNINSTALL keyword.

Table A-124 Commands that can use UNINSTALL
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

no

no

no

no

no

no

yes

Description

Use UNINSTALL to remove an instance of the Reports Server from Microsoft Windows. This process removes the Reports Server service from the system. This keyword is ignored on UNIX.

Syntax

UNINSTALL reports_server_name

Values

reports_server_name The name of an existing Reports Server instance

Default

None

Usage Notes

If you use BATCH=YES with INSTALL, then none of the prompts and dialogs that normally display during the removal process will appear.

A.4.114 UPGRADE_PLSQL

Table A-121 indicates which commands can use the UPGRADE_PLSQL keyword.

Table A-125 Commands that can 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 version required by Oracle Reports Developer.

Syntax

UPGRADE_PLSQL=[YES|NO]

Values

Default

YES

A.4.115 URLPARAMETER

Table A-126 indicates which commands can use the URLPARAMETER keyword.

Table A-126 Commands that can 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://webserver_name/pagename.html

Values

Any valid URL.

Default

None

Usage Notes

This keyword is relevant when the jobType parameter of the job element in the Reports Server configuration file is rwurl, and a URL engine is in place.

A.4.116 USERID

Table A-127 indicates which commands can use the USERID keyword.

Table A-127 Commands that can use USERID
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

yes

yes

yes

yes

yes

yes

no

Description

Use USERID only if you're not using Single Sign-On. Use USERID 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 Running Report Requests.


Syntax

userid=username[/password][@database]

Values

username Username assigned by the database administrator.

password Password for the username.

database The name of the database you are accessing.

Default

None

Usage Notes

A.4.117 WEBSERVER_DEBUG

Table A-128 indicates which commands can use the WEBSERVER_DEBUG keyword.

Table A-128 Commands that can 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 Create debugging files.

NO Do not create debugging files.

Default

NO

Usage Notes

A.4.118 WEBSERVER_DOCROOT

Table A-129 indicates which commands can use the WEBSERVER_DOCROOT keyword.

Table A-129 Commands that can 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

A.4.119 WEBSERVER_PORT

Table A-130 indicates which commands can use the WEBSERVER_PORT keyword.

Table A-130 Commands that can 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 (e.g., 3002) or a range of port numbers (e.g., 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


1 Oracle Application Server instance

2 Port where the Reports servlet is running

3 Secured server only

4 Web server running the CGI scripts

5 Web server listener port

6 Web server installed on the Windows operating system

7 Web server installed on any UNIX operating system

8 Secured server only


Go to previous page Go to next page
Oracle
Copyright © 2003 Oracle Corporation.

All Rights Reserved.
Go To Table Of Contents
Contents
Go To Index
Index