|
Oracle® Application Server Reports Services Publishing Reports to the Web
10g (9.0.4) Part Number B13673-01 |
|
|
|
|
Oracle® Application Server Reports Services Publishing Reports to the Web
10g (9.0.4) Part Number B13673-01 |
|
|
|
|
Environment variables are parameters that configure the environment that hosts Oracle Reports. The Oracle Application Server installer automatically defines default values for relevant environment variables. If you want something other than the default environment, you can edit the environment variable settings:
For Windows, edit the environment variables through the Registry Editor (Start Run Regedit).
For UNIX, edit the environment variables by revising and running the shell script that defines the initial default values (reports.sh). If you do this, be sure to keep a backup of the original, unaltered reports.sh file.
|
Note: If you are upgrading to Oracle Reports 10g (9.0.4), thereports.sh file contains some required changes. If you have modified your current reports.sh file, save a backup and, after installing Oracle Reports 10g (9.0.4), merge your modifications into the reports.sh installed with 10g (9.0.4).
|
The information in this appendix is also documented in the Reports Builder online help, which you can access in two ways:
From the Oracle Technology Network, (http://otn.oracle.com/products/reports/), click Documentation and navigate to the Reports Builder Online Help for the most recent, hosted online help.
From Reports Builder, choose Help > Help Contents.
This sections lists all the environment variables that you can set in Oracle Reports.
For more information on all NLS environment variables, see the Oracle Application Server 10g Globalization Guide on the Oracle Technology Network, (http://otn.oracle.com).
The environment variables shown with an asterisk (*) are supported in Oracle Reports 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. |
This 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.
Any directory on any drive.
ORACLE_HOME
CA_GPREFS=C:\orawin90
This environment variable specifies the location of the user preferences file, CAUPREFS.ORA. The CAUPREFS.ORA file maintains the preferences that you set via 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.
Any directory on any drive.
ORACLE_HOME
CA_UPREFS=C:\orawin90
This environment variable specifies whether to print the delimited character at the end of the line for delimited output.
YES|NO
YES
Set this environment variable to NO to ensure that the delimited character is not printed at the end of the line.
This environment variable specifies the location of the online documentation files, including online help.
Any directory on any drive.
ORACLE_HOME\tools\doc
DOC=C:\orawin90\tools\doc
(DOS SQL*Net users only) This environment variable specifies the interrupt vector address that DOS Oracle products will use. If you use a DOS SQL*Net driver for Windows, check your CONFIG.ORA file located in the DOS Oracle home directory. If INTERRUPT is set in CONFIG.ORA, you must set it to the same value in registry. If this variable is not set in your DOS CONFIG.ORA files, you do not need to set it in the registry.
|
Note: Do not setINTERRUPT to 103 when using a third-party memory management product such as QEMM, 386MAX, CEMM, or EMM386. Doing so will result in unexpected behavior after you start SQLPME and SQL*Net.
|
Same value specified in your DOS CONFIG.ORA file.
Not defined.
This environment variable specifies the language for the Reports Builder. Chapter 18, " Implementing NLS and Bidirectional Support" contains additional detailed information about this environment variable, including a table of valid values.
This environment variable specifies the string used to indicate a positive monetary value.
This environment variable specifies the default format used for dates.
This environment variable specifies the default language used for dates.
This environment variable specifies the string used to indicate a negative monetary value.
This environment variable specifies the language, settings used, including:
The language used to display messages to the user, for example the 'Working...' message.
The default format masks used for dates and numbers.
The sorting sequence.
The characters that make up the character set.
Chapter 18, " Implementing NLS and Bidirectional Support" contains additional detailed information about this environment variable, including a table of valid values.
See the NLS Reference Manual for a current list of available values, or see the Oracle Application Server 10g Globalization Guide on the Oracle Technology Network, (http://otn.oracle.com).
AMERICAN_AMERICA.WE8ISO8859P1
To change locales, you must modify this environment variable, in addition to the REPORTS_RESOURCE environment variable.
When you use features like OracleAS Portal Security, Portal Destination, and Job Status Repository, the JDBC database connections made by OracleAS Reports Services may override the initial NLS_LANG setting. This change may in turn affect the behavior of the running report, such as bidirectional output in PDF. On UNIX platforms, you can work around this issue by setting the NLS_LANG environment variable explicitly in reports.sh. You can also use the new environment switching functionality to dynamically set the environment for Oracle Reports. Refer to Dynamic Environment Switching, for more information.
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.WE8ISO8895P1
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:
NLS_LANG=French_Switzerland.WE8ISO8895P1
This environment variable specifies the character used to separate items in a list.
This environment variable specifies the decimal character and thousands separator for monetary values.
This environment variable specifies the decimal character and grouping separator for numeric values.
This environment variable specifies the type of sort used for character data.
This environment variable specifies the location of AFM files. TK90_AFM is considered first, then ORACLE_AFM.
Any directory on any drive.
Not defined.
If you do not specify values for either of these variables, Oracle Reports looks for AFM files in:
ORACLE_HOME/guicommon9/tk90/admin/AFM
Printing on UNIX requires some setup and configuration to create the proper printing environment. For detailed information, refer to Printing on UNIX with Oracle Reports .
This environment variable specifies the home directory in which Windows Oracle products are installed. This directory is the top directory in the Oracle directory hierarchy.
Any directory on any drive.
C:\orawin90
If you are using Reports Runtime (rwrun), the combined length of ORACLE_HOME and ORACLE_PATH should not exceed 255 characters.
ORACLE_HOME=C:\orawin90
This environment variable specifies the location of HPD files. TK90_HPD is considered first, then ORACLE_HPD.
Any directory on any drive.
Not defined.
If you do not specify values for either these variables, Oracle Reports looks for HPD files in:
ORACLE_HOME/guicommon9/tk90/admin/HPD
Printing on UNIX requires some setup and configuration to create the proper printing environment. For detailed information, refer to Printing on UNIX with Oracle Reports .
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.
Any directory on any drive.
Not defined.
If you are using Reports Runtime(rwrun), the combined length of ORACLE_HOME and ORACLE_PATH should not exceed 255 characters.
ORACLE_PATH=C:\oracle\apps\forms;C:\oracle\apps\reports
This environment variable specifies the location of PPD files. TK90_PPD is considered first, then ORACLE_PPD.
Any directory on any drive.
Not defined.
If you do not specify values for either of these variables, Oracle Reports looks for TFM files in:
ORACLE_HOME/guicommon9/tk90/admin/PPD
Printing on UNIX requires some setup and configuration to create the proper printing environment. For detailed information, refer to Printing on UNIX with Oracle Reports .
This environment variable specifies the location of TFM files. TK90_TFM is considered first, then ORACLE_TFM.
Any directory on any drive.
Not defined.
If you do not specify values for either TK90_TFM or ORACLE_TFM, Oracle Reports looks for TFM files in
ORACLE_HOME/guicommon9/tk90/admin/TFM
Printing on UNIX requires some setup and configuration to create the proper printing environment. For information about printing on UNIX with Oracle Reports, refer to Printing on UNIX with Oracle Reports .
This environment variable specifies the location of the table of contents and index for your online documentation.
Any directory on any drive.
Not defined.
ORAINFONAV_DOCPATH=C:\orawin90\oin
This environment variable specifies the default printer’s name.
Name of default printer
Not defined.
TK_PRINTER takes precedence over PRINTER, i.e., 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.
|
Printing on UNIX requires some setup and configuration to create the proper printing environment. For detailed information, refer to Printing on UNIX with Oracle Reports .
This environment variable specifies the default and remote SQL*Net driver to use when connecting via 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 theREMOTE 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.
|
REMOTE netPrefix:databaseName
where
netPrefix is the network prefix for Named Pipes
databaseNameis the name of the local database
Any valid SQL*Net driver prefix and parameters.
Not defined.
REMOTE=P:PIPER
where
P: is the network prefix for Named Pipes
PIPER is the database name.
(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 printer-independent reports. Oracle Reports has been changed to generate the report output relative to the top-left corner of the physical paper. 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.
To set the REPORTS_ADD_HWMARGIN registry variable:
Edit the Windows registry using a registry editor (for example, regedit.exe).
|
Note: Before you edit the registry, back it up. |
Navigate to the following key:
HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\HOMEn
where n is the number of the ORACLE_HOME containing the installation.
Add a new String value named REPORTS_ADD_HWMARGIN and set the value to YES.
YES|NO
NO
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 Reports Builder have been disabled to ensure consistency with OracleAS Reports Services.
This environment variable specifies the numeric format for Arabic PDF output. Valid values for this environment are: ARABIC (Arabic numerals), HINDI (Hindi numerals), or CONTEXT (Arabic or Hindi depending on the context). This environment variable is case insensitive.
ARABIC|HINDI|CONTEXT
ARABIC (Indo-Arabic)
This environment variable switches the bidirectional (BiDi) layout algorithm for BiDi languages (for example, Arabic or Hebrew). This environment variable is case insensitive.
ORACLE|UNICODE
where
ORACLE Oracle Reports follows the Oracle BiDi algorithm. The Oracle algorithm is used in Oracle Application Server Forms Services.
UNICODE Oracle Reports follows the Unicode BiDi algorithm.
Refer to: http://unicode.org/unicode/reports/tr9/index.html, for more information on the Unicode BiDi algorithm.
ORACLE
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.
Any valid HTML attributes for the <BODY> tag.
Not defined.
This environment variable is supported in Oracle Reports 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. |
REPORTS_CGIDIAGBODYTAGS="bgcolor="#CC3366""
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.
Any HTML tags that are valid between the <HEAD> and </HEAD> tags.
Not defined.
This environment variable is supported in Oracle Reports 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. |
REPORTS_CGIDIAGHEADTAGS="<title>Employee List</title>"
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?
Any valid URL to a Web page or HTML file.
A default help screen is displayed in your browser.
This environment variable is supported in Oracle Reports 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. |
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
This environment variable specifies the fully qualified file name and location of the rwcgi map file, if map file configuration is used.
A valid path to the map file.
ORACLE_HOME\reports\conf\cgicmd.dat
This environment variable is supported in Oracle Reports 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. |
REPORTS_CGIMAP=c:\ora9ias\reports\conf\cgicmd.dat
This environment variable specifies whether to disable all debugging and diagnostic output, such as help and showmap, from rwcgi.
YES|NO
NO
This environment variable is supported in Oracle Reports 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. |
The following request does not work when REPORTS_CGINODIAG=YES:
http://your_webserver/rwcgi/help?
This environment variable specifies the list of JAR files and directories for the Java Virtual Machine (JVM) when started by the Oracle Reports executables. 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: Reports Builder will fail if the value of theREPORTS_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.
|
The default values are mandatory. If any of the entries are removed, the Oracle Reports executables may not behave correctly. Any additional user-defined directory or JAR file that contains Java Classes may be appended to the path.
%ORACLE_HOME%\reports\jlib\rwbuilder.jar;%ORACLE_HOME%\reports\jlib\rwrun.jar;%ORACLE_HOME%\jlib\zrclient.jar;%ORACLE_HOME%\j2ee\home\oc4j.jar;%ORACLE_HOME%\j2ee\home\lib\ojsp.jar
The default value for the environment variable is required for Oracle Reports executables to function correctly. Additional user classes may be appended, but the list must conform to the platform-specific Java CLASSPATH definition.
Example
REPORTS_CLASSPATH=%ORACLE_HOME%\reports\jlib\rwbuilder.jar; %ORACLE_HOME%\reports\jlib\rwrun.jar;%ORACLE_HOME%\jlib\zrclient.jar;%ORACLE_HOME%\j2ee\home\oc4j.jar;%ORACLE_HOME%\j2ee\home\lib\ojsp.jar
Reports Builder will fail if the value of the REPORTS_CLASSPATH environment variable (registry) exceeds 511 characters. To workaround this issue, you can use the CLASSPATH environment variable (system) to specify a value in excess of 511 characters.
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 via its own authentication mechanism (identical to the behavior of Oracle Reports6i). Because the HTTP 1.0 protocol is stateless (i.e., 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 (e.g., 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 theSHOWAUTH 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 ORACLE_HOME\reports\conf. %S forces users to enter their user name and password each time the report is called.
|
Any number of minutes.
30
This environment variable is supported in Oracle Reports 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. |
REPORTS_COOKIE_EXPIRE=30
This environment variable specifies the database authentication template used to log on to the database.
Any HTML file that contains special authentication actions. It is recommended that you keep the default.
dbauth.htm
This environment variable is supported in Oracle Reports 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. |
REPORTS_DB_AUTH=dbauth.htm
This environment variable specifies whether to implement the following features introduced with 10g (9.0.4):
The elimination of the dependency on the DISPLAY environment variable (UNIX only)
ScreenPrinter (screenprinter.ppd) for surface resolution for images and font information (UNIX only)
Advanced Imaging Support (all platforms)
YES|NO
YES
The Reports Server must be started in batch mode to suppress the UI.
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, and HTML, HTMLCSS, and BMP for RTF output.
Printing on UNIX requires some setup and configuration to create the proper printing environment. For detailed information, refer to Printing on UNIX with Oracle Reports .
On UNIX, REPORTS_DEFAULT_DISPLAY = YES overrides any value set for the DISPLAY environment variable.
To revert to the dependency on DISPLAY and use screen fonts:
Set REPORTS_DEFAULT_DISPLAY=NO
Remove the screenprinter.ppd entry in the uiscreenprint.txt file.
This environment variable specifies a pixel size that overrides the operating system’s default pixel size when generating a report to HTML output. Normally, Oracle Reports takes its pixel size from the operating system. If you are working with older reports that rely upon a pixel size that is different from that of the operating system (for example, a pixel size of 80), you can use this variable to maintain the same behavior in your older reports.
Any value ranging from 72 through 200.
Surface resolution determined by Oracle Reports.
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 Printing on UNIX with Oracle Reports .
This environment variable specifies the encryption key used to encrypt the user name and password.
Any encryption key
reports9.0
This environment variable is supported in Oracle Reports 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. |
REPORTS_ENCRYPTION_KEY=reports9.0
The REPORTS_GRAPH_IMAGE_DPI 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 250:
|
72 through 300
72
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 of REPORTS_JVM_OPTIONS to avoid the Out Of Memory error for the JVM
To revert to the old behavior set the value of this environment variable to 72 DPI.
This environment variable specifies any JVM options that you want Reports Builder, Reports Runtime, or OracleAS Reports Services 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, and so on.
List of JVM options in the JVM command line syntax.
-Xmx256M
The default value -Xmx256M specifies the JVM heap size of 256 to avoid the Out Of Memory error when running reports with large graphs or running big reports.
In the server mode, you can also specify the JVM options in the servername.conf file in the engine attribute. If specified, the JVM options set in the server configuration file would take higher precedence to the REPORTS_JVM_OPTIONS environment variable.
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 required where the required character set mapping for Reports NLS_LANG to XML IANA 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 (e.g., JA16SJIS) to what is expected in the XML specification (e.g., Shift_JIS).
You can override this mapping by adding entries to the REPORTS_NLS_XML_CHARSET.
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.
<old_name>=<new_name>[;<old_name>=<new_name>][;<old_name>=<new_name>]...
Not defined.
This environment variable should not be required and is currently only used as a workaround to Bug 2224413:
NLS:NEED STABLE MAPPING FROM ORACLE'S NLS_CHARACTER_SET TO IANA ENCODING
WISO-8859-8=ISO-8859-8-1;CSEUCKR=EUC-KR;WINDOWS-949=EUC-KR;EUC-CN=GBK;WINDOWS-936=GBK
This environment variable specifies whether the system’s surface and fonts should be used instead of the printer’s.
TRUE|not set
TRUE
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. Beginning with Oracle Reports 10g (9.0.4), if the uiprint.txt file does not contain a valid entry (i.e., 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.
Printing on UNIX requires some setup and configuration to create the proper printing environment. For detailed information, refer to Printing on UNIX with Oracle Reports .
This environment variable specifies whether spaces should not be replaced with in HTML or HTMLCSS output.
Oracle Reports will map HTML metadata characters in the data retrieved for a field to the appropriate encoding. That is, Oracle Reports automatically maps: < to < and " to ". 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.
YES|not set
not set
If the value is not set, all spaces are replaced by . 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.
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:
[ Typical data output]
and display as (maintaining preceding spaces):
[ Typical data output]
|
Note: Brackets in the above example are used to show preceding spaces; they are not part of the sentence. |
This environment variable specifies the default image format used in the report.
GIF|JPEG|JPG|PNG|BMP
JPEG
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.
This environment variable setting is overridden by the value of the OUTPUTIMAGEFORMAT command line keyword.
Refer to Advanced Imaging Support for more information.
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 preventing the need to hard-code directory paths.
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, etc.
In addition to directory paths, you can specify the keyword DB when you define REPORTS_PATH. This instructs Reports Builder 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
Reports Builder will first search the directory /home/tkostin/pay. If it cannot find the file in question, it will search /home/tkostin/receive. If it still cannot find the file, it will search the database to which you connected when you began your Reports Builder session.
Any directory on any drive.
%ORACLE_HOME%\REPORT\DEMO; %ORACLE_HOME%\REPORT\DEMO\BITMAP; %ORACLE_HOME%\REPORT\DEMO\REQFILES
REPORTS_PATH is limited to 256 characters.
If you specify a path for the sourceDir attribute of the engine element in the Reports Server configuration file (server_name.conf), the sourceDir value will override the values you set here.
REPORTS_PATH=C:\oracle\apps\reports;C:\myfiles
This environment variable specifies the location of the resource files required for reports. This path must include the NLS directory extension when specifying the location of the resource files.
Any directory on any drive.
%ORACLE_HOME%\reports\res\US\
To change locales, you must modify this environment variable, in addition to NLS_LANG.
For US files:
REPORTS_RESOURCE = %ORACLE_HOME%\reports\res\US\
For Japanese files:
REPORTS_RESOURCE = %ORACLE_HOME%\reports\res\JA\
This environment variable specifies the default Reports Server for Web Cartridge or Web CGI requests. When this parameter is set, you can omit the SERVER command line keyword in report requests to process them using the default server, or you can include the SERVER command line keyword to override the default.
Any Reports Server service entry name.
This environment variable is supported in Oracle Reports 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. |
REPORTS_SERVER=my_rep_server
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.
YES|NO
YES
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.
This environment variable specifies the port number when using SSL.
Any valid port number.
443
This environment variable is supported in Oracle Reports 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. |
REPORTS_SSLPORT=442
This environment variable specifies the authentication template used to authenticate the username and password when users run report requests to a restricted Reports Server.
Any HTML file that contains special authentication actions. It is recommended that you keep the default.
sysauth.htm
This environment variable is supported in Oracle Reports 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. |
REPORTS_SYS_AUTH=sysauth.htm
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.
Any Òuri" that references the Oracle Reports tag library.
/WEB-INF/lib/reports_tld.jar
The default value is typically unchanged. It is the same for both Reports files in both JDeveloper and Reports. The Òprefix" attribute can be changed to avoid naming conflicts independent of the Òuri" attribute.
This environment variable specifies the directory in which you wish to store Reports Builder temporary files. 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.
Any directory on any drive.
Not defined.
REPORTS_TMP=C:\tmp
This environment specifies the DLLs for use by Reports Builder and its related executables (e.g., Reports Runtime). These DLLs are program modules created by you to be called by the Reports Builder executables.
REPORTS_USEREXIT can specify multiple DLLs. Use a backslash (\) to separate directories in a path, and a semicolon (;) to separate complete paths.
If this value is not explicitly set, Reports Builder looks for 60xtb32.dll according to the path variable of the system.
Any user exit dynamic link library (along with its absolute path).
Not defined.
REPORTS_USEREXIT=C:\mydll.dll;d:\mynew.dll;e:\bin\speed.dll
This environment variable specifies the reports-specific directory within the ORACLE_HOME.
A valid directory name.
%ORACLE_HOME%\reports (Windows)
$ORACLE_HOME/reports (UNIX)
(UNIX only) This environment variable specifies the print command to be executed on UNIX for Oracle Reports 6i. In Oracle Reports, TK_PRINT is obsolete; you can achieve the same results by using the printing script file: ORACLE_HOME/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.
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
UnixWare: lp -s -Tpostscript -d'%n' -n%c
Solaris: lpr -P'%n' -#%c -s
Not defined.
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.
Printing on UNIX requires some setup and configuration to create the proper printing environment. For detailed information, refer to Printing on UNIX with Oracle Reports .
(UNIX only) This environment variable specifies the command executed to validate the printer. To make sure 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.
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
Not defined.
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.
|
Printing on UNIX requires some setup and configuration to create the proper printing environment. For detailed information, refer to Printing on UNIX with Oracle Reports .
(UNIX only) This environment variable specifies the default printer’s name.
Name of default printer.
Not defined.
TK_PRINTER takes precedence over PRINTER, i.e., 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.
|
Printing on UNIX requires some setup and configuration to create the proper printing environment. For detailed information, refer to Printing on UNIX with Oracle Reports .
This environment variable specifies the location of AFM files. TK90_AFM is considered first, then ORACLE_AFM.
Any directory on any drive.
Not defined.
If you do not specify values for either of these variables, Oracle Reports looks for AFM files in:
ORACLE_HOME/guicommon9/tk90/admin/AFM
Printing on UNIX requires some setup and configuration to create the proper printing environment. For detailed information, refer to Printing on UNIX with Oracle Reports .
This environment variable specifies the location of HPD files. TK90_HPD is considered first, then ORACLE_HPD.
Any directory on any drive.
Not defined.
If you do not specify values for either these variables, Oracle Reports looks for HPD files in:
ORACLE_HOME/guicommon9/tk90/admin/HPD
Printing on UNIX requires some setup and configuration to create the proper printing environment. For detailed information, refer to Printing on UNIX with Oracle Reports .
This environment variable specifies the location of PPD files. TK90_PPD is considered first, then ORACLE_PPD.
Any directory on any drive.
Not defined.
If you do not specify values for either of these variables, Oracle Reports looks for TFM files in:
ORACLE_HOME/guicommon9/tk90/admin/PPD
Printing on UNIX requires some setup and configuration to create the proper printing environment. For detailed information, refer to Printing on UNIX with Oracle Reports .
This environment variable specifies the location of TFM files. TK90_TFM is considered first, then ORACLE_TFM.
Any directory on any drive.
Not defined.
If you do not specify values for either TK90_TFM or ORACLE_TFM, Oracle Reports looks for TFM files in
ORACLE_HOME/guicommon9/tk90/admin/TFM
Printing on UNIX requires some setup and configuration to create the proper printing environment. For information about printing on UNIX with Oracle Reports, refer to Printing on UNIX with Oracle Reports .
This environment variable specifies the variable part of a default logon account. See your database documentation for more information on setting USERNAME.
Any valid Oracle username (without the OPS$ prefix).
Not defined.
USERNAME=dsanvita
This environment variable specifies the language for the Oracle Reports Runtime component. Chapter 18, " Implementing NLS and Bidirectional Support" contains additional detailed information about this environment variable, including a table of valid values.
This environment variable specifies the number of connections to a remote server for which NETINIT7 should reserve memory.
0 - 33
Not defined.
If you receive an error in the ORA-3100 to ORA-3199 range when you try to log on, there may not be enough real-mode memory to establish a communication buffer with an Oracle server. NETINIT7.EXE solves this problem by reserving memory for server connections.
If you set WIN_REMOTE_SESSIONS to 0, NETINIT7 will not reserve any memory for remote server connections.
Setting WIN_REMOTE_SESSIONS to the values 1 through 33 will reserve memory for the specified number of connections. Note that NETINIT7 reserves 12K of real-mode memory for each remote server connection.
A suggested default value for WIN_REMOTE_SESSIONS is 5. Setting WIN_REMOTE_SESSIONS to 5 should create enough sessions to allow you to run several products.
If you do not add the WIN_REMOTE_SESSIONS parameter, NETINIT7 will reserve memory for one remote server connection.
To use NETINIT7:
Configure the number of sessions by adding the WIN_REMOTE_SESSIONS parameter.
Create the NETINIT7 icon in your Oracle program group. (For more information about creating icons, see your Microsoft Windows documentation.) Enter the following path in the Command Line field of the Windows Program Item Properties dialog box:
%ORACLE_HOME%\bin\netinit7.exe
Start NETINIT7 by double-clicking the icon in the Oracle program group. Make sure that you start NETINIT7 before you start a product. If you want NETINIT7 to run automatically at Windows startup, include the NETINIT7 icon in the Windows Startup program group.
NETINIT7 attempts to reserve real memory for the configured number of server connections. If NETINIT7 cannot allocate the required memory, it displays a warning message and indicates the actual number of sessions for which it has allocated memory.
After allocating memory, NETINIT7 minimizes itself. Restoring NETINIT7 displays the total number of sessions configured and the total amount of memory used. Closing NETINIT7 releases all unused session memory. If an application is still using session memory, NETINIT7 notifies you that applications must log off before session memory can be freed.
|
Note: If you start a product beforeNETINIT7, it will allocate its own session memory, which is not recognized by NETINIT7. NETINIT7 attempts to allocate the configured session memory in addition to memory already allocated by the product you started.
|
(DOS users only) This environment variable applies only to users of Oracle DOS protected mode executables. Check your CONFIG.ORA file, located in the DOS Oracle home directory. If the XMMITR parameter is set in CONFIG.ORA, you must set it to the same value in the registry. If this variable is not set in your DOS CONFIG.ORA files, you do not need to set it in the registry.
XMMITR (Extended Memory Manager Interrupt Vector) specifies the interrupt vector to be used for the extended memory manager/mode transition driver XMM/MTD interrupt services entry point. To set a different vector, the new interrupt vector is expressed as a decimal number. XMMITR should be used only if another program in your system needs to use interrupt 100 decimal, or 64 hexadecimal.
The same value specified in your DOS CONFIG.ORA file.
Not defined.
