Oracle Reports Publishing Reports
Release 6i

A73173-01

Contents

Index

Prev Next

A
RWCLI60 Command Line Arguments

This appendix contains descriptions of RWCLI60 command line arguments.

RWCLI60 parses and transfers the command line to the specified Reports Server (RWMTS60). It uses a command line very similar to RWRUN60.

Syntax

RWCLI60 MODULE|REPORT=runfile USERID=userid 
[ [keyword=]value|(value1, value2, ...) ] SERVER=tnsname

where keyword=value is a valid command line argument.

Usage Notes

MODULE|REPORT

Description MODULE|REPORT is the name of the report to run. (REPORT is allowed for backward compatibility.)

Syntax

[MODULE|REPORT=]runfile 

Values

Any valid runfile (i.e., a file with an extension of .RDF, .REP, or .XML). If you do not enter a file extension, Reports Runtime searches first for a file with extension .REP, then extension .RDF, then .XML, and then no extension. Reports Runtime will use its file path search order to find the file.

USERID

Description USERID is your ORACLE username or placeholder username (i.e., $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, a database logon form is provided.

If you want users to log on to the database, 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 Web CGI command SHOWAUTH and AUTHTYPE=S in the report URL, or include the %D argument to the key mapping entry in the cgicmd.dat (Web CGI) file.

Values

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.

PARAMFORM

Description If PARAMFORM is specified, it must be NO.

Syntax

[PARAMFORM=]NO
CMDFILE

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

Syntax

[CMDFILE=]cmdfile

Values

Any valid command file.

Restrictions

  • A command file may reference another command file.

  • Command file syntax for RWRUN60 arguments is identical to that used on the command line.

  • Values entered on the command line override values specified in command files. For example, suppose that you specify RWRUN60 from the command line with COPIES equal to 1 and CMDFILE equal to RUNONE (a command file). In RUNONE, COPIES is set to 2. Only one copy of the report would be generated in this case.

  • The argument(s) for this keyword may be operating system-specific.

TERM

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

Syntax

[TERM=]termtype

Values

Any valid terminal type.

Default

Installation dependent. (See your Oracle Reports system administrator for a compatible definition.)

Usage Note

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

ARRAYSIZE

Description ARRAYSIZE is the size (in kilobytes) for use with ORACLE array processing. Generally, the larger the array size, the faster the report will run.

Syntax

[ARRAYSIZE=]n 

Values

A number from 1 through 9,999. This means that Reports Runtime can use this number of kilobytes of memory per query in your report.

Default

The default array size is 10K. For details about the ORACLE array processing, see the Oracle8 Server Administrator's Guide.

DESTYPE

Description DESTYPE is the type of device that will receive the report output.

Syntax

[DESTYPE=]{CACHE|LOCALFILE|FILE|PRINTER|SYSOUT|MAIL}

Values

CACHE 

Sends the output directly to the Reports Server's cache. Note that DESTYPE=CACHE is not compatible with the DISTRIBUTE keyword. If the server encounters DISTRIBUTE on the command line, it will ignore the DESTYPE=CACHE command line argument. 

LOCALFILE 

Sends the output to a file on the client machine and forces a synchronous call, regardless of the BACKGROUND value. 

FILE 

Sends the output to the file on the server machine named in DESNAME. 

PRINTER 

Sends the output to the printer on the server machine named in DESNAME. You must have a printer that Oracle Reports can recognize installed and running. 

MAIL 

Sends the output to the mail users specified in DESNAME. You can send mail to any mail system that is MAPI compliant or has the service provider driver installed. The report is sent as an attached file.  

SYSOUT 

Sends the output to the client machine's default output device and forces a synchronous call. 

Default

Taken from the Initial Value property of the DESTYPE parameter.

Usage Note

Screen and Preview cannot be used for DESTYPE with RWCLI60.

DESNAME

Description 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 via 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 usernames by enclosing the names in parentheses and separating them by commas (e.g., (name, name, . . .name)).

Syntax

[DESNAME=]desname

Values

Any valid filename, 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:

Default

Taken from the Initial Value property of the DESNAME parameter. If DESTYPE=FILE and DESNAME is an empty string, it defaults to reportname.lis at runtime.

Usage Notes

  • This keyword is ignored if DESTYPE is SCREEN.

  • If DESTYPE is PREVIEW, Report Builder uses DESNAME to determine which printer's fonts to use to display the output.

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

In some cases, this parameter may be overridden by your operating system.

DESFORMAT

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

Syntax

[DESFORMAT=]desformat

Values

Any valid destination format not to exceed 1K in length. Examples of valid values for this keyword are hpl, hplwide, dec, decwide, decland, dec180, dflt, wide, etc. Ask your System Administrator for a list of valid destination formats.

PDF 

Means that the report output will be sent to a file that can be read by a PDF viewer. PDF output is based upon the currently configured printer for your system. The drivers for the currently selected printer is used to produce the output; you must have a printer configured for the machine on which you are running the report. 

HTML 

Means that the report output will be sent to a file that can be read by an HTML 3.0 compliant browser (e.g., Netscape 2.2). 

HTMLCSS 

Means that the report output sent to a file will include style sheet extensions that can be read by an HTML 3.0 compliant browser that supports cascading style sheets. 

HTMLCSSIE 

Means that the report output sent to a file will include style sheet extensions that can be read by Microsoft Internet Explorer 3.x. 

RTF 

Means that the report output will be sent to a file that can be read by standard word processors (such as Microsoft Word). Note that when you open the file in MS Word, you must choose View->Page Layout to view all the graphics and objects in your report. 

DELIMITED 

Means that the report output will be sent to a file that can be read by standard spreadsheet utilities, such as Microsoft Excel. Note that if you do not choose a delimiter, the default delimiter is a TAB. 

XML 

Means that the report output will be an XML document, saved as a separate file with the .XML extension. This report can be opened and read in an XML-supporting browser, or your choice of XML viewing application. 

Default

Taken from the Initial Value property of the DESFORMAT parameter. For bit-mapped 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.

Usage Notes

  • This keyword is ignored if DESTYPE is SCREEN.

  • The value(s) for this keyword may be case sensitive, depending on your operating system.

CACHELOB

Description Description CACHELOB specifies whether to cache retrieved Oracle8 large object(s) in the temporary file directory (specified by REPORTS60_TMP).

Values

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

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

Default

YES

Usage Notes

  • You can only set this option on the command line.

  • If the location of the temporary file directory does not have sufficient available disk space, it is preferable to set this value to NO. Setting the value to NO, however, may decrease performance, as the LOB may need to be fetched from the server multiple times.

COPIES

Description COPIES is the number of copies of the report output to print.

Syntax

[COPIES=]n

Values

Any valid integer from 1 through 9,999.

Default

Taken from the Initial Value property of the COPIES parameter.

Usage Notes

  • This keyword is ignored if DESTYPE is not Printer.

  • If COPIES is left blank on the Runtime Parameter Form, it defaults to one.

CURRENCY

Description CURRENCY is the currency character to be used in number formats.

Syntax

[CURRENCY=]currency_symbol

Values

Any valid alphanumeric string not to exceed 1K in length.

Default

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.

Usage Notes

  • A CURRENCY value entered in Property Palette will override any CURRENCY value entered on the command line.

THOUSANDS

Description THOUSANDS is the thousands character to be used in number formats.

Syntax

[THOUSANDS=]thousands_symbol

Values

Any valid alphanumeric character.

Default

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.

Usage Notes

  • A THOUSANDS value entered on the Parameter property sheet will override any THOUSANDS value entered on the command line.

  • The alphanumeric character defined as the THOUSANDS value is the actual value that is returned. For example, if you define "," as the THOUSANDS value, "," is returned.

DECIMAL

Description DECIMAL is the decimal character to be used in number formats.

Syntax

[DECIMAL=]decimal_symbol

Values

Any valid alphanumeric character.

Default

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.

Usage Notes

  • A DECIMAL value entered on the Parameter property sheet will override any DECIMAL value entered on the command line.

  • The alphanumeric character defined as the DECIMAL value is actual value that is returned. For example, if you define "." as the DECIMAL value, "." is returned.

READONLY

Description 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 Oracle8 Server SQL Language Reference Manual for more information on SET TRANSACTION READ ONLY).

