Oracle Reports Publishing Reports Release 6i A73173-01 |
|
This chapter shows you how to configure the Reports Server, providing general instructions and then presenting an example Reports Server configuration using Web CGI. In this example, users can dynamically run reports from and receive the report output in their Web browser. No client software is necessary for users to run reports.
You can choose to install and configure the Reports Server automatically using the Smart Server Install or manually using the step-by-step instructions found in this chapter. To do this, you must have the Oracle Developer Server software.
You can choose to install and configure the Reports Server using the following methods:
The Smart Server Install automatically analyzes the dependencies on your machine and then configures the Reports Server based on the options you choose.
To start the Smart Server Install, start the Oracle Installer and choose the Deployment Installation option. See the Getting Started manual for more information on the installation process.
A configuration instructions file is produced at the end of the Smart Server Install that summarizes the configuration settings that were created for you. This configuration instructions file will inform you of any additional configuration settings that you need may need to define manually.
To manually install and configure the Reports Server, follow these steps:
Step 1. Install the software.
Step 2. Configure your Web server. Refer to your Web server documentation.
Step 3. Configure the Reports Web CGI or Servlet.
Step 4. Configure the Reports Server.
Step 5. Run a report request.
Step 6. (Optional) Modify the configuration.
If you want to install and configure a new or additional Reports Server or uninstall an existing Reports Server, see Section 3.3, "Installing or uninstalling the Reports Server at the command line" for more information.
See the following sections for detailed instructions on configuring the Reports Server:
This section provides step-by-step instructions on how to manually configure the Reports Server using the Web CGI and any CGI-aware Web server. If you have using a java-based Web server, see Section 3.4, "Reports Servlet configuration guidelines" for more information.
In order to make this configuration meaningful, it is necessary to make several assumptions. For the purposes of this section, the following assumptions are made:
Tip: This case assumes that you will install software, configure your server settings, and save .RDF files on your machine's "C" drive.
You must have the Oracle Developer Server software to install and configure the Reports Server. Refer to the Getting Started manual for more information on installing the Oracle Reports Thin Client and Oracle Reports Server components and the Report Builder.
Tip: To install just the Reports Thin Client, Reports Server, or the Report Builder, start the Oracle Installer and choose the Custom Installation option. From the Available Products list box, expand the Oracle Developer - Reports node and choose Reports Thin Client, Oracle Reports Server, or Report Builder as desired. Proceed with the installation as described in the Getting Started manual.
On the Web server machine:
On the Reports Server machine:
where repserver.world is the name of the server instance and .world is the domain specified in the NAMES.DEFAULT_DOMAIN setting in the sqlnet.ora file. If the NAMES.DEFAULT_DOMAIN setting is not defined in the sqlnet.ora, then omit .world from the name of the server instance.
Tip: You can edit the Reports Server service entry by opening the tnsnames.ora file in a text editor.
This step is performed on the Web server machine.
Refer to your Web server documentation for more information on configuring your Web server.
Directory Description | Physical directory example | Virtual directory example | Permissions required |
---|---|---|---|
Web cgi-bin |
C:\YOUR_WEBSERVER\BIN |
/CGI-BIN |
execute |
Note: The Web cgi-bin directory on your Web server contains CGI executables.
Note: If you are configuring the Reports Server using the Reports Servlet, see Section 3.4, "Reports Servlet configuration guidelines" for more information.
This step is performed on the Web server machine.
Tip: The cgi-bin directory is defined in your Web server configuration. Refer to your Web server documentation for more information. In Table 3-1, "Web cgi-bin physical and virtual directories", the Web CGI physical directory is C:\YOUR_WEBSERVER\BIN.
This step is performed on your Web server machine.
If the Web server is on a different machine than your Reports Server, you must add the Reports Server service entry that was created on the Reports Service machine to the tnsnames.ora file located on your Web server machine. This will enable the Web CGI executable to communicate with the Reports Server.
Tip: If you don't remember the service entry settings for the Reports Server. Open the tnsnames.ora file located in ORACLE_HOME\NET80\ADMIN directory on your Reports Server machine. Copy or make note of the service entry.
repserver.world =(ADDRESS = (PROTOCOL = TCP)(Host = repserver_ machine.mydomain)(Port = 1949))
where:
repserver.world is the name of the server instance and .world is the domain specified in the NAMES.DEFAULT_DOMAIN setting in the sqlnet.ora file. If the NAMES.DEFAULT_DOMAIN setting is not defined in the sqlnet.ora, then omit .world from the name of the server instance.
repserver_machine.mydomain is the host name or IP address of the machine.
1949 is the port number to which the server is listening.
For Windows NT:
REPORTS60_REPORTS_SERVER=repserver
where repserver is the name of the Reports Server that you are configuring (i.e., the TNS service entry name of the Reports Server). See Section 3.2.1, "Step 1. Install the software".
Note: Refer to your operating system's documentation to determine if the values you set are case-sensitive.
For UNIX:
Tip: You may want to create a shell script that sets environment variables on your Web server machine. To do this, create a file that contains the command described below.
setenv REPORTS60_REPORTS_SERVER repserver
where repserver is the name of the Reports Server that you are configuring (i.e., the TNS service entry name of the Reports Server). See Section 3.2.1, "Step 1. Install the software".
Tip: Refer to your operating system's documentation to determine if the values you set are case-sensitive.
To configure the Reports Server, you can set environment variables, set the default printer, and start the server.
Alternatively, after the Reports Server is installed, you can set the source path in the Reports Server configuration file. See the SOURCEDIR parameter in Appendix B, "Reports Server Configuration Parameters" for more information.
Note: Refer to your operating system's documentation to determine if the values you set are case-sensitive.
Tip: If you want to output to Postscript or to a printer, ensure that the user running the Reports Server service has access to a default printer. Typically, the System Account doesn't have access to printers.
Tip: When you start the Reports Server for the first time, a Reports Server configuration file (e.g., repserver.ora) is created in the ORACLE_HOME\REPORT60\SERVER directory. The setting for your Reports Server cache is set by default. You can change the cache directory, or set the report's source path by modifying the configuration file. If you modify the configuration file, stop and restart the Reports Server for the changes to take effect.
Tip: You may want to create a shell script that sets the environment variables and launches the RWMTS60 executable. To do this, create a file that contains the commands described below.
setenv REPORTS60_PATH $WEB_REPORTS
Tip: Alternatively, after the Reports Server is installed, you can set the source path in the Reports Server configuration file. See the SOURCEDIR parameter in Appendix B, "Reports Server Configuration Parameters" for more information.
setenv TNS_ADMIN $ORACLE_HOME/NET80/ADMIN
Tip: Refer to your operating system's documentation to determine if the values you set are case-sensitive.
During the installation of the Oracle Reports Server, the RWMTS60 command that starts the Reports Server was added to the shell script.
Tip: When you start the Reports Server for the first time, a Reports Server configuration file (e.g., repserver.ora) is created in the $ORACLE_HOME/REPORT60/SERVER directory. The setting for your Reports Server cache is set by default. If you want to change the cache directory, or if you want set the report's source path, you can do so by modifying the configuration file. If you modify the configuration file, you will need to stop and restart the Reports Server to acknowledge the changes.
rwrqv60 server=repserver
Status columns (i.e., NAME, OWNER, DEST, etc.) for this Reports Server are displayed. Currently, though, no status information is available since no jobs are running.
Tip: To stop the Reports Server, press ctrl-C.
Tip: If you want to output to Postscript or to a printer, the printer must be configured in the uiprint.txt file (located in the $ORACLE_HOME/GUICOM6/TK60/ADMIN directory).
http://your_webserver/cgi-bin/rwcgi60.exe?report=your_report.rdf+ userid=username/password@mydb+desformat=html+destype=cache
Notice that the SERVER command line argument is missing from the request. It is not required if you set the REPORTS60_REPORTS_SERVER environment variable on your Web Server machine.
Tip: If the report does not run or if you receive an error message, see Appendix F, "Troubleshooting" for more information.
This completes the Reports Server configuration example using Web CGI for CGI-aware Web servers. You have successfully configured the Reports Server for dynamic reporting.
Next steps:
When you start the Reports Server for the first time, the Reports Server is set with default configuration settings (e.g., maximum and minimum engines). At some point, you may want to modify the Reports Server configuration to tune performance, set up monitoring controls, or implement additional features.
You can set up your database to take snapshots of the Reports Server queue activity whenever jobs are run. When you start the Reports Server, a connection to the database is made. By default, the Reports Server calls an API to delete queue information when the server restarts and to update the queue information in the database table.
You can edit the source for the API in the rw_server.sql script to override the defaults (e.g., prevent the queue from being deleted when restarting the Reports Server). Note that the prototype of the procedure (i.e., the procedure name and the parameters it expects) should not be edited.
To connect to the database, you set the REPOSITORYCONN parameter in the configuration file. To create the queue activity table in the database, you run the rw_server.sql script.
On the Reports Server machine:
REPOSITORYCONN="repserver_schema/password@my_db"
where repserver_schema/password@database is the connection string to the schema in your database that takes snapshots of queue activity of the specified Reports Server. In this case, repserver_schema is the schema for repserver queue activity.
Tip: If you want to take snapshots of queue activity from many Reports Servers, it is recommended that you create a different schema in your database for each Reports Server that you want to take snapshots of. This will prevent you from losing queue activity data when you restart the Reports Server.
cd C:\ORACLE_HOME\REPORT60\SQL <RETURN> plus80 username/password@my_db <RETURN> @rw_server.sql <RETURN> quit <RETURN>
Note: When you restart your Reports Server, queue activity in the database is deleted by default. You can override the default by editing the API.
You can start additional Reports Servers, or stop existing Reports Servers from the command line. You must have already installed the Reports Server component to do this. See Section 3.1, "Installation and Configuration overview" for more information.
RWMTS60 is the executable for the Reports Server. For Windows NT, three commands are associated with it:
You can install, listen, and uninstall the Reports Server manually or in batch mode. Set the BATCH argument to Yes to ignore any error messages raised during the installation and allow the operation to complete without interruption. Any errors or status information raised during installation can be viewed in the Reports Server log file (located on ORACLE_HOME\REPORT60\SERVER\repserver.log). The default for BATCH is No.
You can:
To start another Reports Server, you must:
repserver.world =(ADDRESS = (PROTOCOL = TCP)(Host = repserver2_ machine.mydomain)(Port = 1950))
where:
repserver2.world is the name of the server instance and .world is the domain specified in the NAMES.DEFAULT_DOMAIN setting in the sqlnet.ora file. If the NAMES.DEFAULT_DOMAIN setting is not defined in the sqlnet.ora, then omit .world from the name of the server instance.
repserver_machine.mydomain is the host name or IP address of the machine.
1950 is the port number to which the server is listening.
In order for the Reports Server to run the requested report, it needs to know where the report is located. You can set the report's source path in the REPORTS60_PATH environment variable.
Alternatively, after the Reports Server is installed, you can set the source path in the Reports Server configuration file. See the SOURCEDIR parameter in Appendix B, "Reports Server Configuration Parameters" for more information.
Note: Refer to your operating system's documentation to determine if the values you set are case-sensitive.
rwmts60 -install repserver tcpip
or for batch mode:
rwmts60 -install repserver batch=yes
Tip: Repserver does not need to have the domain qualifier (e.g., .world) appended to it.
Tip: If you want to output to Postscript or to a printer, ensure that the user running the Reports Server service has access to a default printer. Typically, the System Account doesn't have access to printers.
Tip: When you start the Reports Server for the first time, a Reports Server configuration file (e.g., repserver.ora) is created in the ORACLE_HOME\REPORT60\SERVER directory. The setting for your Reports Server cache is set by default. You can change the cache directory, or set the report's source path by modifying the configuration file. If you modify the configuration file, stop and restart the Reports Server for the changes to take effect.
You can set two optional environment variables. The first lets the Reports Server know where the requested report is located. You can set the report's source path in the REPORTS60_PATH environment variable. The second sets the location of the tnsames.ora file.
Tip: You may want to create a shell script that sets the environment variables and launches the RWMTS60 executable. To do this, create a file that contains the commands described below.
setenv REPORTS60_PATH $WEB_REPORTS
Tip: Alternatively, after the Reports Server is installed, you can set the source path in the Reports Server configuration file. See the SOURCEDIR parameter in Appendix B, "Reports Server Configuration Parameters" for more information.
setenv TNS_ADMIN $ORACLE_HOME/NET80/ADMIN
Tip: Refer to your operating system's documentation to determine if the values you set are case-sensitive.
rwmts60 name=repserver
or to run the Reports Server in the background:
rwmts60 name-repserver &
Tip: When you start the Reports Server for the first time, a Reports Server configuration file (e.g., repserver.ora) is created in the $ORACLE_HOME/REPORT60/SERVER directory. The setting for your Reports Server cache is set by default. If you want to change the cache directory, or if you want set the report's source path, you can do so by modifying the configuration file. If you modify the configuration file, you will need to stop and restart the Reports Server to acknowledge the changes.
rwrqv60 server=repserver
Status columns (i.e., NAME, OWNER, DEST, etc.) for this Reports Server are displayed. Currently, though, no status information is available since no jobs are running.
Tip: If you want to output to Postscript or to a printer, the printer must be configured in the uiprint.txt file (located in the $ORACLE_HOME/GUICOM6/TK60/ADMIN directory).
rwmts60 -listen repserver
or in batch mode:
rwmts60 -listen repserver batch=yes
Tip: Repserver does not need to have the domain qualifier (e.g., .world) appended to it.
On Windows NT:
rwmts60 -uninstall repserver
or in batch mode:
rwmts60 -uninstall repserver batch=yes
Tip: Repserver does not need to have the domain qualifier (e.g., .world) appended to it.
On UNIX:
You can configure the Reports Server using the Reports Servlet if you are using a Java-based Web server (e.g., Oracle Lite, Oracle Application Server). The Reports Server configuration using the Reports Servlet is similar to the Web CGI configuration. However, you must also install servlet-enabled Web server software.
Use the following guidelines to configure your Java-based Web server using the Reports Servlet.
Step 1. Install the Oracle Reports Thin client software and servlet-enabled Web server software. Refer to the Getting Started manual for more information on installing the Oracle Reports Thin client. Refer to your Web server documentation for more information on installing the Web server.
Step 2. Configure your Web server. Refer to the Web server's documentation for more information.
Step 3. Configure the Reports Servlet. See Section 3.4.1, "Configuring the Web server".
Step 4. Configure the Reports Server. See Section 3.3, "Installing or uninstalling the Reports Server at the command line" for detailed instructions on configuring the Reports Server.
This step is performed on the Web server machine.
# Oracle Report servlet servlet.RWServlet.code=oracle.reports.rwcgi.RWServlet
http://your_webserver/RWServlet?report=your_report.rdf+
userid=username/password@mydb+desformat=html+destype=cache
Notice that the SERVER command line argument is missing from the request. It is not required if you set the REPORTS60_REPORTS_SERVER environment variable on your Web Server machine to the repserver.
|
![]() Copyright © 1999 Oracle Corporation. All Rights Reserved. |
|