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.7 Command Line Keywords (OUTPUTFOLDER to ROLE)

This section provides a brief description of the Oracle Reports components and the keywords that each component can use.

A.7.1 OUTPUTFOLDER

Table A-71 indicates which components can use the OUTPUTFOLDER keyword.

Table A-71 Components That Use OUTPUTFOLDER

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use OUTPUTFOLDER to specify the name of the Oracle WebDB Release 2.2 or Oracle9iAS Portal Release 1 folder to which to report output should be pushed. This keyword is maintained for backward compatibility with Oracle WebDB Release 2.2 and Oracle9iAS Portal Release 1. Beginning with Oracle Portal 10g Release 1 (9.0.4), use OUTPUTPAGE.

Syntax OUTPUTFOLDER=folder

Values 

folder Any valid folder name (internal name) used in Oracle WebDB Release 2.2 or Oracle9iAS Portal Release 1.

Default Oracle_Reports_Output

Usage Notes 

A.7.2 OUTPUTGRAPHFORMAT

Table A-73 indicates which components can use the OUTPUTGRAPHFORMAT keyword.

Table A-72 Components That Use OUTPUTGRAPHFORMAT

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Description Use OUTPUTGRAPHFORMAT to specify the GRAPH image format.

Syntax OUTPUTGRAPHFORMAT={SVG}

Values 

  • SVG (default)

    Supported Graph image format when DESFORMAT value is HTML or HTMLCSS.

Examples

Example 1

The following command lines generate PNG images with HTML output:

rwclient server=my_rep_server report=images.rdf destype=file desformat=html desname=images.html userid=user_id outputgraphformat=SVG

rwrun report=images.rdf destype=file desformat=html desname=images.html userid=user_id outputgraphformat=SVG

A.7.3 OUTPUTIMAGEFORMAT

Table A-73 indicates which components can use the OUTPUTIMAGEFORMAT keyword.

Table A-73 Components That Use OUTPUTIMAGEFORMAT

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Description Use OUTPUTIMAGEFORMAT to specify the format for images in report output.

Syntax OUTPUTIMAGEFORMAT={PNG|JPEG|JPG|GIF|BMP}

Values 

  • PNG,JPEG (default),JPG

    Supported image formats when DESFORMAT value is PDF, HTML, HTMLCSS, RTF, or SPREADSHEET.

  • GIF

    Supported image format when DESFORMAT value is PDF, HTML, HTMLCSS, or SPREADSHEET.

  • BMP

    Supported image formats when DESFORMAT value is RTF.

Usage Notes 

  • This command line keyword overrides the setting of the REPORTS_OUTPUTIMAGEFORMAT environment variable.

  • This command line keyword is not supported if the REPORTS_DEFAULT_DISPLAY environment variable is explicitly set to NO (default is YES). In this case, image rendering defaults to GIF for HTML, HTMLCSS, and PDF output, and BMP for RTF output.

  • You must ensure the format that you specify matches the output type. For example, BMP only works for RTF output. It will not work for HTML, HTMLCSS or PDF output.

  • A report containing images and run to DESFORMAT=SPREADSHEET using a secured Reports Server is not supported. This is due to Microsoft Excel's limitation on cookie support. Alternatively, you can write the Excel output from a secure Reports Server to a URL using WebDAV.

Examples

Example 1

The following command lines generate PNG images with HTML output:

rwclient server=my_rep_server report=images.rdf destype=file desformat=html desname=images.html userid=user_id outputimageformat=PNG

rwrun report=images.rdf destype=file desformat=html desname=images.html userid=user_id outputimageformat=PNG

Similarly when DESFORMAT=pdf, images are embedded in PNG format in the generated PDF document.

Example 2

An error is displayed if an invalid value is specified for the OUTPUTIMAGEFORMAT. The following command lines generate an error message:

rwclient server=my_rep_server report=images.rdf destype=file desformat=html desname=images.html userid=user_id outputimageformat=ABCD

rwrun report=images.rdf destype=file desformat=html desname=images.html userid=user_id outputimageformat=ABCD

The invalid image format ABCD generates the following error message:

REP-35000: The image output format specified is not supported.

