Oracle Reports Publishing Reports
Release 6i

A73173-01

Contents

Index

Prev Next

3
Configuring the Reports Server

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.

3.1 Installation and Configuration overview

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:

3.1.1 Configuring the Report Server automatically using the Smart Server Install

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.

3.1.2 Configuring the Reports Server 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:

3.2 Configuring the Reports Server: Reports Web CGI example

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.

3.2.1 Step 1. Install the software

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:

  1. Install the Oracle Reports Thin Client component after installing your Web server. Refer to your Web server documentation for more information on installing the Web server.

On the Reports Server machine:

  1. Install the Oracle Reports Server component and the Report Builder. Note that the Report Builder is required only if you need to build reports. If the Reports Server machine is used only as a deployment machine, then do not install the Report Builder component.

  2. When you install the Oracle Reports Server, you will be asked to identify the Reports Server TNS name and Port number. This information is added to the tnsnames.ora file (located in the ORACLE_HOME\NET80\ADMIN directory).

    • Reports Server TNS Name. Type repserver.world or keep the default.

      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.

    • Port. Type the port number to which the server will listen or keep the default.

    Tip: You can edit the Reports Server service entry by opening the tnsnames.ora file in a text editor.

  3. Make note of the Reports Server TNS name and port number. You will need this information to add the service entry for this Reports Server to the tnsnames.ora file located on the Web server machine. See Section 3.2.3.2, "To create a service entry for the Reports Server" for more information.

3.2.2 Step 2. Configure the Web server

This step is performed on the Web server machine.

Refer to your Web server documentation for more information on configuring your Web server.

  1. Start your Web server.

  2. Start your browser.

  3. Create a listener.

  4. Configure your Web server mapping and note the following physical and virtual directories:
    Table 3-1 Web cgi-bin physical and virtual directories
    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.

3.2.3 Step 3. Configure the Reports Web CGI

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.

3.2.3.1 To configure Reports Web CGI

  1. Copy rwcgi60.exe (located in the ORACLE_HOME\BIN directory) to your cgi-bin directory.

    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.

3.2.3.2 To create a service entry for the Reports Server

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.

  1. On your Web Server machine, open the tnsnames.ora file (located in the ORACLE_HOME\NET80\ADMIN directory) in a text editor.

  2. Add the following Reports Server 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.

3.2.3.3 (Optional) To set the default Reports Server

For Windows NT:

  1. On your desktop, choose Start->Run.

  2. Type regedit to display the Registry Editor.

  3. Expand Hkey_local_machine->Software.

  4. Choose Edit->New->String value to add the following environment variable:

    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.

  1. Set the REPORTS60_REPORTS_SERVER environment variable to the name of the Reports Server:

    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.

3.2.4 Step 4. Configure the Reports Server

To configure the Reports Server, you can set environment variables, set the default printer, and start the server.

3.2.4.1 To configure the Reports Server in Windows NT

3.2.4.1.1 (Optional) To set the source path

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.

  1. Create the source directory if it doesn't already exist.

  2. On your desktop, choose Start->Run.

  3. Type regedit to display the Registry Editor.

  4. Expand Hkey_local_machine->Software.

  5. Double-click REPORTS60_PATH.

  6. Add a new reports source path (e.g. C:\WEB_REPORTS).

    Note: Refer to your operating system's documentation to determine if the values you set are case-sensitive.

3.2.4.1.2 Start the Reports Server

  1. On the Reports Server machine desktop, choose Start->Settings->Control Panel and double-click (Services).

  2. In the Services dialog box, choose Oracle Reports Server [repserver] and click Startup.

  3. From the startup dialog, select This Account in the Log On As section and type or select an operating system user name and password. This specifies that the server is run as that user.

    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.

  4. Set the service to start automatically (when the system is started).

  5. Click OK.

  6. Click Start. A Service Control message box indicates when your Reports Server has started. If your Reports Server cannot start, see Appendix F, "Troubleshooting" for more information.

    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.

3.2.4.2 To configure the Reports Server on UNIX

3.2.4.2.1 (Optional) Set enviornment variables

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.

  1. Create a directory for your source reports (e.g., /WEB_REPORTS).

  2. Set the REPORTS60_PATH environment variable to locate the reports:

    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.

  3. Set the TNS_ADMIN environment variable to point to the location of the tnsnames.ora file:

    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.

3.2.4.2.2 Start the Reports Server

During the installation of the Oracle Reports Server, the RWMTS60 command that starts the Reports Server was added to the shell script.

  1. Run the shell script to start the Reports Server.

    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.

  2. (Optional) From the $ORACLE_HOME/BIN directory, run the following command line to ensure that the Reports Server is running:

     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).