Syntax

[READONLY=]{YES|NO}

Values

YES requests read consistency.

NO means do not provide read consistency.

Default

NO

Usage Notes

This keyword is only useful for reports using multiple queries, because ORACLE automatically provides read consistency, without locking, for single query reports.

Restrictions

  • In the Report trigger order of execution, notice where the SET TRANSACTION READONLY occurs.

LOGFILE

Description LOGFILE is the name of the file to whichFile->Print Screen output is sent. If the specified file already exists, output will be appended to it. This keyword is only used in character mode.

Syntax

[LOGFILE=]logfile

Values

Any valid filename.

Default

dfltrep.log in the current directory.

BUFFERS

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

Syntax

[BUFFERS=]n

Values

A number from 1 through 9,999. For some operating systems, the upper limit may be lower.

Default

640K

Usage Notes

  • If this setting is changed in the middle of you session, the changes does not take effect until the next time the report is run.

BATCH

Description If BATCH is specified, it must be YES.

Syntax

[BATCH=]YES
PAGESIZE

Description PAGESIZE is the dimensions of the physical page (i.e., the size of the page that the printer outputs). Note that 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, the report will not run.

Syntax

[PAGESIZE=]width x height

Values

Any valid page dimensions of the form: page width x page height, where page width and page height are zero or more. The maximum width/height depends upon the unit of measurement. For inches, the maximum width/height is 512 inches. For centimeters, it is 1312 centimeters. For picas, it is 36,864 picas.