A.7.4 OUTPUTPAGE

Table A-74 indicates which components can use the OUTPUTPAGE keyword.

Table A-74 Components That Use OUTPUTPAGE

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use OUTPUTPAGE to specify the name of the Oracle Portal page to which report output should be pushed. For backward compatibility with earlier versions (Oracle WebDB Release 2.2 and Oracle9iAS Portal Release 1), see OUTPUTFOLDER.

Syntax OUTPUTPAGE=page

Values 

page Any valid page name (internal name) used in Oracle Portal.

Default Oracle_Reports_Output

Usage Notes 

  • Use of this keyword is optional to push Oracle Reports output to Oracle Portal:

    • If you do not specify an output page, Oracle Portal will create a default page named Oracle_Reports_Output.

    • If you specify an output page, use the internal name and not the display name. The internal name is used to uniquely identify the Oracle Portal component instance.

  • The value for this keyword is case-sensitive.

  • The page should contain at least one item region when used with DESTYPE=ORACLEPORTAL.

  • 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.7.5 OVERWRITE

Table A-75 indicates which components can use the OVERWRITE keyword.

Table A-75 Components That Use OVERWRITE

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description Use OVERWRITE to specify whether to overwrite existing files with the converted files.

Syntax OVERWRITE={YES|NO|PROMPT}

Values 

  • YES Automatically overwrite any existing files of the same name.

  • NO Do not to convert reports if there are existing files of the same name and display a warning message

  • PROMPT Prompt you before overwriting any existing files.

Default NO

A.7.6 PARAMETER

Table A-75 indicates which components can use the parameter keyword.

Table A-76 Components That Use parameter

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

yes

yes

yes


Description Use parameter to specify a parameter that is part of the report's definition. The value you specify is used for that parameter's value.

Syntax parameter=value

Values 

  • parameter The name of the parameter as defined in the report.

  • value Any valid value for that parameter.

Default Taken from the Initial Value property of the parameter.

Usage Notes 

  • You can override the default value on the Runtime Parameter Form.

  • Values may be in single or double quotes. The effect of single or double quotes is operating-system specific.

  • If you specify runfile(s) using the REPORT keyword, the parameter value(s) will be validated using the settings specified for each parameter (for example, Input Mask, Validation Trigger) in the report(s).

  • If you do not specify runfile(s) using the REPORT keyword, the parameter value(s) are not parsed, or validated, because they may refer to parameters that have not yet been defined.

A.7.7 P_AVAILABILITY

Table A-77 indicates which components can use the P_AVAILABILITY keyword.

Table A-77 Components That Use P_AVAILABILITY

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description  Use P_AVAILABILITY to specify the name of the availability calendar that determines when the reports specified will be available for processing. This keyword is only used when DTYPE=REGISTER.

Syntax P_AVAILABILITY=calendar_name

Values 

calendar_name Any valid availability calendar name.

Default None

Usage Notes The availability calendar must exist in Oracle Portal before running the SQL*PLUS script. If it does not, an invalid package may be created.

A.7.8 P_DESCRIPTION

Table A-78 indicates which components can use the P_DESCRIPTION keyword.

Table A-78 Components That Use P_DESCRIPTION

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description Use P_DESCRIPTION to specify the text that provides additional information about the report. This keyword is only used when DTYPE=REGISTER.

Syntax  P_DESCRIPTON=description_text

Values 

description_text Any text string.

Default None

A.7.9 P_FORMATS

Table A-79 indicates which components can use the P_FORMATS keyword.

Table A-79 Components That Use P_FORMATS

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description Use P_FORMATS to specify the allowable destination formats for the specified reports. This keyword is only used when DTYPE=REGISTER.

Syntax P_FORMATS=destination_format|(destination_format1,destination_format2,...)

Values 

destination_format Any valid destination format (for example, HTML) or a list of valid destination formats enclosed by parentheses with a comma separating the names (for example: HTMLCSS, PDF, RTF).

Usage Notes If the destination format for the report is DELIMITEDDATA, it may not be possible to batch register the report in Oracle Portal. As a workaround, you can define a different destination format, then batch register the report, and later manually edit the report to DESFORMAT=DELIMITEDDATA. For more information about batch registering reports, see Appendix C, "Batch Registering Reports in Oracle Portal"

