The default values are mandatory. If any of the entries are removed, the Oracle Reports components may not behave correctly. Any additional user-defined directory or JAR file that contains Java Classes may be appended to the path.

The PRINT command and all necessary keywords for your flavor of UNIX, including the following elements:

%n is the printer name string.

%c is the number of copies.

This string is much like a printf() format. If this environment variable is not set, Oracle Reports 6i uses the standard default value for the platform. Examples of default values on various platforms are as follows:

B.1.1 CA_GPREFS

DescriptionThis environment variable specifies the location of the global preferences file, CAGPREFS.ORA. Global preferences are shared among networked users. In addition to searching the directory specified by CA_GPREFS, products will also search the current directory for the CAGPREFS.ORA file.

The CAGPREFS.ORA file is automatically created by the Oracle Installer. To modify the global preference settings, use a text editor such as Notepad to manually edit this file. Global preferences set in the CAGPREFS.ORA file can be overridden by the local preference file, CAUPREFS.ORA, which is defined by CA_UPREFS.

Valid ValuesAny directory on any drive.

DefaultORACLE_HOME

Example CA_GPREFS=C:\orawin

B.1.2 CA_UPREFS

Description This environment variable specifies the location of the user preferences file, CAUPREFS.ORA. The CAUPREFS.ORA file maintains the preferences that you set through Tools >Tools Options within your products. In addition to searching the directory specified by CA_UPREFS, the product will also search the current directory for the CAUPREFS.ORA file.

Several Oracle products write their preference information to the CAUPREFS.ORA file. To manually modify the user preference settings, use a text editor such as Notepad to edit this file. User preferences set in the CAUPREFS.ORA file override global preferences set in the CAGPREFS.ORA file, which is defined by CA_GPREFS.

Valid Values Any directory on any drive.

Default ORACLE_HOME

Example CA_UPREFS=C:\orawin

B.1.3 DELIMITED_LINE_END

Description This environment variable specifies whether to print the delimited character at the end of the line for delimited output.

Valid Values YES|NO

Default YES

Usage Notes

Set this environment variable to NO to ensure that the delimited character is not printed at the end of the line.

B.1.4 DOC

Description This environment variable specifies the location of the online documentation files, including online Help.

language Specifies the language and its conventions for displaying messages and day and month names.

territory Specifies the territory and its conventions for calculating week and day numbers.

charset Specifies the character set used for the UPPER, LOWER, and INITCAP functions, and the type of sort used by an ORDER BY query. This argument also controls the character set used for displaying messages.

Default AMERICAN_AMERICA.WE8ISO8859P1

Usage Notes

To change locales, you must modify this environment variable, in addition to the REPORTS_RESOURCE environment variable.

On UNIX, you must set this variable in ORACLE_INSTANCE/config/reports/bin/reports.sh. If this variable is already set in an environment where Oracle Reports is running, then the value set in this environment is used instead of the value set in reports.sh. To use the value that is set in reports.sh, you must reset the value of the variable in the environment.

Examples Suppose you want your application to run in French. The application will be used in France and data will be displayed using the WE8ISO8895P1 character set. You would set NLS_LANG as follows:

NLS_LANG=French_France.WE8ISO8859P1

Now, suppose you still want your application to run in French, but this time it will be used in Switzerland. You would set NLS_LANG as follows:

B.1.21 ORACLE_INSTANCE

Description This environment variable specifies the directory in which files specific to the application server instance are installed.

Valid Values Any directory on any drive.

Default Directory specified by the user during installation.

Usage Notes

The length of ORACLE_INSTANCE should not exceed 255 characters.

Example

ORACLE_INSTANCE=C:\oracle\apps\reports

B.1.22 ORACLE_PATH

Description This environment variable specifies the search path for files referenced by Reports Runtime. Note that the directories specified by ORACLE_PATH are searched after those specified by REPORTS_PATH.

ORACLE_PATH can specify multiple directories. Use a semi-colon (;) to separate directory names in a list of paths.

Valid Values Any directory on any drive.

Default Not defined.

Usage Notes

If you are using Reports Runtime(rwrun), the combined length of ORACLE_HOME and ORACLE_PATH should not exceed 255 characters.

Example ORACLE_PATH=C:\oracle\apps\forms;C:\oracle\apps\reports

B.1.23 ORACLE_PPD

Description This environment variable specifies the location of PPD files. TK_PPD is considered first, then ORACLE_PPD.

Valid Values Any directory on any drive.

Default Not defined.

Usage notes

If you do not specify values for either of these variables, Oracle Reports looks for PPD files in:

B.1.26 PRINTER

TK_PRINTER takes precedence over PRINTER; that is, if both variables are set, TK_PRINTER is considered first and PRINTER is considered only if TK_PRINTER does not specify a valid printer. If neither TK_PRINTER nor PRINTER is set to a valid printer, Oracle Reports uses the first entry in your uiprint.txt file. If REPORTS_NO_DUMMY_PRINTER is set, but the uiprint.txt file does not contain a valid entry, then screenprinter.ppd specified in uiscreenprint.txt is used.

