A
Command Line Arguments

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

Note:

For examples of using command line arguments in your runtime URL, see Chapter 8, "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/arguments 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 argument. 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.

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] [BCC] [BLANKPAGES] 
[BUFFERS] [CACHELOB] [CC] [CELLWRAPPER] [CMDFILE] [COPIES] [CUSTOMIZE] 
[DATEFORMATMASK] [DELIMITED_HDR] [DELIMITER] [DESFORMAT] [DESNAME] [DESTINATION] 
[DESTYPE] [DISTRIBUTE] [EXPIRATION] [EXPRESS_SERVER] [FROM] [IGNOREMARGIN] 
[JOBNAME] [JOBTYPE] [LONGCHUNK] [MODE] [MODULE|REPORT] [NONBLOCKSQL] 
[NOTIFYFAILURE] [ONFAILURE] [ONSUCCESS] [ORIENTATION] [PAGESIZE] [PDFCOMP] 
[PDFEMBED] [READONLY] [REPLYTO] [REPORT|MODULE] [ROLE] [RUNDEBUG] [SCHEDULE] 
[SERVER] [SUBJECT] [TOLERANCE] [TRACEMODE] [TRACEOPTS] [USERID]

A.1.2 rwrun

The rwrun command runs a report using the Oracle9iAS 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 the 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] [COPIES] [CUSTOMIZE] 
[DATEFORMATMASK] [DELIMITED_HDR] [DELIMITER] [DESFORMAT] [DESNAME] [DESTINATION] 
[DESTYPE] [DISTRIBUTE] [EXPRESS_SERVER] [FROM] [IGNOREMARGIN] [LONGCHUNK] [MODE] 
[MODULE|REPORT] [NONBLOCKSQL] [NOTIFYFAILURE] [ONFAILURE] [ONSUCCESS] 
[ORIENTATION] [PAGESIZE] [PAGESTREAM] [PDFCOMP] [PDFEMBED] [PRINTJOB] [READONLY] 
[REPLYTO] [REPORT|MODULE] [ROLE] [RUNDEBUG] [SAVE_RDF] [SUBJECT] [TRACEFILE] 
[TRACEMODE] [TRACEOPTS] [USERID]

A.1.3 rwbuilder

The rwbuilder command invokes the Reports Builder. When you include a REPORT|MODULE keyword with the rwbuilder command at the command prompt, then press Enter, the Reports Builder opens with the specified report highlighted in the Reports Builder Navigator. When no report is specified, the 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] 
[ONFAILURE] [ONSUCCESS] [PAGESIZE] [PRINTJOB] [READONLY] [REPORT|MODULE] 
[RUNDEBUG] [SAVE_RDF] [TRACEFILE] [TRACEMODE] [TRACEOPTS] [USERID] [WEBSERVER_
DEBUG] [WEBSERVER_DOCROOT] [WEBSERVER_PORT]

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:

Combine a report file with an XML file to create a new report

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

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

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:

Converting a .rep file
Using a .rex file as the source
Using a report created on another platform as the source

In all other situations, you must compile the report's PL/SQL yourself (e.g., using ProgramCompileAll in the Reports Builder).

Note:

Fonts are mapped when a report is opened by the 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]

A.1.5 rwservlet

The rwservlet command translates and delivers information between HTTP and the Reports Server.

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 Chapter 8, "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] [BCC] [BLANKPAGES] 
[BUFFERS] [CACHELOB] [CC] [CELLWRAPPER] [CMDKEY] [CONTENTAREA] [COPIES] 
[CUSTOMIZE] [DATEFORMATMASK] [DELAUTH] [DELIMITED_HDR] [DELIMITER] [DESFORMAT] 
[DESNAME] [DESTINATION] [DESTYPE] [DISTRIBUTE] [EXPIRATION] [EXPIREDAYS] 
[EXPRESS_SERVER] [FROM] [GETJOBID] [GETSERVERINFO] [HELP] [IGNOREMARGIN] 
[ITEMTITLE] [JOBNAME] [JOBTYPE] [KILLJOBID] [LONGCHUNK] [MODE] [MODULE|REPORT] 
[NONBLOCKSQL] [NOTIFYFAILURE] [NOTIFYSUCCESS] [NOTIFYFAILURE] [ONFAILURE] 
[ONSUCCESS] [ORIENTATION] [OUTPUTFOLDER] [OUTPUTPAGE] [PAGEGROUP] [PAGESIZE] 
[PAGESTREAM] [PARAMFORM] [PARSEQUERY] [PDFCOMP] [PDFEMBED] [READONLY] 
[REPLACEITEM] [REPLYTO] [REPORT|MODULE] [ROLE] [RUNDEBUG] [SCHEDULE] [SERVER] 
[SHOWENV] [SHOWENV] [SHOWMAP] [SHOWJOBS] [SHOWMYJOBS] [SITENAME] [STATUSFORMAT] 
[STATUSFOLDER] [STATUSPAGE] [SSOCONN] [SUBJECT] [TOLERANCE] [TRACEMODE] 
[TRACEOPTS] [URLPARAMETER] [USERID]

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, showjobid, killjobid, parsequery, showauth, delauth, getjobid, and getserverinfo. Refer to the syntax description for each of these keywords for more information.

A.1.6 rwcgi

Like rwservlet, the rwcgi command translates and delivers information between HTTP and the Reports Server. Between rwservlet and rwcgi, the rwservlet command is the recommend choice. Reports CGI is maintained only for backward compatibility.

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] [BCC] [BLANKPAGES] 
[BUFFERS] [CACHELOB] [CC] [CELLWRAPPER] [CONTENTAREA] [COPIES] [CUSTOMIZE] 
[DATEFORMATMASK] [DELIMITED_HDR] [DELIMITER] [DESFORMAT] [DESNAME] [DESTINATION] 
[DESTYPE] [DISTRIBUTE] [EXPIRATION] [EXPIREDAYS] [EXPRESS_SERVER] [FROM] 
[IGNOREMARGIN] [ITEMTITLE] [JOBNAME] [JOBTYPE] [LONGCHUNK] [MODE] 
[MODULE|REPORT] [NONBLOCKSQL] [NOTIFYFAILURE] [NOTIFYSUCCESS] [NOTIFYFAILURE] 
[ONFAILURE] [ONSUCCESS] [ORIENTATION] [OUTPUTFOLDER] [OUTPUTPAGE] [PAGEGROUP] 
[PAGESIZE] [PAGESTREAM] [PARAMFORM] [PDFCOMP] [PDFEMBED] [READONLY] 
[REPLACEITEM] [REPLYTO] [REPORT|MODULE] [ROLE] [RUNDEBUG] [SCHEDULE] [SERVER] 
[SITENAME] [STATUSFOLDER] [STATUSPAGE] [SUBJECT] [TOLERANCE] [TRACEMODE] 
[TRACEOPTS] [USERID]

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.

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