Default None

A.7.10 P_JDBCPDS

Table A-80 indicates which components can use the P_JDBCPDS keyword.

Table A-80 Components That Use P_JDBCPDS

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Description Use P_JDBCPDS to specify the JDBC pluggable data source (PDS) connection string to connect to a database for running a report containing a JDBC query.

Syntax P_JDBCPDS=userid/password@database

Values A valid JDBC PDS connection string where:

  • userid The user ID for connecting to the JDBC pluggable data source.

  • password The password for the user ID.

  • database The database connection information, specific to the particular data source, as detailed in Section 14.1.2.1, "Sample Connection Information".

Usage Notes P_JDBCPDS is the default sign-on name for connecting to a JDBC PDS. You can change this name in Reports Builder when defining the JDBC query in the Report Wizard. The new sign-on name can be used on the command line as the value for the P_JDBCPDS command line keyword. For more information on defining your JDBC query in Reports Builder, see Section 14.1.2, "Defining and Running a JDBC Query".

Example

To connect to a Sybase data source:

P_JDBCPDS=sybuser/sybpwd@server1.mydomain.com:1300

A.7.11 P_NAME

Table A-81 indicates which components can use the P_NAME keyword.

Table A-81 Components That Use P_NAME

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description Use P_NAME to specify the report name displayed in Oracle Portal. This keyword is only used when DTYPE=REGISTER.

Syntax P_NAME=report_name

Values 

report_name Any report name.

Default  If P_NAME is not specified, the PL/SQL function is populated with the report definition file name.

Usage Notes 

  • If P_NAME is not specified, the PL/SQL function is populated with the report definition file name.

  • Specify P_NAME only when you want to use the same report name for each report definition file being registered in Oracle Portal. This option is typically left blank.

  • The report name cannot be prefaced with numeric characters (for example, 401K_ report is an invalid file name and my_401K_report is valid).

A.7.12 P_OWNER

Table A-82 indicates which components can use the P_OWNER keyword.

Table A-82 Components That Use P_OWNER

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description Use P_OWNER to specify the Oracle Portal DB Provider that owns a report's package, which is created when the report definition files are registered. This keyword is only used when DTYPE=REGISTER.

Syntax  P_OWNER=portal_dbprovider

Values 

portal_dbprovider Any valid Oracle Portal DB Provider name.

Default  The name of the Oracle Portal DB Provider to which you are connected when you run the SQL*PLUS script file.

A.7.13 P_PFORMTEMPLATE

Table A-83 indicates the Components That Use the P_PFORMTEMPLATE keyword.

Table A-83 Components That Use P_PFORMTEMPLATE

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description  Use P_PFORMTEMPLATE to specify the name of the Oracle Portal template that determines the style of the Runtime Parameter Form. This keyword is only used when DTYPE=REGISTER.

Syntax P_PFORMTEMPLATE=template_name

Values 

template_name Any valid Oracle Portal template name.

Default None

A.7.14 P_PRINTERS

Table A-84 indicates the Components That Use the P_PRINTERS keyword.

Table A-84 Components That Use P_PRINTERS

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description Use P_PRINTERS to specify the allowable printers for the specified reports. This keyword is only used when DTYPE=REGISTER.

Syntax P_PRINTERS=printer_name

Values 

printer_name Any valid printer (for example, PRT1), or a list of valid printers enclosed by parentheses with a comma separating the names (for example, (PRT1,PRT2,PRT3)).

Default None

Usage Note Access to the printer(s) should already exist in Oracle Portal before running the SQL*Plus script.

A.7.15 P_PRIVILEGE

Table A-85 indicates which components can use the P_PRIVILEGE keyword.

Table A-85 Components That Use P_PRIVILEGE

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description  Use P_PRIVILEGE to specify the users or roles who have access privileges to run the specified reports. This keyword is only used when DTYPE=REGISTER.

Syntax  P_PRIVILEGE=user_name

Values 