Note:

REPORTS_NO_DUMMY_PRINTER is set by default and is required to be set at all times. If it is not set (as a result of being user-modified), then the REP-1800 error is raised.

B.1.27 REMOTE

Description This environment variable specifies the default and remote SQL*Net driver to use when connecting through a local database. The parameter can include the default SQL*Net parameters (complete database string).

If a user logs on and specifies a connection with an explicit driver prefix matching the one specified in REMOTE, but specifies no SQL*Net parameters, the parameters specified in REMOTE are used. This parameter enables the DBA to define a "normal" network connection for which the SQL*Net user need not specify connection parameters. You can reset this parameter on the command line at any time.

Note:

If you use a DOS SQL*Net driver for Windows, check to see whether the REMOTE parameter is set in your CONFIG.ORA file located in the DOS Oracle home directory. If REMOTE is set in CONFIG.ORA, you must set it to the same value in the registry.

Syntax REMOTE=netPrefix:databaseName

Valid Values

netPrefix Any valid SQL*Net driver prefix.

databaseName The name of the local database.

Default Not defined.

Example REMOTE=P:PIPER

where

P: is the network prefix for Named Pipes

PIPER is the database name

B.1.28 REPORTS_ADD_HWMARGIN

Description (Windows only) This environment variable specifies whether to include the printer hardware-based left margin. By default, this margin is ignored. 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 reports independent of the printer hardware margin. These reports can then be deployed across various printers.

In the past, the printer's printable area was used, causing inconsistencies in the location of the report output when moving across different printer models.

If required, you can revert to the previous behavior by setting the registry variable REPORTS_ADD_HWMARGIN to YES.

Add a new String value named REPORTS_ADD_HWMARGIN and set the value to YES.

Valid Values YES|NO

Default NO

Usage Note

When 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 box of Oracle Reports Builder have been disabled to ensure consistency with Oracle Reports Services.

B.1.32 REPORTS_CGIDIAGBODYTAGS

Description This environment variable specifies the HTML attributes to add to the <BODY> tag in the rwcgi diagnostic and debugging output. For example, you can use this environment variable to set up text and background color or image.

This environment variable is backward compatible.

Valid Values Any valid HTML attributes for the <BODY> tag.

Default Not defined.

Usage Notes

This environment variable is supported for backward compatibility for Common Gateway Interface (CGI) reports, or when Single Sign-On is not used.

Note:

The functionality of JavaServer Pages (JSPs) or servlets replaces support for CGI.

Example REPORTS_CGIDIAGBODYTAGS="bgcolor="#CC3366""

B.1.33 REPORTS_CGIDIAGHEADTAGS

Description This environment variable specifies the HTML tags to insert between the <HEAD> and </HEAD> tags in the rwcgi diagnostic and debugging output. For example, you can use this environment variable to set up <TITLE> or <META> tags.

Valid Values Any HTML tags that are valid between the <HEAD> and </HEAD> tags.

Default Not defined.

Usage Notes

This environment variable is supported for backward compatibility for Common Gateway Interface (CGI) reports, or when Single Sign-On is not used.

Note:

The functionality of JavaServer Pages (JSPs) or servlets replaces support for CGI.

Example REPORTS_CGIDIAGHEADTAGS="<title>Employee List</title>"

B.1.34 REPORTS_CGIHELP

Description This environment variable specifies the URL and URI of the rwcgi help file that should display when rwcgi is invoked with the following empty request:

http://your_webserver/rwcgi?

Valid Values Any valid URL to a Web page or HTML file.

Default A default help screen is displayed in your browser.

Usage Notes

This environment variable is supported for backward compatibility for Common Gateway Interface (CGI) reports, or when Single Sign-On is not used.

Note:

The functionality of JavaServer Pages (JSPs) or servlets replaces support for CGI.

Examples

To display the www.yahoo.com page in your browser:

REPORTS_CGIHELP=http://www.yahoo.com

To display an HTML file named myhelpfile.htm in your browser:

REPORTS_CGIHELP=http://your_webserver/myhelpfile.htm

B.1.35 REPORTS_CGIMAP

Description This environment variable specifies the fully qualified file name and location of the rwcgi key map file (for more information, see Section 17.13, "Using a Key Map File"), if map file configuration is used.

B.1.36 REPORTS_CGINODIAG

Description This environment variable specifies whether to disable all debugging and diagnostic output, such as help and showmap, from rwcgi.

This environment variable is backward compatible.

Valid Values YES|NO

Default NO

Usage Notes

This environment variable is supported for backward compatibility for Common Gateway Interface (CGI) reports, or when Single Sign-On is not used.

