Oracle Report Services:
Publishing Reports to the Web with Oracle9i Application Server
Version 1.0.2

A86784-01

PrevNext

Contents

Index

3
Configuring the Oracle Reports Server on Windows NT and UNIX

When you install the Oracle9i Application Server with the Oracle HTTP Server powered by Apache, the Oracle Reports Server servlet and the Oracle Reports Server CGI are automatically configured for you in the Windows NT and UNIX environments. This chapter describes how to manually change the configurations that were provided by default.

This chapter also describes how to start and stop the Oracle Reports Server and the configuration environment variables.

3.1 Starting and Stopping the Oracle Reports Server

Throughout this chapter you are asked to start, stop, and restart the Oracle Reports Server. Following are the instructions for doing this.

3.1.1 Starting the Oracle Reports Server

The following sections describe how to start the Oracle Reports Server on Windows NT or on UNIX.

3.1.1.1 Starting the Oracle Reports Server on Windows NT

Proceed with the following steps to start the Oracle Reports Server on Windows NT:

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

  2. In the Services dialog box, choose Oracle Reports Server [repserver] (where repserver is the name of the Oracle Reports Server instance) and click Startup, which gives you the Services dialog window.

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

    If you want to output to PostScript or to a printer, then ensure the user running the Oracle Reports Server service has access to a default printer. Typically, the System Account does not have access to printers.

  4. Set the Startup Type of the service to Automatic when the system is started.

  5. Click OK.

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

    When you start the Oracle Reports Server for the first time, an Oracle Reports Server configuration file (for example, repserver.ora) is created in the ORACLE_HOME\REPORT60\SERVER directory. The setting for your Oracle 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, then stop and restart the Oracle Reports Server for the changes to take effect.

3.1.1.2 Starting the Oracle Reports Server on UNIX

Do the following steps to start the Oracle Reports Server on UNIX:

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

    rwmts60 name=repserver
    
    

    Run the following command to run the Oracle Reports Server in the background:

    rwmts60 name=repserver &
    
    
  2. From the $ORACLE_HOME/BIN directory, run the following command line to ensure the Oracle Reports Server is running:

    rwrqv60 server=repserver
    
    

    Status columns (for example, NAME, OWNER, and DEST) for the Oracle Reports Server are displayed. Currently, though, no status information is available since no jobs are running.

If you want to output to PostScript or to a printer, then the printer must be configured in the uiprint.txt file (this file is located in the $ORACLE_HOME/guicommon6/tk60/ADMIN directory).

3.1.2 Starting the Oracle Reports Server on Windows NT as a Non-Service

Run the following command:

rwmts60 -listen repserver

Or in batch mode:

rwmts60 -listen repserver batch=yes

The repserver does not need to have the domain qualifier (for example, .world) appended to it.

3.2 Stopping the Oracle Reports Server

The following sections discuss how to stop the Oracle Reports Server on Windows NT and UNIX.

3.2.1 Stopping or Deinstalling the Oracle Reports Server on Windows NT

To stop the Oracle Reports Server on Windows NT, you do the following:

  1. On the Oracle 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
    
    

    The repserver does not need to have the domain qualifier (for example, .world) appended to it.

3.2.2 Stopping the Oracle Reports Server on UNIX

Do one of the following to stop the Oracle Reports Server:

3.3 Configuring the Oracle Reports Server Servlet

With the Oracle HTTP Server powered by Apache, there are two Oracle Reports Server servlet configurations that you can manually change:

3.3.1 Configuring the Oracle Reports Server Servlet with JSDK

The following configuration assumes that the Oracle HTTP Server powered by Apache is installed in the following directory:

/private1/ias

It also assumes that the Oracle Reports Server is installed in the following directory:

/private1/ias/6iserver