user_name Any user name or role that Oracle Portal can recognize (for example, SCOTT), or a list of user names or roles enclosed by parentheses with a comma separating the names (for example, (SCOTT,JABERS,PMARTIN)).

Default None

A.7.16 P_SERVERS

Table A-86 indicates which components can use the P_SERVERS keyword.

Table A-86 Components That Use P_SERVERS

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description  Use P_SERVERS to specify the names of the restricted Reports Servers that can run the report. This keyword is only used when DTYPE=REGISTER.

Syntax P_SERVERS=tnsname

Values 

tnsname Any valid TNS name of the Reports Server (for example, repserver), or a list of valid Reports Server TNS names enclosed by parentheses with a comma separating the names (for example, (repserver, acct_server, sales_server)).

Default None

Usage Notes Access to the Reports Server(s) should already exist in Oracle Portal.

A.7.17 P_TRIGGER

Table A-87 indicates the Components That Use the P_TRIGGERS keyword.

Table A-87 Components That Use P_TRIGGER

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description Use P_TRIGGER to specify the PL/SQL function that is executed when parameter values are specified on the command line and when users accept the Runtime Parameter Form. The function must return a boolean value (TRUE or FALSE).

This keyword is only used when DTYPE=REGISTER.

Syntax P_TRIGGER=plsql_function

Values 

plsql_function Any valid PL/SQL function that returns a boolean value.

Default None

Example

P_TRIGGER="Is begin IF UPPER(DESTYPE) = ''PRINTER'' AND EMPNAME = ''SMITH'' THEN RETURN(TRUE); ELSE RETURN(FALSE); END IF; end;"

A.7.18 P_TYPES

Table A-88 indicates which components can use the P_TYPES keyword.

Table A-88 Components That Use P_TYPES

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

yes

no

no


Description Use P_TYPES to specify the allowable destination types for the specified reports. This keyword is only used when DTYPE=REGISTER.

Syntax P_TYPES=destination_type

Values 

destination_type Any valid destination type (for example, CACHE to display in a browser), or a list of valid destination types enclosed by parentheses with a comma separating the names (for example, (CACHE,MAIL,PRINTER)).

Default  None

A.7.19 PAGEGROUP

Table A-89 indicates which components can use the PAGEGROUP keyword.

Table A-89 Components That Use PAGEGROUP

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description Use PAGEGROUP to specify the name of the Oracle Portal page group to which report output should be pushed. For backward compatibility with earlier releases, see SITENAME (for Oracle WebDB Release 2.2) and CONTENTAREA (for Oracle9iAS Portal Release 1). The page group must be created in Oracle Portal before you can use this keyword.

Syntax PAGEGROUP=pagegroup

Values 

pagegroup Any valid page group name (internal name) used in Oracle Portal.

Default None

Usage Notes 

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

  • The page group name should be the internal name and not the display name. The internal name is used to uniquely identify the Oracle Portal page 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.7.20 PAGESIZE

Table A-90 indicates which components can use the PAGESIZE keyword.

Table A-90 Components That Use PAGESIZE

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

yes

yes

no


Description Use PAGESIZE to set the dimensions of the physical page (that is, the size of the page that the printer outputs). The page must be large enough to contain the report. For example, if a frame in a report expands to a size larger than the page dimensions, then the report is not run.

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 more than zero. The maximum width and height depends which unit of measurement was set in Oracle Reports Builder (Edit > Preferences > General tab). For inches, the maximum width and height is 512 inches. For centimeters, it is 1312 centimeters. For picas, it is 36,864 picas.

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, then the following formula is used to determine page size if none is specified: (default page size * character page size)/default character page size. For example, if the character page size is 80 x 20, then the bit-mapped page size would be:
( (8.5 * 80)/80) x ((11 * 20)/66) = (680/80) x (220/66) = 8.5 x 3.33.

Usage Notes 

  • On some printers the printable area of the physical page is restricted. For example, the sheet of paper a printer takes might 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 Oracle Reports Builder that is bigger than the printable area your printer allows, then clipping might 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.

  • Letter size is 8.5 inches x 11 inches. A4 size is 210mm x 297mm, or 8.25 inches x 11.75 inches.

  • If you use the PAGESIZE keyword, then its value overrides the page dimensions of the report definition.

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

