Oracle9iAS Reports Services Publishing Reports to the Web Release 2 (9.0.2) Part Number A92102-01 |
|
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:
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.
The rwclient
command parses and transfers a command line to the specified (or default) Reports Server.
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]
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.
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]
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.
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]
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).
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]
The rwservlet
command translates and delivers information between HTTP and the Reports Server.
Note:
When you use the |
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]
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.
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]
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.
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]
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.
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.
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.)
Table A-1 indicates which commands can use the ACCESSIBLE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
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.
ACCESSIBLE={YES|NO}
YES means accessibility feature is enabled for Reports PDF output.
NO
Table A-2 indicates which commands can use the ARRAYSIZE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
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.
ARRAYSIZE=n
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.
10
ARRAYSIZE
can also be used with jobs run as JSPs.
Table A-3 indicates which commands can use the AUTHID
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
yes |
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.
AUTHID=username[/password]
Any valid user name and, optionally, password created in Oracle9iAS Portal. See your DBA to create new users accounts in Oracle9iAS Portal.
None
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.
Table A-4 indicates which commands can use the AUTOCOMMIT
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
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.
AUTOCOMMIT={YES|NO}
YES or NO
AUTOCOMMIT
can also be used with jobs run as JSPs.
Table A-5 indicates which commands can use the AUTOSTART
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
no |
no |
yes |
Use AUTOSTART to specify that the Reports Server will automatically start after initial installation and after a reboot, without requiring a user logon.
AUTOSTART={YES|NO}
YES or NO
NO
The AUTOSTART keyword is only recognized on Microsoft Windows platforms.
Table A-6 indicates which commands can use the BATCH
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
yes |
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.
BATCH={YES|NO}
NO
Table A-7 indicates which commands can use the BCC
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use BCC
to specify e-mail recipient(s) of a blind courtesy copy.
BCC=someone@foo.com OR BCC="someone@foo.com,sometwo@foo.com"
Any one or more valid e-mail addresses.
None
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.
Table A-8 indicates which commands can use the BLANKPAGES
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
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.
BLANKPAGES={YES|NO}
YES means print all blank pages. NO means do not print blank pages.
YES
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.
Table A-9 indicates which commands can use the BUFFERS
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
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.
BUFFERS=n
A number from 1 through 9999 (note that thousands are not expressed with any internal punctuation, e.g., a comma or a decimal point). For some operating systems, the upper limit might be lower.
640
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.
Table A-10 indicates which commands can use the CACHELOB
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
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.).
CACHELOB=NO
YES means to cache the LOB in the temporary file directory. NO means to not cache the LOB in the temporary file directory.
YES
CACHELOB
can also be used with jobs run as JSPs.
Table A-12 indicates which commands can use the CC
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use CC to specify e-mail recipient(s) of a courtesy copy.
CC=someone@foo.com OR CC="someone@foo.com,sometwo@foo.com"
Any one or more valid e-mail addresses.
None
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.
Table A-12 indicates which commands can use the CELLWRAPPER
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use CELLWRAPPER to specify the character or characters that should be placed both before and after the cells in a delimited report output.
CELLWRAPPER=value
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:
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 |
None
Table A-13 indicates which commands can use the CMDFILE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
yes |
no |
no |
no |
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.
CMDFILE=cmdfile
Any valid command file.
None
rwservlet
and rwcgi
, use the key argument to refer to a key in the cgicmd.dat file in lieu of using the CMDFILE
keyword.
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.
Table A-14 indicates which commands can use the CMDKEY
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
no |
no |
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". |
CMDKEY=key
The name of any key associated with a command line specified in the cgicmd.dat file.
None
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.
Table A-15 indicates which commands can use the CONTENTAREA
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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.)
CONTENTAREA="Name of Portal content area"
The name of any valid Oracle Portal content area.
None
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.
Table A-16 indicates which commands can use the COPIES
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use COPIES to specify the number of copies of the report output to print.
COPIES=n
Any valid integer from 1 through 9999 (note that thousands are not expressed with any internal punctuation, e.g., a comma or a decimal point).
Taken from the Initial Value property of the COPIES
parameter (the Initial Value was defined in the Reports Builder at design time).
Table A-17 indicates which commands can use the CUSTOMIZE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
yes |
yes |
yes |
no |
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.
CUSTOMIZE=filename.xml | (filename1.xml, filename2.xml, ...)
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". |
None
CUSTOMIZE
can also be used with jobs run as JSPs.
Table A-18 indicates which commands can use the DATEFORMATMASK
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use DATEFORMATMASK to specify how date values display in your delimited report output.
DATEFORMATMASK=mask
Any valid date format mask.
None
This keyword can only be used if you have specified DESFORMAT=DELIMITED
DATEFORMATMASK
can also be used with jobs run as JSPs.
Table A-19 indicates which commands can use the DELAUTH
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
yes |
no |
Use DELAUTH
to delete rwservlet
or rwcgi userid cookies.
http://yourwebserver/yourservletpath/rwservlet/DELAUTH[?]
[server=servername][&authid=username/password]
See Syntax.
None
Related keywords are SERVER and AUTHID.
Table A-20 indicates which commands can use the DELIMITED_HDR
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use DELIMITED_HDR
to switch off all boilerplate (such as the Report header) when running a report with DESFORMAT
=DELIMITED
.
DELIMITED_HDR={YES|NO}
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.
YES
This keyword can be used only if you have specified DESFORMAT
=DELIMITED
.
Table A-21 indicates which commands can use the DELIMITER
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use DELIMITER to specify the character or characters to use to separate the cells in your report output.
DELIMITER=value
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 |
Tab
This keyword can be used only if you have specified DESFORMAT
=DELIMITED
.
Table A-22 indicates which commands can use the DESFORMAT
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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.
DESFORMAT=desformat
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.
Value | Description |
---|---|
CHARACTER |
When the MODE is CHARACTER, the DESFORMAT specifies a printer definition, such as |
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. |
|
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. |
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.
The value or values for this keyword might be case sensitive, depending on your operating system.
Table A-24 indicates which commands can use the DESNAME
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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
DESNAME=desname
Any valid cache destination, file name, printer name, e-mail ID, or OraclePortal, not to exceed 1K in length. For printer names, you can optionally specify a port. For example:
DESNAME=printer,LPT1: DESNAME=printer,FILE:
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.
The argument(s) for this keyword might be case sensitive, depending on your operating system.
Table A-25 indicates which commands can use the DEST
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
Use DEST to specify the name(s) of the converted reports or libraries.
DEST={dname|(dname1, dname2, ...)|pathname}
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)
).
If the DEST keyword is not specified, rwconverter uses the following default names:
(qanda,test,dmast) or (qanda, test, dmast)
Table A-26 indicates which commands can use the DESTINATION
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use the DESTINATION keyword to specify the name of an XML file that defines the distribution for the current run of the report.
DESTINATION=filename.xml
The name of an XML file that defines a report or report section distribution.
None
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". |
Table A-27 indicates which commands can use the DESTYPE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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.
DESTYPE={cache|localFile|file|printer|sysout|mail|oraclePortal|
name_of_pluggable_destination}
Table A-28 lists and describes the valid values for the DESTYPE
keyword.
DESTYPE
keyword
Value | Description |
---|---|
cache |
Sends the output directly to Oracle9iAS Reports cache. |
localFile |
Valid only for |
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. |
|
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. |
Taken from the Initial Value property of the DESTYPE parameter (the Initial Value was defined in the Reports Builder at design time).
Table A-29 indicates which commands can use the DISTRIBUTE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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.
DISTRIBUTE={YES|NO}
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.
NO
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". |
Table A-30 indicates which commands can use the DTYPE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
Use DTYPE to specify the format to which to convert the reports or libraries.
DTYPE={PLDFILE|PLLFILE|RDFFILE|REPFILE|TDFFILE|XMLFILE|JSPFILE
|REGISTER}
The following values apply:
.rdf
extension).
.rep
extension).
.rex
extension).
.tdf
extension).
.xml
extension).
.jsp
extension).
REPFILE
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.
Table A-31 indicates which commands can use the DUNIT
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
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.
DUNIT={CENTIMETER|CHARACTER|INCH|POINT}
Null
Table A-32 indicates which command can use the EXPIRATION
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
yes |
no |
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.
EXPIRATION=time_string
None
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.
Table A-33 indicates which commands can use the EXPIREDAYS
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
yes |
no |
Use EXPIREDAYS to specify the number of days after which the reports output pushed to Oracle Portal should be expired.
EXPIREDAYS={PERMANENT|1 day|2 days|3 days|7 days|14 days|31 days|
60 days|90 days|120 days}
PERMANENT (does not expire)|1 day|2 days|3 days|7 days|14 days|
31 days|60 days|90 days|120 days.
None
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.
Table A-34 indicates which commands can use the EXPRESS_SERVER
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
Use EXPRESS_SERVER to specify the Express Server to which you want to connect.
EXPRESS_SERVER="server=[
server]/domain=[
domain]/user=[
userid]/
passwd
password=[]"
EXPRESS_SERVER="server=[server]/domain=[domain]/ user=[userid]/password=[passwd]/ramuser=[ramuserid]/ rampassword=[rampasswd]/ramexpressid=[ramexpid]/ ramserverscript=[ramsscript]/rammasterdb=[ramdb]/ ramconnecttype=[ramconn]"
A valid connect string enclosed in double quotes (") where:
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:
EXPRESS_SERVER
's
server value
None
EXPRESS_SERVER="server=ncacn_ip_tcp:olap2-pc/sl=0/ st=1/ct=0/sv=1/domain=tools//reports"
Table A-36 indicates which commands can use the FORMSIZE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
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. |
FORMSIZE=width x height
Any valid values in the specified unit of measurement.
None
For non-character DUNITs, you can use a decimal to specify fractions (e.g., 8.5 x 11).
Table A-37 indicates which commands can use the FROM
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use FROM
to specify the e-mail address of the sender of an e-mail.
FROM=someone@foo.com
Any valid e-mail address.
loginid@machine_name
Related keywords include BCC, CC, FROM, REPLYTO, and SUBJECT. Note that DESNAME is used to specify the main recipient(s) of the e-mail.
Table A-38 indicates which commands can use the GETJOBID
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
yes |
no |
Use GETJOBID
to get the result output of the Reports Server job with job ID [n].
http://yourwebserver/reports/rwservlet/getjobid[n][?]
[server=server_name][&authid=username/password][&statusformat={html|xml|xmldtd}]
See Syntax.
None
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.
Table A-39 indicates which commands can use the GETSERVERINFO
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
no |
no |
Use GETSERVERINFO
to display Reports Server information.
http://yourwebserver/reports/rwservlet/getserverinfo[?]
[server=server_name][&authid=username/password]
See Syntax.
None
Related keywords are SERVER and AUTHID.
Table A-40 indicates which commands can use the HELP
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
yes |
no |
Use HELP
to show a help topic that lists the additional commands you can use with the rwservlet
command.
http://yourwebserver/reports/rwservlet/help
See Syntax.
None
Table A-41 indicates which commands can use the IGNOREMARGIN
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
Use IGNOREMARGIN
to specify whether Reports ignores the printer's hardware margin and uses one specified in the report definition's physical page margin.
IGNOREMARGIN={YES|NO}
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.
NO
Table A-42 indicates which commands can use the INSTALL keyword
Table A-42rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
no |
no |
yes |
Use INSTALL to configure an instance of the Reports Server on Microsoft Windows as a service. This argument does not work on UNIX platforms.
INSTALL REPORTS_SERVER_NAME
A valid name for the Reports Server instance
none
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.
Table A-43 indicates which commands can use the ITEMTITLE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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.
ITEMTITLE="Your output title"
Any text.
The report filename
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.
Table A-44 indicates which commands can use the JOBNAME
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
yes |
no |
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.
JOBNAME=string
Any job name.
None
JOBNAME
can also be used with jobs run as JSPs.
Table A-45 indicates which commands can use the JOBTYPE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
yes |
no |
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.
JOBTYPE={a job for which the Reports Server has an engine}
REPORT
Table A-46 indicates which commands can use the KILLJOBID
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
yes |
no |
Use KILLJOBID
to kill a Reports Server job with the specified job ID [n].
http://yourwebserver/reports/rwservlet/killjobid[n][?]
[server=server_name][&authid=username/password][&statusformat={html|xml|xmldtd}]
See Syntax.
None
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.
Table A-47 indicates which commands can use the LONGCHUNK
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
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.
LONGCHUNK=n
A number from 1 through 9999 (note that thousands are not expressed with any internal punctuation, e.g., a comma or a decimal point). For some operating systems, the upper limit might be lower.
10
LONGCHUNK
can also be used with jobs run as JSPs.
Table A-48 indicates which commands can use the MODE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use MODE to specify whether to run the report in character mode or bitmap.
MODE={BITMAP|CHARACTER|DEFAULT}
The following values apply:
DEFAULT
Table A-49 indicates which commands can use the MODULE|REPORT
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
Use MODULE
or REPORT
to specify the name of the report to run.
REPORT|MODULE=runfile
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.
None
Table A-50 indicates which commands can use the NONBLOCKSQL
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
Use NONBLOCKSQL to specify whether to allow other programs to execute while Oracle9iAS Reports Runtime is fetching data from the database.
NONBLOCKSQL={YES|NO}
YES means that other programs can run while data is being fetched. NO means that other programs cannot run while data is being fetched.
YES
NONBLOCKSQL
can also be used with jobs run as JSPs.
Table A-51 indicates which commands can use the NOTIFYFAILURE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
yes |
no |
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".
NOTIFYFAILURE={name1@mycompany.com,name2@mycompany.com}
One or more valid e-mail addresses.
None
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.
Table A-52 indicates which commands can use the NOTIFYSUCCESS
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
yes |
no |
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".
NOTIFYSUCCESS={name1@mycompany.com,name2@mycompany.com}
One or more valid e-mail addresses.
None
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.
Table A-53 indicates which commands can use the NUMBERFORMATMASK
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use NUMBERFORMATMASK to specify how number values display in your delimited report output.
NUMBERFORMATMASK=mask
Any valid number format mask.
None
This keyword can only be used if you have specified DESFORMAT=DELIMITED.
NUMBERFORMATMASK
can also be used with jobs run as JSPs.
Table A-54 indicates which commands can use the ONFAILURE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
Use ONFAILURE to specify whether you want a COMMIT or ROLLBACK performed if an error occurs and a report fails to complete.
ONFAILURE={COMMIT|ROLLBACK|NOACTION}
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.
ROLLBACK, if a USERID is provided. NOACTION, if called from an external source (for example, Oracle9iDS Forms Services) with no USERID provided.
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.
Table A-55 indicates which commands can use the ONSUCCESS
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
Use ONSUCCESS to specify that either a COMMIT or ROLLBACK should be performed when a report is finished running.
ONSUCCESS={COMMIT|ROLLBACK|NOACTION}
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.
COMMIT, if a USERID is provided. NOACTION, if called from an external source (for example, Oracle9iDS Forms Services) with no USERID provided.
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.
Table A-56 indicates which commands can use the ORIENTATION
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
ORIENTATION controls the direction in which the pages of the report will print.
ORIENTATION={DEFAULT|LANDSCAPE|PORTRAIT}
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
Table A-57 indicates which commands can use the OUTPUTFOLDER
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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.
OUTPUTFOLDER=Oracle_Reports_Output
Any valid folder name used in Oracle9iAS Portal.
Oracle_Reports_Output
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.
Table A-58 indicates which commands can use the OUTPUTPAGE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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.)
OUTPUTPAGE=Oracle_Reports_Output
Any valid page name used in Oracle Portal.
Oracle_Reports_Output
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.
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.
Table A-59 indicates which commands can use the OVERWRITE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
Use OVERWRITE to specify whether to overwrite existing files with the converted files.
OVERWRITE={YES|NO|PROMPT}
NO
Table A-60 indicates which commands can use the P_AVAILABILITY keyword.
Table A-60rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
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.
P_AVAILABILITY=calendar_name
Any valid availability calendar name.
none
· The availability calendar must exist in Oracle9iAS Portal before running the SQL*PLUS script. If it does not, an invalid package may be created.
Table A-61 indicates which commands can use the P_DESCRIPTION
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
P_DESCRIPTION is text that provides additional information about the report. This keyword is only used when DTYPE=REGISTER.
P_DESCRIPTON=DESCRIPTION_TEXT
Any text string.
none
Table A-62 indicates which commands can use the P_FORMATS
keyword. This keyword is only used when DTYPE=REGISTER.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
P_FORMATS is the allowable destination formats for the specified reports. This keyword is only used when DTYPE=REGISTER.
P_FORMATS=(HTMLCSS,PDF,...)
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)).
none
Table A-63 indicates which commands can use the P_NAME
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
P_NAME is the report name displayed in Oracle9iAS Portal. This keyword is only used when DTYPE=REGISTER.
P_NAME=REPORT_NAME
Any report name.
If P_NAME is not specified, the PL/SQL function is populated with the report definition file name.
Specify P_NAME only when you want to use the same report name for each report definition file being registered in 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).
Table A-64 indicates which commands can use the P_OWNER
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
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.
P_OWNER=PORTAL_SCHEMA_NAME
Any valid Oracle9iAS Portal schema name.
The name of the Oracle9iAS Portal schema to which you are logged on when you run the SQL*PLUS script file.
Table A-65 indicates the commands that can use the P_PFORMTEMPLATE keyword.
Table A-65rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
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.
P_PFORMTEMPLATE=TEMPLATE_NAME
Any valid Oracle9iAS Portal template name.
none
Table A-66 indicates the commands that can use the P_PRINTERS keyword.
Table A-66rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
P_PRINTERS is the allowable printers for the specified reports. This keyword is only used when DTYPE=REGISTER.
P_PRINTERS=(PRT1,PRT2,...)
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)).
none
Access to the printer(s) should already exist in Oracle9iAS Portal before running the SQL*Plus script.
Table A-67 indicates which commands can use the P_PRIVILEGE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
P_PRIVILEGE is the users or roles who have access privileges to run the specified reports. This keyword is only used when DTYPE=REGISTER.
P_PRIVILEGE=(SCOTT,JABERS,PMARTIN,...)
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)).
none
Table A-68 indicates which commands can use the P_SERVERS
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
P_SERVERS is the names of the restricted Reports Servers that can run the report. This keyword is only used when DTYPE=REGISTER.
P_SERVERS=(repserver1,repserver2,...)
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)).
none
·Access to the Reports Server(s) should already exist in Oracle9iAS Portal.
Table A-69 indicates the commands that can use the P_TRIGGERS keyword.
Table A-69rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
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.
P_TRIGGER=PLSQL_FUNCTION
Any valid PL/SQL function that returns a boolean value.
none
Table A-70 indicates which commands can use the P_TYPES
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
P_TYPES is the allowable destination types for the specified reports. This keyword is only used when DTYPE=REGISTER.
P_TYPES=(CACHE,MAIL,...)
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)).
none
Table A-93 indicates which commands can use the PAGEGROUP
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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.
PAGEGROUP="Name of Oracle Portal page group"
Any valid page group used in Oracle Portal.
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.
Table A-72 indicates which commands can use the PAGESIZE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
yes |
yes |
yes |
no |
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.
PAGESIZE=width x height
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.
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.
Table A-73 indicates which commands can use the PAGESTREAM
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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:
PAGESTREAM={YES|NO}
YES means to stream the pages. NO means to output the report without page streaming.
NO
Table A-74 indicates which commands can use the PARAMFORM
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
yes |
no |
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.
PARAMFORM=YES|NO|HTML
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.
NO
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.
Table A-75 indicates which commands can use the PARSEQUERY
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
yes |
no |
Use PARSEQUERY
to parse an rwservlet
query and display the constructed Reports Server command line.
http://yourwebserver/reports/rwservlet/parsequery[?]
[server=servername][&authid=username/password]query_string
See Syntax.
None
Table A-76 indicates which commands can use the PDFCOMP
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use PDFCOMP
to specify whether PDF output should be compressed.
PDFCOMP={any value 0 through 9) OR {YES|NO}
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.
6
Table A-77 indicates which commands can use the PDFEMBED
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use PDFEMBED
to specify whether Reports will embed the Type1 Postscript font file(s) specified in uifont.ali into PDF output.
PDFEMBED={YES|NO}
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.
YES
Table A-78 indicates which commands can use the PRINTJOB
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
yes |
no |
no |
no |
no |
Use PRINTJOB to specify whether the Print Job dialog box should be displayed before running a report.
PRINTJOB={YES|NO}
YES or NO
NO
Table A-79 indicates which commands can use the READONLY
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
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.
READONLY={YES|NO}
YES requests read consistency. NO means do not provide read consistency.
NO
READONLY
can also be used with jobs run as JSPs.
Table A-80 indicates which commands can use the REPLACEITEM
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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.
REPLACEITEM={YES|NO}
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.
None
Use of this keyword is optional. Relevant keywords include CONTENTAREA, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER, OUTPUTPAGE, PAGEGROUP, REPLACEITEM, SCHEDULE, SITENAME, STATUSFOLDER, STATUSPAGE.
Table A-81 indicates which commands can use the REPLYTO
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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).
REPLYTO=someone@foo.com
Any valid e-mail address.
None
Related keywords include BCC, CC, FROM, REPLYTO, and SUBJECT. Note that DESNAME is used to specify the main recipient(s) of the e-mail.
See MODULE|REPORT.
Table A-82 indicates which commands can use the ROLE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use ROLE to specify the database role to be checked for the report at runtime.
ROLE={rolename[/rolepassword]}
A valid role and (optionally) a role password.
None
ROLE
can also be used with jobs run as JSPs.
Table A-83 indicates which commands can use the RUNDEBUG
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
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.
RUNDEBUG={YES|NO}
YES means display additional error/warning messages. NO means do not display additional error/warning messages.
YES
RUNDEBUG
can also be used with jobs run as JSPs.
Table A-84 indicates which commands can use the SAVE_RDF
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
yes |
yes |
no |
no |
no |
no |
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.
SAVE_RDF=filename.rdf
Any valid file name.
None
You can use SAVE_RDF
with a JSP file, but only the paper layout part, not the Web source.
Table A-85 indicates which commands can use the SCHEDULE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
yes |
no |
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"
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.
SCHEDULE
keyword
None
Table A-87 indicates which commands can use the SERVER
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
yes |
yes |
Use SERVER to specify the name of the Reports Server you want to use to run this report.
SERVER=servername
The server name or a TNS service entry name if you're using a 6i compatible server.
The server name specified in the REPORTS_SERVER environment variable for rwcgi.
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.
Table A-88 indicates which commands can use the SHOWENV
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
yes |
no |
Use SHOWENV
to display the rwserver
configuration file. (rwservlet.properties).
http://yourwebserver/reports/rwservlet/showenv[?]
[server=servername][&authid=username/password]
See Syntax.
None
Table A-89 indicates which commands can use the SHOWJOBS
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
yes |
no |
Use SHOWJOBS
to display a Web view of Reports Server queue status.
http://yourwebserver/reports/rwservlet/showjobs[n][?]
[server=server_name][&authid=username/password][&statusformat={html|xml|xmldtd}]
See Syntax.
None
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.
Table A-90 indicates which commands can use the SHOWMAP
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
yes |
no |
Use SHOWMAP
to display rwservlet
key mappings.
http://yourwebserver/reports/rwservlet/showmap[?]
[server=servername][&authid=username/password]
See Syntax.
None
Table A-89 indicates which commands can use the SHOWMYJOBS
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
no |
no |
Use SHOWMYJOBS
to display the Reports Server queue status for a particular user.
http://yourwebserver/reports/rwservlet/showmyjobs[?]
[server=server_name][&authid=username/password][&statusformat={html|xml|xmldtd}]
See Syntax.
None
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.
Table A-92 indicates which commands can use the SHUTDOWN
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
no |
no |
yes |
Use SHUTDOWN to shut down a previously running server. You must also use AUTHID to supply a user name and password.
SHUTDOWN={NORMAL|IMMEDIATE}
NORMAL or IMMEDIATE
NORMAL
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.
Table A-93 indicates which commands can use the SITENAME
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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.
SITENAME=sitename
Any valid site name used in Oracle Portal.
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.
Table A-94 indicates which commands can use the SOURCE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
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.
SOURCE={source_name|(source_name1, source_name2, ...)}
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)
).
None
(qanda,test,dmast) OR (qanda, test, dmast)
Table A-95 indicates which commands can use the SSOCONN
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
no |
no |
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.
SSOCONN=key[/type[/conn_str]][,key[/type[/conn_str]]]
For example:
ssoconn=mykey/OracleDB/userid
The following information describes the variable values expressed in the SSOCONN syntax:
None
ssoconn=key1/type1/conn_str,key2/type2/conn_str2,key3/type3/conn_str3
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.
For more information about Reports and single sign-on (SSO), see Chapter 7, "Data Source Single Sign-On".
Note:
Table A-89 indicates which commands can use the STATUSFORMAT
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
yes |
no |
no |
Use STATUSFORMAT
to specify the format for the Web view of Reports Server queue status.
Reports_URL/rwservlet/showjobs?
server=server_name&statusformat={html|xml|xmldtd}
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.
Use STATUSFORMAT
in conjunction with the SHOWJOBS
and SHOWMYJOBS keywords.
Table A-98 indicates which commands can use the STATUSFOLDER
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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.)
STATUSFOLDER=Oracle_Reports_Status
Any valid folder name used in Oracle Portal.
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.
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.
Table A-99 indicates which commands can use the STATUSPAGE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
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.
STATUSPAGE=Oracle_Reports_Status
Any valid page name used in Oracle Portal.
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.
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.
Table A-100 indicates which commands can use the STYPE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
no |
Use STYPE to specify the format of the report(s) or libraries to be converted.
STYPE={PLDFILE|PLLFILE|RDFFILE|REXFILE|XMLFILE|JSPFILE}
Use any one of the following values:
RDFFILE
When DTYPE=REGISTER, choose RDDFILE, REXFILE, XML, or JSPFILE for STYPE.
Table A-101 indicates which commands can use the SUBJECT
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
yes |
no |
Use SUBJECT
to specify the subject line of an e-mail.
SUBJECT="any text"
Any text.
None
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.
Table A-102 indicates which commands can be used with the TOLERANCE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
yes |
no |
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.
TOLERANCE=time_string
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.
None
Table A-103 indicates which commands can use the TRACEFILE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
yes |
yes |
no |
no |
no |
no |
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. |
TRACEFILE=tracefile
Any valid file name.
None
See Section 14.5.1.1, "Trace Overview" for additional information about how tracing works with Reports.
Table A-104 indicates which commands can use the TRACEMODE
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
no |
TRACEMODE indicates whether new trace information should be appended to existing information in a trace file or overwrite the entire file.
TRACEMODE={TRACE_APPEND|TRACE_REPLACE}
TRACE_APPEND adds the new information to the end of the file. TRACE_REPLACE overwrites the file.
TRACE_APPEND
See Section 14.5.1.1, "Trace Overview" for additional information about how tracing works with Reports.
Table A-105 indicates which commands can use the TRACEOPTS
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
yes |
yes |
TRACEOPTS indicates the tracing information that you want to be logged in the trace file when you run the report.
TRACEOPTS={TRACE_ERR|TRACE_PRF|TRACE_APP|TRACE_PLS|TRACE_SQL|TRACE_ TMS|TRACE_DST|TRACE_ALL|TRACE_EXC|(TRACE_ERR, TRACE_PLS, ...)}
The following values apply:
TRACE_OPTS=(TRACE_APP, TRACE_PRF)
means you want TRACE_APP and TRACE_PRF applied.
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.
Table A-106 indicates which commands can use the UNINSTALL keyword
Table A-106rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
no |
no |
no |
no |
yes |
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.
UNINSTALL REPORTS_SERVER_NAME
The name of an existing Reports Server instance
none
If you use BATCH=YES with INSTALL, then none of the prompts and dialogs that normally display during the removal process will appear.
Table A-107 indicates which commands can use the URLPARAMETER
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
yes |
no |
Use URLPARAMETER
to specify the URL that is to be fetched with the URL engine.
URLPARAMETER=http://webserver_name/pagename.html
Any valid URL.
None
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.
Table A-108 indicates which commands can use the USERID
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
yes |
yes |
yes |
yes |
yes |
yes |
no |
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". |
userid=username[/password][@database]
The logon definition must be in one of the following forms and cannot exceed 512 bytes in length:
username[/password] username[/password][@database]
None
USERID
can also be used with jobs run as JSPs.
Table A-109 indicates which commands can use the WEBSERVER_DEBUG
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
yes |
no |
no |
no |
no |
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.
WEBSERVER_DEBUG={YES|NO}
Yes means create debugging files. No means do not create debugging files.
NO
Use this keyword only when you're running a job as a JSP. Relevant keywords include WEBSERVER_DEBUG, WEBSERVER_DOCROOT, WEBSERVER_PORT.
Table A-110 indicates which commands can use the WEBSERVER_DOCROOT
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
yes |
no |
no |
no |
no |
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.
WEBSERVER_DOCROOT=REPORTS_TMP/docroot
For example:
WEBSERVER_DOCROOT=c:/temp/docroot
The directory to the document root folder in your Reports temporary folder.
None
Use this keyword only when you're running a job as a JSP. Relevant keywords include WEBSERVER_DEBUG, WEBSERVER_DOCROOT, WEBSERVER_PORT.
Table A-111 indicates which commands can use the WEBSERVER_PORT
keyword.
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwcgi | rwserver |
---|---|---|---|---|---|---|
no |
no |
yes |
no |
no |
no |
no |
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.
WEBSERVER_PORT=port number or range of numbers
Any valid port number or range of port numbers.
The default port is 3000. The default range of ports is 3000-3010.
Use this keyword only when you're running a job as a JSP. Relevant keywords include WEBSERVER_DEBUG, WEBSERVER_DOCROOT, WEBSERVER_PORT.
|
![]() Copyright © 2002 Oracle Corporation. All Rights Reserved. |
|