You do the following steps to configure the Oracle Reports Server servlet with JSDK:

  1. Add the following entry to the Oracle Reports Server servlet properties file, servlet.properties, (for example, the Oracle Reports Server servlet properties file located in /private1/ias/Apache/Jsdk/examples):

    servlet.RWServlet.code=oracle.reports.rwcgi.RWServlet
    
    
  2. Create the directory hierarchy oracle/reports/rwcgi in your Web server Java class directory:

    /private1/ias/Apache/Jsdk/examples/oracle/reports/rwcgi
    
    

    You then copy into this new directory the RWServlet.class file found in:

    /private1/ias/6iserver/reports60/java
    
    
  3. Add the root directory from the previous step into your CLASSPATH environment variable, located in /private1/ias/Apache/Ojsp. Also add Ojsp/lib/servlet.jar to the CLASSPATH environment variable. For example:

    setenv CLASSPATH/private1/ias/Apache/jdk/bin:
    /private1/ias/Apache/jdk/lib/classes.zip:
    /private1/ias/Apache/Jsdk/examples:/private1/ias/Apache/Ojsp/lib/servlet.jar
    
    
  4. Set the PATH variable by entering the following:

    setenv PATH /private1/ias/6iserver/bin:/private1/ias/Apache/Apache/bin:
    private1/ias/Apache/jdk/bin:
    private1/ias/Apache/jsdk/bin:$PATH
    
    
  5. Start the Oracle Reports Server.

  6. Start the Oracle Reports Server servlet runner by running the following command:

    servletrunner &
    
    
  7. Verify that the Oracle Reports Server servlet is running by doing the following:

    1. Running the following from your browser to ensure the installation and setup are okay:

      http://hostname:portno/servlet/RWServlet/help?
      
      

      where:

      hostname 

      is the machine name where the Apache listener is running. 

      portno 

      is the port number that where the Apache listener is started. 

      This shows you that the Help page is active.

    1. Run the following from your browser to ensure the Oracle Reports Server is up:

      http://hostname:portno/servlet/RWServlet/showjobs?
      server=repserver
      
      
    2. Enter the following from your browser to run a report:

      http://hostname:portno/servlet/RWServlet?server=repserver+
      report=ReportName+destype=cache+userid=ConnectString+desformat=htmlcss
      
      

      You can also use the cgicmd.dat file for key mapping.

If you modify the configuration file, then you need to stop and restart the Oracle Reports Server to acknowledge the changes.

3.3.2 Configuring the Oracle Reports Server Servlet with JServ

You do the following to configure the Oracle HTTP Server powered by Apache to run the Oracle Reports Server servlet with JServ. The changes are made in the ias_home/Apache/Jserv/etc/jserv.properties file, where ias_home is the location where you installed iAS:

  1. Add the following line:

    wrapper.classpath=ias_home/Apache/Jserv/servlets
    
    
  2. Change the wrapper.env=ORACLE_HOME=ias_home line to the following:

    wrapper.env=ORACLE_HOME=ias_home/6iserver
    
    
  3. Change the wrapper.env=LD_LIBRARY_PATH=ias_home/lib line to the following:

    wrapper.env=LD_LIBRARY_PATH=ias_home/lib:ias_home/6iserver/bin:ias_home/
    6iserver/lib
    
    
  4. Add the following line to the Apache/Jserv/etc/zone.properties file:

    servlet..RWServlet.code=oracle.reports.rwcgi.RWServlet
    
    
  5. Copy the RWServlet.class file to the following directory (you might need to create the directory):

    ias_home/Apache/Jserv/servlets/oracle/reports/rwcgi
    
    

    The http://host:port/servlet/RWServlet URL runs the servlet.

  6. Start the Oracle Reports Server.

  7. Start the Oracle HTTP Server powered by Apache listener using the following command:

    httpdsctl start
    
    
  8. Verify the Oracle Reports Server is running by:

    1. Run the following from your browser to ensure the installation and setup are okay:

      http://hostname:portno/servlets/RWServlet/help?
      
      

      This shows you that the Help page is active.

    1. Run the following from your browser to ensure the Oracle Reports Server is up:

      http://hostname:portno/servlets/RWServlet/showjobs?
      server=repserver
      
      
    2. Enter the following from your browser to run a report:

      http://hostname:portno/servlets/RWServlet?server=repserver+
      report=ReportName+destype=cache+userid=ConnectString+desformat=htmlcss
      
      

      You can also use the cgicmd.dat file for key mapping.

If you modify the configuration file, then you need to stop and restart the Oracle Reports Server to acknowledge the changes.

3.4 Configuring the Oracle HTTP Server powered by Apache Listener