A.7.21 PAGESTREAM

Table A-91 indicates which components can use the PAGESTREAM keyword.

Table A-91 Components That Use PAGESTREAM

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  PAGESTREAM enables or disables page streaming (pagination) 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 Paginate the report output.

  • NO Output the report without pagination.

Default NO

A.7.22 PARAMFORM

Table A-92 indicates which components can use the PARAMFORM keyword.

Table A-92 Components That Use PARAMFORM

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

no

yes

no


Description Use PARAMFORM to specify whether to display the Runtime Parameter Form when you execute a report through Oracle Reports Servlet (rwservlet). PARAMFORM is used only to supply parameters to paper layout reports, not JSP-based Web reports.

Syntax PARAMFORM=YES|NO|HTML

Values 

  • YES Display the Parameter Form.

  • NO Do not display the Parameter Form.

  • HTML Display the Parameter Form in HTML format.

Default NO

Usage Notes 

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

  • Do not use this keyword when running a report in an Oracle Portal environment. This is because Oracle Portal enables you to set up a Report Runtime Parameter Form, which would conflict with a Parameter Form you specify with the PARAMFORM keyword.

Example

http://myias.mycomp.com:7779/rwservlet?server=myrepserver+report=test.rdf 
+userid=scott/tiger@mydb+destype=cache+desformat=htmlcss+paramform=html

A.7.23 PARSEQUERY

Table A-93 indicates which components can use the PARSEQUERY keyword.

Table A-93 Components That Use PARSEQUERY

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

no

no

yes

no


Description  Use PARSEQUERY to parse an rwservlet query and display the constructed Reports Server command line.