Note:

The functionality of JavaServer Pages (JSPs) or servlets replaces support for CGI.

Example The following request does not work when REPORTS_CGINODIAG=YES:

http://your_webserver/rwcgi/help?

B.1.37 REPORTS_CLASSPATH

Description This environment variable specifies the list of JAR files and directories for the Java Virtual Machine (JVM) when started by the Oracle Reports components. You would typically add to this list when you need to include your own classes when designing reports (for example, when adding additional pluggable data sources (PDSs) or using the PL/SQL to Java bridge).

Caution:

Oracle Reports Builder will fail if the value of the REPORTS_CLASSPATH environment variable (registry) exceeds 511 characters. To work around this issue, you can use the CLASSPATH environment variable (system) to specify a value in excess of 511 characters.

Valid Values The default values are mandatory. If any of the entries are removed, the Oracle Reports components may not behave correctly. Any additional user-defined directory or JAR file that contains Java Classes may be appended to the path.

The default value for the environment variable is required for Oracle Reports components to function correctly. Additional user classes may be appended, but the list must conform to the platform-specific Java CLASSPATH definition.

Oracle Reports Builder will fail if the value of the REPORTS_CLASSPATH environment variable (registry) exceeds 511 characters. To work around this issue, you can use the CLASSPATH environment variable (system) to specify a value in excess of 511 characters.

B.1.38 REPORTS_CONTAINSHTMLTAGS

Oracle Reports' interpretation of inline HTML tags may be different from the browser's interpretation. As a result, a report designed with inline HTML tags in Oracle Reports 6i, Oracle9i Reports, or Oracle Reports 10g Release 1 (9.0.4) may generate a different HTML or HTMLCSS output in Oracle Reports10g Release 2 (10.1.2) and 11g Release 1 (11.1.1).

Valid Values

YES Oracle Reports interprets the HTML tags for those 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 output, the browser will interpret the HTML formatting tags; for other output formats, the HTML tags themselves will appear as is in the report output. Set this environment variable to NO if you do not wish for Oracle Reports to interpret HTML formatting tags, and thus retain the behavior of prior releases.

The command line keyword CONTAINSHTMLTAGS overrides the value of this environment variable.

B.1.39 REPORTS_COOKIE_EXPIRE

Description This environment variable specifies the lifetime of a cookie within a given Reports Server session.

If Single Sign-On is not being used, then any user accessing a secured instance of the Reports Server is challenged to identify themselves by rwservlet through its own authentication mechanism (identical to the behavior of Oracle Reports 6i). Because the HTTP 1.0 protocol is stateless (that is, each call to the server is effectively independent of all others), users might need to authenticate themselves for each report request unless a cookie is maintained.

To allow users to authenticate themselves only once per session, rwservlet has its own client-side cookie, the authid cookie, in which it stores the required authentication information for the current session. Once the user is authenticated, an encrypted cookie is created in the browser to enable the user to submit multiple report jobs without re-authenticating for each request. The authid cookies are terminated when the user closes their browser session, but you should not rely strictly on this method of terminating the cookie. You should limit the lifetime of the cookie within a given session using the REPORTS_COOKIE_EXPIRE environment variable. For example, a user might log on and then go to lunch, leaving the browser session open. To minimize the potential for a security breach in this situation, the administrator may define the REPORTS_COOKIE_EXPIRE environment variable on the Reports Server. When rwservlet receives a job request, it compares the time saved in the cookie with the current system time. If the time is longer than the number of minutes defined in the environment variable (for example, 30 minutes), the cookie is rejected and the user is challenged to provide authentication information.

Note:

If you want to force users to authenticate themselves for a specific report, you can use the SHOWAUTH command line keyword. Alternatively, you can include a %S in the corresponding report entry in the key map file. This file is usually called cgicmd.dat and is located in $DOMAIN_HOME/servers/WLS_REPORTS/stage/reports/reports/configuration/cgicmd.dat%S forces users to enter their user name and password each time the report is called. For more information, see Section 17.13, "Using a Key Map File".

Valid Values Any number of minutes.

Default 30

Usage Note

This environment variable is supported for backward compatibility for Common Gateway Interface (CGI) reports, or when Single Sign-On is not used.

Note:

The functionality of JavaServer Pages (JSPs) or servlets replaces support for CGI.

Example REPORTS_COOKIE_EXPIRE=30

B.1.40 REPORTS_DB_AUTH

Description This environment variable specifies the database authentication template used to log on to the database. This environment variable is backward compatible.

Valid Values Any HTML file that contains special authentication actions. It is recommended that you keep the default.

Default dbauth.htm

Usage Note

This environment variable is supported for backward compatibility for Common Gateway Interface (CGI) reports, or when Single Sign-On is not used.

Note:

The functionality of JavaServer Pages (JSPs) or servlets replaces support for CGI.

