Skip Headers
Oracle® Fusion Middleware Publishing Reports to the Web with Oracle Reports Services
11g Release 1 (11.1.1)

Part Number B32121-06
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

A.5 Command Line Keywords (ACCESSIBLE to DESTYPE)

This section describes each of the command line keywords that can be used in Oracle Reports.

A.5.1 ACCESSIBLE

Table A-2 indicates which components can use the ACCESSIBLE keyword.

Table A-2 Components That Use ACCESSIBLE

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Description  Use ACCESSIBLE to specify whether accessibility-related features offered through Oracle Reports are enabled (YES) or disabled (NO) for PDF output.

For detailed information about PDF in Oracle Reports, see Chapter 11, "Using PDF in Oracle Reports".

Syntax ACCESSIBLE={YES|NO}

Values 

  • YES Accessibility features are enabled for PDF output.

  • NO Accessibility features are not enabled for PDF output.

Default NO

A.5.2 ARRAYSIZE

Table A-3 indicates which components can use the ARRAYSIZE keyword.

Table A-3 Components That Use ARRAYSIZE

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Description  Use ARRAYSIZE to specify the size (in kilobytes) for use with Oracle's array processing. Generally, the larger the array size, the faster the report will run.

Syntax  ARRAYSIZE=n

Values  

n A number from 1 through 9999 (no comma is used with thousands). This means that Reports Runtime can use this number of kilobytes of memory per query in your report.

Default  10

Usage Notes ARRAYSIZE can be used when running JSP-based Web reports from the command line.

A.5.3 AUTHID

Table A-4 indicates which components can use the AUTHID keyword.

Table A-4 Components That Use AUTHID

rwclient rwrun rwbuilder rwconverter rwservlet rwserver rwbridge

yes

yes

no

no

yes

yes

yes


Description  

  • Use AUTHID to specify the user name and password to be 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

  • With rwbridge: Use AUTHID to specify the user name and the password to authorize shutting down the Oracle Reports Bridge. You can set the identifier element in the Oracle Reports Bridge configuration (using Oracle Enterprise Manager) to the administrator user name and password to secure the Oracle Reports Bridge. This ensures that only administrators can shut down the Oracle Reports Bridge.

Syntax  AUTHID=username/password

Values  

  • username/password Any valid user name and password created in Oracle Portal. See your DBA to create new users accounts in Oracle Portal.

  • With rwbridge:

    username/password The user name and password specified in the identifier element in the Oracle Reports Bridge configuration file (rwbridge_bridgename.conf).

Default None

Usage Notes 

  • AUTHID can be used when running JSP-based Web reports from the command line.

  • If you have a Single Sign-On environment, then the Oracle Application Server Single Sign-On Server will perform the authentication step and pass only the user name to the Reports Server in AUTHID. It is recommended that you use Single Sign-On.

A.5.4 AUTOCOMMIT

Table A-5 indicates which components can use the AUTOCOMMIT keyword.

Table A-5 Components That Use AUTOCOMMIT

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Description  Use AUTOCOMMIT to specify whether database changes (for example, CREATE) should be automatically committed to the database. Some non-Oracle databases (for example, SQL Server) require that AUTOCOMMIT=YES.

Syntax AUTOCOMMIT={YES|NO}

Values 

  • YES Data changes are committed to the database automatically.

  • NO Data changes are not committed to the database until the COMMIT command runs or one of the PL/SQL commands that cause the data to be committed runs.

Default NO

Usage Notes AUTOCOMMIT can be used when running JSP-based Web reports from a URL.

A.5.5 BACKGROUND

Table A-6 indicates which components can use the BACKGROUND keyword.

Table A-6 Components That Use BACKGROUND

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

no

no

no

yes

no


Description BACKGROUND specifies whether a report on the server should be run synchronously (NO) or asynchronously (YES).

Note:

The BACKGROUND system parameter is deprecated in Oracle Reports. BACKGROUND is used only on the command line.

Syntax BACKGROUND={YES|NO}

Values 

  • YES Runs the report asynchronously. The client sends the call to the server, then continues with other processes without waiting for the report job to complete. If the client process is killed, the job is canceled.

  • NO Runs the report synchronously. The client waits for the report to queue, be assigned to a runtime engine, run, and finish.

Default NO

Usage Notes If BACKGROUND=YES is used with rwbuilder, a warning is issued and the keyword is ignored.

A.5.6 BATCH

Table A-7 indicates which components can use the BATCH keyword.

Table A-7 Components That Use BATCH

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

yes


Description  Use BATCH when you want the server to run in no-UI mode. No user interface is displayed 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 box displays while it is running.

With rwconverter, BATCH=YES suppresses all terminal input and output in order to convert reports and libraries without user intervention. With rwserver, BATCH turns the server dialog box off (YES) or on (NO) to display or suppress process messages.

Syntax BATCH={YES|NO}

Values 

  • YES Suppresses all terminal input and output (report is run in the background). This is the default for rwrun.

  • NO Allows special terminal input and output. For rwconverter, the Convert dialog box is displayed, and when you accept the dialog box, the conversion is performed.

Default NO

Usage Notes

  • If BATCH=YES, error messages are sent to SYSOUT. For more information on SYSOUT, see DESTYPE.

  • If BATCH=YES, PARAMFORM=YES is invalid because it is not meaningful to have the Runtime Parameter Form appear in batch mode.

A.5.7 BCC