Default

For bitmap, 8.5 x 11 inches. For character mode, 80 x 66 characters. If the report was designed for character mode and is being run or converted on bitmap, 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, the bit-mapped page size would be: (8.5 * 80)/80 x (11 * 20)/66 = 8.5 x 3.33.

Usage Notes

  • On some printers the printable area of the physical page is restricted. For example, the sheet of paper a printer takes may be 8.5 x 11 inches, but the printer might only be able to print on an area of 8 x 10.5 inches. If you define a page width x page height in Report Builder that is bigger than the printable area your printer allows, clipping may occur in your report output. To avoid clipping, you can either increase the printable area for the printer (if your operating system allows it) or you can set the page width x page height to be the size of the printable area of the page.

  • If this keyword is used, its value overrides the page dimensions of the report definition.

  • A PAGESIZE value entered on the Runtime Parameter Form will override any PAGESIZE value entered on the command line.

PROFILE

Description PROFILE is the name of a file in which you want to store performance statistics on report execution. If you specify a filename, Report Builder calculates statistics on the elapsed and CPU time spent running the report. PROFILE calculates the following statistics:

  • TOTAL ELAPSED TIME is the amount of time that passes between when you issue RWBLD60 and when you leave the designer. TOTAL ELAPSED TIME is the sum of Report Builder Time and ORACLE Time.

  • Time is the amount of time spent in Report Builder.

  • ORACLE Time is the amount of time spent in the database and is composed of the following:

  • UPI is the amount of time spent to do such things as connect to the database, parse the SQL, and fetch the data.

  • SQL is the amount of time spent performing SRW.DO_SQL.

  • TOTAL CPU Time used by process is the CPU time spent while in the designer.

Note: For some operating systems, the Report Builder time includes the database time because the database is included in Report Builder's process.

Syntax

[PROFILE=]profiler_file

Values

Any valid filename in the current directory.

RUNDEBUG

Description 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:

  • frames or repeating frames that overlap but do not enclose another object. This can lead to objects overwriting other objects in the output.

  • layout objects with page-dependent references that do not have fixed sizing. Report Builder will make such objects fixed in size regardless of the Vertical and Horizontal Elasticity properties.

  • bind variables referenced at the wrong frequency in PL/SQL.

Syntax

[RUNDEBUG=]{YES|NO}

Values

YES means perform extra runtime error checking.

NO means do not perform extra runtime error checking.

Default

YES

ONSUCCESS

Description ONSUCCESS is whether you want a COMMIT or ROLLBACK performed when a report is finished executing.

Syntax

[ONSUCCESS=]{COMMIT|ROLLBACK|NOACTION}

Values

COMMIT means perform a COMMIT when a report is done.

ROLLBACK means perform a ROLLBACK when a report is done.

NOACTION means do nothing when a report is done.

Default

COMMIT, if a USERID is provided.

NOACTION, if called from an external source (e.g., Oracle Forms) with no USERID provided.