Example REPORTS_DB_AUTH=dbauth.htm

B.1.41 REPORTS_DEFAULT_DISPLAY

Description This environment variable specifies whether to implement the following features introduced with Oracle Reports 10g Release 1 (9.0.4):

The elimination of the dependency on the DISPLAY variable (UNIX only)

Using ScreenPrinter (screenprinter.ppd) for surface resolution for images and font information, which eliminates the dependency on having a valid printer defined (PRINTER and TK_PRINTER environment variables set to a valid printer, or a valid entry in uiprint.txt) for Reports Runtime (UNIX only).

REPORTS_DEFAULT_DISPLAY=YES enables the enhanced imaging support introduced with the REPORTS_OUTPUTIMAGEFORMAT environment variable and OUTPUTIMAGEFORMAT command line keyword. The surface resolution can be controlled with the entry in the screenprinter.ppd file. If REPORTS_DEFAULT_DISPLAY=NO, imaging support is limited to GIF format (for PDF output, HTML, HTMLCSS) and BMP format (for RTF output).

On UNIX, REPORTS_DEFAULT_DISPLAY=YES overrides any value set for the DISPLAY variable. Even if the DISPLAY variable is defined, the X-Windows display surface will not be used by default. The surface resolution can be controlled with the entry in the screenprinter.ppd. For users upgrading from releases prior to Oracle Reports 10g Release 1 (9.0.4), this change may impact the appearance, number of pages, output file size, or performance of existing reports.

This feature is not available on the IBM AIX platform due to lack of functionality in the IBM JDK 1.4 (does not support headless option). For this reason, the dependency on DISPLAY still exists on AIX.

To revert to the dependency on DISPLAY and use screen fonts (old font look up algorithm):

B.1.42 REPORTS_DEFAULT_PIXEL_SIZE

Description This environment variable specifies a pixel size that overrides the display server's default pixel size when generating a report to HTML output. Normally, Oracle Reports takes its pixel size from the display server. If you are working with older reports that rely upon a pixel size that is different from that of the display server (for example, a pixel size of 80), you can use this variable to maintain the same behavior in your older reports.

Valid Values Any value ranging from 72 through 200.

Default Surface resolution determined by Oracle Reports.

Usage Notes

For Windows, REPORTS_DEFAULT_PIXEL_SIZE is set in the registry. For UNIX, it is set from the command prompt or in a shell script.

If REPORTS_DEFAULT_DISPLAY = YES (default), Oracle Reports still uses the value specified for REPORTS_DEFAULT_PIXEL_SIZE for HTML output. However, if a value is not explicitly set for REPORTS_DEFAULT_PIXEL_SIZE , the surface resolution is can be controlled with the entry in the screenprinter.ppd file, as described in Chapter 9, "Printing on UNIX with Oracle Reports".

B.1.43 REPORTS_ENABLE_RTF_SPACING

This environment variable specifies whether to enable functionality that prevents truncation of multiline text in RTF output. This environment variable may not be needed in most circumstances, and should be set to YES only if you see truncation of multiline text in RTF output.

B.1.46 REPORTS_ENHANCED_SUBSET

Description This environment variable specifies whether to include the enhanced TTF font subsetting feature when generating a report. This environment variable is set to YES by default to ensure that the PDF file generated is accessible and searchable.

Valid Values YES|NO

Default YES

Usage Note

Oracle Reports uses the enhanced font subsetting implementation, by default. If you set REPORTS_ENHANCED_SUBSET=NO, Oracle Reports will to revert to the Type3 font subsetting implementation used in releases prior to Oracle Reports 10g Release 2 (10.1.2).

B.1.47 REPORTS_FONT_DIRECTORY

Description (UNIX only) This environment variable specifies the location of all the font files for all TTF and TTC fonts used in your reports. It enables you to create reports that are easily portable across operating systems by eliminating the need to hard-code directory paths.

The directory specified by REPORTS_FONT_DIRECTORY is not given access by default. It is used only to search for files, and Oracle Reports handles any associated security settings separately if and when the target files are located.

Define REPORTS_FONT_DIRECTORY in the same fashion you define other environment variables on your operating system, keeping in mind platform-specific rules such as path length, and so on.

You must either save your font files in $ORACLE_INSTANCE/reports/fonts or set REPORTS_FONT_DIRECTORY to point the folder where the font files are saved.

B.1.48 REPORTS_GRAPH_IMAGE_DPI

Description This environment variable specifies a dots per inch (DPI) value for graphs output to a PDF file or a printer. The default value for this environment variable is set at 72 DPI to minimize the time taken to generate the report as well as to reduce the report file size.

If you specify a value higher than 72 DPI, you will see an improvement in the image resolution for graphs sent to a PDF file or a printer. However, this affects the time taken to generate the report output as well as the file size.

Note:

With the value of REPORTS_GRAPH_IMAGE_DPI=250:

The time taken to generate a report with a graph increases 5 to 6 times when compared to the time taken to generate the same report with the value set to 72 DPI.

The PDF file size also increases 5 to 6 times.

Valid Values 72 through 300

Default 72

Usage Notes

On Windows, use the registry to specify the value. On Unix/Linux, set the environment variable in reports.sh.

When you set a higher DPI value, you may also need to change the JVM heap size value through REPORTS_JVM_OPTIONS to avoid the Out Of Memory error for the JVM.

This environment variable is not supported in Oracle Reports distribution functionality, as it is specific to PDF and printer outputs only.

B.1.49 REPORTS_IGNORE_IMAGE_TAG_RES

Description This environment variable is useful when a report includes certain image formats that have the ability to store the physical size of the image, which usually includes resolution and pixel dimensions. To ensure the image is not scaled to the physical dimensions, you can set this environment variable to YES to specify that Oracle Reports should ignore image resolution information and only use the pixel dimensions of the image. This ensures that this type of image from a database column is displayed correctly instead of displaying as a thumbnail.

Valid Values

YES Oracle Reports ignores image resolution information, and uses only the pixel dimensions of the image.

NO Oracle Reports does not ignore the image resolution information in the image.

Default NO

B.1.50 REPORTS_JPEG_QUALITY_FACTOR

Description This environment variable specifies the level of image quality desired for JPEG images. It provides control over the trade-off between JPEG image quality and size of the image. The better the quality of the image, the greater the image file size.

Valid Values 0 through 100

Default 100 (highest quality)

Usage Notes

On Windows, use the registry to specify the value. On Unix/Linux, set the environment variable in reports.sh.

If REPORTS_JPEG_QUALITY_FACTOR is not specified or incorrectly specified (for example, set to a string or an out of range value), the default value is used.

A value of 75 provide a good quality image, while ensuring a good compression ratio.

B.1.51 REPORTS_JVM_OPTIONS

Description This environment variable specifies any JVM options that you want Oracle Reports Builder, Reports Runtime, or Reports Converter to consider when it starts its JVM. For example, you can use this environment variable to specify the starting heap size and maximum heap size for the JVM, additional classpath entries, generate random or non-sequential job IDs, and so on.

Valid Values List of JVM options in the JVM command line syntax.

Default -Xmx256M

Usage Notes

The default value -Xmx256M specifies the JVM heap size of 256 MB to avoid the Out Of Memory error when running reports with large graphs or running big reports.

When the Reports Engine starts up, it checks for JVM options specified in the rwserver.conf file in the jvmoptions attribute of the engine element. For more information, see Section 7.2.1.9, "engine". If specified, the JVM options set in rwserver.conf override the value of the REPORTS_JVM_OPTIONS environment variable. If not specified in rwserver.conf, Oracle Reports uses the JVM options specified by the REPORTS_JVM_OPTIONS environment variable.

When running reports with Reports Builder, Reports Runtime, and Reports Converter, JVM options specified on the command line with the JVMOPTIONS command line keyword override JVM options specified by the REPORTS_JVM_OPTIONS environment variable.

To generate random and non-sequential job IDs, you can set REPORTS_JVM_OPTIONS to -Djobid=random and export REPORTS_JVM_OPTIONS.

B.1.52 REPORTS_NETWORK_CONFIG

Description This environment variable should be set only if you want rwclient, rwrqm, rwcgi, or Oracle Forms Services to use a custom network configuration file. If this environment variable is not set, then these components will use the default network configuration file (rwnetwork.conf). For more information about rwnetwork.conf, see Section 7.5, "Network Configuration File".

B.1.53 REPORTS_NLS_XML_CHARSETS

Description This environment variable provides an override option to enable you to define the character set encoding used when saving a report in XML format. This is only necessary when the required character set mapping for NLS_LANG to XML IANA-defined character sets do not produce the required results.

To enable your XML parser to understand the characters within the XML files, Oracle Reports does the following:

Adds an encoding attribute to the XML declaration based on the value in NLS_CHARACTERSET, the character set part of the NLS_LANG variable.

Translates the value set as the NLS_LANG character set (for example, JA16SJIS) to what is expected in the XML specification (for example, Shift_JIS).

You can override this mapping by adding entries to the REPORTS_NLS_XML_CHARSET.

Valid Values Set of mapping pairs separated by semicolons. The first value is the encoding that is being produced and the second mapped value is the value that should be used for these cases.

B.1.54 REPORTS_NO_DUMMY_PRINTER

Description This environment variable, together with other printer and display environment variables and settings, specifies whether the system's surface and fonts should be used instead of the printer's.

Valid Values TRUE|not set

Default TRUE

Usage Notes