Table A-8 indicates which components can use the BCC keyword.

Table A-8 Components That Use BCC

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use BCC to specify e-mail recipient(s) of a blind courtesy copy (that is, one in which the names of specified recipients are not visible (published) to other recipients).

Note:

A blind copy is one in which the names of specified recipients are not visible (published) to other recipients.

Syntax BCC="emailid" | ("emailid","emailid",...)

Values 

emailid A valid e-mail address in the form someone@foo.com.

Default None

Usage Notes 

  • Enclose each address in quotation marks. To specify more than one e-mail address, separate each address with a comma.

  • Related keywords include CC, FROM, REPLYTO, and SUBJECT. Note that DESNAME is used to specify the main recipient(s) of the e-mail.

  • BCC can be used when running JSP-based Web reports from the command line.

A.5.8 BLANKPAGES

Table A-9 indicates which components can use the BLANKPAGES keyword.

Table A-9 Components That Use BLANKPAGES

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Description  Use BLANKPAGES to specify whether to suppress blank pages when you print a report. Use this keyword when there are blank pages in your report output that you do not want to print.

Syntax BLANKPAGES={YES|NO}

Values 

  • YES Prints all blank pages.

  • NO Does not print blank pages.

Default  YES

Usage Notes BLANKPAGES is especially useful if your logical page spans multiple physical pages (or panels), and you wish to suppress the printing of any blank physical pages.

A.5.9 BUFFERS

Table A-10 indicates which components can use the BUFFERS keyword.

Table A-10 Components That Use BUFFERS

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Description  Use BUFFERS to specify the size of the virtual memory cache in kilobytes. You should tune this setting to ensure that you have enough space to run your reports, but not so much that you are using too much of your system's resources.

Syntax BUFFERS=n

Values 

n A number from 1 through 9999 (note that thousands are not expressed with any internal punctuation, for example, a comma or a decimal point). For some operating systems, the upper limit might be lower.

Default 640

Usage Notes 

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

  • BUFFERS can be used when running JSP-based Web reports from the command line.

A.5.10 CACHELOB

Table A-11 indicates which components can use the CACHELOB keyword.

Table A-11 Components That Use CACHELOB

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Description  Use CACHELOB to specify whether to cache retrieved ORACLE 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, rwserver.conf; note that a tempDir setting overrides a REPORTS_TMP setting.).

Syntax CACHELOB={YES|NO}

Values 

  • YES The LOB will be cached in the temporary file directory.

  • NO The LOB will not be cached 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 on the server does not have sufficient available disk space, then it is preferable to set this value to NO. Setting the value to NO, however, might decrease performance, as the LOB might need to be fetched from the database multiple times.

  • CACHELOB can be used when running JSP-based Web reports from the command line.

A.5.11 CC

Table A-12 indicates which components can use the CC keyword.

Table A-12 Components That Use CC

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use CC to specify e-mail recipient(s) of a courtesy copy.

Syntax CC="emailid" | ("emailid","emailid",...)

Values 

emailid A valid e-mail address in the form someone@foo.com.

Default None

Usage Notes 

  • Enclose each address in quotation marks. To specify more than one e-mail address, separate each address with a comma.

  • Related keywords include BCC, FROM, REPLYTO, and SUBJECT. Note that DESNAME is used to specify the main recipient(s) of the e-mail.

A.5.12 CELLWRAPPER

Table A-13 indicates which components can use the CELLWRAPPER keyword.

Table A-13 Components That Use CELLWRAPPER

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use CELLWRAPPER to specify the character or characters that displays around the delimited cells in your report output.

Syntax CELLWRAPPER=value

Values 

value Any alphanumeric character or string of alphanumeric characters.

Table A-14 Valid Values - General

Value Description

"

A double quotation mark displays on each side of the cell

'

A single quotation mark displays on each side of the cell


Table A-15 Valid Values - Reserved

Value Description

tab

A tab displays on each side of the cell

space

A single space displays on each side of the cell

return

A new line displays on each side of the cell

none

No cell wrapper is used


Table A-16 Valid Values - Escape Sequences Based on the ASCII Character Set

Value Description

\t

A tab displays on each side of the cell

\n

A new line displays on each side of the cell


Default None

Usage Notes 

  • This keyword can only be used if you have specified DESFORMAT=DELIMITED or DESFORMAT=DELIMITEDDATA.

  • The cell wrapper is different from the actual delimiter. The cell wrapper specifies what character appears around delimited data. The delimiter indicates the boundary or break point between two pieces of data.

A.5.13 CMDFILE

Table A-17 indicates which components can use the CMDFILE keyword.

Table A-17 Components That Use CMDFILE

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

yes

no

no


Description  Use CMDFILE to call a file that contains one report's command line options. The file called must be an ASCII file, either .txt or any other ASCII-type file.

