 Contents |
 Index |
|
|
|
|
This appendix contains descriptions of RWCLI60 command line arguments. RWCLI60 parses and transfers the command line to the specified Oracle Reports Services (RWMTS60). It uses a command line very similar to RWRUN60.
Following is the syntax for the RWCLI60 command line, where keyword=value is a valid command line argument:
RWCLI60 MODULE|REPORT=runfile USERID=userid [ [keyword=]value|(value1, value2, ...) ] SERVER=tnsname
The following usage notes apply to the RWCLI60 command line:
MODULE|REPORT is the name of the report to run. (REPORT is allowed for backward compatibility.)
[MODULE|REPORT=]runfile
Any valid runfile (that is, a file with an extension of .RDF, .REP, or .XML). If you do not enter a file extension, then Oracle Reports Runtime searches first for a file with extension .REP, then extension .RDF, then .XML, and then no extension. Oracle Reports Runtime will use its file path search order to find the file.
USERID is your ORACLE user name or placeholder user name (that is, $username) and password with an optional database name, Net8 communication protocol to access a remote database, or ODBC datasource name (if accessing a non-Oracle datasource). If the password is omitted, then a database logon form is provided.
If you want users to log on to the database, then omit the USERID command line argument from the report request. If you want users to log on every time they run report requests, then use the CGI command SHOWAUTH and AUTHTYPE=S in the report URL, or include the %D argument to the key mapping entry in the cgicmd.dat (CGI) file.
The logon definition must be in one of the following forms and cannot exceed 512 bytes in length:
username[/password] username[/password][@database] [user[/password]]@ODBC:datasource[:database] or [user[/password]]@ODBC:* <$username>[/password] <$username>[/password][@database]
See Appendix D, "Database Connection Strings" for a list of valid connection strings.
If PARAMFORM is specified, then it must be NO.
[PARAMFORM=]NO
CMDFILE is a file that contains arguments for the RWRUN60 command. This option enables you to run a report without having to specify a large number of arguments each time you invoke RWRUN60.
[CMDFILE=]cmdfile
Any valid command file.
The following restrictions apply:
TERM is the type of terminal on which you are using RWRUN60. TERM is useful for the Runtime Parameter Form and Runtime Previewer only. This keyword is only used in character mode.
[TERM=]termtype
Any valid terminal type.
Installation dependent. (See your Oracle Reports Services system administrator for a compatible definition.)
The argument or arguments for this keyword might be case sensitive, depending on your operating system.
ARRAYSIZE is 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 9,999. This means that Oracle Reports Runtime can use this number of kilobytes of memory per query in your report.
The default array size is 10K. For details about the ORACLE array processing, see the Oracle8i Server Administrator's Guide.
DESTYPE is the type of device that will receive the report output.
[DESTYPE=]{CACHE|LOCALFILE|FILE|PRINTER|SYSOUT|MAIL}
Taken from the Initial Value property of the DESTYPE parameter.
Screen and Preview cannot be used for DESTYPE with RWCLI60.
DESNAME is the name of the file, printer, 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 MAPI-compliant application on Windows or your native mail application on UNIX). You can specify multiple user names by enclosing the names in parentheses and separating them by commas (for example, (name, name, . . .name)).
[DESNAME=]desname
Any valid file name, printer name, or e-mail ID 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. If DESTYPE=FILE and DESNAME is an empty string, then it defaults to reportname.lis at runtime.
The following usage notes apply:
In some cases, this parameter might be overridden by your operating system.
In bit-mapped environments, DESFORMAT specifies the printer driver to be used when DESTYPE is FILE. In character-mode environments, it specifies the characteristics of the printer named in DESNAME.
[DESFORMAT=]desformat
Any valid destination format not to exceed 1K in length. Examples of valid values for this keyword are, for example, hpl, hplwide, dec, decwide, decland, dec180, dflt, wide. Ask your System Administrator for a list of valid destination formats.
Taken from the Initial Value property of the DESFORMAT parameter. For bit-mapped Oracle Report Builder, if 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 following usage notes apply:
CACHELOB specifies whether to cache retrieved Oracle8 large object or objects in the temporary file directory (specified by REPORTS60_TMP).
YES means to cache the LOB in the temporary file directory. NO means to not cache the LOB in the temporary file directory.
YES
The following usage notes apply:
COPIES is the number of copies of the report output to print.
[COPIES=]n
Any valid integer from 1 through 9,999.
Taken from the Initial Value property of the COPIES parameter.
The following usage notes apply:
CURRENCY is the currency character to be used in number formats.
[CURRENCY=]currency_symbol
Any valid alphanumeric string not to exceed 1K in length.
The default for ORACLE is determined by the ORACLE National Language Support facilities. You can also set a default of up to four characters in the Initial Value property of the CURRENCY parameter.
A CURRENCY value entered in Property Palette overrides any CURRENCY value entered on the command line.
THOUSANDS is the thousands character to be used in number formats.
[THOUSANDS=]thousands_symbol
Any valid alphanumeric character.
The default for ORACLE is determined by the ORACLE National Language Support facilities. You can also set a default of up to four characters in the Initial Value property of the THOUSANDS parameter.
The following usage notes apply:
DECIMAL is the decimal character to be used in number formats.
[DECIMAL=]decimal_symbol
Any valid alphanumeric character.
The default for ORACLE is determined by the ORACLE National Language Support facilities. You can also set a default in the Initial Value property of the DECIMAL parameter.
READONLY requests read consistency across multiple queries in a report. When accessing data from ORACLE, read consistency is accomplished by a SET TRANSACTION READ ONLY statement (refer to your Oracle8i Server SQL Language Reference Manual for more information on SET TRANSACTION READ ONLY).
[READONLY=]{YES|NO}
YES requests read consistency. NO means do not provide read consistency.
NO
This keyword is only useful for reports using multiple queries, because ORACLE automatically provides read consistency, without locking, for single query reports.
In the Report trigger order of execution, notice where the SET TRANSACTION READONLY occurs.
LOGFILE is the name of the file to which File->Print Screen output is sent. If the specified file already exists, then output is appended to it. This keyword is only used in character mode.
[LOGFILE=]logfile
Any valid file name.
dfltrep.log in the current directory.
BUFFERS is 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 9,999. For some operating systems, the upper limit might be lower.
640K
If this setting is changed in the middle of you session, then the changes does not take effect until the next time the report is run.
If BATCH is specified, then it must be YES.
[BATCH=]YES
PAGESIZE is 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 zero or more. The maximum width and height depends upon the unit of measurement. 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 = 8.5 x 3.33.
The following usage notes apply:
PROFILE is the name of a file in which you want to store performance statistics on report execution. If you specify a file name, then Oracle Report Builder calculates statistics on the elapsed and CPU time spent running the report. PROFILE calculates the following statistics:
[PROFILE=]profiler_file
Any valid file name in the current directory.
RUNDEBUG is whether you want extra runtime checking for logical errors in reports. RUNDEBUG checks for things that are not errors but might result in undesirable output. RUNDEBUG checks for the following:
[RUNDEBUG=]{YES|NO}
YES means perform extra runtime error checking. NO means do not perform extra runtime error checking.
YES
ONSUCCESS is whether you want a COMMIT or ROLLBACK performed when a report is finished executing.
[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, Oracle 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.
ONFAILURE is 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, Oracle Forms Services) with no USERID provided.
The COMMIT or ROLLBACK for ONFAILURE is performed after the after fails. Other COMMITs and ROLLBACKs can occur prior to this one. For more information, see the READONLY command.
KEYIN is the name of a keystroke file that you want to run at runtime. KEYIN is used to run the keystroke files created with KEYOUT. Since KEYIN is used to run a keystroke file, it is only relevant when running in a character-mode environment.
[KEYIN=]keyin_file
Any valid key file name in the current directory.
KEYOUT is the name of a keystroke file in which you want Oracle Reports Runtime to record all of your keystrokes. You can then use KEYIN to run the keystroke file. KEYOUT and KEYIN are useful when you have certain keystrokes that you want to do each time you run a report. They are also useful for debugging purposes. Since KEYOUT is used to create a keystroke file, it is only relevant when running reports in a character-mode environment.
[KEYOUT=]keyout_file
Any valid file name.
ERRFILE is the name of a file in which you want Oracle Report Builder to store error messages.
[ERRFILE=]error_file
Any valid file name.
LONGCHUNK is the size (in kilobytes) of the increments in which Oracle Report 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 Oracle7 and Oracle8.
[LONGCHUNK=]n
A number from 1 through 9,999. For some operating systems, the upper limit might be lower.
10K
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. PORTRAIT means portrait orientation.
DEFAULT
The following usage notes apply:
BACKGROUND is whether the call is synchronous (BACKGROUND=NO) or asynchronous (BACKGROUND=YES). A synchronous call means that the client waits for the report to queue, be assigned to a runtime engine, run, and finish. An asynchronous call means that the client simply sends the call without waiting for it to complete. If the client process is killed during a synchronous call, then the job is canceled.
[BACKGROUND=]{YES|NO}
YES or NO
NO
MODE specifies whether to run the report in character mode or bitmap. This enables you to run a character-mode report from bit-mapped Oracle Report Builder or vice versa. For example, if you want to send a report to a PostScript printer from a terminal (for example, a vt220), then you could invoke character-mode RWRUN60 and run the report with MODE=BITMAP. On Windows, specifying MODE=CHARACTER means that the Oracle Report Builder ASCII driver is used to produce editable ASCII output.
[MODE=]{BITMAP|CHARACTER|DEFAULT}
The following values apply:
DEFAULT
PRINTJOB specifies whether the Print Job dialog box should be displayed before running a report.
[PRINTJOB=]{YES|NO}
YES or NO
NO
The following usage notes apply:
TRACEFILE is the name of the file in which Oracle Report Builder logs trace information.
[TRACEFILE=]tracefile
Any valid file name.
The following usage notes apply:
.RDF file. You cannot specify logging when running a .REP file.
RWRUN60 MODULE=order_entry USERID=scott/tiger TRACEFILE=trace.log LOGFILE=mylog.log ERRFILE=err.log
TRACEMODE indicates whether Oracle Report Builder should add the trace information to the 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
Trace information can only be generated when running an .RDF file. You cannot specify logging when running a .REP file.
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|(opt1, opt2, ...)}
The following values apply:
.DST file format, so you can cut and past to generate a .DST file from the trace file.
Trace information can only be generated when running a .RDF file. You cannot specify logging when running a .REP file.
Specifies 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
NONBLOCKSQL specifies whether to allow other programs to execute while Oracle 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
ROLE specifies the database role to be checked for the report at runtime. ROLE is ignored for RWBLD60.
[ROLE=]{rolename/[rolepassword]}
A valid role and (optionally) a role password.
DISABLEPRINT specifies whether to disable File->Print, or File->Choose (on Motif) and the equivalent toolbar buttons in the Runtime Previewer.
[DISABLEPRINT=]{YES|NO}
YES or NO
NO when there are blank pages in your report output that you do not want to print.
DISABLEMAIL specifies whether to disable the Mail menu and the equivalent toolbar buttons in the Runtime Previewer.
[DISABLEMAIL=]{YES|NO}
YES or NO
NO
DISABLEFILE specifies whether to disable the File->Generate to File menu in the Runtime Previewer.
[DISABLEFILE=]{YES|NO}
YES or NO
NO
DISABLENEW specifies whether to disable the Generate->New Previewer menu to prevent the ability to display a new instance of the Runtime Previewer.
[DISABLENEW=]{YES|NO}
YES or NO
The DESTINATION keyword allows you to specify the name of a .DST file that defines the distribution for the current run of the report.
[DESTINATION=]filename.DST
The name of a .DST file that defines a report or report section distribution.
To enable the DESTINATION keyword, you must specify DISTRIBUTE=YES on the command line.
DELIMITER specifies the character or characters to use to separate the cells in your report output.
DISTRIBUTE enables or disables distributing the report output to multiple destinations, as specified by the distribution list defined in the report distribution definition or a .DST 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 and DESFORMAT parameters. This is fundamentally a debug mode to allow running a report set up for distribution without actually executing the distribution.
NO
To enable the DESTINATION keyword, you must specify DISTRIBUTE=YES.
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
BLANKPAGES specifies 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.
SERVER is the TNS service entry name of Oracle Reports Services.
[SERVER=]tnsname
Any valid TNS service entry name.
If you set the REPORTS60_REPORTS_SERVER environment variable on your Web server machine, then you can omit the SERVER command line argument to process requests using the default server, or you can include the SERVER command line argument to override the default.
JOBNAME is the name for a job to appear in the Oracle Reports Queue Manager. It is treated as a comment and has nothing to do with the running of the job. If it is not specified, then the queue manager shows the report name as the job name.
[JOBNAME=]string
SCHEDULE is a scheduling command. The default is now. To eliminate the need for quoting the scheduling command, use underscore (_) instead of a space. For example:
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
Following is the correct syntax:
[SCHEDULE=]string
where the string is:
[FREQ from] TIME [retry {n} + after LEN]
TOLERANCE is the time tolerance for duplicate job detection in minutes. TOLERANCE determines the maximum acceptable time 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 4.2, "Duplicate Job Detection" for more information on duplicate job detection.
[TOLERANCE=]number
Any number of minutes starting from 0
The following usage notes apply:
DELIMITER specifies 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 any of these four 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 argument can only be used if you have specified DESFORMAT=DELIMITED.
CELLWRAPPER specifies the character or characters that displays around the delimited cells in your report output.
[CELLWRAPPER=]value
Any alphanumeric character or string of alphanumeric characters.
|
" |
means a double quotation mark displays on each side of the cell |
|
' |
means a single quotation mark displays on each side of the cell |
You can also use any of these four reserved values:
You can also use escape sequences based on the ASCII character set, such as:
|
\t |
means a tab displays on each side of the cell |
|
\n |
means a new line displays on each side of the cell |
None.
The following usage notes apply:
DATEFORMATMASK specifies how date values display in your delimited report output.
[DATEFORMATMASK=]mask
Any valid date format mask
This argument can only be used if you have specified DESFORMAT=DELIMITED
NUMBERFORMATMASK specifies how number values display in your delimited report output.
[NUMBERFORMATMASK=]mask
Any valid number format mask
This argument can only be used if you have specified DESFORMAT=DELIMITED.
EXPRESS_SERVER specifies 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. The following table describes the parameters and their settings:
The following usage notes apply:
EXPRESS_SERVER="server=ncacn_ip_tcp:olap2-pc/sl=0/ st=1/ct=0/sv=1/ domain=tools//reports"
AUTHID is the user name and password used to authenticate users to the restricted Oracle Reports Server. User authentication ensures that the users making report requests have access privileges to run the requested report. When users successfully log on, their browser is sent an encrypted cookie that authenticates them to the secured Oracle Reports Server registered in Oracle WebDB. By default, the cookie expires after 30 minutes. When a cookie expires, subsequent requests (that is, ones sent to a secured Oracle Reports Server) must be re-authenticated.
You can use the REPORTS60_COOKIE_EXPIRE environment variable to change the expiration time of the authentication cookie. See Appendix C, "Environment Variables" for more information.
If you want users to authenticate and remain authenticated until the cookie expires, then omit the AUTHID command line argument from the report request. If you want users to authenticate every time they run report requests, then use the CGI command SHOWAUTH and AUTHTYPE=S in the report URL, or include the %S argument to the key mapping entry in the cgicmd.dat (CGI) file.
[AUTHID=]username/password
Any valid user name and password created in Oracle WebDB. See your DBA to create new users accounts in Oracle WebDB.
CUSTOMIZE specifies an XML file that you want to apply to the report when it is run. The XML file contains customizations (for example, font changes or color changes) 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.
SAVE_RDF specifies a file to which you want to save a combined .RDF file and .XML customization file. This argument is most useful when you have an .RDF file to which you are applying an .XML file with the CUSTOMIZE keyword and want to save the combination of the two to a new .RDF file.
[SAVE_RDF=]filename.rdf
Any valid file name.
|
 Copyright © 2000 Oracle Corporation. All Rights Reserved. |
|