REPORTS_NO_DUMMY_PRINTER is set by default and is required to be set at all times. If it is not set (as a result of being user-modified), and there is no valid printer, error REP-1800 error is raised. Alternatively, you could use TK_PRINT_STATUS when you have no valid printer. A valid printer response is required by Oracle Reports to generate output, even if you are generating to a file.

If the uiprint.txt file does not contain a valid entry (that is, no valid printer is defined), but REPORTS_NO_DUMMY_PRINTER is set, Oracle Reports uses screenprinter.ppd specified in uiscreenprint.txt. You should unset this environment variable only if you do not want the screenprinter.ppd driver to be used by Oracle Reports when there is no valid printer.

The limitation of this approach is that these reports might lose their formatting when viewed from another system if it is not identical to the system where the report was designed. Furthermore, when this report is printed, the formatting would not be correct because the fonts and their metrics differ.

B.1.55 REPORTS_NO_HTML_SPACE_REPLACE

This environment variable specifies whether spaces should not be replaced with &nbsp; in HTML or HTMLCSS output.

Oracle Reports maps HTML metadata characters in the data retrieved for a field to the appropriate encoding. That is, Oracle Reports automatically maps:

< to &lt;

" to &quot;

In most cases, the browser produces the correct results and handles the spaces correctly. In some cases, the browser's handling of spaces does not produce the required output. This happens in such cases as where the user has padded the front of the data to produce indentation. Since the browser will treat multiple spaces as single space, the indentation is lost.

Valid Values YES|not set

Default not set

Usage Notes

If the value is not set, all spaces are replaced by &nbsp;. This could cause problems in your output where you want the browsers to handle line breaks on spaces. It will also increase the size of the generated HTML file.

If a field's Contains HTML Tags property is set to Yes, then no encoding will take place since Oracle Reports just passes the field's value through to the output.

Example

If REPORTS_NO_HTML_SPACE_REPLACE is set to YES, then the output for the sentence [Typical data output] will be:

[ Typical data output]

and display as (ignoring preceding spaces):

[Typical data output]

Not setting the environment variable will cause the output to change to:

[&nbsp;&nbsp;Typical&nbsp;data&nbsp;output]

and display as (maintaining preceding spaces):

[ Typical data output]

Note:

Brackets in the preceding example are used to show preceding spaces; they are not part of the sentence.

B.1.56 REPORTS_OUTPUTIMAGEFORMAT

Description This environment variable specifies the default image format used in the report.

Valid Values GIF|JPEG|JPG|PNG|BMP

Default JPEG

Usage Notes

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

This environment variable setting is overridden by the value of the OUTPUTIMAGEFORMAT command line keyword.

B.1.57 REPORTS_PATH

Description This environment variable specifies the search path for files referenced by Reports Runtime. The directories specified by REPORTS_PATH are searched first, then those specified by ORACLE_PATH. This environment variable is used to locate reports and external objects that you use in your reports, such as PL/SQL libraries, external queries, and external boilerplate. It enables you to create reports that are easily portable across operating systems by eliminating the need to hard-code directory paths.

The directories specified by REPORTS_PATH are not given access by default. They are used only to search for files, and Oracle Reports handles any associated security settings separately if and when the target files are located.

Define REPORTS_PATH in the same fashion you define other environment variables on your operating system, keeping in mind such platform-specific rules as path length, and so on.

In addition to directory paths, you can specify the keyword DB when you define REPORTS_PATH. This instructs Oracle Reports to search the database to which you are currently connected.

Suppose you specified the following on a UNIX platform:

setenv REPORTS_PATH /home/tkostin/pay:/home/tkostin/receive:DB

Oracle Reports will first search the directory /home/tkostin/pay. If it cannot find the file in question, it will search /home/tkostin/receive.

If you specify a path for the sourceDir attribute of the engine element in the Reports Server configuration file (rwserver.conf), the sourceDir value will override the values you set here.

Example

REPORTS_PATH=C:\oracle\apps\reports;C:\myfiles

B.1.58 REPORTS_RESTRICT_DIRECTORIES

This environment variable specifies whether read/write access to directories is restricted. If set to YES, Oracle Reports has read/write access only to directories specified by REPORTS_PATH.

Valid Values YES|NO

Default NO

B.1.59 REPORTS_RESOURCE

This environment variable specifies the location of the resource files required for reports. This path must include the globalization support directory extension when specifying the location of the resource files.

Valid Values Any directory on any drive.

Default %ORACLE_HOME%\reports\res

Usage Note

To change locales, you must modify this environment variable, in addition to NLS_LANG.

Examples For US files:

REPORTS_RESOURCE=%ORACLE_HOME%\reports\res\US\

For Japanese files:

REPORTS_RESOURCE=%ORACLE_HOME%\reports\res\JA\

B.1.60 REPORTS_SERVER

Description This environment variable specifies the default Reports Server for Web Cartridge or Web CGI requests. When this environment variable is set, you can omit the SERVER command line keyword in report requests to process them using the default Reports Server, or you can include the SERVER command line keyword to override the default.

