Oracle® Fusion Middleware Publishing Reports to the Web with Oracle Reports Services 11g Release 1 (11.1.1) B32121-01 |
|
![]() Previous |
![]() Next |
This section provides a brief description of the Oracle Reports components and the keywords that each component can use
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.
Table A-106 indicates which components can use the RUNDEBUG
keyword.
Table A-106 Components That Use RUNDEBUG
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
no |
Description Use RUNDEBUG
to specify that you want extra runtime checking for logical errors in the report. RUNDEBUG
checks for things that are not errors but might result in undesirable output, and displays these as warnings at runtime, before displaying the report output. Using RUNDEBUG
to run a report in debug mode is not the same as debugging a report using the PL/SQL Interpreter.
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. Such objects will be fixed in size regardless of the Vertical Elasticity and Horizontal Elasticity property settings.
Bind variables referenced at the wrong frequency in PL/SQL.
Syntax RUNDEBUG={YES|NO}
Values
YES
Perform extra runtime error checking.
NO
Do not perform extra runtime error checking.
Default YES
Usage Notes RUNDEBUG
can be used when running JSP-based Web reports from the command line.
Table A-107 indicates which components can use the SAVE_RDF
keyword.
Table A-107 Components That Use SAVE_RDF
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
yes |
yes |
no |
no |
no |
Description Use SAVE_RDF
to specify a filename for a combined RDF file and XML customization file. This keyword is useful when you combine an existing RDF file with a Oracle Reports XML customization file using the CUSTOMIZE
keyword, and you wish to save the combination to a new RDF file.
Syntax SAVE_RDF=
filename
.rdf
Values Any valid file name.
Default None
Usage Notes You can use SAVE_RDF
with a JSP file, but only the paper layout part, not the Web source.
Table A-108 indicates which components can use the SCHEDULE
keyword.
Table A-108 Components That Use SCHEDULE
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
no |
Description Use SCHEDULE
to set the day, time, and frequency a report should be run. The default is to run the report once, now. Time values are expressed according to a 24-hour day (that is, one o'clock is expressed 13:00). To eliminate the need for quoting the scheduling command, use underscores (_) instead of spaces. You can also specify an expiration for a report job after a number of runs or on a particular date/time.
Syntax SCHEDULE
=string
where string
is:
[FREQ
from]
TIME
[retry {
n
} after
LEN
expires {on|after} time|
n
]
Table A-109 lists and explains the values used in this string.
Table A-109 Values for string used with the SCHEDULE keyword
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 |
EXPIRES |
on {today | tomorrow | {MONTHS {d | dd} [,year]}}|after n |
Default None
Examples
SCHEDULE=every_first_fri_of_month_from_15:53_Oct_23,_1999_retry_3_after_1_hour_expires_on_15:53_Oct_23,_2003
SCHEDULE=last_weekday_before_15_from_15:53_Oct_23,_1999_retry_after_1_hour_expires_after_100
Or:
SCHEDULE="every first fri of month from 15:53 Oct 23, 1999 retry 3 after 1 hour expires on 15:53 Oct 23, 2003"
SCHEDULE="last weekday before 15 from 15:53 Oct 23, 1999 retry after 1 hour expires after 100"
Table A-110 indicates which components can use the SERVER
keyword.
Table A-110 Components That Use SERVER
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
yes |
Description Use SERVER
to specify the name of the Reports Server you want to use to run this report.
Syntax SERVER=
server_name
Values See Syntax
Usage Notes
For jobs run with rwservlet
or as a JSP, you can omit the SERVER
keyword if you have specified a default server in the Oracle Reports Servlet (rwservlet
) configuration file, rwservlet.properties
; or you can include the SERVER
keyword to override the default.
SERVER
can be used when running JSP-based Web reports from the command line.
Table A-111 indicates which components can use the SHOWAUTH
keyword.
Table A-111 Components That Use SHOWAUTH
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
no |
no |
yes |
no |
Description Use SHOWAUTH
to display the Reports Server logon page and run the report.
Syntax http://
your_webserver
/reports/rwservlet/showauth[?][server=
server_name
][&authid=
username
/
password
][&nextpage=
key_in_cgicmd.dat
]&authtype={s|d}
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.
When authtype=s
the Reports System User Authentication dialog box is displayed. The Reports Database User Authentication dialog box is displayed when authtype=d
.
Table A-112 indicates which components can use the SHOWENV
keyword.
Table A-112 Components That Use SHOWENV
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
no |
no |
yes |
no |
Description Use SHOWENV
to display the rwservlet
configuration file (rwservlet.properties
).
Syntax http://
your_webserver
/reports/rwservlet/showenv[?][server=
server_name
][&authid=
username
/
password
]
Values See Syntax
Default None
Usage Notes
Table A-113 indicates which components can use the SHOWJOBID
keyword.
Table A-113 Components That Use SHOWJOBID
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
no |
no |
yes |
no |
Description SHOWJOBID
shows the status of the Reports Server job with job ID n.
Syntax http://
your_webserver
/reports/rwservlet/showjobidn[?][server=
server_name
][&authid=
username
/
password
][&statusformat={html|xml|xmldtd}]
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.
The job must be current (enqueued or scheduled).
Use SHOWJOBS
to see the current list of jobs. The STATUSFORMAT
can be set to html
(default), xml
, or xmldtd
to return status in that format. The status information is generated in HTML, XML, or XMLDTD (with an internal DTD subset).
Related keywords are SHOWJOBS, SERVER, AUTHID, and STATUSFORMAT.
Table A-114 indicates which components can use the SHOWJOBS
keyword.
Table A-114 Components That Use SHOWJOBS
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
no |
no |
yes |
no |
Description Use SHOWJOBS
to display a Web view of Reports Server queue status. In a cluster environment, SHOWJOBS displays all the in-process servers that are part of the cluster. You can view the jobs of both cluster and individual servers. Even if the server is down, you can retrieve information about past jobs for that server.
Syntax http://
your_webserver
/
reports
/rwservlet/showjobs[
n
][?][server=
server_name
][&authid=
username
/
password
][&queuetype={current|past|future}][&startrow=
start_position_in_job_queue
][&count=
number_of_jobs_to_display
][&statusformat={html|xml|xmldtd}]
Values See Syntax
Default None
Usage Notes
This keyword does not require a value; that is, keywords are entered by themselves without a corresponding value.
The name of the Reports Server must be specified implicitly by environment variable or Oracle Reports Servlet (rwservlet
) configuration file, or explicitly in the URL request. The refresh number n
is optional. When it is specified, the report's queue status will be updated every n
seconds.
The STATUSFORMAT
can be set to html
(default), xml
, or xmldtd
to return status in that format. The status information is generated in HTML, XML, or XMLDTD (with an internal DTD subset).
Related keywords are SERVER, AUTHID, and STATUSFORMAT.
Example
Use SHOWJOBS
to display a consolidated job queue in a high availability environment, as follows:
http://host:port/reports/rwservlet/showjobs
where host
and port
is the load balancer host name and port number.
Table A-115 indicates which components can use the SHOWMAP
keyword.
Table A-115 Components That Use SHOWMAP
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
no |
no |
yes |
no |
Description Use SHOWMAP
to display rwservlet
key mappings.
Syntax http://
your_webserver
/reports/rwservlet/showmap[?][server=
server_name
][&authid=
username
/
password
]
Values See Syntax
Default None
Usage Notes:
Table A-116 indicates which components can use the SHOWMYJOBS
keyword.
Table A-116 Components That Use SHOWMYJOBS
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
no |
no |
yes |
no |
Description Use SHOWMYJOBS
to display the Reports Server queue status for a particular user.
Syntax http://
your_webserver
/reports/rwservlet/showmyjobs[?][server=
server_name
][&authid=
username
/
password
][&statusformat={html|xml|xmldtd}]
Values See Syntax
Default None
Usage Notes
This keyword does not require a value; that is, commands are entered by themselves without a corresponding value.
The STATUSFORMAT
can be set to html (default), xml , or xmldtd to return status in that format. The status information is generated in html, xml, or xmldtd (with an internal dtd subset).
Related keywords are SERVER, AUTHID, and STATUSFORMAT.
Table A-117 indicates which components can use the SHUTDOWN
keyword.
Table A-117 Components That Use SHUTDOWN
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver | rwbridge |
---|---|---|---|---|---|---|
no |
no |
no |
no |
no |
yes |
yes |
Description Use SHUTDOWN
to shut down a previously running server, or to shut down the Oracle Reports Bridge.
When used with rwserver
, you must also use AUTHID to supply a user name and password.
When used with rwbridge
, you must also use AUTHID to supply a user name and password if the Oracle Reports Bridge is secured (the identifier
element is set in the Oracle Reports Bridge configuration file).
Syntax SHUTDOWN={NORMAL|IMMEDIATE}
Values
NORMAL
Shuts the server or Oracle Reports Bridge down gracefully, using normal shutdown procedures.
IMMEDIATE
Shuts the server or Oracle Reports Bridge down immediately, without waiting for other processes to complete running.
Default NORMAL
Usage Notes The user of the SHUTDOWN
keyword must be an Oracle Reports Administrative user. If the server has security enabled, it will query the security API to determine the user's role eligibility to execute the shutdown (in other words, the user must be an Oracle Reports Administrative user). If security is not enabled, then the user must nonetheless be an Oracle Reports Administrative user defined for that server.
Table A-118 indicates which components can use the SITENAME
keyword.
Table A-118 Components That Use SITENAME
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
no |
Description Use SITENAME
to specify the name of the Oracle WebDB Release 2.2 site to which report output should be pushed. This keyword is maintained for backward compatibility with Oracle WebDB Release 2.2; for backward compatibility with Oracle9iAS Portal Release 1, see CONTENTAREA. Begining with Oracle Portal 10g Release 1 (9.0.4), use PAGEGROUP.
Syntax SITENAME=
name
Values
name
Any valid site name used in Oracle WebDB Release 2.2.
Default None
Usage Notes
Use of this keyword is required to push Oracle Reports output to Oracle WebDB Release 2.2.
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.
Table A-119 indicates which components can use the SOURCE
keyword.
Table A-119 Components That Use SOURCE
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
Description Use SOURCE
to specify the report/library or list of reports/libraries to be converted. The rwconverter
command requires that you specify a source report or library.
Syntax SOURCE={
source_name
|(
source_name1
,
source_name2
, ...)}
Values Any valid report/library name or filename, or a list of valid report/library names or filenames enclosed in parentheses and separated by commas (for example, (qanda, test, dmast)
).
Default None
Usage Notes
SQL wildcard characters (%
and _) may be used for reports or libraries that are stored in the database. For example, R%
would fetch all reports stored in the database that begin with R
. All reports that match will be converted.
A list of report/library names or filenames must be enclosed in parentheses, with commas separating the names. For example:
(qanda,test,dmast) OR (qanda, test, dmast)
Wildcard characters are invalid for reports/libraries stored in files (that is, with extensions of .rdf
, .rep
, .rex
, .pld
, .pll
, or .xml
).
The value(s) for the SOURCE
keyword may be operating system-specific.
If you are using user-owned Oracle Reports Builder tables, reports/libraries from multiple users must be converted for each user individually.
To convert reports/libraries, you must have created them or been granted access to the ones you did not create. If no USERID
string is prefixed to the report/library name, the USERID
string is assumed to be that the current user.
When DTYPE=REGISTER
, you may only want to list report definition files with common parameters, such as destination types and formats, user access, and availability calendars.
Table A-120 indicates which components can use the SQLTRACE
keyword.
Table A-120 Components That Use SQLTRACE
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
no |
Description Use SQLTRACE
to specify whether to perform SQL tracing on your report without modifying the report definition.
Syntax SQLTRACE=[YES|NO]
Values
YES
SQL tracing will be performed on the report.
NO
SQL tracing will not be performed on the report.
Default NO
Table A-121 indicates which components can use the SSOCONN
keyword.
Table A-121 Components That Use SSOCONN
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
no |
no |
yes |
no |
Description Use SSOCONN
to specify one or more connect strings to use to connect to one or more data sources in a Single Sign-On environment.
Syntax SSOCONN=
key
[/
type
[/
conn_string_parameter
]][,
key
[/
type
[/
conn_string_parameter
]]]
Values The following information describes the variable values expressed in the SSOCONN
syntax:
key
refers to a connection string value stored in Oracle Internet Directory.
type
is the kind of data source to which you are connecting, to identify the format in the string associated with key
. The type
value must be a valid resource type stored in the Oracle Internet Directory. Oracle Reports provides default resource types for the following:
Oracle database (OracleDB
)
JDBC (JDBCPDS
)
Oracle Express (EXPRESSPDS
)
conn_string_parameter
is the name of the Oracle Reports system or user parameter to be used to pass the connection string to rwservlet
to run the report. For example, in the case of the OracleDB
data source, Oracle Reports receives the connection string through the USERID
parameter and uses it to connect to the specified Oracle database. Similarly, for JDBCPDS
, P_JDBCPDS
is used. If you have your own custom pluggable data sources, you would need to define your own user parameter for passing the connection string to Oracle Reports and specify it as conn_string_parameter
for SSOCONN
.
For example:
SSOCONN=mykey/OracleDB/USERID
Default None
Usage Notes
If multiple data sources are used in the report, use a comma to separate data source connection strings. For example:
ssoconn=key1/type1/conn_str,key2/type2/conn_str2,key3/type3/conn_str3
When you use SSOCONN
in a command line, you cannot:
Specify AUTHID
in the same command line.
Run against a Reports Server that is not secure.
Have SINGLESIGNON
=NO
in rwservlet.properties
.
Simplified versions of SSOCONN
are also available, as shown in Table A-122.
Table A-122 Simplified Versions of the SSOCONN Option
Option | Description |
---|---|
|
When only the key name is specified, the default values for |
|
When both key name and data source type are specified, the default value for |
SSOCONN
can be used when running JSP-based Web reports from the command line. If you are using the SSOCONN
keyword with a report run as a JSP, use an ampersand (&
) to separate connection strings. For example:
http://...:8888/myjsp/foo.jsp?name1=
value1
&name2=
value2
…
Note: For more information on Oracle Reports and Single Sign-On (SSO), see Chapter 16, "Configuring and Administering OracleAS Single Sign-On". |
Table A-123 indicates which components can use the STATUSFOLDER
keyword.
Table A-123 Components That Use STATUSFOLDER
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
no |
Description Use STATUSFOLDER
to specify the name of the Oracle WebDB Release 2.2 or Oracle9iAS Portal Release 1 folder to which job status information should be pushed. If this is omitted, a new folder is created called Oracle_Reports_Status
. 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 STATUSPAGE.
Syntax STATUSFOLDER=
folder
Values
folder
Any valid folder name (internal name) used in Oracle WebDB Release 2.2 or Oracle9iAS Portal Release 1.
Default Oracle_Reports_Status
Usage Notes
Use of this keyword is optional to push Oracle Reports output to Oracle WebDB Release 2.2 or Oracle9iAS Portal Release 1.
The value for this keyword is case sensitive.
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.
Table A-124 indicates which components can use the STATUSFORMAT
keyword.
Table A-124 Components That Use STATUSFORMAT
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
no |
no |
yes |
no |
Description Use STATUSFORMAT
to specify the format for the Web view of the Reports Server queue status.
Syntax http://
yourwebserver
/rwservlet/showjobs? server=
server_name
&statusformat={html|xml|xmldtd}
Values
html
Outputs the Reports Server queue status in HTML format.
xml
Outputs the Reports Server queue status in XML format.
Note: Oracle Reports 11g Release 1 (11.1.1) includes a new param namedERRORSTATUSXML that can be used to view the error status in the XML format even if Reports job fails. To view the ERRORSTATUSXML in XML, set ERRORSTATUSXML=Yes on the rwservlet command line.
In case of event-based reporting, before calling the
|
xmldtd
Outputs the Reports Server queue status in XML format with in-line Data Type Definition information.
Default html
Usage Notes Use STATUSFORMAT
in conjunction with the SHOWJOBS and SHOWMYJOBS keywords.
Table A-125 indicates which components can use the STATUSPAGE
keyword.
Table A-125 Components That Use STATUSPAGE
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
no |
Description Use STATUSPAGE
to specify the name of the Oracle Portal page to which job status information should be pushed. If this is omitted, a new page is created called Oracle_Reports_Status
. For backward compatibility with earlier releases (Oracle WebDB Release 2.2 and Oracle9iAS Portal Release 1), see STATUSFOLDER.
Syntax STATUSPAGE=
page
Values
page
Any valid page name (internal name) used in Oracle Portal.
Default Oracle_Reports_Status
Usage Notes
Use of this keyword is optional to push output to Oracle Portal.
The value for this keyword is case sensitive.
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.
Table A-126 indicates which components can use the STYPE
keyword.
Table A-126 Components That Use STYPE
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
no |
yes |
no |
no |
Description Use STYPE
to specify the format of the report(s) or libraries to be converted.
Syntax STYPE={PLDFILE|PLLFILE|RDFFILE|REXFILE|XMLFILE|JSPFILE}
Values Use any one of the following values:
PLDFILE
Source PL/SQL libraries are stored in files in ASCII format.
PLLFILE
Source PL/SQL libraries are stored in files containing source code and P-code (compiled PL/SQL).
RDFFILE
Source report(s) are stored in one or more report definition files (files with the rdf extension).
REXFILE
Source report(s) are stored in one or more text files (files with the rex extension).
XMLFILE
Source report(s) are stored in one or more XML files.
JSPFILE
Source report(s) are stored in one or more JSP files.
Default RDFFILE
Usage Notes When DTYPE=REGISTER
, choose RDDFILE,REXFILE,XML
, or JSPFILE
for STYPE
.
Table A-127 indicates which components can use the SUBJECT
keyword.
Table A-127 Components That Use SUBJECT
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
yes |
no |
no |
yes |
no |
Description Use SUBJECT
to specify the subject line of an e-mail.
Syntax SUBJECT="
string
"
Values Any text string.
Default None
Usage Notes
Table A-128 indicates which components can use the SUPPRESSLAYOUT
keyword.
Table A-128 Components That Use SUPPRESSLAYOUT
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
no |
Description Use SUPPRESSLAYOUT
to specify whether to suppress the formatting of the paper layout at runtime. The keyword allows users to control whether the paper layout in a report is executed at runtime. The most common use of this keyword is to increase the performance of JSP reports. Since a JSP report may have a paper layout and reference objects in it through an <rw:include
> tag, Oracle Reports formats the paper layout before running the JSP section of the report. To improve the performance of single source JSP reports that store both paper and Web layouts but do not reference paper layout objects, set SUPPRESSLAYOUT=YES
on the command line.
Note: If there is an<rw:include> tag, then no output will be created for the tag. |
Syntax SUPPRESSLAYOUT=[YES|NO]
Values
YES
Paper layout objects will not be formatted at runtime
NO
Paper layout objects will be formatted at runtime.
Default NO
Table A-129 indicates which components can be used with the TOLERANCE
keyword.
Table A-129 Components That Use TOLERANCE
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
no |
Description Use TOLERANCE
to set the maximum acceptable time (in minutes) 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 Reusing Report Output from Cache for more information on duplicate job detection.
Syntax TOLERANCE=
time_string
Values
time_string
Can be in one of two formats:
n
{
unit
}
, for a number with an optional unit. The unit can be minute(s), hour(s), or day(s). The default unit is minute(s) if no unit is specified.
{
Mon DD
,
YYYY
}
hh
:
mi
:
ss
am|pm {
timezone
}
, for a date/time format. Date information is optional. If it isn't specified, today is assumed. Time zone is also optional. If it isn't specified, the Reports Server's time zone is used. The date/time is always in a US locale. This format is the same as defined in the Java DateFormat.MEDIUM type.
Default None
Usage Notes
If TOLERANCE
is not specified, then Oracle Reports Services reruns the report even if a duplicate report is found in the cache.
If a report is being processed (that is, in the current job queue) when an identical job is submitted, then Oracle Reports Services reuses the output of the currently running job even if TOLERANCE
is not specified or is set to zero.
Table A-130 indicates which components can use the URLPARAMETER
keyword.
Table A-130 Components That Use URLPARAMETER
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
no |
no |
no |
yes |
no |
Description Use URLPARAMETER
to specify the URL that is to be fetched with the URL engine.
Syntax URLPARAMETER=http://
your_webserver
/
page_name
.html
Values Any valid URL.
Default None
Usage Notes This keyword is relevant when jobType=rwurl
in the job element in the Reports Server configuration file, and a URL engine is in place.
Table A-131 indicates which components can use the USEJVM
keyword.
Table A-131 Components That Use USEJVM
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
no |
no |
no |
no |
no |
Description Use USEJVM
to specify whether or not rwclient
should use Java Virtual Machine (JVM) to communicate with Reports Server.
Syntax USEJVM=YES|NO
Values
YES
rwclient
starts JVM and tries to connect to Reports Server using CORBA; if this fails, then it will attempt to connect using SQLNet, which is available for backward compatibility.
NO
rwclient
does not start JVM; instead, it uses SQLNet to communicate with Reports Server (Oracle Reports 6i Server).
Default YES
Table A-132 indicates which components can use the USERID
keyword.
Table A-132 Components That Use USERID
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
yes |
yes |
yes |
yes |
no |
Description Use USERID
only if you are not using Single Sign-On to specify your Oracle user name and password, with an optional database name for accessing a remote database. If the password is omitted, then a database logon form opens automatically before the user is allowed to run the report.
If you want users to log on to the database, then omit the password portion of the USERID
keyword from the report request. If you want users to log on every time they run report requests, then use the cgicmd.dat
key map file (for more information, see Section 17.13, "Using a Key Map File") to specify the runtime command, and include the %D
option in the relevant key mapping entry.
Syntax userid=
username
[/
password
][@
database
]
Values
username
Username assigned by the database administrator.
password
Password for the username. See "Usage Notes", below.
database
The name of the database you are accessing.
Default None
Usage Notes
The logon definition cannot exceed 512 bytes in length.
USERID
can be used when running JSP-based Web reports from the command line.
It is strongly recommended that you do not include the password when using USERID
with rwbuilder
, rwrun
, rwclient
, or rwconverter
. On many operating systems, this information can become available to any user (for example, with the ps
command on UNIX). Instead, use the SSOCONN keyword.
Table A-133 indicates which components can use the USERSTYLES
keyword.
Table A-133 Components That Use USERSTYLES
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
yes |
yes |
yes |
no |
yes |
no |
Description Use USERSTYLES
to specify whether an external style sheet file (.css
) is associated with a report when generating HTMLCSS output. The style sheets to be applied to the report are specified by the report's Style Sheets property. The value is set to YES
by default, and will override any design-time styles included in the Paper Design layout.
See Also: Oracle Reports Building Reports for more information on inline HTML formatting. |
Syntax USERSTYLES=YES|NO
Values
YES
Associates your report with one or more external style sheets, as specified by the report's Style Sheets property, when generating HTMLCSS
output.
NO
Associates your report with the formatting applied during the design of the report. External style sheets will be ignored.
Default YES
Usage Notes
If you specify a value other than YES
or NO
, Oracle Reports defaults to YES
.
If you find that your report is not associated with an external style sheet, ensure the following:
You have specified the correct path to the style sheet in the Style Sheets property.
The styles specified by the CSS Class Name and the CSS ID properties are defined in the specified style sheets.
See Also: Oracle Reports online Help for more information on the Style Sheets, CSS Class Name, and CSS ID properties. |
USERSTYLES
is set to YES
.
Example
http://myias.mycomp.com:7779/reports/rwservlet?server=myrepserv+report=test.jsp+us erid=scott/tiger@mydb+desformat=HTMLCSS+DESTYPE=cache+userstyles=yes
Table A-133 indicates which components can use the VALIDATETAG
keyword.
Table A-134 Components That Use VALIDATETAG
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
yes |
no |
no |
no |
Description VALIDATETAG
specifies whether to enforce JSP tag validation and check for items such as duplicate field identification or malformed attributes when designing or deploying a JSP-based Web report.
See Also: Section 23.8, "Running the Report" for more information about usingVALIDATETAG to tune the performance of your report. |
Syntax VALIDATETAG=YES|NO
Values
YES
Enforces tag validation and checks for items such as duplicate field identification or malformed attributes.
NO
Turns tag validation off.
Default
YES
At design time, when running a JSP-based Web report from Oracle Reports Builder.
NO
At run time, when deploying a JSP-based Web report.
Usage notes
This feature is useful only during the design phase, but not in the production environment. By default, VALIDATETAG=YES
in Oracle Reports Builder during report design, and VALIDATETAG=NO
in Oracle Reports Services for report deployment. To turn this option on when deploying a report, specify VALIDATETAG=YES
in your http
request (for example, http://my.server.com/myreport.jsp?VALIDATETAG=YES
).
Using VALIDATETAG=YES
when deploying a report slows performance.
If you start Reports Builder from the command line with rwbuilder
VALIDATETAG=NO
, you run the risk of designing a report with invalid JSP tag structure.
Table A-135 indicates which components can use the WEBSERVER_DEBUG
keyword.
Table A-135 Components That Use WEBSERVER_DEBUG
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
yes |
no |
no |
no |
Description Use WEBSERVER_DEBUG
for JSP debugging. It creates the stderr.log
and stdout.log
files under the docroot
/
port#
directory, and leaves temporary JSP files under docroot
/
port#
/
default
and log files under docroot
/
port#
/log
for your inspection.
Syntax WEBSERVER_DEBUG={YES|NO}
Values
YES
Creates debugging files.
NO
Does not create debugging files.
Default NO
Usage Notes
Use this keyword only when you're running a job as a JSP.
Relevant keywords include WEBSERVER_DEBUG,WEBSERVER_DOCROOT,WEBSERVER_PORT.
Table A-136 indicates which components can use the WEBSERVER_DOCROOT
keyword.
Table A-136 Components That Use WEBSERVER_DOCROOT
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
yes |
no |
no |
no |
Description Use WEBSERVER_DOCROOT
to set the Oracle Reports document root directory. All files you reference in your JSP, such as images, HTML, and the like, should be relative to this directory. By setting the document root to your working directory, you avoid having to copy these files around.
Syntax WEBSERVER_DOCROOT=
REPORTS_TMP/docroot
Values The root folder directory for your report files.
Default $FMW_HOME/servers/WLS_REPORTS/stage/reportsApp/reportsApp/web.war
Usage Notes
Use this keyword only when you're running a job as a JSP.
Relevant keywords include WEBSERVER_DEBUG,WEBSERVER_DOCROOT,WEBSERVER_PORT.
Example
WEBSERVER_DOCROOT=c:/temp/docroot
Table A-137 indicates which components can use the WEBSERVER_PORT
keyword.
Table A-137 Components That Use WEBSERVER_PORT
rwclient | rwrun | rwbuilder | rwconverter | rwservlet | rwserver |
---|---|---|---|---|---|
no |
no |
yes |
no |
no |
no |
Description Use WEBSERVER_PORT
to specify the port number an internal Web server listens to. Oracle Reports Builder runs the JSP reports at the port number specified by WEBSERVER_PORT
Syntax WEBSERVER_PORT=
port_num
Values
port_num
Any valid port number
Default
Port number of the external web server such as Oracle HTTP Server
Usage Notes
Use this keyword only when you're running a job as a JSP.
Relevant keywords include WEBSERVER_DEBUG,WEBSERVER_DOCROOT,WEBSERVER_PORT.