6.1 Starting and Stopping Reports Server

The best way to run Reports Server is through the Oracle Process Manager and Notification Server (OPMN). OPMN provides a centralized mechanism for initializing, maintaining, and shutting down your Oracle HTTP Server, Oracle WebLogic Server processes, and OracleAS Reports Services. For more information on configuring Reports Server through OPMN, see Section 8.8, "Configuring Reports Server with the Oracle Process Manager and Notification Server and Oracle Enterprise Manager"

Important:

You must start or stop a Reports Server registered with Oracle Enterprise Manager only through Oracle Enterprise Manager 11g or OPMN. OPMN automatically restarts Reports Server if it stops responding for some reason. OPMN runs as a Windows service on Windows.

In Oracle Reports, running Reports Server as Windows service is no longer supported (rwserver -install server_name). As a result, the related command line keywords INSTALL and UNINSTALL are obsolete. If you start or stop a Reports Server that is managed by OPMN running as a Windows service or through the command line, you may face the following issues:

  • Oracle Enterprise Manager may not accurately reflect the status of Reports Server and metrics information.

  • Oracle Enterprise Manager 11g may display errors when starting or stopping Reports Server.

For more information about the obsolescence of running Reports Server as a Windows service, see A Guide to Functional Changes Between Oracle Reports 6i and 10g on the Oracle Technology Network (OTN).

6.1.1 Starting, Stopping, and Restarting Reports Servers from Oracle Enterprise Manager

When the standalone Reports Server is configured through OPMN, you can start, stop, and restart it through Oracle Enterprise Manager

Note:

The in-process server is available as part of wls_reports and thus registered with Oracle Enterprise Manager during installation of Oracle Application Server. If you add any Reports Servers after installing Oracle Application Server, you must register the new server(s) in the Oracle Enterprise Manager's targets.xml file and the Oracle Process Manager and Notification Server's opmn.xml file. For more information, see Section 8.8, "Configuring Reports Server with the Oracle Process Manager and Notification Server and Oracle Enterprise Manager"

To start, stop, or restart a Reports Server:

  1. From the Reports Server main page, navigate to Reports > Control menu, and select:

    • Start Up to start the server.

    • Shut Down.. to stop the server.

    • Restart... to restart the server.

6.1.2 Starting, Stopping, and Restarting Reports Servers from the Oracle Process Manager and Notification Server

Before you start the Oracle Reports Server with Oracle Process Manager and Notification (OPMN), you must add the Server to OPMN, as shown in the following example:

ORACLE_INSTANCE/bin/opmnctl createcomponent -adminUsername weblogic -adminHost <host_name> -adminPort <port> -oracleHome <oracle_home -oracleInstance <instance_home> -instanceName <instancename> -componentName <bridge_name> -componentType ReportsServerComponent

You can use the following command lines to start, stop, and restart Reports Server if it was configured through the Oracle Process Manager and Notification Server:

ORACLE_INSTANCE/bin/opmnctl startproc ias-component=reports_server_name
ORACLE_INSTANCE/bin/opmnctl startproc process-type=ReportsServerComponent
ORACLE_INSTANCE/bin/opmnctl stopproc ias-component=reports_server_name
ORACLE_INSTANCE/bin/opmnctl restartproc ias-component=reports_server_name

The Reports Server name must match the name in the ias-component id in the opmn.xml file.

You can also query the status of the Oracle Process Manager and Notification Server, by using the following command:

ORACLE_INSTANCE/bin/opmnctl status

For more information on configuring Reports Server through the Oracle Process Manager and Notification Server, see Section 8.8, "Configuring Reports Server with the Oracle Process Manager and Notification Server and Oracle Enterprise Manager"

6.1.3 Alternative Methods of Starting and Stopping Reports Server

If you choose not to run Reports Server through OPMN and maintain it through Oracle Enterprise Manager, you can use these older methods of running Reports Server:

  • Starting the In-process Server (Windows and UNIX)

  • Starting Reports Server from a Command Line (Windows and UNIX)

  • Stopping Reports Server

Important:

Beginning with Oracle Reports 10g Release 2 (10.1.2), running Reports Server as a Windows service is no longer supported, as mentioned at the beginning of this section.

6.1.3.1 Starting the In-process Server (Windows and UNIX)

If you are using Reports Server as an in-process server (the default configuration), sending a run report request starts the in-process server; however, if you are sending a request through a command line, the servlet must be invoked first using either the run report URL or the Web command URL. When you have successfully started the servlet, this also means you have successfully started the in-process server.

To directly start the in-process server from a URL, enter the following from your Web browser:

http://your_machine_name:your_port_num/reports/rwservlet/startserver

6.1.3.2 Starting Reports Server from a Command Line (Windows and Linux)