You do the following to change the default configuration for the Oracle HTTP Server powered by Apache listener to run the Oracle Reports Server CGI:

  1. Add the following entry to the file httpds.conf (found in /private1/ias/Apache/Apache/conf):

    ScriptAlias /cgi-bin/      "/private1/ias/6iserver/bin"
    
    
  2. Start the Oracle Reports Server.

  3. Start the Oracle HTTP Server powered by Apache listener using the following command:

    httpdsctl start
    
    
  4. Verify the Oracle Reports Server CGI is running by:

    1. Run the following from your browser to ensure the installation and setup are okay:

      http://hostname:portno/cgi-bin/rwcgi60/help?
      
      

      This shows you that the Help page is active.

    1. Run the following from your browser to ensure the Oracle Reports Server is up:

      http://hostname:portno/cgi-bin/rwcgi60/showjobs?
      server=repserver
      
      
    2. Enter the following from your browser to run a report:

      http://hostname:portno/cgi-bin/rwcgi60?server=repserver+
      report=ReportName+destype=cache+userid=ConnectString+desformat=htmlcss
      
      

      You can also use the cgicmd.dat file for key mapping.

If you modify the configuration file, then you need to stop and restart the Oracle Reports Server to acknowledge the changes.

3.5 Configuring the Web Server

In order to make this configuration example meaningful, it is necessary to make several assumptions:

The CGI-BIN directory on your Web server contains CGI executables. The following are performed on the Web server machine:

  1. Start your Web server by entering the following:

  2. Start your browser.

  3. Create a listener.

  4. Configure your Web server mapping and note the physical and virtual directories. For example:

    Table 3-1  CGI-BIN Physical and Virtual Directories
    Directory Description  Physical Directory example  Virtual Directory Example  Permissions Required 

    CGI-BIN 

    c:\orant\oas\bin 

    /CGI-BIN 

    execute 

    Apache Web server CGI-BIN 

    c:\program files\Apache Group\Apache\cgi-bin 

    /CGI-BIN 

    execute 

    The physical directory depends on directory settings chosen during the installation of your Web server software.

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

3.5.1 Configuring the Oracle Reports Server CGI

The following steps are performed on the Web server machine.

3.5.1.1 Configuring the Oracle Reports Server CGI

To configure the Oracle Reports Server CGI copy rwcgi60.exe (located in the ORACLE_HOME\BIN directory) to your CGI-BIN directory.

In Table 3-1, " CGI-BIN Physical and Virtual Directories" the CGI physical directory is C:\your_webserver\bin, or if you are using the Apache Web Server, C:\Program Files\Apache Group\Apache\cgi-bin.

The CGI-BIN directory is defined in your Web server configuration. The Oracle Reports Server CGI must be in a path mapped as a CGI directory. The Oracle Reports Services RDF files must be in a path only accessible to the Oracle Reports Server. If you choose the default installation of Oracle Reports Server 6i and the Oracle WebDB Listener, then you will find the rwcgi60.exe file in the following path:

D:\orant\bin\rwcgi.exe

3.5.1.2 Creating a Service Entry for the Oracle Reports Server

If the Web server is on a different machine than your Oracle Reports Server, then you must add the Oracle Reports Server service entry. This service entry was created on the Oracle Reports Server machine in the tnsnames.ora file. The tnsnames.ora file is located on your Web server machine. This enables the CGI executable to communicate with the Oracle Reports Server.

If you do not remember the service entry settings for the Oracle Reports Server, then open the tnsnames.ora file located in the ORACLE_HOME\NET80\ADMIN directory on your Oracle 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 Oracle 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.5.1.3 Setting the Default Oracle Reports Server (Optional)

You can, optionally, set defaults for the Oracle Reports Server on both the Windows NT platform or the UNIX platform.

3.5.1.3.1 Windows NT

For Windows NT, perform the following steps.

  1. On your desktop, navigate to Start->Run.

  2. Type regedit to have the Registry Editor displayed.

  3. From the menu, expand Hkey_local_machine->Software.

  4. First choose the Edit->New->String value to add the following registry entry:

    REPORTS60_REPORTS_SERVER
    
    

    Then double click on the REPORTS60_REPORTS_SERVER to enter the repserver value, where repserver is the name of the Oracle Reports Server that you are configuring (the TNSnames service entry name of the Oracle Reports Server).