A.2 Command Line Syntax

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

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

All file names and paths specified in the client command line refer to files and directories on the server machine, except for any file specified for the command file keyword (CMDFILE=). 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.
If you don't specify a path for a keyword value that includes a file name, The Reports Server will try to find the file from the REPORTS_PATH environment variable.
If the command line contains CMDFILE=, then the command file is read and appended to the original command line before being sent to Oracle9iAS Reports Server. The Oracle9iAS Reports Engine does not reread the command file. (See CMDFILE.)

A.4 Command Line Arguments

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 Reports are enabled (YES) or disabled (NO) for PDF output. No means it isn't.

Syntax

ACCESSIBLE={YES|NO}

Values

YES means accessibility feature is enabled for Reports PDF output.

Default

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 ORACLE array processing. Generally, the larger the array size, the faster the report will run.

Syntax

ARRAYSIZE=n

Values

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

Default

Usage Notes

ARRAYSIZE can also be used with jobs run as JSPs.

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, optionally, the password to be used to authenticate users to the restricted Oracle9iAS Reports Server. User authentication ensures that the users making report requests have access privileges to run the requested report.

Syntax

AUTHID=username[/password]

Values

Any valid user name and, optionally, password created in Oracle9iAS Portal. See your DBA to create new users accounts in Oracle9iAS Portal.

Default

None

Usage Notes

AUTHID can also be used with jobs run as JSPs.

If you have a single sign-on environment, then the Oracle Single Sign-on Server will perform the authentication step and pass only the user name to the Reports Server in AUTHID.

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

YES or NO

Default

Usage Notes

AUTOCOMMIT can also be used with jobs run as JSPs.

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

YES or NO

Default

Usage Notes

The AUTOSTART keyword is only recognized on Microsoft Windows platforms.

A.4.6 BATCH

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

Table A-6 Commands that can use BATCH

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

Description

With rwconverter, BATCH suppress 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.

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.

Syntax

BATCH={YES|NO}

Default

A.4.7 BCC

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

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

Note:

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

Syntax

BCC=someone@foo.com OR BCC="someone@foo.com,sometwo@foo.com"

Values

Any one or more valid e-mail addresses.

Default

None

Usage Notes

To specify more than one e-mail address, enclose the list of addresses in quotation marks and separate each address in the list with a comma.

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

BCC can also be used with jobs run as JSPs.

A.4.8 BLANKPAGES

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

Table A-8 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

YES means print all blank pages. NO means do not print blank pages.

Default

YES

Usage Notes

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

A.4.9 BUFFERS

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

Table A-9 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

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

If this setting is changed in the middle of your session, then the change does not take effect until the next time the report is run.

BUFFERS can also be used with jobs run as JSPs.

A.4.10 CACHELOB

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

Table A-10 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 Oracle8 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=NO

Values

YES means to cache the LOB in the temporary file directory. NO means to not cache the LOB in the temporary file directory.

Default

YES

Usage Notes

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

A.4.11 CC

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

Table A-11 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=someone@foo.com OR CC="someone@foo.com,sometwo@foo.com"

Values

Any one or more valid e-mail addresses.

Default

None

Usage Notes

To specify more than one e-mail address, enclose the list of addresses in quotation marks and separate each address in the list with a comma.

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

A.4.12 CELLWRAPPER

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

Table A-12 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 should be placed both before and after the cells in a delimited report output.

Syntax

CELLWRAPPER=value

Values

Any alphanumeric character or string of alphanumeric characters.

"	means a double quotation mark is placed on each side of the cell
'	means a single quotation mark is placed on each side of the cell

You can also use these reserved values:

tab	means a tab is placed on each side of the cell
space	means a single space is placed on each side of the cell
return	means a new line is placed on each side of the cell
none	means no cell wrapper is used

You can also use escape sequences based on the ASCII character set, such as:

\t	means a tab is placed on each side of the cell
\n	means a new line is placed on each side of the cell

Default

None

Usage Notes

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

A.4.13 CMDFILE

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

Table A-13 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 arguments. 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.

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

Syntax

CMDFILE=cmdfile

Values

Any valid command file.

Default

None

Usage Notes

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

A.4.14 CMDKEY

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

Table A-14 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:// .../reports/rwservlet?cmddkey=key& ...

Note:

You can also use CMDKEY with modules run as JSPs. For more information, see Chapter 8, "Running Report Requests".

Syntax

CMDKEY=key

Values

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

Default

None

Usage Notes

When you use CMDKEY with rwservlet, you can use it in any order in the command line (or the URL, following the question mark). With rwservlet, you can use additional command line keywords along with CMDKEY.

CMDKEY can also be used with jobs run as JSPs.

A.4.15 CONTENTAREA

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

Table A-15 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 content area within Oracle Portal to which report output should be pushed. This keyword is maintained for backward compatibility with earlier versions of Oracle Portal (i.e., 3.0.9). For Oracle9iAS Portal, use PAGEGROUP. (See also SITENAME.)

Syntax

CONTENTAREA="Name of Portal content area"

Values

The name of any valid Oracle Portal content area.

Default

None

Usage Notes

Use of this keyword is required to push Reports output to Oracle Portal. Put quotation marks around the value if the value has any character spaces in it or you are specifying the argument in the cgicmd.dat file.

Relevant keywords include CONTENTAREA, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER, OUTPUTPAGE, PAGEGROUP, REPLACEITEM, SCHEDULE, SITENAME, STATUSFOLDER, STATUSPAGE.

Oracle Portal objects, such as pages, page groups, and the like, have two names: a display name and an internal name. When you create objects within Oracle Portal that you will use with Oracle Reports output, keep the internal name and the display name the same, following the rules for internal naming specified in the Oracle Portal online help. This way, when you provide a value for a Portal-related keyword in a Reports command line, you will not run into problems with which name to specify.

A.4.16 COPIES

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

Table A-16 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

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 the Reports Builder at design time).

Usage Notes

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

A.4.17 CUSTOMIZE

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

Table A-17 Commands that can use CUSTOMIZE

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

Description

Use CUSTOMIZE to specify a Reports XML file to be run against the current report. The Reports 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