Usage Notes

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

ONFAILURE

Description ONFAILURE is whether you want a COMMIT or ROLLBACK performed if an error occurs and a report fails to complete.

Syntax

[ONFAILURE=]{COMMIT|ROLLBACK|NOACTION}

Values

COMMIT means perform a COMMIT if a report fails.

ROLLBACK means perform a ROLLBACK if a report fails.

NOACTION means do nothing if a report fails.

Default

ROLLBACK, if a USERID is provided.

NOACTION, if called from an external source (e.g., Oracle Forms) with no USERID provided.

Usage Notes

  • 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

Description Description KEYIN is the name of a keystroke file that you want to execute at runtime. KEYIN is used to run the keystroke files created with KEYOUT. Since KEYIN is used to execute a keystroke file, it is only relevant when running in a character-mode environment.

Syntax

[KEYIN=]keyin_file

Values

Any valid key filename in the current directory.

KEYOUT

Description KEYOUT is the name of a keystroke file in which you want Reports Runtime to record all of your keystrokes. You can then use KEYIN to execute 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.

Syntax

[KEYOUT=]keyout_file

Values

Any valid filename.

ERRFILE

Description ERRFILE is the name of a file in which you want Report Builder to store error messages.

Syntax

[ERRFILE=]error_file

Values

Any valid filename.

LONGCHUNK

Description LONGCHUNK is the size (in kilobytes) of the increments in which Report Builder retrieves a LONG column value. When retrieving a LONG value, you may want to retrieve it in increments rather than all at once because of memory size restrictions. LONGCHUNK applies only to Oracle7 and Oracle8.

Syntax

[LONGCHUNK=]n

Values

A number from 1 through 9,999. For some operating systems, the upper limit may be lower.

Default

10K

ORIENTATION

Description ORIENTATION controls the direction in which the pages of the report will print.

Syntax

[ORIENTATION=]{DEFAULT|LANDSCAPE|PORTRAIT}

Values

DEFAULT means use the current printer setting for orientation.

LANDSCAPE means landscape orientation

PORTRAIT means portrait orientation

Default

DEFAULT

Usage Notes

  • If ORIENTATION=LANDSCAPE for a character mode report, you must ensure that your printer definition file contains a landscape clause.

  • Not supported when output to a PCL printer on Motif.

BACKGROUND

Description 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, the job is canceled.

Syntax

[BACKGROUND=]{YES|NO}

Values

YES or NO

Default

NO

MODE

Description MODE specifies whether to run the report in character mode or bitmap. This enables you to run a character-mode report from bit-mapped Report Builder or vice versa. For example, if you want to send a report to a Postscript printer from a terminal (e.g., a vt220), you could invoke character-mode RWRUN60 and run the report with MODE=BITMAP. On Windows, specifying MODE=CHARACTER means that the Report Builder ASCII driver will be used to produce editable ASCII output.

Syntax

[MODE=]{BITMAP|CHARACTER|DEFAULT}

Values

BITMAP

DEFAULT means to run the report in the mode of the current executable being used.

CHARACTER

Default

DEFAULT

PRINTJOB

Description PRINTJOB specifies whether the Print Job dialog box should be displayed before running a report.

Syntax

[PRINTJOB=]{YES|NO}

Values

YES or NO

Default

NO

Usage Notes

  • When a report is run as a spawned process (i.e., one executable, such as RWRUN60, is called from within another executable, such as RWBLD60), the Print Job dialog box will not appear, regardless of PRINTJOB.

  • When DESTYPE=MAIL, the Print Job dialog box will not appear, regardless of PRINTJOB.

TRACEFILE

Description TRACEFILE is the name of the file in which Report Builder logs trace information.

Syntax

[TRACEFILE=]tracefile

Values

Any valid filename.

Usage Notes

  • Trace information can only be generated when running an .RDF file. You cannot specify logging when running a .REP file.

  • If you specify LOGFILE or ERRFILE as well as TRACEFILE, all of the trace information will be placed in the most recently specified file. For example, in the following case, all of the specified trace information would be placed in the err.log because it is the last file specified in the RWRUN60 command.

    RWRUN60 MODULE=order_entry 
    USERID=scott/tiger 
    TRACEFILE=trace.log LOGFILE=mylog.log 
    	ERRFILE=err.log 
    