3.5.1.3.2 UNIX

For UNIX, set the REPORTS60_REPORTS_SERVER environment variable to the name of the Oracle Reports Server.

You might 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, where repserver is the name of the Oracle Reports Server that you are configuring (the TNSnames service entry name of the Oracle Reports Server):

setenv REPORTS60_REPORTS_SERVER repserver

3.6 Configuring the Oracle Reports Server with Environment Variables

This section discusses how you can configure and start the Oracle Reports Server with environment variables

3.6.1 Configuring the Oracle Reports Server in Windows NT with Environment Variables

There are two primary steps for configuring the Oracle Reports Server in Windows NT with environment variables:

  1. Setting the environment variables (optional)

  2. Starting the Oracle Reports Server

3.6.1.1 Setting the Environment Variables (Optional)

You can set two optional environment variables. The first lets the Oracle 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.

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

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

    setenv REPORTS60_PATH /WEB_REPORTS
    
    

    Alternatively, after the Oracle Reports Server is installed, you can set the source path in the Oracle Reports Server configuration file. See the SOURCEDIR parameter in Appendix B, "Oracle Reports Services 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
    

3.6.1.2 Starting the Oracle Reports Server

To start the Oracle Reports Server, you do the following:

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

  2. In the Services dialog box, choose Oracle Reports Server [repserver] (where repserver is the name of the Oracle Reports Server instance) and click Startup, which gives you the Services dialog window.

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

    If you want to output to PostScript or to a printer, then ensure the user running the Oracle Reports Server service has access to a default printer. Typically, the System Account does not have access to printers.

  4. Set the Startup Type of the service to Automatic when the system is started.

  5. Click OK.

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

    When you start the Oracle Reports Server for the first time, an Oracle Reports Server configuration file (for example, repserver.ora) is created in the ORACLE_HOME\REPORT60\SERVER directory. The setting for your Oracle 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, then stop and restart the Oracle Reports Server for the changes to take effect.

3.6.2 Configuring the Oracle Reports Server on UNIX with Environment Variables

There are two primary steps for configuring the Oracle Reports Server on UNIX with environment variables:

  1. Setting environment variables (optional)

  2. Starting the Oracle Reports Server

3.6.2.1 Setting the Environment Variables (Optional)

You can set two environment variables, REPORTS60_PATH and TNS_ADMIN. The REPORTS60_PATH is the search path for the Oracle Reports Server source files (for example, RDFs, TDFs, and PLLs), and TNS_ADMIN overrides the default location for tnsnames.ora and sqlnet.ora. To set these do the following:

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

  2. Set the REPORTS60_PATH environment variable to locate the reports. For example, using the C shell syntax:

    setenv REPORTS60_PATH /WEB_REPORTS
    
    

    Alternatively, after the Oracle Reports Server is installed, you can set the source path by using the SOURCEDIR parameter. See Appendix B, "Oracle Reports Services Configuration Parameters" for more information.

  3. Set the TNS_ADMIN environment variable to point to the location of the tnsnames.ora file. For example, using the C shell syntax:

    setenv TNS_ADMIN $ORACLE_HOME/NET80/ADMIN
    

3.6.2.2 Starting the Oracle Reports Server on UNIX

Do the following steps to start the Oracle Reports Server on UNIX:

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

    rwmts60 name=repserver
    
    

    Run the following command to run the Oracle Reports Server in the background:

    rwmts60 name=repserver &
    
    
  2. From the $ORACLE_HOME/BIN directory, run the following command line to ensure the Oracle Reports Server is running:

    rwrqv60 server=repserver
    
    

    Status columns (for example, NAME, OWNER, and DEST) for the Oracle Reports Server are displayed. Currently, though, no status information is available since no jobs are running.

If you want to output to PostScript or to a printer, then the printer must be configured in the uiprint.txt file (this file is located in the $ORACLE_HOME/guicommon6/tk60/ADMIN directory).

3.7 Environment Variables

Environment variables are the configuration parameters that are used to control or customize the behavior of the Oracle Reports Server. Variables can be set using a command line for Windows NT and a shell script for UNIX.

Variable  Description 

REPORTS60_COOKIE_EXPIRE 

Determines the expire time of the cookie in minutes. The default value is 30.

