E Reports Server and Bridge Diagnostic Utility

This appendix describes the arguments and usage of the Reports Server and bridge diagnostic utility, rwdiag.

Overview of rwdiag
Command Line Syntax

For troubleshooting scenarios and diagnosis, see Section D.8, "Diagnosing Oracle Reports Bridge Problems".

E.1 Overview of rwdiag

rwdiag is a utility used to find Reports Servers and bridges on the network, and monitor packets broadcast on the network by the Reports Server and its clients. It is also helpful for choosing optimal settings for ORACLE_HOME/reports/conf/rwnetwork.conf and for bridge timeout values. rwdiag is similar to the osfind utility provided by the Borland VisiBroker ORB, which has been replaced by the JDK ORB in Oracle Reports 10g Release 2 (10.1.2).

Note:

Oracle Reports 10g Release 2 (10.1.2) replaces the use of Borland's Visibroker with Sun Microsystems' industry-standard Java Developer's Kit Object Request Broker (JDK ORB). The JDK ORB provides support for Reports Server requests from clients across subnets, and enables the broadcast mechanism for dynamic Reports Server discovery both within a subnet and across subnets.

You can invoke rwdiag with one of two scripts depending upon your operating platform:

For Microsoft Windows:

ORACLE_HOME/bin/rwdiag.bat

For UNIX:

ORACLE_HOME/bin/rwdiag.sh

E.1.1 Examples

The sections that follow provide a series of examples illustrating the use of rwdiag.

E.1.1.1 Example 1

This command line tries to find a Reports Server or bridge named abc on the network with the default search timeout of 10 seconds.

rwdiag.bat  -find abc

This command returns a success message, name, type, host name, and the time taken, if abc os found on the network. If a naming service is used as the discovery mechanism for Oracle Reports, only the success message would be returned as the host name would be unavailable to the utility.

E.1.1.2 Example 2

This command tries to find a Reports Server or bridge named abc on the network with a search timeout of 5 seconds.

rwdiag.bat  -find abc  -timeout 5

E.1.1.3 Example 3

This command tries to find a Reports Server or bridge named abc on the network using the settings in the configuration file xyz.conf.

rwdiag.bat  -find abc  -conf  xyz.conf

Following are the contents of xyz.conf:

<?xml version = '1.0' encoding = 'ISO-8859-1'?>
<!DOCTYPE discoveryService SYSTEM "file:c:\orawin\reports\dtd\rwnetworkconf.dtd">
<discoveryService>
   <multicast channel="105.2.3.8" port="35078" timeout="1000" retry="3"/>
   <!--namingService name="Cos" host="localhost" port="9999"/-->
</discoveryService>

Notice how the channel address and port number are picked up from the configuration file. If for some reason abc were running on another port, it would not be found.

E.1.1.4 Example 4

This command tries to find all Reports Servers and bridges on the network.

rwdiag.bat  -findAll

With a broadcast mechanism, all information is provided. If a naming service is used as the discovery mechanism for Oracle Reports, host information is unavailable.

E.1.1.5 Example 5

This command monitors all packets broadcast on the network by the Reports Servers and their clients, and prints the packet information on the screen. The monitoring stops when you press q and Enter.

rwdiag.bat  -monitor

E.1.1.6 Example 6

This command monitors all packets broadcast on the network by the Reports Servers and their clients, and saves the packet information to the log file, c:\log.txt. The monitoring stops when you press q and Enter.

rwdiag.bat  -monitor  -log  c:\log.txt

E.2 Command Line Syntax

rwdiag includes keywords that enable you to do the following:

Locate a Reports Server or bridge running on the network.
List all running Reports Servers or bridges on the network.
Monitor packets on the network broadcast by Reports Servers or clients.

E.2.1 Syntax

rwdiag.bat | rwdiag.sh {-find server_or_bridge_name | -findAll | 
   -monitor [-log log_file_name]} [-conf config_file_name]  [-timeout seconds]

where

rwdiag.bat is the script for Microsoft Windows.

rwdiag.sh is the script for UNIX.

-find server_or_bridge_name finds the Reports Server or bridge named server_or_bridge_name.

-findAll finds and lists all Reports Servers and bridges on the network.

-monitor lists the packets broadcast on the network. To stop monitoring, press q and Enter. This option is not supported when the discovery mechanism specified in the network configuration file is a naming service.

-log log_file_name specifies a log file to which the monitor output is written. If not specified, the monitor output is displayed on the screen. The file name can be an absolute path. If just a file name is specified, the log file is created in the current folder.

-conf config_file_name specifies a custom configuration file. If not specified, rwnetwork.conf is the default file name. The settings such as discovery mechanism (broadcast or naming service) and port numbers are taken from this file. The utility assumes the configuration file is located in ORACLE_HOME\reports\conf. If a non-existent file is specified, the file is created with the default settings in rwnetwork.template.

-timeout seconds specifies the timeout value in seconds. If not specified, the default value is 10 seconds. Timeout is the length of time the client waits for a response from the server after broadcasting the request packet. This option is ignored when the discovery mechanism specified in the network configuration file is naming service.

E.2.2 Usage Notes

The host information is not available when using a naming service discovery mechanism.
Time taken to locate the server is not displayed for a naming service discovery mechanism because the lookup is based upon the Reports Server name in the naming service. The utility does not need to await response from the server. Hence, the time taken is not relevant for a naming service.
Bridges cannot be located using a naming service because they do not bind to the naming service. Only Reports Server implementations are bound to the naming service.
The timeout value in the configuration file is ignored. Only the value specified in the command line is taken into account. If not specified in the command line, the default value is 10 seconds.
If the Reports Server you try to locate is not found, the utility generates a REP-50504 message, which states that the server was not found.