TRACEMODE

Description TRACEMODE indicates whether Report Builder should add the trace information to the file or overwrite the entire file.

Syntax

[TRACEMODE=]{TRACE_APPEND|TRACE_REPLACE}

Values

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

TRACE_REPLACE overwrites the file.

Default

TRACE_APPEND

Usage Notes

  • Trace information can only be generated when running an .RDF file. You cannot specify logging when running a .REP file.

TRACEOPTS

Description TRACEOPTS indicates the tracing information that you want to be logged in the trace file when you run the report.

Syntax

[TRACEOPTS=]{TRACE_ERR|TRACE_PRF|TRACE_APP|TRACE_PLS|
TRACE_SQL|TRACE_TMS|TRACE_DST|TRACE_ALL|(opt1, opt2, ...)}

Values

A list of options in parentheses means you want all of the enclosed options to be used. For example, TRACE_OPTS=(TRACE_APP, TRACE_PRF) means you want TRACE_APP and TRACE_PRF applied.

TRACE_ALL means log all possible trace information in the trace file.

TRACE_APP means log trace information on all the report objects in the trace file.

TRACE_BRK means list breakpoints in the trace file.

TRACE_DST means list distribution lists in the trace file. You can use this information to determine which section was sent to which destination. The trace file format is very similar to the .DST file format, so you can cut and past to generate a .DST file from the trace file.

TRACE_ERR means list error messages and warnings in the trace file.

TRACE_PLS means log trace information on all the PL/SQL objects in the trace file.

TRACE_PRF means log performance statistics in the trace file.

TRACE_SQL means log trace information on all the SQL in the trace file.

TRACE_TMS means enter a timestamp for each entry in the trace file.

Default

TRACE_ALL

Usage Notes

  • Trace information can only be generated when running a .RDF file. You cannot specify logging when running a .REP file.

AUTOCOMMIT

Description Specifies whether database changes (e.g., CREATE) should be automatically committed to the database. Note that some non-ORACLE databases (e.g., SQL Server) require that AUTOCOMMIT=YES.

Syntax

[AUTOCOMMIT=]{YES|NO}

Values

YES or NO

Default

NO

NONBLOCKSQL

Description NONBLOCKSQL specifies whether to allow other programs to execute while Reports Runtime is fetching data from the database.

Syntax

[NONBLOCKSQL=]{YES|NO}

Values

YES means that other programs can execute while data is being fetched.

NO means that other programs cannot execute while data is being fetched.

Default

YES

ROLE

Description ROLE specifies the database role to be checked for the report at runtime. ROLE is ignored for RWBLD60.

Syntax

[ROLE=]{rolename/[rolepassword]}

Values

A valid role and (optionally) a role password.

DISABLEPRINT

Description DISABLEPRINT specifies whether to disable File->Print, or File->Choose (on Motif) and the equivalent toolbar buttons in the Runtime Previewer.

Syntax

[DISABLEPRINT=]{YES|NO}

Values

YES or NO

Default

NO

when there are blank pages in your report output that you do not want to print.

DISABLEMAIL

Description DISABLEMAIL specifies whether to disable the Mail menu and the equivalent toolbar buttons in the Runtime Previewer.

Syntax

[DISABLEMAIL=]{YES|NO}

Values

YES or NO

Default

NO

DISABLEFILE

Description DISABLEFILE specifies whether to disable the File->Generate to File menu in the Runtime Previewer.

Syntax

[DISABLEFILE=]{YES|NO}

Values

YES or NO

Default

NO

DISABLENEW

Description DISABLENEW specifies whether to disable the Generate->New Previewer menu to prevent the ability to display a new instance of the Runtime Previewer.

Syntax

[DISABLENEW=]{YES|NO}

Values

YES or NO

Default

NO

DESTINATION

Description The DESTINATION keyword allows you to specify the name of a .DST file that defines the distribution for the current run of the report.

Syntax

[DESTINATION=]filename.DST

Values

The name of a .DST file that defines a report or report section distribution.

Usage Note

To enable the DESTINATION keyword, you must specify DISTRIBUTE=YES on the command line.

DISTRIBUTE

Description DELIMITER specifies the character(s) 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.