3.2.5 Step 5. Run a report request from a Web browser

  1. Ensure that the Reports Server is configured properly. In a Web browser, make the following request:

    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.

  2. (Optional) View the status of the request.

    • For Windows NT, start the Reports Queue Manager, choose to view the repserver queue. See the Reports Queue Manager online help for more information.

    • For UNIX run the following command:

      rwrqv60 server=repserver showjobs=current
      
      

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:

3.2.6 Step 6. (Optional) Modify the Reports Server configuration

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.

3.2.6.1 To update the database with job queue activity

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:

  1. Open the repserver.ora configuration file (located on the ORACLE_HOME\REPORT60\SERVER directory) in a text editor.

  2. Add the following configuration parameter.

    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.

  3. Run the rw_server.sql script (located in the ORACLE_HOME\REPORT60\SQL directory) from the command line. At the command line prompt, type:

    cd C:\ORACLE_HOME\REPORT60\SQL <RETURN>
    plus80 username/password@my_db <RETURN>
    @rw_server.sql <RETURN>
    quit <RETURN>
    
    
  4. Stop and restart the Reports Server to accept the changes made to the configuration file. When the Reports Server starts up, it connects to the database.

    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.

3.3 Starting or stopping the Reports Server from the command line

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:

3.3.1 Start another Reports Server

To start another Reports Server, you must:

3.3.1.1 To create a service entry for the Reports Server

  1. On your Reports Server machine, open the tnsnames.ora file (located in the ORACLE_HOME\NET80\ADMIN directory) in a text editor.

  2. Add the following Reports Server service entry:

    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.

  3. Repeat steps 1 and 2 on the Web server machine if it is installed on a different machine than the Reports Server.

3.3.1.2 To configure the Reports Server on Windows NT

3.3.1.2.1 (Optional) Set the source path

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.

  1. Create the source directory if it doesn't already exist.

  2. On your desktop, choose Start->Run.

  3. Type regedit to display the Registry Editor.

  4. Expand Hkey_local_machine->Software.

  5. Double-click REPORTS60_PATH.

  6. Add a new reports source path (e.g. C:\WEB_REPORTS).

    Note: Refer to your operating system's documentation to determine if the values you set are case-sensitive.

3.3.1.2.2 Start the Reports Server

  1. On the Reports Server machine desktop, choose Start->Run.

  2. Type the following command line argument:

     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.

  3. Click Yes to install the Reports Server as an NT Service and Click OK to start up the service.

  4. On your desktop, choose Start->Settings->Control Panel and double-click (Services).

  5. In the Services dialog box, choose Oracle Reports Server [repserver] and click Startup.

  6. From the startup dialog, select This Account in the Log On As section and type or select an operating system user name and password. This specifies that the server is run as that user.

    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.

  7. Set the service to start automatically (when the system is started).

  8. Click OK.

  9. Click Start. A Service Control message box indicates when your Reports Server has started. If your Reports Server cannot start, see Appendix F, "Troubleshooting" for more information.

    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.

3.3.1.3 To configure the Reports Server on UNIX

3.3.1.3.1 (Optional) Set environment variables

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.

  1. Create a directory for your source reports (e.g., /WEB_REPORTS).

  2. Set the REPORTS60_PATH environment variable to locate the reports:

    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.

  3. Set the TNS_ADMIN environment variable to point to the location of the tnsnames.ora file:

    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.

3.3.1.3.2 Start the Reports Server

  1. From the $ORACLE_HOME/BIN directory, run the following command line to run the Reports Server in the foreground:

    rwmts60 name=repserver
    
    

    or to run the Reports Server in the background:

    rwmts60 name-repserver &
    
    
  2. To determine if your server is running, go to step 2. If your Reports Server does not start or you get an error message, see Appendix F, "Troubleshooting" for more information.

    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.

  3. (Optional) From the $ORACLE_HOME/BIN directory, run the following command line to ensure that the Reports Server is running:

     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).

3.3.2 Start the Reports Server on Windows NT as a non-service

  1. Run the following command line:

    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.

3.3.3 Stop the Reports Server

On Windows NT:

  1. On the Reports Server machine desktop, choose Start->Run.

  2. Type the following command line argument:

    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:

  1. Press ctrl-C.

3.4 Reports Servlet configuration guidelines

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.

3.4.1 Configuring the Web server

This step is performed on the Web server machine.

  1. Add the following entry to the servlet properties file (e.g., servlet.properties)

    # Oracle Report servlet
    servlet.RWServlet.code=oracle.reports.rwcgi.RWServlet
    
    
  2. Set the CLASS_PATH environment variable to directory containing the Oracle Reports RWServlet.class file.

  3. When you complete the Reports Server configuration, ensure that the Reports Server is configured properly. In a Web browser, make the following request:

    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.


Prev Next
Oracle
Copyright © 1999 Oracle Corporation.

All Rights Reserved.

Contents

Index