Before you start the Reports Server from command line, you must set the COMPONENT_CONFIG_DIRECTORY environment variable as follows:

COMPONENT_CONFIG_DIRECTORY=ORACLE_INSTANCE/config/ReportsServerComponent/<reports_server_name>

To start Reports Server as a standalone server on Windows, use the following command:

rwserver server=server_name

Add the BATCH command line keyword to start up the server without displaying dialog boxes or messages.

rwserver server=server_name batch=yes

You can run this command on UNIX using the following syntax:

rwserver.sh server=server_name

Or:

rwserver.sh server=server_name batch=yes

Important:

If DISPLAY is not set, you must start Reports Server in batch mode (batch=yes).

For more information about removing DISPLAY and printer dependencies in UNIX systems, see Section 10.8.

For more information about the REPORTS_DEFAULT_DISPLAY environment variable, see Appendix B.

You can run this command from any directory as long as the shell script can be reached in your PATH environment variable.

6.1.3.3 Stopping Reports Server

There are several ways to stop Reports Server on Windows and UNIX, as follows:

  • If Reports Server is running on Windows through the rwserver executable, or on UNIX through a shell script, rwserver.sh, click Shutdown in the Reports Server dialog box.

  • If you are not running Reports Server from the command line, launch Oracle Enterprise Manager, and navigate to the Reports Server home page and from the Reports menu select Control > Shut Down...

  • If Reports Server is running as an in-process server through the Reports Servlet, issue the following URL:

    http://your_host_name:port_number/reports/rwservlet/stopserver?authid=admin user/admin password
    
  • If Reports Server is running from a command line on Windows or UNIX, use any of the following commands, depending on how you want to shut down the Reports Server.

    Note:

    On UNIX, use rwserver.sh instead of rwserver.

    Before you shut down the server, you must set the COMPONENT_CONFIG_DIRECTORY environment variable as follows:

    COMPONENT_CONFIG_DIRECTORY=ORACLE_INSTANCE/config/ReportsServerComponent/<reports_server_name>

    To shut down the server normally (that is, finish pending jobs and then stop):

    rwserver server=server shutdown=normal authid=username/password
    

    To shut down the server immediately (that is, stop without finishing pendingjobs):

    rwserver server=server shutdown=immediate authid=username/password
    

    To shut down the server without displaying any related messages:

    rwserver server=server shutdown=normal authid=username/password batch=yes
    

    The keywords used with the rwserver command are described in Appendix A, "Command-Line Keywords"

    Note:

    authid is Reports Server's administration user name and password. In Oracle Reports 11g Release 1 (11.1.1), the default security is based on standards-based Java EE security model through Oracle Platform Security Services. For a non-secure Reports Server, this user is defined in the identifier element. The following bullet contains more information on how to stop a non-secure Reports Server using the command line.
  • When you stop or shut down a non-secure Reports Server from the command line using either rwserver.sh or rwrqv.sh, you must provide a valid authid, which must match the value set in the identifier element in the server configuration file. However, the identifier element is set during Reports configuration while installing Oracle Application Server and encrypted by Reports Server. You can reset the identifier element to any value. If you have registered this Reports Server with Oracle Enterprise Manager and OPMN, you must also change the corresponding properties in targets.xml for Oracle Enterprise Manager integration to work. Perform the following steps:

    1. In the non-secure Reports Server's configuration file, server_name.conf, modify the identifier element to specify the username/password and set the encrypted attribute to no. For example:

      <identifier encrypted="no">scott/tiger</identifier>
      
    2. Stop and restart Reports Server manually for the changes made to the server_name.conf file to take effect.

      Note:

      You must restart Reports Server for any configuration changes to take effect.

      Reports Server will now encrypt the username/password value of the identifier element. After Reports Server reads the changes made in the server_name.conf, the following commands should execute successfully (with scott/tiger as the username/password):

      ./rwserver.sh server=server_name shutdown=normal authid=scott/tiger
      ./rwrqv.sh server=server_name shutdown=normal authid=scott/tiger
      
    3. For Oracle Enterprise Manager integration, edit the targets.xml file (in $ORACLE_INSTANCE/EMAGENT/emagent_asinst_1/sysman/emd ) using any text editor, as follows:

      • Search for target with TYPE="oracle_repserv" and DISPLAY_NAME="Reports Server: server_name".

      • In the entry, set the UserName property and the Password property to the same user name and password as in the identifier element in the server_name.conf file. Set the ENCRYPTED attribute to FALSE for these two properties.

      • Restart Oracle Enterprise Manager for the changes to take effect.

      You should now be able to stop and shut down a non-secure Reports Server using Oracle Enterprise Manager.

      Note:

      These steps are required only for a non-secure Reports Server and not for secure Reports Servers.