Syntax

[DISTRIBUTE=]{YES|NO}

Values

YES means to distribute the report to the distribution list.

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

Default

NO

Usage Note

To enable the DESTINATION keyword, you must specify DISTRIBUTE=YES.

PAGESTREAM

Description PAGESTREAM enables or disables page streaming for the report when formatted as HTML or HTMLCSS output, using the navigation controls set by either of the following:

  • the Page Navigation Control Type and Page Navigation Control Value properties in the Report Property Palette.

  • PL/SQL in a Before Report trigger (SRW.SET_PAGE_NAVIGATION_HTML)

Syntax

[PAGESTREAM=]{YES|NO}

Values

YES means to stream the pages.

NO means to output the report without page streaming.

Default

NO

BLANKPAGES

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

Syntax

[BLANKPAGES=]{YES|NO}

Values

YES means print all blank pages

NO means do not print blank pages

Default

YES

Usage Note

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

Description SERVER is the TNS service entry name of the Reports Server.

Syntax

[SERVER=]tnsname

Values

Any valid TNS service entry name.

Usage Note

If you set the REPORTS60_REPORTS_SERVER environment variable on your Web Server machine, 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

Description JOBNAME is the name for a job to appear in the 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, the queue manager will show the report name as the job name.

Syntax

[JOBNAME=]string
SCHEDULE

Description 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

Note: Earlier forms of the SCHEDULE syntax are supported, but only the current SCHEDULE syntax is documented here.

Syntax

[SCHEDULE=]string

where the string is:

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

FREQ   hourly | daily | weekly | monthly | {every LEN | DAYREPEAT}} | {last {WEEKDAYS | weekday | weekend} before {n}+} 

LEN 

{n}+ {minute[s] | hour[s] | day[s] | week[s] | month[s]} 
DAYREPEAT  {first | second | third | fourth | fifth} WEEKDAYS of month 
WEEKDAYS  mon | tue | wed | thu | fri | sat | sun 
TIME  now | CLOCK [DATE] 
CLOCK  h:m | h:mm | hh:m | hh:mm 
DATE  today | tomorrow | {MONTHS {d | dd} [,year]} 
MONTHS  jan | feb | mar | apr | may | jun | jul | aug | sep | oct | nov | dec 

TOLERANCE

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

Syntax

[TOLERANCE=]number

Values: any number of minutes starting from 0


Usage Note:

  • If tolerance is not specified, then the Report Server will rerun the report even if a duplicate report is found in the cache.

  • If a report is being processed (i.e., in the current job queue) when an identical job is submitted, the Reports Server will reuse the output of the currently running job even if TOLERANCE is not specified or is set to zero.

DELIMITER

Description DELIMITER specifies the character(s) to use to separate the cells in your report output.

Syntax

[DELIMITER=]value

Values

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

, means a comma separates each cell

. means a period separates each cell

You can also use 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

Default

Tab

Usage Note

This argument can only be used if you've specified DESFORMAT=DELIMITED.

CELLWRAPPER

Description CELLWRAPPER specifies the character(s) that displays around the delimited cells in your report output.

Syntax

[CELLWRAPPER=]value

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:

tab means a tab displays on each side of the cell

space means a single space displays on each side of the cell

return means a new line displays on each side of the cell

none means no cell wrapper is used

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

\t means a tab displays on each side of the cell

\n means a new line displays on each side of the cell

Default

None

Usage Notes

  • This argument can only be used if you've specified DESFORMAT=DELIMITED.

  • The cell wrapper is different from the actual delimiter.

DATEFORMATMASK

Description DATEFORMATMASK specifies how date values display in your delimited report output.

Syntax

[DATEFORMATMASK=]mask

Values

Any valid date format mask

Usage Note

This argument can only be used if you've specified DESFORMAT=DELIMITED

NUMBERFORMATMASK

Description NUMBERFORMATMASK specifies how number values display in your delimited report output.

Syntax

[NUMBERFORMATMASK=]mask

Values

Any valid number format mask

Usage Note

This argument can only be used if you've specified DESFORMAT=DELIMITED.

EXPRESS_SERVER

Description EXPRESS_SERVER specifies the Express Server to which you want to connect.

Syntax

EXPRESS_SERVER="server=[server]/domain=[domain]/
user=[userid]/password=[passwd]"