This environment variable is backward compatible.

Valid Values Any Reports Server service entry name.

Usage Note

This environment variable is supported for backward compatibility for Common Gateway Interface (CGI) reports, or when Single Sign-On is not used.

Note:

The functionality of Java Server Pages (JSPs) or servlets replaces support for CGI. The default Reports Server name is defined in the Oracle Reports Servlet (rwservlet) configuration file (rwservlet.properties), as described in Section 7.3.1.1.1, "server".

Example REPORTS_SERVER=my_rep_server

B.1.61 REPORTS_SOLARIS_9

Description This environment variable resolves a synchronization issue between native Motif libraries and JDK UI packages on Solaris 2.9. When REPORTS_SOLARIS_9=YES, Reports Builder responds as expected. If you set REPORTS_SOLARIS_9=NO in a Solaris 2.9 environment, Reports Builder may stop responding when invoking either the Report Wizard or Data Wizard.

Valid Values YES|NO

Default YES on Solaris 2.9; NO on other platforms.

B.1.62 REPORTS_SPACE_BREAK

Description This environment variable specifies whether to consider white spaces as a delimiter. Oracle Reports employs an algorithm to properly wrap a line, when a word cannot fit in the same line. By default the word wrapping algorithm considers white spaces as a delimiter.

Valid Values YES|NO

Default YES

Usage Note

Set this environment variable to NO only for Asian languages with multibyte character sets, such as Chinese. This ensures that Oracle Reports does not consider white spaces as delimiters and will enable appropriate word wrapping functionality required by languages with multibyte character sets.

B.1.63 REPORTS_SRWRUN_TO_SERVER

Description

This environment variable specifies whether to allow the SERVER or USERID keywords when running a report using the SRW.RUN_REPORT built-in procedure.

Valid Values YES|not set

Default not set

Usage Notes

Keywords SERVER and USERID with SRW.RUN_REPORT are deprecated. If you have reports created in prior releases that use these keywords with SRW.RUN_REPORT, you can set REPORTS_SRWRUN_TO_SERVER=YES to continue to run these reports with the current release.

You may encounter issues when attempting to run reports created in prior releases asynchronously. For this reason, it is important to migrate your reports to the latest Oracle Reports release as soon as possible.

Note:

For a description of the SRW built-in package, including the SRW.RUN_REPORT built-in procedure, see the Oracle Reports online Help.

B.1.64 REPORTS_SSLPORT

Description This environment variable specifies the port number when using SSL.

Valid Values Any valid port number.

Default 443

Usage Note

This environment variable is supported for backward compatibility for Common Gateway Interface (CGI) reports, or when Single Sign-On is not used.

Note:

The functionality of Java Server Pages (JSPs) or servlets replaces support for CGI.

Example REPORTS_SSLPORT=442

B.1.65 REPORTS_SYS_AUTH

Description This environment variable specifies the authentication template used to authenticate the username and password when users run report requests to a restricted Reports Server.

Valid Value Any HTML file that contains special authentication actions. It is recommended that you keep the default.

Default sysauth.htm

Usage Note

This environment variable is supported for backward compatibility for Common Gateway Interface (CGI) reports, or when Single Sign-On is not used.

Note:

The functionality of Java Server Pages (JSPs) or servlets replaces support for CGI.

Example REPORTS_SYS_AUTH=sysauth.htm

B.1.66 REPORTS_TAGLIB_URI

Description This environment variable specifies the location of the tag prefix used in the Web source of a JSP-based report. It defines the Reports URI of the tag library (TAGLIB) declarations of the .jsp file. This is typically:

<%@ taglib uri="/WEB-INF/lib/reports_tld.jar" prefix="rw" %>

When Oracle Reports finds a "uri" that matches the environment variable, it will use the corresponding "prefix" attribute to identify Oracle Reports tags within the .jsp file.

The default value is typically unchanged. It is the same for both reports files in both JDeveloper and Oracle Reports. The "prefix" attribute can be changed to avoid naming conflicts independent of the "uri" attribute.

B.1.67 REPORTS_TMP

Description This environment variable specifies the directory in which you wish to store Oracle Reports Builder temporary files. Oracle Reports Builder will use only one directory for this purpose; do not define more than one.

Define REPORTS_TMP in the same fashion you define other environment variables on your base operating system, keeping in mind such platform-specific rules as path length, and so on. If you don't define REPORTS_TMP, it will default to the current working directory.

Valid Values Any directory on any drive.

Default Not defined.

Example REPORTS_TMP=C:\tmp

B.1.68 REPORTS_USEREXITS

Description This environment variable specifies the libraries for use by Oracle Reports. These libraries are program modules created by you to be called by Oracle Reports.

