Skip Headers

Oracle9iAS Reports Services Publishing Reports to the Web
Release 2 (9.0.2)

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

Go to previous page Go to next page

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.

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:

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

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

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.

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]
                                
<div>
<table> <tr><td> <hr> 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. <hr> </td> </tr> </table> </div>

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

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

NO

A.4.2 ARRAYSIZE

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

Table A-2 Commands that can use ARRAYSIZE
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

yes

yes

yes

no

yes

yes

no

Description

Use ARRAYSIZE to specify the size (in kilobytes) for use with 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

10

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=u
                                
sername[/
                                
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

NO

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

NO

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.

Syntax
                                 
BCC=
                                
someone@foo.com OR BCC="
                                
someone@foo.com,s
                                
ometwo@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

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="s
                                
omeone@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

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

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

                              
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

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

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

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

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

NO

Usage Notes

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

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:

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

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:

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

PERMANENT (does not expire)|1 day|2 days|3 days|7 days|14 days|
31 days|60 days|90 days|120 days.

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.

ramexpressid

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

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

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=s erver_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=s erver_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

NO

A.4.39 INSTALL

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

Table A-42
rwclient rwrun rwbuilder rwconverter rwservlet rwcgi rwserver

no

no

no

no

no

no

yes

Commands that can use INSTALL
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=s erver_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

10

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:

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.

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

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.

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