Syntax http://your_webserver/reports/rwservlet/parsequery[?]
[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.7.24 PDFCOMP

Table A-94 indicates which components can use the PDFCOMP keyword.

Table A-94 Components That Use PDFCOMP

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use PDFCOMP to specify whether PDF output should be compressed.

Syntax PDFCOMP=value|{YES|NO}

Values 

  • value Any value 0 though 9. A value of 0 means PDF output will not be compressed. A value of 1 through 9 will compress the PDF output and permit users to control the compression level.

  • YES Compresses output at compression level 6.

  • NO Compresses output at compression level 0 (no compression).

Default 6

A.7.25 PDFEMBED

Table A-95 indicates which components can use the PDFEMBED keyword.

Table A-95 Components That Use PDFEMBED

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use PDFEMBED to specify whether Oracle Reports will embed the Type1 PostScript font file(s) specified in the uifont.ali file into PDF output.

Syntax PDFEMBED={YES|NO}

Values 

  • YES The PDF driver will embed the font(s) specified in the [PDF:Embed] header of the uifont.ali file into the PDF output.

  • NO The font(s) will not be added to PDF output.

Default YES

A.7.26 PDFOWNER

Table A-96 indicates which components can use the PDFOWNER keyword.

Table A-96 Components That Use PDFOWNER

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Note:

To generate PDF encrypted report output using Oracle Reports Builder (rwbuilder), you must pass at least one of the PDF encryption command line keywords (PDUSER, PDFOWNER, or PDFSECURITY) in the command to start rwbuilder.

In Oracle Reports Builder, select Generate to File > PDF to generate the PDF encrypted output.

Description  Use PDFOWNER to specify the owner password for encrypted PDF report output. This password is used in combination with PDFUSER to specify authorization privileges for opening PDF report output (in Acrobat Reader 5.0 or later) and changing the passwords or access permissions of the PDF report output (in Acrobat Writer 6.0 or later). Refer to Table 11-5 for the effect of the possible combinations of the PDFOWNER and PDFUSER command line keywords.

For more information, see Section 11.2.4, "Encryption, Password Protection, and Permissions Security".

Syntax PDFOWNER=owner_password

Values 

owner_password The owner password that must be entered by the end user when prompted.

Default None

A.7.27 PDFSECURITY

Table A-97 indicates which components can use the PDFSECURITY keyword.

Table A-97 Components That Use PDSECURITY

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Note:

To generate PDF encrypted report output using Oracle Reports Builder (rwbuilder), you must pass at least one of the PDF encryption command line keywords (PDUSER, PDFOWNER, or PDFSECURITY) in the command to start rwbuilder.

In Oracle Reports Builder, select Generate to File > PDF to generate the PDF encrypted output.

Description  Use PDFSECURITY to suppress up to 8 permissions for encrypted PDF report output. PDFSECURITY may be specified with or without PDFUSER and PDFOWNER.

For more information, see Section 11.2.4, "Encryption, Password Protection, and Permissions Security".

Syntax PDFSECURITY=suppress_permission[,suppress_permission...]

Values 

suppress_permission Any of the values listed in Table A-98, which specifies the associated effect when the value is specified:

Table A-98 PDFSECURITY Values

Value Effect

NOHIRESPRINTING

Disallows high resolution printing; instead, the document prints at a low resolution.

NOMODIFYCONTENTS

Disallows modifying the contents of the document by operations other than those controlled by NOMODIFYANNOTATIONS, NOFILLIN, and NOASSEMBLY.

NOCOPY

Disallows copying or otherwise extracting text and graphics from the document by operations other than that controlled by NOSCREENREADERS.

NOMODIFYANNOTATIONS

Disallows adding or modifying text annotations, fill in interactive form fields, and, if NOMODIFYCONTENTS is also specified, disallow creating or modifying interactive form fields (including signature fields).

NOFILLIN

Disallows filling in existing interactive form fields (including signature fields), even if NOMODIFYANNOTATIONS is not specified.

NOSCREENREADERS

Disallows extracting text and graphics (for accessibility support or for other purposes).

NOASSEMBLY

Disallows assembling the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if NOMODIFYCONTENTS is not specified.

NOPRINTING

Disallows printing the PDF document.


Default None (all permissions are granted).

Example

PDFSECURITY=NOHIRESPRINTING,NOMODIFYCONTENTS,NOCOPY

A.7.28 PDFUSER

Table A-99 indicates which components can use the PDFUSER keyword.

Table A-99 Components That Use PDFUSER

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Note:

To generate PDF encrypted report output using Oracle Reports Builder (rwbuilder), you must pass at least one of the PDF encryption command line keywords (PDUSER, PDFOWNER, or PDFSECURITY) in the command to start rwbuilder.

In Oracle Reports Builder, select Generate to File > PDF to generate the PDF encrypted output.

Description  Use PDFUSER to specify the user password for encrypted PDF report output. This password is used in combination with PDFOWNER to specify authorization privileges for opening PDF report output (in Acrobat Reader 5.0 or later) and changing the passwords or access permissions of the PDF report output (in Acrobat Writer 6.0 or later). Refer to Table 11-5 for the effect of the possible combinations of the PDFOWNER and PDFUSER command line keywords.

For more information, see Section 11.2.4, "Encryption, Password Protection, and Permissions Security".

Syntax PDFUSER=user_password

Values 

user_password The user password that must be entered by the end user when prompted.

Default None

A.7.29 PFACTION

Table A-100 indicates which components can use the PFACTION keyword.

Table A-100 Components That Use PFACTION

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

no

no

no

no

no


Note:

PFACTION is also used with the Oracle Forms Services keyword RUN_REPORT_OBJECT, which is the most secure approach for calling Oracle Reports from Oracle Forms on the Web. For detailed information about using RUN_REPORT_OBJECT to call Oracle Reports from Oracle Forms, refer to the Oracle Application Server 10g Integrating Oracle Reports in Oracle Forms Services Applications white paper on OTN (http://otn.oracle.com/products/forms/pdf/10g/frm10gsrw10g.pdf). Also refer to the Oracle Fusion Middleware Forms Services Deployment Guide.

Description  Use PFACTION to specify the action string for a Parameter Form. When a request is submitted through rwclient or the Oracle Forms Services RUN_REPORT_OBJECT keyword to run a report that has a Parameter Form, the Parameter Form generated cannot be used unless PFACTION is included in the command line. The unusable Parameter Form is caused by an empty action attribute (because rwclient and RUN_REPORT_OBJECT call Oracle Reports directly on the server, Oracle Reports cannot access the Web environment to obtain the information required to populate the action attribute when generating the HTML Parameter Form).

The action attribute is part of the standard HTML form tag that defines the action that is performed when the end user clicks Submit. The action attribute in the Oracle Reports Parameter Form should contain hidden runtime parameters that are required to process the Oracle Reports request after the end user clicks Submit.

Syntax PFACTION=request_URL_to_rwservlet?_hidden_encoded_original_url_string

Values 

  • request_URL_to_rwservlet The http://host:port/reports/rwservlet URL.

  • encoded_original_url_string The query string to run the report.

Example

rwclient.exe report=pform.rdf destype=cache desformat=pdf paramform=yes PFACTION="http://mymachine.mycompany.com:7777/reports/rwservlet?_hidden_report=pform.rdf%20destype=cache%20desformat=pdf"

A.7.30 PRINTJOB

Table A-101 indicates which components can use the PRINTJOB keyword.

Table A-101 Components That Use PRINTJOB

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

no

no

yes

no

no

no


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

Syntax PRINTJOB={YES|NO}

Values 

  • YES The Print Job dialog box is displayed before the report is run.

  • NO The report is run without displaying the Print Job dialog box.

Default YES

Usage Notes  

  • When a report is run as a spawned process (that is, one component, such as rwrun, is called from within another component, such as rwbuilder), the Print Job dialog box does not appear, regardless of PRINTJOB.

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

A.7.31 READONLY

Table A-102 indicates which components can use the READONLY keyword.

Table A-102 Components That Use READONLY

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

yes

no

yes

no


Description  Use READONLY to request read consistency across multiple queries in a report. When accessing data from an Oracle database, read consistency is accomplished by a SET TRANSACTION READ ONLY statement (refer to your Oracle database documentation for more information on SET TRANSACTION READ ONLY).

Note:

Refer to the Oracle SQL documentation (available on the Oracle Technology Network, (http://www.oracle.com/technology/index.html) for more information on SET TRANSACTION READ ONLY.

Syntax READONLY={YES|NO}

Values 

  • YES Requests read consistency.

  • NO Do not provide read consistency.

Default NO

Usage Notes 

  • READONLY is only useful for reports using multiple queries. An Oracle database automatically provides read consistency, without locking, for single-query reports.

  • In the report trigger order of execution, SET TRANSACTION READ ONLY must be set up before the data fetch occurs.

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

A.7.32 RECURSIVE_LOAD

Table A-103 indicates which components can use the RECURSIVE_LOAD keyword.

Table A-103 Components That Use RECURSIVE_LOAD

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

yes

yes

no


Description  Use RECURSIVE_LOAD to specify whether to validate external references in program units when running a report. If any of the references become invalid, the program unit is automatically recompiled. Setting RECURSIVE_LOAD to NO is useful when running your report against a different database than the one against which its PL/SQL was originally compiled.

Syntax RECURSIVE_LOAD={YES|NO}

Values 

  • YES Validates external references when running a report. If any of the references become invalid, the program unit is recompiled (whether it be in .rdf or .pll).

  • NO Does not validate external references when running a report. This setting is useful when running a report against a different database than the one against which its PL/SQL was originally compiled.

Default YES

A.7.33 REPLYTO

Table A-104 indicates which components can use the REPLYTO keyword.

Table A-104 Components That Use REPLYTO

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use REPLYTO to specify the e-mail address to which replies should be sent when the sender wants replies to go to someone other than the sender (specified by the FROM keyword).

Syntax REPLYTO="emailid"

Values 

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

Default None

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

A.7.34 REPORT | MODULE

See MODULE|REPORT.

A.7.35 ROLE

Table A-105 indicates which components can use the ROLE keyword.

Table A-105 Components That Use ROLE

rwclient rwrun rwbuilder rwconverter rwservlet rwserver

yes

yes

no

no

yes

no


Description  Use ROLE to specify the database role to be checked for the report at runtime. This keyword is useful for giving you the ability to run reports that query database tables to which you would not normally have access privileges.

Syntax ROLE={rolename[/rolepassword]}

Values 

rolename A valid role.

rolepassword (Optional) The matching role password.

Default None

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