Syntax with RAM

EXPRESS_SERVER="server=[server]/domain=[domain]/
user=[userid]/password=[passwd]/ramuser=[ramuserid]/
rampassword=[rampasswd]/ramexpressid=[ramexpid]/ ramserverscript=[ramsscript]/rammasterdb=[ramdb]/
ramconnecttype=[ramconn]"

values

A valid connect string enclosed in double quotes (") where

server is the Express server string (e.g., ncacn_ip_tcp:olap2-pc/sl=x/st=x/ct=x/sv=x/). See below for more details on the server string.

domain is the Express Server domain.

user is the userid to log on to the Express Server.

password is the password for the userid.

ramuser is the userid to log into the RDBMS.

rampassword is the password for the RDBMS.

ramexpressid is the Oracle Sales Analyzer database userid. This is required for Oracle Sales Analyzer databases only.

ramserverscript is the complete file name (including the full path) of the remote database configuration file (RDC) on the server. This file specifies information such as the location of code and data databases. Using UNC (Universal Naming Convention) syntax allows multiple users to use the same connection to access the data without having to map the same drive letter to that location. UNC syntax is \\ServerName\ShareName\ followed by any subfolders and/or files.

rammasterdb is the name of the Relational Access Manager database to attach initially. You must specify only the database file name. This database must reside in a directory that is included in the path list in ServerDBPath for Express Server. You can check the ServerDBPath in the File I/O tab of the Express Configuration Manager dialog box.

ramconnecttype is the type of Express connection. Always specify 0 for a direct connection.

Parameters

The server value contains four parameters that correspond to settings that are made in the Oracle Express Connection Editor and stored in connection (.XCF) files. All four parameters are required and can be specified in any order. The following table describes the parameters and their settings..

Parameter  Description  Setting 

sl  

Server Login  

-2: Host (Domain Login)

-1: Host (Server Login)

0: No authentication required

1: Host (Domain Login) and Connect security

2: Host (Domain Login) and Call security

3: Host (Domain Login) and Packet security

4: Host (Domain Login) and Integrity security

5: Host (Domain Login) and Privacy security

Note: Windows NT uses all the settings. Unix systems use only the settings 0, -1, and -2.See the Express Connection Editor Help system for information on these settings. 

st 

Server Type 

:1: Express Server 

ct 

Connection Type 

0: Express connection 

sv 

Server Version 

1: Express 6.2 or greater 

Usage Notes

  • You can have spaces in the string if necessary (e.g., if the userid is John Smith) because the entire string is inside of quotes.

  • If a forward slash (/) is required in the string, you must use another forward slash as an escape character. For example, if the domain were tools/reports, the command line should be as follows:

    EXPRESS_SERVER="server=ncacn_ip_tcp:olap2-pc/sl=0/
    st=1/ct=0/sv=1/ domain=tools//reports"
    
    
  • You can use single quotes within the string. It is not treated specially because it is enclosed within double quotes.

AUTHID

Description AUTHID is the username and password used to authenticate users to the restricted 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 Reports Server registered in WebDB. By default, the cookie expires after 30 minutes. When a cookie expires, subsequent requests (i.e., ones sent to a secured 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, 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 Web CGI command SHOWAUTH and AUTHTYPE=S in the report URL, or include the %S argument to the key mapping entry in the cgicmd.dat (Web CGI) file.

Syntax

[AUTHID=]username/password

Values

Any valid username and password created in Oracle WebDB. See your DBA to create new users accounts in WebDB.

CUSTOM

Description CUSTOMIZE specifies an XML file that you want to apply to the report when it is run. The XML file contains customizations (e.g., font changes or color changes) that change the report definition in some way.

Syntax

[CUSTOMIZE=]filename.xml | (filename1.xml, filename2.xml, . . .)

Values

A filename or list of filenames that contain a valid XML report definition, with path information prefixed to the filename(s) if necessary.

SAVE_RDF

Description 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 via the CUSTOMIZE keyword and want to save the combination of the two to a new .RDF file.

Syntax

[SAVE_RDF=]filename.rdf

Values

Any valid filename.


Prev Next
Oracle
Copyright © 1999 Oracle Corporation.

All Rights Reserved.

Contents

Index