Cookies save encrypted user names and passwords on the client-side when users log on to a secured Oracle Reports Server to run report requests. When users successfully log on, their browser is sent an encrypted cookie. When a cookie expires, subsequent requests (that is, ones that are sent to a secured Oracle Reports Server), user must re-authenticate to run the report. 

REPORTS60_DB_AUTH 

Specifies the database authentication template used to log on to the database. The default value is dbauth.htm

REPORTS60_ENCRYPTION_KEY 

Specifies the encryption key used to encrypt the user name and password for the cookie. The encryption key can be any character string. The default value is reports6.0. 

REPORTS60_REPORTS_SERVER 

Specifies the default Oracle Reports Server for Web requests. When this parameter is set, you can omit the SERVER command line argument in report requests to process them using the default server, or you can include the SERVER command line argument to override the default. 

REPORTS60_SSLPORT 

If you are using SSL and you want to use a port number other than 443, then you can use this variable to set a different port number. The default value is 443. 

REPORTS60_SYS_AUTH 

Specifies the authentication template used to authenticate the user name and password when users run report request to a secured Oracle Reports Server. The default value is sysauth.htm

3.8 Running a Report Request from a Web Browser

You do the following to run a report request from a Web browser:

  1. Ensure the Oracle 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@my_db+desformat=html+destype=cache
    
    

    where:

    username/password 

    is replaced with a valid database logon. 

    my_db 

    is replaced with tnsnames.ora entry you created for earlier for the Oracle Reports Server (Section 3.5.1.2, "Creating a Service Entry for the Oracle Reports Server"). 

    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.

    If the report does not run or if you receive an error message, then refer to Appendix F, "Troubleshooting" for more information.

  2. View the status of the request (optional):

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

    • For UNIX run the following command:

      rwrqv60 server=repserver showjobs=current
      

3.8.1 Other Steps

You can also perform the following, additional, steps:

  1. Tune the Oracle Reports Server (optional) to optimize performance or implement additional features, such as access control. Doing this step eliminates the need to show all of the parameters as shown in Section 3.8, "Running a Report Request from a Web Browser"; thus protecting your user name and password information.

  2. Make reports available to users. See Chapter 4, "Running Report Requests" for more information on how to specify run requests and make them available to users.

3.9 Modifying the Oracle Reports Server Configuration (Optional)

When you start the Oracle Reports Server for the first time, the Oracle Reports Server is set with default configuration settings (for example, maximum and minimum engines). At some point, you might want to modify the Oracle Reports Server configuration to tune performance, set up monitoring controls, or implement additional features.

3.9.1 Updating the Database with Job Queue Activity

You can set up your database to take snapshots of the Oracle Reports Server queue activity whenever jobs are run. When you start the Oracle Reports Server, a connection to the database is made. By default, the Oracle 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 (for example, to prevent the queue from being deleted when restarting the Oracle Reports Server). The prototype of the procedure (the procedure name and the parameters it expects) should not be edited.

If you change the contents of the script, then you have to run it as that user, and then restart the Oracle Reports Server for the changes to take effect.

3.9.1.1 On the Oracle Reports Server Machine

To update the database with job queue activity on the Oracle Reports Server machine, you do the following:

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

  2. The repserver_schema must have, at a minimum, create table and create package privileges to run the rw_server.sql script 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>
    
    
  3. Add the following configuration parameter, where the connection string to the schema in your database that takes snapshots of queue activity of the specified Oracle Reports Server is repserver_schema/password@my_db. In this case, repserver_schema is the schema for repserver queue activity.

    REPOSITORYCONN="repserver_schema/password@my_db"
    
    

    If you want to take snapshots of queue activity from many Oracle Reports Servers, then it is recommended that you create a different schema in your database for each Oracle Reports Server that requires snapshots. This prevents you from losing queue activity data when you restart the Oracle Reports Server.

  4. Stop and restart the Oracle Reports Server to accept the changes made to the configuration file. When the Oracle Reports Server starts up, it connects to the database.


    Note:

    When you restart your Oracle Reports Server, queue activity in the database is deleted by default. You can override the default by editing the API. 



Prev Next
Oracle
Copyright © 2000 Oracle Corporation.

All Rights Reserved.

Contents

Index