Middleware
Reports
| 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).
|
Note: Fonts are mapped when a report is opened by the Reports Builder or Reports Runtime, not during the conversion. |
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]
<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>
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=u
sername[/
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.
|
Note: A blind copy is one in which the names of specified recipients are not visible (published) to other recipients. |
BCC=
someone@foo.com OR BCC="
someone@foo.com,s
ometwo@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="s
omeone@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
|
Note: For valid DATEFORMATMASK values see the Reports Builder online help topic, "Date and Time Format Mask Syntax." |
DATEFORMATMASK can also be used with jobs run as JSPs.
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
on the command line. If both these keywords are specified,
=YES
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
]/
password=[
passwd
]"
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=s
erver_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=s
erver_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-42| rwclient | 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=s
erver_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.
|
Note: For valid NUMBERFORMATMASK values see the Reports Builder online help topic, "Number Format Mask Syntax." |
NUMBERFORMATMASK can also be used with jobs run as JSPs.
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.