A file name or list of file names that contain a valid XML report definition, with path information prefixed to the file name or file names if necessary. (Affixing paths becomes 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 Chapter 10, "Customizing Reports with XML".

Default

None

Usage Notes

CUSTOMIZE can also be used with jobs run as JSPs.

A.4.18 DATEFORMATMASK

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

Table A-18 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

Any valid date format mask.

Default

None

Usage Notes

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

Note:

For valid DATEFORMATMASK values see the Reports Builder online help topic, "Date and Time Format Mask Syntax."

DATEFORMATMASK can also be used with jobs run as JSPs.

A.4.19 DELAUTH

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

Table A-19 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 userid cookies.

Syntax

http://yourwebserver/yourservletpath/rwservlet/DELAUTH[?]

[server=servername][&authid=username/password]

Values

See Syntax.

Default

None

Usage Notes

Related keywords are SERVER and AUTHID.

A.4.20 DELIMITED_HDR

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

Table A-20 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 switch off all boilerplate (such as the Report header) when running a report with DESFORMAT=DELIMITED.

Syntax

DELIMITED_HDR={YES|NO}

Values

YES means to turn off all boilerplate text in the delimited output file. NO means to leave boilerplate text as is in the delimited output file.

Default

YES

Usage Notes

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

A.4.21 DELIMITER

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

Table A-21 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

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

,	means a comma separates each cell
.	means a period separates each cell

You can also use these reserved values:

tab	means a tab separates each cell
space	means a space separates each cell
return	means a new line separates each cell
none	means no delimiter is used

You can also use escape sequences based on the ASCII character set, such as:

\t	means a tab separates each cell
\n	means a new line separates each cell

Default

Tab

Usage Notes

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

A.4.22 DESFORMAT

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

Table A-22 Commands that can use DESFORMAT

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

Description

Specifies the format for the job output. In bit-mapped environments, use DESFORMAT to specify the printer driver to be used when DESTYPE is FILE. In character-mode environments, use it to specify the characteristics of the printer named in DESNAME.

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

Table A-23 Valid values for DESFORMAT

Value	Description
CHARACTER	When the MODE is CHARACTER, the DESFORMAT specifies a printer definition, such as `hpl`, `hplwide`, `dec`, `decwide`, `decland`, `dec180`, `dflt`, or `wide`.
DELIMITED	This report output is sent to a file that can be read by standard spreadsheet utilities, such as Microsoft Excel. If you do not choose a delimiter, then the default delimiter is a TAB.
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.
POSTSCRIPT	This report output is sent to a file that is in Postscript format.
RTF	Rich Text Format. This report output is sent to a file that can be read by word processors (such as Microsoft Word). When you open the file in MS 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 the Reports Builder at design time). When you run a report via the Reports Builder and DESFORMAT is blank or dflt, then the current printer driver (specified in File > Choose Printer) is used. If nothing has been selected in Choose Printer, then Postscript is used by default.

Usage Notes

The value or values for this keyword might be case sensitive, depending on your operating system.

A.4.23 DESNAME

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

Table A-24 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, Oracle9iAS Portal, or e-mail ID (or distribution list) to which the report output will be sent. To send the report output by e-mail, specify the e-mail ID as you do in your e-mail application (any SMTP-compliant application). You can specify multiple user names by separating them with commas, and without spaces. For example:

name,name,name

Syntax

DESNAME=desname

Values

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 the Reports Builder at design time). If DESTYPE=FILE and DESNAME is an empty string, then it defaults to reportname.lis at runtime.

Usage Notes

The argument(s) for this keyword might be case sensitive, depending on your operating system.

A.4.24 DEST

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

Table A-25 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={dname|(dname1, dname2, ...)|pathname}

Values

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:

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

Usage Notes

A list of report/library names of filenames must be enclosed in parentheses with commas separating each entry. For example:
```
(qanda,test,dmast) or (qanda, test, dmast)
```
If you have more destination names than there are source names, the extra destination names are ignored. If you have fewer destination names than there are source names, default names will be used after the destination names run out.
The value(s) for the DEST keyword may be operating system-specific.
When DTYPE=REGISTER, multiple destinations are not required. If you list more than one SQL*Plus script file name for DEST, only the first one is recognized. The others are ignored.

A.4.25 DESTINATION

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

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

Syntax

DESTINATION=filename.xml

Values

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 9, "Creating Advanced Distributions".

A.4.26 DESTYPE

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

Table A-27 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 Reports Destination API, this is how the destination you created gets called.

Syntax

DESTYPE={cache|localFile|file|printer|sysout|mail|oraclePortal|

name_of_pluggable_destination}

Values

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

Table A-28 Valid values for the `DESTYPE` keyword

Value	Description
cache	Sends the output directly to Oracle9iAS Reports 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 Oracle9iAS Reports Server can recognize installed and running.
mail	Sends the output to the mail users specified in DESNAME. You can send mail to any mail system that works with SMTP.
OraclePortal	Sends the output to Oracle Portal. Relevant keywords include CONTENTAREA, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER, OUTPUTPAGE, PAGEGROUP, REPLACEITEM, SCHEDULE, SITENAME, STATUSFOLDER, STATUSPAGE.
sysout	Valid only for rwcgi. Sends the output to the client machine's default output device and forces a synchronous call.
name_of_pluggable_destination	If you have created your own pluggable destination via the Reports Destination API, this is what you use to call the destination you created.

Default

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

A.4.27 DISTRIBUTE

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

Table A-29 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 the Reports Builder at design time) or a distribution XML file.

Syntax

DISTRIBUTE={YES|NO}

Values

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

Default

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 Chapter 9, "Creating Advanced Distributions".

A.4.28 DTYPE

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

Table A-30 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|TDFFILE|XMLFILE|JSPFILE

|REGISTER}

Values

The following values apply:

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

Default

REPFILE

Usage Notes

When you try to create a .rep file using rwconverter, the source report's PL/SQL is automatically compiled. If there are compile errors, an error message is displayed and the .rep file is not created. To avoid this problem, make sure you compile the source report's PL/SQL using FileCompile, in the Reports Builder, before you try to create a .rep file.

When converting a report to a template, only objects in the report's header and trailer sections and the margin area are used in the template. Objects in the main section are ignored.

A.4.29 DUNIT

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

Table A-31 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

C ENTIMETER means the converted reports will initially use centimeters as the unit of measurement
CHARACTER means the converted reports will initially use characters as the unit of measurement.
INCH means the converted reports will initially use inches as the unit of measurement.
POINT means the converted reports will initially use points as the unit of measurement

Default

Null

A.4.30 EXPIRATION

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

Table A-32 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 Section 8.8, "Reusing Report Output from Cache" (in Chapter 8) for more information on duplicate job detection.

Syntax

EXPIRATION=time_string

Default

None

Values

The time string can be in one of two formats:

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

A.4.31 EXPIREDAYS

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

Table A-33 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 reports output pushed to Oracle Portal should be expired.

Syntax

EXPIREDAYS={PERMANENT|1 day|2 days|3 days|7 days|14 days|31 days|

60 days|90 days|120 days}

Values

Default

None

Usage Notes

Use of this keyword is optional when you are pushing Reports output to Oracle Portal. Relevant keywords include CONTENTAREA, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER, OUTPUTPAGE, PAGEGROUP, REPLACEITEM, SCHEDULE, SITENAME, STATUSFOLDER, STATUSPAGE.

A.4.32 EXPRESS_SERVER

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

Table A-34 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:

`server`	is 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`	is the Express Server domain.
`user`	is the user ID to log on to the Express Server.
`password`	is the password for the user ID.
`ramuser`	is the user ID to log into the RDBMS.
`rampassword`	is the password for the RDBMS.
`ramexpressi`d	is the Oracle Sales Analyzer database user ID. This is required for Oracle Sales Analyzer databases only.
`ramserverscript`	is 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`	is 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`	is 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-35 describes the parameters and their settings:

Table A-35 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

You can have spaces in the string if necessary (for example, if the user ID is John Smith) because the entire string is enclosed in quotes.
If a forward slash (/) is required in the string, then you must use another forward slash as an escape character. For example, if the domain were tools or reports, then the command line should be as follows:
```
EXPRESS_SERVER="server=ncacn_ip_tcp:olap2-pc/sl=0/
st=1/ct=0/sv=1/domain=tools//reports"
```
You can use single quotes within the string. They are not treated specially because the entire string is enclosed in double quotes.

A.4.33 FORMSIZE

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

Table A-36 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 (DUNIT).

Note:

For more information on the Runtime Parameter Form, see the PARAMFORM keyword.

Syntax

FORMSIZE=width x height

Values

Any valid values in the specified unit of measurement.

Default

None

Usage Notes

For non-character DUNITs, you can use a decimal to specify fractions (e.g., 8.5 x 11).

A.4.34 FROM

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

Table A-37 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=someone@foo.com

Values

Any valid e-mail address.

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.35 GETJOBID

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

Table A-38 Commands that can use GETJOBID

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

Description

Use GETJOBID to get the result output of the Reports Server job with job ID [n].

Syntax

http://yourwebserver/reports/rwservlet/getjobid[n][?]

[server=server_name][&authid=username/password][&statusformat={html|xml|xmldtd}]

Values

See Syntax.

Default

None

Usage Notes

Job must be successfully finished and present in the Reports Server cache. Use SHOWJOBS to see the current list of jobs. The status format can be html, xml, or xmldtd to return status in that format. The default is html.

Related keywords are SERVER, AUTHID, and STATUSFORMAT.

The STATUSFORMAT parameter is only valid for rwservlet, not for rwcgi.

A.4.36 GETSERVERINFO

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

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

Syntax

http://yourwebserver/reports/rwservlet/getserverinfo[?]

[server=server_name][&authid=username/password]

Values

See Syntax.

Default

None

Usage Notes

Related keywords are SERVER and AUTHID.

A.4.37 HELP

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

Table A-40 Commands that can use HELP

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

Description

Use HELP to show a help topic that lists the additional commands you can use with the rwservlet command.

Syntax

http://yourwebserver/reports/rwservlet/help

Values

See Syntax.

Default

None

A.4.38 IGNOREMARGIN

Table A-41 indicates which commands can use the IGNOREMARGIN keyword.

Table A-41 Commands that can use IGNOREMARGIN

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

Description

Use IGNOREMARGIN to specify whether Reports ignores the printer's hardware margin and uses one specified in the report definition's physical page margin.

Syntax

IGNOREMARGIN={YES|NO}

Values

YES means Reports will ignore the printer's hardware margin and use the one specified by the report's physical page margin. NO means Reports will add the printer's hardware margin with the report's physical page margin when it prints out the report.

Default

A.4.39 INSTALL

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

Table A-42 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 argument does not work on UNIX platforms.

Syntax

INSTALL REPORTS_SERVER_NAME

Values

A valid name for the Reports Server instance

Default

none

Usage Notes

If you use the AUTOSTART keyword with INSTALL, the Reports Server service will be started automatically after installation and whenever the system is restarted.

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

A.4.40 ITEMTITLE

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

Table A-43 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 Oracle Portal should use for report output. The name will display in Oracle Portal and link to Reports output.

Syntax

ITEMTITLE="Your output title"

Values

Any text.

Default

The report filename

Usage Notes

Use of this keyword is optional when you are pushing Reports output to Oracle Portal. Put quotation marks around the value if the value has any character spaces in it or you are specifying the argument in the cgicmd.dat file.

Relevant keywords include CONTENTAREA, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER, OUTPUTPAGE, PAGEGROUP, REPLACEITEM, SCHEDULE, SITENAME, STATUSFOLDER, STATUSPAGE.

A.4.41 JOBNAME

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

Table A-44 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 the Oracle9iAS Reports Queue Manager. It is treated as a comment and has nothing to do with running the job. If JOBNAME is not specified, then the Oracle9iAS Reports Queue Manager shows the report name as the job name.

Syntax

JOBNAME=string

Values

Any job name.

Default

None

Usage Notes

JOBNAME can also be used with jobs run as JSPs.

A.4.42 JOBTYPE

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

Table A-45 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={a job for which the Reports Server has an engine}

Default

REPORT

A.4.43 KILLJOBID

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

Table A-46 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/killjobid[n][?]

[server=server_name][&authid=username/password][&statusformat={html|xml|xmldtd}]

Values

See Syntax.

Default

None

Usage Notes

The job must be current (enqueued or scheduled). Use SHOWJOBS to see the current list of jobs. The STATUSFORMAT can be set to html, xml, or xmldtd to return status in that format. The default is html.

Related keywords are SHOWJOBS, SERVER, AUTHID, and STATUSFORMAT.

The STATUSFORMAT parameter is only valid for rwservlet, not for rwcgi.

A.4.44 LONGCHUNK

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

Table A-47 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 Oracle9iDS 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

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

Usage Notes

LONGCHUNK can also be used with jobs run as JSPs.

A.4.45 MODE

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

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

Syntax

MODE={BITMAP|CHARACTER|DEFAULT}

Values

The following values apply:

BITMAP
CHARACTER
DEFAULT means BITMAP.

Default

DEFAULT

A.4.46 MODULE|REPORT

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

Table A-49 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

Any valid runfile (that is, a file with an extension of REP, RDF, JSP, or XML). If you do not enter a file extension, then the Oracle9iAS Reports Runtime searches first for a file with extension REP, then extension RDF, then JSP, and then no extension. Oracle9iAS Reports Runtime uses its REPORTS_PATH search order to find the file, if the directory path is not prefixed to the file name.

Default

None

A.4.47 NONBLOCKSQL

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

Table A-50 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 Oracle9iAS Reports Runtime is fetching data from the database.

Syntax

NONBLOCKSQL={YES|NO}

Values

YES means that other programs can run while data is being fetched. NO means that other programs cannot run while data is being fetched.

Default

YES

Usage Notes

NONBLOCKSQL can also be used with jobs run as JSPs.

A.4.48 NOTIFYFAILURE

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

Table A-51 Commands that can use NOTIFYFAILURE

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	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 Chapter 3, "Configuring Oracle9iAS Reports Services".

Syntax

NOTIFYFAILURE={name1@mycompany.com,name2@mycompany.com}

Values

One or more valid e-mail addresses.

Default

None

Usage Notes

The default notification e-mail templates that are used for the body of the notification e-mail are included with your installation of Oracle9iAS. The NOTIFYFAILURE template is named failnote.txt, and is located at ORACLE_HOME\reports\template.

NOTIFYFAILURE can also be used with jobs run as JSPs.

A.4.49 NOTIFYSUCCESS

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

Table A-52 Commands that can use NOTIFYSUCCESS

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	no	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 Chapter 3, "Configuring Oracle9iAS Reports Services".

Syntax

NOTIFYSUCCESS={name1@mycompany.com,name2@mycompany.com}

Values

One or more valid e-mail addresses.

Default

None

Usage Notes

The default notification e-mail templates that are used for the body of the notification e-mail are included with your installation of Oracle9iAS. The NOTIFYSUCCESS template is named succnote.txt, and is located at ORACLE_HOME\reports\template.

NOTIFYSUCCESS can also be used with jobs run as JSPs.

A.4.50 NUMBERFORMATMASK

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

Table A-53 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

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

Note:

For valid NUMBERFORMATMASK values see the Reports Builder online help topic, "Number Format Mask Syntax."

NUMBERFORMATMASK can also be used with jobs run as JSPs.

A.4.51 ONFAILURE

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

Table A-54 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 a report fails to complete.

Syntax

ONFAILURE={COMMIT|ROLLBACK|NOACTION}

Values

COMMIT means perform a COMMIT if a report fails. ROLLBACK means perform a ROLLBACK if a report fails. NOACTION means do nothing if a report fails.

Default

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

Usage Notes

The COMMIT or ROLLBACK for ONFAILURE is performed after the report fails. Other COMMITs and ROLLBACKs can occur prior to this one. For more information, see the READONLY command.

ONFAILURE can also be used with jobs run as JSPs.

A.4.52 ONSUCCESS

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

Table A-55 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

COMMIT means perform a COMMIT when a report is done. ROLLBACK means perform a ROLLBACK when a report is done. NOACTION means do nothing when a report is done.

Default

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

Usage Notes

The COMMIT or ROLLBACK for ONSUCCESS is performed after the after-report trigger fires. Other COMMITs and ROLLBACKs can occur prior to this one. For more information, see the READONLY command.

ONSUCCESS can also be used with jobs run as JSPs.

A.4.53 ORIENTATION

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

Table A-56 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 means use the current printer setting for orientation. LANDSCAPE means landscape orientation (long side at top and bottom). PORTRAIT means portrait orientation (short side at top and bottom).

Default

DEFAULT

Usage Notes

If ORIENTATION=LANDSCAPE for a character mode report, then you must ensure that your printer definition file contains a landscape clause.
Not supported when output to a PCL printer on Motif.

A.4.54 OUTPUTFOLDER

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

Table A-57 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 Portal folder to push Reports output into. This keyword is maintained for backward compatibility with earlier versions of Oracle Portal (WebDB 2.2 and Oracle Portal 3.0.9). For Oracle9iAS Portal version 2.0, use OUTPUTPAGE.

Syntax

OUTPUTFOLDER=Oracle_Reports_Output

Values

Any valid folder name used in Oracle9iAS Portal.

Default

Oracle_Reports_Output

Usage Notes

The value for this keyword is case sensitive. Use of this keyword is required to push Reports output to Oracle Portal. Put quotation marks around the value if the value has any character spaces in it or you are specifying the argument in the cgicmd.dat file.

Relevant keywords include CONTENTAREA, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER, OUTPUTPAGE, PAGEGROUP, REPLACEITEM, SCHEDULE, SITENAME, STATUSFOLDER, STATUSPAGE.

A.4.55 OUTPUTPAGE

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

Table A-58 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 Portal page to push Reports output information into. (For backward compatibility with versions of Oracle Portal earlier than Oracle9iAS Portal version 2.0, see OUTPUTFOLDER.)

Syntax

OUTPUTPAGE=Oracle_Reports_Output

Values

Any valid page name used in Oracle Portal.

Default

Oracle_Reports_Output

Usage Notes

The value for this keyword is case sensitive. Use of this keyword is optional for pushing Reports output to Oracle Portal. If an output page is not specified, Oracle9iAS Portal will create a default page named Oracle Reports Output.

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

Keywords relevant to pushing Reports output to Oracle Portal include CONTENTAREA, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER, OUTPUTPAGE, PAGEGROUP, REPLACEITEM, SCHEDULE, SITENAME, STATUSFOLDER, STATUSPAGE.

A.4.56 OVERWRITE

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

Table A-59 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

YES means that rwconverter should automatically overwrite any existing files of the same name.
NO means not to convert reports and to display a warning message if there are existing files of the same name.
PROMPT means to prompt you before overwriting any existing files.

Default

A.4.57 P_AVAILABILITY

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

Table A-60 Commands that can use P_AVAILABILITY

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

Description

P_AVAILABILITY is 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

Any valid availability calendar name.

Default

none

Usage Notes

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

A.4.58 P_DESCRIPTION

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

Table A-61 Commands that can use P_DESCRIPTION

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

Description

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

Syntax

P_DESCRIPTON=DESCRIPTION_TEXT

Values

Any text string.

Default

none

A.4.59 P_FORMATS

Table A-62 indicates which commands can use the P_FORMATS keyword. This keyword is only used when DTYPE=REGISTER.

Table A-62 Commands that can use P_FORMATS

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

Description

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

Syntax

P_FORMATS=(HTMLCSS,PDF,...)

Values

Any valid destination type (e.g., HTML), or a list of valid destination types enclosed by parentheses with a comma separating the names (e.g., (HTMLCSS,PDF,RTF)).

Default

none

A.4.60 P_NAME

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

Table A-63 Commands that can use P_NAME

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

Description

P_NAME is the report name displayed in Oracle9iAS Portal. This keyword is only used when DTYPE=REGISTER.

Syntax

P_NAME=REPORT_NAME

Values

Any report name.

Default

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

Usage Notes

Specify P_NAME only when you want to use the same report name for each report definition file being registered in Oracle9iAS Portal. This argument is typically left blank.

The report name cannot be prefaced with numeric characters (e.g., 401K_ report is an invalid file name and my_401K_report is valid).

A.4.61 P_OWNER

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

Table A-64 Commands that can use P_OWNER

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

Description

P_OWNER is the Oracle9iAS Portal schema 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_SCHEMA_NAME

Values

Any valid Oracle9iAS Portal schema name.

Default

The name of the Oracle9iAS Portal schema to which you are logged on when you run the SQL*PLUS script file.

A.4.62 P_PFORMTEMPLATE

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

Table A-65 Commands that can use P_PFORMTEMPLATE

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

Description

P_PFORMTEMPLATE is the name of the Oracle9iAS 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

Any valid Oracle9iAS Portal template name.

Default

none

A.4.63 P_PRINTERS

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

Table A-66 Commands that can use P_PRINTERS

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

Description

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

Syntax

 P_PRINTERS=(PRT1,PRT2,...)

Values

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 Oracle9iAS Portal before running the SQL*Plus script.

A.4.64 P_PRIVILEGE

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

Table A-67 Commands that can use P_PRIVILEGE

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

Description

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

Syntax

 P_PRIVILEGE=(SCOTT,JABERS,PMARTIN,...)

Values

Any user name or role that Oracle9iAS 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.65 P_SERVERS

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

Table A-68 Commands that can use P_SERVERS

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

Description

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

Syntax

 P_SERVERS=(repserver1,repserver2,...)

Values

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 Oracle9iAS Portal.

A.4.66 P_TRIGGER

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

Table A-69 Commands that can use P_TRIGGER

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

Description

P_TRIGGER is a 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

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

Default

none

A.4.67 P_TYPES

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

Table A-70 Commands that can use P_TYPES

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

Description

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

Syntax

P_TYPES=(CACHE,MAIL,...)

Values

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.68 PAGEGROUP

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

Table A-71 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 Oracle Portal page group to push report output to. For WebDB 2.2, use SITENAME instead. For Oracle Portal 3.0, use CONTENTAREA instead. For Oracle9iAS Portal version 2.0 and later, use PAGEGROUP.

The page group must be created in Oracle Portal before you can use this parameter.

Syntax

PAGEGROUP="Name of Oracle Portal page group"

Values

Any valid page group used in Oracle Portal.

Default

None

Usage Notes

Relevant keywords include CONTENTAREA, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER, OUTPUTPAGE, PAGEGROUP, REPLACEITEM, SCHEDULE, SITENAME, STATUSFOLDER, STATUSPAGE.

A.4.69 PAGESIZE

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

Table A-72 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 the Reports Builder (Edit Preferences General tab). For inches, the maximum width and height is 512 inches. For centimeters, it is 1312 centimeters. For picas, it is 36,864 picas.

Default

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

Usage Notes

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

A.4.70 PAGESTREAM

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

Table A-73 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 for the report when formatted as HTML or HTMLCSS output, using the navigation controls set by either of the following:

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

Syntax

PAGESTREAM={YES|NO}

Values

YES means to stream the pages. NO means to output the report without page streaming.

Default

A.4.71 PARAMFORM

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

Table A-74 Commands that can use PARAMFORM

rwclient	rwrun	rwbuilder	rwconverter	rwservlet	rwcgi	rwserver
yes	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

YES means the parameter form should be displayed. NO means the parameter form should not be displayed. HTML means the parameter form should be displayed in HTML format.

Default

Usage Notes

Do not use this keyword when running a report in an Oracle Portal environment. This is because Oracle Portal allows you to set up a Reports runtime parameter form, which may conflict with a form you specify with the PARAMFORM keyword.

A.4.72 PARSEQUERY

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

Table A-75 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]query_string

Values

See Syntax.

Default

None

A.4.73 PDFCOMP

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

Table A-76 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={any value 0 through 9) OR {YES|NO}

Values

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

Default

A.4.74 PDFEMBED

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

Table A-77 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 Reports will embed the Type1 Postscript font file(s) specified in uifont.ali into PDF output.

Syntax

PDFEMBED={YES|NO}

Values

YES means that the PDF driver will embed the font(s) specified in the PDFEMBED parameter of the uifont.ali file into the PDF output. NO means that the font(s) will not be added to PDF output.

Default

YES

A.4.75 PRINTJOB

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

Table A-78 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

YES or NO

Default

Usage Notes

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

A.4.76 READONLY

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

Table A-79 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, 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 means do not provide read consistency.

Default

Usage Notes

This keyword is only useful for reports using multiple queries. Oracle automatically provides read consistency, without locking, for single query reports.
In the Report trigger order of execution, SET TRANSACTION READ ONLY must be set up before the data fetch occurs.
READONLY can also be used with jobs run as JSPs.

A.4.77 REPLACEITEM

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

Table A-80 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 Oracle Portal should replace an earlier version of the same item stored in the same output target.

Syntax

REPLACEITEM={YES|NO}

Values

YES specifies that earlier report output should be replaced. NO means do not replace previous version. In this case, a link to the new output will be added to a list of links to previous versions of the same report.

Default

None

Usage Notes

Use of this keyword is optional. Relevant keywords include CONTENTAREA, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER, OUTPUTPAGE, PAGEGROUP, REPLACEITEM, SCHEDULE, SITENAME, STATUSFOLDER, STATUSPAGE.

A.4.78 REPLYTO

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

Table A-81 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=someone@foo.com

Values

Any valid e-mail address.

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.79 REPORT|MODULE

See MODULE|REPORT.

A.4.80 ROLE

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

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

Syntax

ROLE={rolename[/rolepassword]}

Values

A valid role and (optionally) a role password.

Default

None

Usage Notes

ROLE can also be used with jobs run as JSPs.

A.4.81 RUNDEBUG

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

Table A-83 Commands that can use RUNDEBUG

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

Description

Use RUNDEBUG to turn on error messages/warnings that would otherwise not be displayed. For example, with RUNDEBUG=YES, you might get the error message: Frame 1 overlaps but does not contain Frame 2. This situation may or may not be acceptable, depending on the job being run.

Syntax

RUNDEBUG={YES|NO}

Values

YES means display additional error/warning messages. NO means do not display additional error/warning messages.

Default

YES

Usage Notes

RUNDEBUG can also be used with jobs run as JSPs.

A.4.82 SAVE_RDF

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

Table A-84 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 Reports XML customization file using the CUSTOMIZE keyword, and you wish to save the combination to a new RDF file.

Syntax

SAVE_RDF=filename.rdf

Values

Any valid file name.

Default

None

Usage Notes

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

A.4.83 SCHEDULE

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

Table A-85 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. For example, use:

SCHEDULE=every_first_fri_of_month_from_15:53_Oct_23,_1999_retry_3_after_1_hour
SCHEDULE=last_weekday_before_15_from_15:53_Oct_23,_1999_retry_after_1_hour

Or:

SCHEDULE="every first fri of month from 15:53 Oct 23, 1999 retry 3 after 1 hour"
SCHEDULE="last weekday before 15 from 15:53 Oct 23, 1999 retry after 1 hour"

Syntax

SCHEDULE=string

where the string is:

[FREQ from] TIME [retry {n} + after LEN]

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

Table A-86 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

Default

None

A.4.84 SERVER

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

Table A-87 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

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

SERVER can also be used with jobs run as JSPs.

A.4.85 SHOWENV

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

Table A-88 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 rwserver configuration file. (rwservlet.properties).

Syntax

http://yourwebserver/reports/rwservlet/showenv[?]

[server=servername][&authid=username/password]

Values

See Syntax.

Default

None

A.4.86 SHOWJOBS

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

Table A-89 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][&statusformat={html|xml|xmldtd}]

Values

See Syntax.

Default

None

Usage Notes

The name of the Reports Server must be specified implicitly by environment variable or servlet configuration file, or explicitly in the URL request. The refresh number [n] is optional. When it is specified, the report's queue status will be updated every [n] seconds. The STATUSFORMAT can be set to html, xml, or xmldtd to return status in that format. The default is html.

Related keywords are SERVER, AUTHID, and STATUSFORMAT.

The STATUSFORMAT parameter is only valid for rwservlet, not for rwcgi.

A.4.87 SHOWMAP

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

Table A-90 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=username/password]

Values

See Syntax.

Default

None

A.4.88 SHOWMYJOBS

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

Table A-91 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

The STATUSFORMAT can be set to html, xml, or xmldtd to return status in that format. The default is html.

Related keywords are SERVER, AUTHID, and STATUSFORMAT.

The STATUSFORMAT parameter is only valid for rwservlet, not for rwcgi.

A.4.89 SHUTDOWN

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

Table A-92 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 a 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 a Reports Administrative user). If security is not enabled, then the user must nonetheless be a Reports Administrative user defined for that server.

A.4.90 SITENAME

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

Table A-93 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 site to push report output to. For Oracle Portal 3.0 users this is the content area name. (See also CONTENTAREA.) This keyword is maintained for backward compatibility with earlier versions of Oracle Portal (and WebDB). For Oracle9iAS Portal version 2.0 and later, use PAGEGROUP.

Syntax

SITENAME=sitename

Values

Any valid site name used in Oracle Portal.

Default

None

Usage Notes

Relevant keywords include CONTENTAREA, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER, OUTPUTPAGE, PAGEGROUP, REPLACEITEM, SCHEDULE, SITENAME, STATUSFOLDER, STATUSPAGE.

A.4.91 SOURCE

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

Table A-94 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

SQL wildcard characters (% and _) may be used for reports or libraries that are stored in the database. For example, R% would fetch all reports stored in the database that begin with R. All reports that match will be converted.
A list of report/library names or filenames must be enclosed in parentheses, with commas separating the names. For example:
```
(qanda,test,dmast) OR (qanda, test, dmast)
```
Wildcard characters are invalid for reports/libraries stored in files (i.e., with extensions of rdf, rep, rex, pld, pll, or xml).
The value(s) for the SOURCE keyword may be operating system-specific.
If you are using user-owned Reports Builder tables, reports/libraries from multiple users must be converted for each user individually.
To convert reports/libraries, you must have created them or been granted access to the ones you did not create. If no userid is prefixed to the report/library name, the userid is assumed to be the current user.
When DTYPE=REGISTER, you may only want to list report definition files with common parameters, such as destination types and formats, user access, and availability calendars.

A.4.92 SSOCONN

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

Table A-95 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:

key refers to a connection string value stored in the Oracle Internet Directory (OID).
type is a predefined character string that specifies a Reports data source type. Types provided with your Oracle9iAS installation include OracleDB, JDBCPDS (Java Database Connectivity Pluggable Data Source), and ExpressPDS (Oracle Express Pluggable Data Source).
conn_str is the name of the connection string parameter that rwservlet will compose to run the report

Default

None

Usage Notes

If multiple data sources are used in the report, use a comma to separate data source connection strings. For example:
```
ssoconn=key1/type1/conn_str,key2/type2/conn_str2,key3/type3/conn_str3
```

Simplified versions of the SSOCONN argument are also available. Table A-96 provides examples.

Table A-96 Simplified versions of the SSOCONN argument

Argument	Description
ssoconn=mkey	When only the key name is specified, the default type (Oracle DB) will be used, and the connect parameter is the USERID keyword.
ssoconn=mkey/PDSApp	When both key name and application type are specified, the connection parameter is the USERID keyword.
ssoconn=mkey/PDSApp/P_1	When everything is specified, the specified values are used.

SSOCONN can also be used with jobs run as JSPs.

Note:
For more information about Reports and single sign-on (SSO), see Chapter 7, "Data Source Single Sign-On".

A.4.93 STATUSFORMAT

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

Table A-97 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

Reports_URL/rwservlet/showjobs?

server=server_name&statusformat={html|xml|xmldtd}

Values

HTML, XML, or XMLDTD. Use HTML to specify that the Reports queue status output should be in HTML format. Use XML to specify that it should be in XML format. Use XMLDTD to specify that it should be in XML format with in-line Data Type Definition information.

Default

HTML

Usage Notes

Use STATUSFORMAT in conjunction with the SHOWJOBS and SHOWMYJOBS keywords.

A.4.94 STATUSFOLDER

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

Table A-98 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 folder to push status information into. If this is omitted, a new folder is created called "Oracle_Reports_Status." This value is retained for backward compatibility with earlier versions of Oracle Portal. For the current version (Oracle9iAS Portal version 2.0 and above, see STATUSPAGE.)

Syntax

STATUSFOLDER=Oracle_Reports_Status

Values

Any valid folder name used in Oracle Portal.

Default

Oracle_Reports_Status

Usage Notes

The value for this keyword is case sensitive. Use of this keyword is optional.

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

A.4.95 STATUSPAGE

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

Table A-99 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 page to push job status information into. If this is omitted, a new page is created called "Oracle_Reports_Status." Use this keyword with Oracle9iAS Portal version 2.0 and later. For backward compatibility, see STATUSFOLDER.

Syntax

STATUSPAGE=Oracle_Reports_Status

Values

Any valid page name used in Oracle Portal.

Default

Oracle_Reports_Status

Usage Notes

The value for this keyword is case sensitive. Use of this keyword is optional.

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

A.4.96 STYPE

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

Table A-100 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:

PLDFILE means the source PL/SQL libraries are stored in files in ASCII format.
PLLFILE means the source PL/SQL libraries are stored in files containing source code and P-code (compiled PL/SQL).
RDFFILE means the source report(s) are stored in one or more report definition files (files with the rdf extension).
REXFILE means the source report(s) are stored in one or more text files (files with the rex extension).
XMLFILE means the source report(s) are stored in one or more XML files.
JSPFILE means the source report(s) are stored in one or more JSP files.

Default

RDFFILE

Usage Notes

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

A.4.97 SUBJECT

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

Table A-101 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

Enclose subjects that contain character spaces in quotation marks. Single-word subjects do not require quotation marks.

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

A.4.98 TOLERANCE

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

Table A-102 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 Section 8.8, "Reusing Report Output from Cache" (in Chapter 8) for more information on duplicate job detection.

Syntax

TOLERANCE=time_string

Values

The time string can be in one of two formats:

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

Default

None

Usage Notes

If TOLERANCE is not specified, then Oracle9iAS Reports Services reruns the report even if a duplicate report is found in the cache.
If a report is being processed (that is, in the current job queue) when an identical job is submitted, then Oracle9iAS Reports Services reuses the output of the currently running job even if TOLERANCE is not specified or is set to zero.

A.4.99 TRACEFILE

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

Table A-103 Commands that can use TRACEFILE

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

Description

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

Note:
In a runtime environment, or when you are monitoring Reports Services components, you can use all three TRACE keywords. But for server security, in a server environment you can use only TRACEOPTS. This is to prevent files from being written arbitrarily to the Reports Server's file system.
Tracing for the Reports Server is configured in the server configuration file, <server_name>.conf (see Chapter 3). Tracing for the Reports Servlet is configured in the servlet configuration file, rwservlet.properties (see Chapter 3). Tracing for individual jobs is specified from the runtime command line, via the TRACEOPTS command line argument.

Syntax

TRACEFILE=tracefile

Values

Any valid file name.

Default

None

Usage Notes

See Section 14.5.1.1, "Trace Overview" for additional information about how tracing works with Reports.

A.4.100 TRACEMODE

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

Table A-104 Commands that can use TRACEMODE

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

Description

TRACEMODE indicates whether new trace information should be appended to existing information in a trace file or overwrite the entire file.

Syntax

TRACEMODE={TRACE_APPEND|TRACE_REPLACE}

Values

TRACE_APPEND adds the new information to the end of the file. TRACE_REPLACE overwrites the file.

Default

TRACE_APPEND

Usage Notes

See Section 14.5.1.1, "Trace Overview" for additional information about how tracing works with Reports.

A.4.101 TRACEOPTS

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

Table A-105 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_ERR|TRACE_PRF|TRACE_APP|TRACE_PLS|TRACE_SQL|TRACE_
TMS|TRACE_DST|TRACE_ALL|TRACE_EXC|(TRACE_ERR, TRACE_PLS, ...)}

Values

The following values apply:

A list of options in parentheses means you want all of the enclosed options to be used. For example, TRACE_OPTS=(TRACE_APP, TRACE_PRF) means you want TRACE_APP and TRACE_PRF applied.
TRACE_ALL logs all possible trace information in the trace file.
TRACE_APP logs trace information on all the report objects in the trace file.
TRACE_BRK lists all breakpoints in the trace file.
TRACE_DBG logs debug information.
TRACE_DST lists distribution lists in the trace file. You can use this information to determine which section was sent to which destination.
TRACE_ERR lists error messages and warnings in the trace file.
TRACE_EXC lists Reports Server exceptions.
TRACE_INF is a catch-all option that dumps any information not covered by the other options into the trace file/
TRACE_LOG duplicates log information in your trace file. If you have specified a log element, in addition to a trace element, in your server configuration file, this value will cause information that is sent to the log file to also be sent to the trace file.
TRACE_PLS logs trace information on all the PL/SQL objects in the trace file.
TRACE_PRF logs performance statistics in the trace file.
TRACE_SQL logs trace information on all the SQL in the trace file.
TRACE_STA provides server and engine state information, such as initialize, ready, run, and shut-down.
TRACE_TMS enters a timestamp for each entry in the trace file.
TRACE_WRN lists server warning messages.

Default

TRACE_ALL

Usage Notes

TRACEOPTS can also be used with jobs run as JSPs.

See Section 14.5.1.1, "Trace Overview" for additional information about how tracing works with Reports.

A.4.102 UNINSTALL

Table A-106 indicates which commands can use the UNINSTALL keyword

Table A-106

rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

no

no

no

no

no

no

yes

Commands that can use UINSTALL

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

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.103 URLPARAMETER

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

Table A-107 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.104 USERID

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

Table A-108 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 Reports key mapping file, cgicmd.dat, to specify the runtime command, and include the %D argument in the relevant key mapping entry.

Note:

For information on using the cgicmd.dat file, see Chapter 8, "Running Report Requests".

Syntax

userid=username[/password][@database]

Values

The logon definition must be in one of the following forms and cannot exceed 512 bytes in length:

username[/password] 
username[/password][@database]

Default

None

Usage Notes

USERID can also be used with jobs run as JSPs.

A.4.105 WEBSERVER_DEBUG

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

Table A-109 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 JSP temporary files under docroot/port#/default and log files under docroot/port#/log for your inspection.

Syntax

WEBSERVER_DEBUG={YES|NO}

Values

Yes means create debugging files. No means do not create debugging files.

Default

Usage Notes

Use this keyword only when you're running a job as a JSP. Relevant keywords include WEBSERVER_DEBUG, WEBSERVER_DOCROOT, WEBSERVER_PORT.

A.4.106 WEBSERVER_DOCROOT

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

Table A-110 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 Reports temporary folder.

Default

None

Usage Notes

Use this keyword only when you're running a job as a JSP. Relevant keywords include WEBSERVER_DEBUG, WEBSERVER_DOCROOT, WEBSERVER_PORT.

A.4.107 WEBSERVER_PORT

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

Table A-111 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, 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, Reports tries to look for a free port in that range.

Syntax

WEBSERVER_PORT=port number or range of numbers

Values

Any valid port number or range of port numbers.

Default

The default port is 3000. The default range of ports is 3000-3010.

Usage Notes

Use this keyword only when you're running a job as a JSP. Relevant keywords include WEBSERVER_DEBUG, WEBSERVER_DOCROOT, WEBSERVER_PORT.

A Command Line Arguments

A.1 Command Overview

A.1.1 rwclient

Keywords used with rwclient

A.1.2 rwrun

Keywords used with rwrun

A.1.3 rwbuilder

Keywords used with rwbuilder

A.1.4 rwconverter

Keywords used with rwconverter

A.1.5 rwservlet

Keywords used with rwservlet

A.1.6 rwcgi

Keywords used with rwcgi

A.1.7 rwserver

Keywords used with rwserver

A.2 Command Line Syntax

A.3 General Usage Notes

A.4 Command Line Arguments

A.4.1 ACCESSIBLE

Table A-1 Commands that can use ACCESSIBLE

Description

Syntax

Values

Default

A.4.2 ARRAYSIZE

Table A-2 Commands that can use ARRAYSIZE

Description

Syntax

Values

Default

Usage Notes

A.4.3 AUTHID

Table A-3 Commands that can use AUTHID

Description

Syntax

Values

Default

Usage Notes

A.4.4 AUTOCOMMIT

Table A-4 Commands that can use AUTOCOMMIT

Description

Syntax

Values

Default

Usage Notes

A.4.5 AUTOSTART

Table A-5 Commands that can use AUTOSTART

Description

Syntax

Values

Default

Usage Notes

A.4.6 BATCH

Table A-6 Commands that can use BATCH

Description

Syntax

Default

A.4.7 BCC

Table A-7 Commands that can use BCC

Description

Syntax

Values

Default

Usage Notes

A.4.8 BLANKPAGES

Table A-8 Commands that can use BLANKPAGES

Description

Syntax

Values

Default

Usage Notes

A.4.9 BUFFERS

Table A-9 Commands that can use BUFFERS

Description

Syntax

Values

Default

Usage Notes

A.4.10 CACHELOB

A
Command Line Arguments