CMDFILE differs from the cgicmd.dat key map file (for more information, see Section 18.13, "Using a Key Map 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. Additionally, the CMDFILE keyword can be used along with other arguments in a command line; while, when you use the key argument associated with cgicmd.dat, it is the only argument that appears in the command line.

The CMDFILE keyword enables you to run a report without specifying a large number of options each time you invoke a run command.

Syntax  CMDFILE=filename

Values  

filename Any valid command file name.

Default None

Usage Notes 

  • With rwservlet, use the CMDKEY keyword to refer to a key in the cgicmd.dat file instead of using the CMDFILE keyword.

  • A command file can reference another command file.

  • The syntax for a command line you specify in the command file is identical to that used on the command line.

  • Values entered on the command line override values specified in command files. For example, suppose you specify 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.

  • The value for this keyword might be operating system-specific.

A.5.14 CMDKEY

Table A-18 indicates which components can use the CMDKEY keyword.

Table A-18 Components That Use CMDKEY

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

no

yes

no


Description  Use CMDKEY to call a key-identified command line in the cgicmd.dat key map file (for more information, see Section 18.13, "Using a Key Map File"). For example:

Syntax CMDKEY=key

Values 

key The name of any key associated with a command line specified in the cgicmd.dat file.

Default None

Usage Notes 

  • When you use CMDKEY with rwservlet, you can use it in any order in the command line (or the URL, following the question mark). With rwservlet, you can use additional command line keywords along with CMDKEY.

  • CMDKEY can be used when running JSP-based Web reports from the command line.

Example

http://your_webserver/reports/rwservlet?cmdkey=key& ...

A.5.15 COLLATE

Table A-19 indicates which components can use the COLLATE keyword.

Table A-19 Components That Use COLLATE

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description Use COLLATE to control the collating behavior when a report is output to a printer.

Syntax COLLATE={YES|NO}

Values 

  • YES Collates the pages when output to a printer.

  • NO Does not collate the pages when output to a printer.

Default YES

Example

Printing three copies of a three page document with COLLATE set to YES would result in output similar to the following:

1 2 3 | 1 2 3 | 1 2 3

The order specified is the page numbers being printed. This behavior is similar to selecting the Collate check box in the Print dialog box.

Printing three copies of a three page document with COLLATE set to NO would result in output similar to the following:

1 1 1 | 2 2 2 | 3 3 3

A.5.16 COMPILE_ALL

Table A-20 indicates which components can use the COMPILE_ALL keyword.

Table A-20 Components That Use COMPILE_ALL

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description Use COMPILE_ALL to forcibly compile all program units in the report being converted by rwconverter, except in the following cases:

  • If the destination type (DTYPE) is REXFILE, XMLFILE, or JSPFILE, then rwconverter will not compile any program units. When REX, XML, or JSP report definitions are opened in Oracle Reports Builder or Reports Server, they are automatically compiled by Oracle Reports.

Syntax COMPILE_ALL={YES|NO}

Values 

  • YES Compiles all program units, except in cases where DTYPE is REXFILE, XMLFILE, or JSPFILE.

  • NO Compiles only uncompiled program units.

Default NO

Usage Notes By default, rwconverter compiles all uncompiled program units during the conversion operation. When COMPILE_ALL=YES, then rwconverter forcibly compiles all the program units (including those already compiled) in the report. This may be useful when moving a report to a different client machine, to ensure everything is recompiled and avoid potential incompatibilities.

A.5.17 CONTAINSHTMLTAGS

Table A-23 indicates which components can use the CONTAINSHTMLTAGS keyword.

Table A-21 Components That Use CONTAINSHTMLTAGS

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Description You can use a defined set of HTML formatting tags to format text style (bold, italics, underline, and strikethrough) and text attributes (font name, font color, and font size), and generate formatted text objects in all bitmap output formats supported by Oracle Reports when the objects' Contains HTML Tags property is set to Yes.

Use CONTAINSHTMLTAGS to specify whether Oracle Reports should interpret the HTML formatting tags for all the supported output formats.

Syntax CONTAINSHTMLTAGS=YES|NO

Values 

  • YES Oracle Reports interprets the HTML formatting tags for all objects whose Contains HTML Tags property is set to Yes.

  • NO Oracle Reports does not interpret the HTML tags for the report, regardless of the object's Contains HTML Tags property setting. For HTML and HTMLCSS ouput, the browser will interpret the HTML formatting tags; for other output formats, the HTML tags themselves will appear as is in the report output.

Default YES

Usage Notes

  • The supported output formats are: PDF, RTF, HTML, HTMLCSS, SPREADSHEET, and PostScript.

  • Oracle Reports' interpretation of HTML tags may be different from the browser's interpretation. As a result, a report designed with HTML tags in releases prior to Oracle Reports 10g Release 2 (10.1.2) may generate different HTML or HTMLCSS output than later releases, where Oracle Reports interprets HTML formatting tags. If you do not wish for Oracle Reports to interpret HTML formatting tags, and instead retain the behavior of prior releases, set the REPORTS_CONTAINSHTMLTAGS environment variable to NO.

  • If you set the REPORTS_CONTAINSHTMLTAGS environment variable to NO, you can still specify CONTAINSHTMLTAGS=YES on the command line for selected reports to have Oracle Reports interpret the HTML formatting tags for all the supported output formats. In other words, the value specified by this command line keyword overrides the REPORTS_CONTAINSHTMLTAGS environment variable.

A.5.18 CONTAINSOLE

Note:

OLE support is obsolete in Oracle Reports (OLE is a client/server feature that is not applicable in a Web-based environment). Instead, use mime types with associated plug-ins and hyperlinks.

Table A-23 indicates which components can use the CONTAINSOLE keyword.

Table A-22 Components That Use CONTAINSOLE

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Description For backward compatibility, use CONTAINSOLE to specify whether the program units or attached libraries for the report contain any OLE (Object Linking and Embedding) calls. If CONTAINSOLE=YES, the OLE system is initialized at the start of report execution and terminated at the end of that report execution.

Syntax CONTAINSOLE=YES|NO

Values 

  • YES The report includes OLE calls in program units or attached libraries.

  • NO The report does not contain any OLE calls in program units or attached libraries.

Default NO

A.5.19 CONTENTAREA

Table A-23 indicates which components can use the CONTENTAREA keyword.

Table A-23 Components That Use CONTENTAREA

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description Use CONTENTAREA to specify the Oracle9iAS Portal Release 1 content area to which report output should be pushed. This keyword is maintained for backward compatibility with Oracle9iAS Portal Release 1; for backward compatibility with Oracle WebDB Release 2.2, see SITENAME. Beginning with Oracle Portal 10g Release 1 (9.0.4), use PAGEGROUP.

Syntax CONTENTAREA=name

Values 

name The name (internal name) of any valid Oracle9iAS Portal Release 1 content area.

Default None

Usage Notes 

  • Use of this keyword is required to push Oracle Reports output to Oracle9iAS Portal Release 1.

  • The CONTENTAREA name should be the internal name and not the display name. The internal name is used to uniquely identify the Oracle9iAS Portal Release 1 component instance.

  • Relevant keywords include CONTENTAREA*, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER*, OUTPUTPAGE, PAGEGROUP, SITENAME*, STATUSFOLDER*, STATUSPAGE.

    * maintained for backward compatibility with Oracle9iAS Portal Release 1 and Oracle WebDB Release 2.2.

A.5.20 COPIES

Table A-24 indicates which components can use the COPIES keyword.

Table A-24 Components That Use COPIES

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description Use COPIES to specify the number of copies of the report output to print.

Syntax COPIES=n

Values 

n Any valid integer from 1 through 9999 (note that thousands are not expressed with any internal punctuation, for example, a comma or a decimal point).

Default Taken from the Initial Value property of the COPIES parameter (the Initial Value was defined in Oracle Reports Builder at design time).

Usage Notes  

  • This keyword is ignored if DESTYPE is not PRINTER.

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

A.5.21 CUSTOMIZE

Table A-25 indicates which components can use the CUSTOMIZE keyword.

Table A-25 Components That Use CUSTOMIZE

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

yes

yes

no


Description  Use CUSTOMIZE to specify an Oracle Reports XML file to be run against the current report. The XML file contains customizations (for example, changes to the layout or data model) that change the report definition in some way.

Syntax CUSTOMIZE=filename.xml | (filename1.xml, filename2.xml,...)

Values  

filenamen.xml The names of the files that contain a valid XML report definition, with path information prefixed to the name(s) if necessary. (if the files are not located in a path specified in the REPORTS_PATH registry or SourceDir property of the engine element).

Note:

For more information on customizing reports at runtime with XML customization files, see Chapter 22, "Customizing Reports with XML".

Default None

Usage Notes 

  • Typically, the file extension of an XML report definition is .xml, but it does not have to be when it is used with the CUSTOMIZE keyword.

  • CUSTOMIZE can be used when running JSP-based Web reports from the command line.

  • In some cases, Microsoft Internet Explorer ignores the mimetype of a URL's return stream and instead sets the type by looking at the URL. This can be a problem when you include CUSTOMIZE as the last keyword when specified in a URL; for example:

    ...REPORT=emp.rdf CUSTOMIZE=c:\myreports\emp.xml

    In this scenario, your URL ends with the extension .xml and Internet Explorer treats the return stream as XML, when in fact it is HTML. As a result, you will receive a browser error. To work around this issue, you should never use recognized file extensions at the end of a URL. In the preceding example, you could switch the positions of the REPORT and CUSTOMIZE parameters in your URL.

A.5.22 DATEFORMATMASK

Table A-26 indicates which components can use the DATEFORMATMASK keyword.

Table A-26 Components That Use DATEFORMATMASK

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description Use DATEFORMATMASK to specify how date values display in your delimited report output.

Syntax DATEFORMATMASK=mask

Values 

mask Any valid date format mask.

Default None

Usage Notes 

  • This keyword can only be used if you have specified DESFORMAT=DELIMITED or DESFORMAT=DELIMITEDDATA.

    Note:

    For valid DATEFORMATMASK values see the Oracle Reports online Help topic, "Date and Time Format Mask Syntax."

  • DATEFORMATMASK can be used when running JSP-based Web reports from the command line.

A.5.23 DBPROXYCONN

Table A-26 indicates which components can use the DBPROXYCONN keyword.

Table A-27 Components That Use DBPROXYCONN

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description Use DBPROXYCONN to specify The key to be used for obtaining proxy user name, password, and database information from Oracle Internet Directory. This key is created in Oracle Internet Directory when specifying default Resource Access Information.

Syntax dbproxyconn=key

Values 

KEY The resource name configured in Oracle Internet Directory in the user RAD or the default RAD.

Default None

Usage Notes 

You can add the dbproxy connection keys in the server configuration files.

A.5.24 DELAUTH

Table A-28 indicates which components can use the DELAUTH keyword.

Table A-28 Components That Use DELAUTH

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

no

yes

no


Description  Use DELAUTH to delete rwservlet user ID cookies.

Syntax http://your_webserver/reports/rwservlet/delauth[?]
[server=
server_name][&authid=username/password]

Values See Syntax

Default None

Usage Notes 

  • This keyword is a command that does not require a value; that is, commands are entered by themselves without a corresponding value.

  • Related keywords are SERVER and AUTHID.

A.5.25 DELIMITED_HDR

Table A-29 indicates which components can use the DELIMITED_HDR keyword.

Table A-29 Components That Use DELIMITED_HDR

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use DELIMITED_HDR to turn off boilerplate text (such as the report header) when running a report with DESFORMAT=DELIMITED or DESFORMAT=DELIMITEDDATA.

Syntax DELIMITED_HDR={YES|NO}

Values 

  • YES Leave boilerplate text as is in the delimited output file.

  • NO Turn off all boilerplate text in the delimited output file.

Default YES

Usage Notes This keyword can be used only if you have specified DESFORMAT=DELIMITED or DESFORMAT=DELIMITEDDATA.

A.5.26 DELIMITER

Table A-30 indicates which components can use the DELIMITER keyword.

Table A-30 Components That Use DELIMITER

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use DELIMITER to specify the character or characters to use to separate the cells in your report output.

Syntax DELIMITER=value

Values 

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

Table A-31 Valid Values - General

Values Description

,

A comma separates each cell

.

A period separates each cell


Any of these reserved values:

Table A-32 Valid Values - Reserved

Values Description

tab

A tab separates each cell

space

A space separates each cell

return

A new line separates each cell

none

No delimiter is used


Table A-33 Valid Values - Escape Sequence based on the ASCII Character set

Values Description

\t

A tab separates each cell

\n

A new line separates each cell


Default Tab

Usage Notes This keyword can be used only if you have specified DESFORMAT=DELIMITED or DESFORMAT=DELIMITEDDATA.

A.5.27 DESFORMAT

Table A-34 indicates which components can use the DESFORMAT keyword.

Table A-34 Components That Use DESFORMAT

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use DESFORMAT to specify either the output format for the report, or the printer definition to use when formatting the report when DESTYPE=FILE and DESNAME=filename.

Syntax DESFORMAT=desformat

Values Any valid destination format not to exceed 1K in length. Examples of valid values for this keyword are listed and described in Table A-35.

Table A-35 Valid Values for DESFORMAT

Value Description

DFLT

The report output is sent to a file that uses the default printer driver to format the report (for example, a PostScript driver generates PostScript output format).

DELIMITED

The report output is sent to a file that can be read by standard spreadsheet utilities, such as Microsoft Excel. If you do not specify a delimiter (through the DELIMITER keyword), the default delimiter is a tab. See Usage Notes.

DELIMITEDDATA

Provides similar functionality as DELIMITED, and is used when you have problems running large volume reports with DESFORMAT=DELIMITED. See Usage Notes.

HTML

The report output is sent to a file that is in HTML format. See Usage Notes.

HTMLCSS

The report output is sent to a file that includes style sheet extensions. See Usage Notes.

PDF

The report output is sent to a file that is in PDF format and can be read by a PDF viewer, such as Adobe Acrobat. PDF output is based upon the currently configured printer for your system. The drivers for the currently selected printer are used to produce the output; you must have a printer configured for the machine on which you are running the report.

printer definition

The printer definition to use when formatting the report when DESTYPE=FILE and DESNAME=filename:

If MODE=BITMAP, this is the name of the printer. A value of DFLT means the default printer driver is used.

If MODE=CHARACTER, this is the name of a printer definition file (.prt file), such as hpl, hplwide, dec, decwide, decland, dec180, dflt, or wide. Ask your System Administrator for a list of valid printer definitions.

RTF

The report output is sent to a file that can be read by word processors (such as Microsoft Word). When you open the file in Microsoft Word, you must choose View > Page Layout to view all the graphics and objects in your report. See Usage Notes.

SPREADSHEET

(Command line only) The report output is sent to an HTML file that can be directly opened with Microsoft Excel 2000. You can generate spreadsheet output from the paper layout of reports saved in any format (.rdf, .jsp, .xml). See Usage Notes.

ENHANCEDSPREADSHEET

(Command line only) Introduced in Oracle Reports 11g Release 1 (11.1.1), the report output is sent to an HTML file that is compatible with spreadsheet applications, such as Microsoft Excel, and also provides enhancements to the SPREADSHEET output format to enable you to burst and distribute reports to spreadsheet format, as well as generate large data sets (up to 75,000 rows) to spreadsheets. You can generate spreadsheet output from the paper layout of reports saved in any format (.rdf, .jsp, .xml). See Usage Notes.

XML

The report output is saved as an XML file. This report can be opened and read in an XML-supporting browser, or your choice of XML viewing application.


Default Taken from the Initial Value property of the DESFORMAT system parameter (defined in Oracle Reports Builder at design time). When you run a report through Oracle Reports Builder and DESFORMAT is blank or DFLT, then the current printer driver (specified in File > Printer ) is used. If a Printer Name has not been selected, then Oracle Reports Builder defaults to PostScript output format.

Usage Notes  

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

  • When DESFORMAT=HTML or DESFORMAT=HTMLCSS, spaces are replaced with  . This default behavior eliminates alignment issues for number values that are right-aligned. If you do not want spaces replaced with   in your HTML and HTMLCSS output, then you must set REPORTS_NO_HTML_SPACE_REPLACE to YES. This removes the functionality of the DELIMITER command line keyword for HTML and HTMLCSS output (DELIMITER is still valid when DESFORMAT=DELIMITED).

  • DESFORMAT=DELIMITED is not supported in a DST file, which is specified on the command line with the DESTINATION keyword to distribute the report. In this case, Oracle Reports displays an error:

    REP-34305: Invalid keyword setting for the destid='DEST1'

    Note:

    DST files are supported for backward compatibility; the preferred and recommended method of distributing reports is with the Distribution dialog box in Reports Builder, or using XML as described in Chapter 20, "Creating Advanced Distributions".

    The DELIMITED functionality also honors the DELIMITER, CELLWRAPPER, NUMBERFORMATMASK, and DATEFORMATMASK command line keywords.

  • When DESFORMAT=DELIMITEDDATA, the DelimitedData driver runs off the report data model and operates in much the same way as the XML driver. Since the driver runs off the data model, any formatting defined in the layout are not reflected in the DelimitedData output.

    You can set the following column properties to alter column names and exclude columns from the DelimitedData output file:

    • The XML Tag property can be used to enter a column alias.

    • The Exclude from XML Output property can be used to exclude the column from the DelimitedData output.

    The DELIMITEDDATA functionality also honors the DELIMITER, CELLWRAPPER, NUMBERFORMATMASK, and DATEFORMATMASK command line keywords just as DELIMITED does.

    For more information on delimited output, see "About delimited output" in the Oracle Reports online Help (and also in the "Advanced Concepts" chapter in the Oracle Reports Building Reports manual).

  • When DESFORMAT=SPREADSHEET, the report output preserves the rich layout formatting such as colors, fonts, conditional formatting, graphs, and images. For detailed information about how different report objects are generated in a report run to DESFORMAT=SPREADSHEET, see "About Spreadsheet Output" in the Oracle Reports online Help (and also in the "Advanced Concepts" chapter in the Oracle Reports Building Reports manual).

  • When you open RTF output generated by Oracle Reports in Microsoft Word 95 for Japanese, you may encounter anomalies in the output, such as dashes not appearing correctly. These issues are specific to Microsoft Word 95 and do not occur in Microsoft Word 97 for Japanese.

A.5.28 DESNAME

Table A-36 indicates which components can use the DESNAME keyword.

Table A-36 Components That Use DESNAME

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use DESNAME to specify the name of the cache, file, printer, WebDAV server, or e-mail ID (or distribution list) to which the report output will be sent.

Syntax DESNAME=desname

Values 

desname Any valid cache destination, file name, printer name, e-mail ID, or WebDAV server, not to exceed 1K in length. For printer names, you can optionally specify a port. For example:

DESNAME=printer,LPT1:DESNAME=printer,FILE:

Default Taken from the Initial Value property of the DESNAME parameter (the Initial Value was defined in Oracle Reports Builder at design time). If DESTYPE=FILE and DESNAME is an empty string, then it defaults to reportname.lis at runtime.

Usage Notes  

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

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

    tsmith@companya.com,gjones@companyb.com,mroberts@companyc.com

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

Examples

Example 1: Sending report output to a file

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf destype=file
desname=c:\mydir\test.pdf

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=file+desname=c:\mydir\test.pdf

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf
destype=file desname=c:\mydir\test.

Example 2: Sending report output to a printer

rwrun report=test.rdf userid=scott/tiger@mydb destype=printer
desname=myprinter

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+destype=printer+desname=myprinter

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb destype=printer desname=myprinter

Example 3: Sending report output to e-mail

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf destype=mail
desname="emp1@comp.com, emp2@comp.com" cc="emp3@comp.com" bcc="mgr@comp.com"
replyto="me@comp.com" from="me@comp.com"

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=mail+desname="emp1@comp.com, emp2@comp.com"+cc="emp3@comp.com"+bcc="mgr@comp.com"+
replyto="me@comp.com"+from="me@comp.com"

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf
destype=mail desname="emp1@comp.com, emp2@comp.com" cc="emp3@comp.com"
bcc="mgr@comp.com" replyto="me@comp.com" from="me@comp.com"

Example 4: Sending report output to WebDAV (any WebDAV server or Oracle Portal WebDAV)

Note:

Currently there is no support for FTP and WebDAV destinations from the Reports Builder environment. However, they are supported from the Reports Runtime and the Reports Server environments.

rwrun report=test.rdf userid=scott/tiger@mydb desformat=htmlcss destype=webdav
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=htmlcss+destype=webdav+
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydbdesformat=htmlcss
destype=webdav
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.htm"

A.5.29 DEST

Table A-37 indicates which components can use the DEST keyword.

Table A-37 Components That Use DEST

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description Use DEST to specify the name(s) of the converted reports or libraries.

Syntax DEST={dest_name|(dest_name1, dest_name2, …)|pathname}

Values 

dest_name Any valid report/library name or filename, or a list of valid report/library names of filenames enclosed in parentheses and separated by commas (for example, (qanda,text,dmast)).

Default If the DEST keyword is not specified, rwconverter uses the following default names:

  • If DTYPE is PLDFILE, then the DEST default name is source.pld.

  • If DTYPE is PLLFILE, then the DEST default name is source.pll.

  • If DTYPE is RDFFILE, then the DEST default name is source.rdf.

  • If DTYPE is REPFILE, then the DEST default name is source.rep.

  • If DTYPE is REXFILE, then the DEST default name is source.rex.

  • If DTYPE is TDFFILE, then the DEST default name is source.tdf.

  • If DTYPE is XMLFILE, then the DEST default name is source.xml.

  • If DTYPE is JSPFILE, then the DEST default name is source.jsp.

  • If DTYPE is REGISTER, then the DEST default name is the name of the SQL*Plus script output file (for example, output.sql).

Usage Notes 

  • A list of report/library names of filenames must be enclosed in parentheses with commas separating each entry. For example:

    (qanda,test,dmast) or (qanda, test, dmast)

  • If you have more destination names than there are source names, the extra destination names are ignored. If you have fewer destination names than there are source names, default names will be used after the destination names run out.

  • The value(s) for the DEST keyword may be operating system-specific.

  • When DTYPE=REGISTER, multiple destinations are not required. If you list more than one SQL*Plus script file name for DEST, only the first one is recognized. The others are ignored.

A.5.30 DESTINATION

Table A-38 indicates which components can use the DESTINATION keyword.

Table A-38 Components That Use DESTINATION

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use the DESTINATION keyword to specify the name of an XML file that defines the distribution for the current run of the report.

Note:

XML based distribution files must have the.xml extension.

Syntax DESTINATION=filename.xml

Values 

filename.xml The name of an XML file that defines a report or report section distribution.

Default None

Usage Notes 

  • To enable the DESTINATION keyword, you must specify DISTRIBUTE=YES on the command line. If both these keywords are specified, DESTYPE, DESNAME, and DESFORMAT are ignored if they are also specified.

  • In some cases, Microsoft Internet Explorer ignores the mimetype of a URL's return stream and instead sets the type by looking at the URL. This can be a problem when you are defining the distribution for a report because your URL might end with the DESTINATION keyword. For example:

    ...DISTRIBUTE=yes DESTINATION=c:\oracle\reports\dist\mydist.xml

    In this scenario, your URL ends with the extension .xml and Internet Explorer treats the return stream as XML, when in fact it is HTML. As a result, you will receive a browser error. To work around this issue, you should never use recognized file extensions at the end of a URL. In the preceding example, you could switch the positions of the DISTRIBUTE and DESTINATION parameters in your URL.

Note:

For more information on creating advanced distributions, see Chapter 20, "Creating Advanced Distributions".

A.5.31 DESTYPE

Table A-39 indicates which components can use the DESTYPE keyword.

Table A-39 Components That Use DESTYPE

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use DESTYPE to specify the type of device that will receive the report output for paper-based reports. If you have created your own pluggable destination through the Oracle Reports Destination API, this is how the destination you created gets called.

Syntax DESTYPE={CACHE|LOCALFILE|FILE|PRINTER|MAIL|ORACLEPORTAL|FTP|
WEBDAV|
name_of_pluggable_destination}

Values Table A-40 lists and describes the valid values for the DESTYPE keyword.

Table A-40 Valid Values for DESTYPE

Value Description

CACHE

Valid only for rwclient and rwservlet. Sends the output directly to the Web browser (cache).

LOCALFILE

Valid only for rwclient and rwservlet. Sends the output to a file on the client machine, synchronously or asynchronously.

When used with rwclient, DESTYPE=LOCALFILE saves the output to the client machine using the file name specified by DESNAME.

When used with rwservlet, DESTYPE=LOCALFILE sets the mimetype to application/octet-stream to force the browser to display the Save dialog box. If for some reason this does not work, you can instead specify DESTYPE=CACHE and add MIMETYPE=REPORTS/LOCAL (or any non-registered mimetype) to force the browser to display the Save dialog box.

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 Oracle Reports Services can recognize installed and running. See Usage Notes, below.

MAIL

Sends the output to the mail users specified in DESNAME. You can send mail to any mail system that works with SMTP.

Note: The configuration file rwserver.conf must include the outgoing mail server name. This applies in both Windows and UNIX environments. Refer to Section 8.2.1.2, "pluginParam".

ORACLEPORTAL

Valid only for rwclient and rwservlet. Sends the output to Oracle Portal. Relevant keywords include CONTENTAREA*, EXPIREDAYS, ITEMTITLE, OUTPUTFOLDER*, OUTPUTPAGE, PAGEGROUP, SCHEDULE, SITENAME*,STATUSFOLDER*,STATUSPAGE.

* maintained for backward compatibility with Oracle9iAS Portal Release 1 and Oracle WebDB Release 2.2.

See Usage Notes, below.

FTP

Sends the output to the specified FTP server. See Usage Notes, below.

WEBDAV

Sends the output to the specified WebDAV server so that the report can be published directly. See Usage Notes, below.

name_of_pluggable_destination

If you have created your own pluggable destination through the Oracle Reports Destination API, this is what you use to call the destination you created.


Default Taken from the Initial Value property of the DESTYPE system parameter (defined in Oracle Reports Builder at design time).

Usage Notes

  • DESTYPE values of SCREEN and PREVIEW are no longer valid because the Reports Runtime (rwrun) user interface is obsolete. In Oracle Reports Builder, you can still set the DESTYPE system parameter to SCREEN to format a report to display screen fonts in the Previewer in the Oracle Reports Builder user interface.

  • DESTYPE=PRINTER: On Windows the hardware-based left margin is ignored, by default. The printing origin starts from the top left corner (0,0) of the physical paper and not the printable area. This is to facilitate the design of printer hardware-based margin independent reports. Printing reports without hardware-based left margins on Windows You must ensure that your report's layout contains enough margin spacing such that your data falls within the printable area. Margin fields in the Page Setup dialog have been disabled to ensure consistency with Oracle Reports Services. To revert to the old behavior of including the hardware margin, set the REPORTS_ADD_HWMARGIN environment variable to YES.

  • DESTYPE=ORACLEPORTAL: Before you push Oracle Reports output to Oracle Portal, ensure that you have created the following:

    • A valid OUTPUTPAGE containing at least one item region.

    • A valid PAGEGROUP containing at least one item region.

    Additionally, you must edit the Reports Server configuration file (rwserver.conf) as follows:

    1. Uncomment the destype=oraclePortal element.

      <destination
         destype="oraclePortal"
         class="oracle.reports.server.DesOraclePortal">
         <!--property name="portalUserid"
                   value="%PORTAL_DB_USERNAME%/%PORTAL_DB_
                           PASSWORD%@%PORTAL_DB_TNSNAME%" 
                   encrypted="no"/--> 
      </destination>
      

      Note:

      In 11g Release 1 (11.1.1), by default, the portalUserid is commented out. Reports Server will determine the connection string and push the report to Oracle Portal. You must uncomment this only if you are using a different Oracle Portal instance.

    2. Substitute the values in the portalUserid property with your Oracle Portal connection information if you do not want to push Oracle Reports output to the default Oracle Portal instance.

      Note:

      If you do not substitute the values or uncomment the destype entry, you will get the following error:

      REP-56092: No class defined for destination type oracleportal

    Running the request is very similar to any other out-of-the-box destinations. For example:

    http://your_server:port/reports/rwservlet?report=test.rdf&userid=scott/tiger@repportal&authid=pushportal/trial&destype=oracleportal&desformat=PDF&pagegroup=PORTAL_REPORTS&outputpage=reports_output&itemtitle=pushtoportal&statuspage=result
    
  • DESTYPE=FTP: Running the request is very similar to any other out-of-the-box pluggable destinations. You must specify the complete FTP URL location along with the file name. If the FTP server needs an authentication, that also needs to be part of the URL as shown in the following example:

    http://your_server:port/reports/rwservlet?report=rep.jsp&destype=FTP&desname=ftp://user:pwd@ftpServer/dir/myreport.pdf&desformat=pdf
    

    In this example, the DESTYPE is FTP and the DESNAME value is a complete FTP URL location along with the report name myreport.pdf.

    To specify proxy information to send and receive information through a firewall, see Section 8.7, "Entering Proxy Information".

    Note:

    The proxy server specified for the FTP destination must support the SOCKS protocol. This check is performed during initialization. If the proxy server does not support the SOCKS protocol, then the server raises the following error:

    REP-62352: FTP Proxy Server specified is not responding

  • DESTYPE=WEBDAV: Running the request is very similar to any other out-of-the-box plyuggable destinations. You must specify the complete WebDAV URL location along with the file name. If the WebDAV server needs an authentication, that also needs to be part of the URL as shown in the following example:

    http://your_server:port/reports/rwservlet?report=rep.jsp&destype=webdav&desname=http://user:pwd@webdavserver/myreport.pdf&desformat=pdf

    In this example, the DESTYPE is WEBDAV and the DESNAME value is a complete WebDAV URL location along with the report name myreport.pdf.

    To specify proxy information to send and receive information through a firewall, see Section 8.7, "Entering Proxy Information".

Examples

Example 1: Running a paper report to a browser (cache)

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=cache

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf
destype=cache

Example 2: Sending report output to a file

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf destype=file
desname=c:\mydir\test.pdf

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=file+desname=c:\mydir\test.pdf

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf
destype=file desname=c:\mydir\test.pdf

Example 3: Sending report output to a printer

rwrun report=test.rdf userid=scott/tiger@mydb destype=printer
desname=myprinter

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+destype=printer+desname=myprinter

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb destype=printer desname=myprinter

Example 4: Sending report output to e-mail

rwrun report=test.rdf userid=scott/tiger@mydb desformat=pdf destype=mail
desname="emp1@comp.com, emp2@comp.com" cc="emp3@comp.com" bcc="mgr@comp.com"
replyto=me@comp.com" from="me@comp.com"

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=pdf+destype=mail+
desname="emp1@comp.com,emp2@comp.com"+cc="emp3@comp.com"+bcc="mgr@comp.com"+
replyto="me@comp.com"+from="me@comp.com"

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb desformat=pdf
destype=mail desname="emp1@comp.com, emp2@comp.com" cc="emp3@comp.com"
bcc="mgr@comp.com" replyto="me@comp.com" from="me@comp.com"

Example 5: Sending report output to WebDAV (any WebDAV server or Oracle Portal WebDAV)

rwrun report=test.rdf userid=scott/tiger@mydb desformat=htmlcss destype=webdav
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+desformat=htmlcss+destype=webdav+
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb
desformat=htmlcss destype=webdav
desname="http://myusername:mypassword@mywebdavserv.com/mydir/test.html"

Example 6: Sending report output to Oracle Portal

rwrun report=test.rdf userid=scott/tiger@mydb destype=oracleportal desformat=PDF
pagegroup=mypagegrp outputpage=reports_output itemtitle=pushtoportal
statuspage=result

http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.rdf+
userid=scott/tiger@mydb+destype=oracleportal+desformat=PDF+pagegroup=mypagegrp+
outputpage=reports_output+itemtitle=pushtoportal+statuspage=result

rwclient server=myrepserv report=test.rdf userid=scott/tiger@mydb
destype=oracleportal desformat=PDF pagegroup=mypagegrp outputpage=reports_output
itemtitle=pushtoportal statuspage=result