REPORTS_USEREXITS can specify multiple libraries. On Windows, use a backslash (\) to separate directories in a path, and a semicolon (;) to separate complete paths. On UNIX, use a forward slash (/) to separate directories in a path, and a colon (:) to separate complete paths.

If this value is not explicitly set, Oracle Reports looks for rwxtb.dll according to the path variable of the system.

Note:

You can call Java methods using the ORA_JAVA built-in package and the Java Importer. This reduces the need to have user exits in a report and allows for a more open and portable deployment. You may also use the ORA_FFI built-in package, which provides a foreign function interface for invoking C functions in a dynamic library. With the availability of these built-in packages, the use of user exits is deprecated in Oracle Reports, though makefiles are still be supplied to permit you to continue to work with existing user exits.

For backward compatibility, the prior name REPORTS_USEREXIT is allowed for this environment variable.

Valid Values Any user exit library (along with its absolute path).

Default Not defined.

Example

On Windows:

REPORTS_USEREXITS=C:\mydll.dll;d:\mynew.dll;e:\bin\speed.dll

On UNIX:

REPORTS_USEREXITS=/usr/oracle/mylib.so:/usr/oracle/myfolder/speed.so

B.1.69 REPORTS_UTF8_XMLOUTPUT

Description This environment variable specifies whether the UTF8 character set is used instead of the NLS_LANG character set. This environment variable is in effect only when the encoding attribute is not specified by the XML Prolog Value property (see the Oracle Reports online Help for a description of the XML Prolog Value property).

Valid Values

YES Assigns the UTF8 character set (when the XML Prolog Value property is not set).

NO Assigns the NLS_LANG (or IANA-defined) character set (when the XML Prolog Value property is not set).

Default YES

B.1.70 RW

This environment variable specifies the reports-specific directory within the ORACLE_HOME.

Valid Values A valid directory name.

Default

%ORACLE_HOME%\reports (Windows)

$ORACLE_HOME/reports (UNIX)

B.1.71 TK_PRINT

Description (UNIX only) This environment variable specifies the print command to be executed on UNIX for Oracle Reports 6i. In later releases, TK_PRINT is obsolete; you can achieve the same results by using the printing script file: $ORACLE_INSTANCE/config/reports/bin/rwlpr.sh This script supports lp and lpr commands by default. If you use some other printing command for your machine, this file needs to be modified accordingly.

Valid Values The PRINT command and all necessary keywords for your flavor of UNIX, including the following elements:

%n is the printer name string.

%c is the number of copies.

This string is much like a printf() format. If this environment variable is not set, Oracle Reports 6i uses the standard default value for the platform. Examples of default values on various platforms are as follows:

System V:lp -s -d'%n' -n%c

Solaris:lpr -P'%n' -#%c -s

Default Not defined.

Usage Notes

In most cases, the default print commands will meet your needs. We recommend that you only set this environment variable when you have a specific need to alter the default value. For example, if you want duplexed output, you need to set TK_PRINT.

B.1.72 TK_PRINT_STATUS

Description (UNIX only) This environment variable specifies the command executed to validate the printer. To ensure that the printer is valid, this command is executed and its output is searched for the strings unknown, non-existent, or invalid. If one of these strings appears in the output, the printer is considered invalid and cannot be selected. Otherwise, the printer is accepted by Oracle Reports.

Valid Values Should include %n for the printer name (see also TK_PRINT).

If this environment variable is not set, Oracle Reports uses the built-in default values:

System V: /usr/bin/lpstat -p'%n' 2>&1

Other:/usr/etc/lpc status '%n' 2>&1

Default Not defined.

Usage Notes

You should only use this environment variable in cases where the printer status command on your platform differs from the default values, or when you have no valid printer. If you have no valid printer, you can set TK_PRINT_STATUS=echo and specify a dummy entry in the uiprint.txt file. This workaround ensures that Oracle Reports gets a valid response when checking for a printer.

If REPORTS_NO_DUMMY_PRINTER is set, but the uiprint.txt file does not contain a valid entry, then screenprinter.ppd specified in uiscreenprint.txt is used.

Note:

REPORTS_NO_DUMMY_PRINTER is set by default and is required to be set at all times. If it is not set (as a result of being user-modified), error REP-1800 error is raised.

B.1.73 TK_PRINTER

TK_PRINTER takes precedence over PRINTER; that is, if both variables are set, TK_PRINTER is considered first and PRINTER is considered only if TK_PRINTER does not specify a valid printer. If neither TK_PRINTER nor PRINTER is set to a valid printer, Oracle Reports uses the first entry in your uiprint.txt file. If REPORTS_NO_DUMMY_PRINTER is set, but the uiprint.txt file does not contain a valid entry, then screenprinter.ppd specified in uiscreenprint.txt is used.

Note:

REPORTS_NO_DUMMY_PRINTER is set by default and is required to be set at all times. If it is not set (as a result of being user-modified), error REP-1800 error is raised.