5
Oracle Enterprise Manager

You can monitor and manage your Reports Servers through Oracle Enterprise Manager. This chapter describes how to configure Oracle Enterprise Manager for your Reports Server as well as the Reports Server pages available in Oracle Enterprise Manager.

You will find more information on the Reports Server in Oracle9iAS Reports Services Publishing Reports to the Web, included on the Oracle9iAS documentation CD.

5.1 Oracle Enterprise Manager Configuration

After installation, the Reports Server instance is not accessible from Oracle Enterprise Manager. The reason for this problem is that the password set for the reports target is not the Oracle9iAS admin password.

To fix this problem, do the following:

1. Open the file $ORACLE_HOME/sysman/emd/targets.xml.

2. Search for the reports target. The target type for reports is oracle_repserv. The target definition will contain a property for UserName, for example:

   <Property NAME="UserName" VALUE="repadmin"/>
   
   
   

3. Change the VALUE to be the Oracle9iAS admin name, for example:

   <Property NAME="UserName" VALUE="orcladmin"/> 
   
   
   

4. Search for the Password property of the Reports Server, for example:

   <Property NAME="Password" VALUE="3f769c1e7cfd7411"  ENCRYPTED="TRUE"/>
   
   
   

5. Change the VALUE to be the Oracle9iAS admin password and set ENCRYPTED = "FALSE" for example:

   <Property NAME="Password" VALUE="adminpasswd"  ENCRYPTED="FALSE"/>
   
   
   

6. Search for the server name property of the Reports Server. For example, if the Reports Server is installed on the machine prod1-sun in domain us.oracle.com, it would have the following server property:

   <Property NAME="Server" VALUE="rep_prod1-sun.us.oracle.com"/>
   
   
   

7. Delete the domain portion of the server name. For example, in the case above, you would remove us.oracle.com:

   <Property NAME="Server" VALUE="rep_prod1-sun"/>
   
   
   

8. Restart Oracle Enterprise Manager:

      #   $ORACLE_HOME/bin/emctl stop
      #   $ORACLE_HOME/bin/emctl start
   
   
   

Oracle Enterprise Manager will automatically encrypt the password and set the ENCRYPTED flag to TRUE.

5.2 Reports Server Main Page

This page summarizes the status of the selected Reports Server.

Table 5-1 Reports Server Main Page

Setting	Description
General Section
Current Status	Indicates whether the server is up or down.
Start Time	Indicates the date and time the selected Reports Server was last started.
Stop Server/Start Server/Restart Server	These buttons enable you to stop, start, or restart the selected Reports Server from inside Oracle Enterprise Manager. Click Stop Server to stop the selected Reports Server; click Start Server to start the selected Reports Server. Click Restart to stop then start the selected Reports Server. The Start and Stop buttons display when the server is down; the Restart and Stop buttons display when the server is up.
Configuration Section
Cluster Name	If the selected Reports Server is a member of a server cluster, the cluster name is listed here.
Trace Option	If you have entered an Oracle Trace option in your Reports Server configuration file, <server_name>.conf, this field lists the option(s) you have entered.
Trace Mode	Indicates the trace mode specified in the Reports Server configuration file for the trace log file, either replace (the default) or append. Trace replace replaces the existing text in the trace log file with new information. Trace append appends new information to the end of the existing trace log file.
Maximum Queue Size	Lists the value you have entered for the maximum queue size under the queue element in your Reports Server configuration file (<server_name>.conf). The queue element specifies the maximum number of jobs that can be held in the Reports queue, including the scheduled, current, and finished job queues. If the maximum is reached, the oldest job(s) are automatically purged to make room for the newest (first in/first out, or FIFO).
Status Section
Active Engines	Indicates the number of engines currently running on the selected Reports Server.
CPU Usage (%)	Lists the percentage of the host machine's CPU currently employed by the selected Reports Server.
Memory Usage (MB)	Lists the number of megabytes (MB) of the host machine's RAM currently employed by the selected Reports Server.
Average Response Time (ms)	Lists the average number of milliseconds it takes for the selected Reports Server to process a request from the client.
Response and Load Section
Current Jobs	Provides the total number of currently running jobs in the Job Queue. When this number is higher than 0, it links to the Current Jobs Queue, where you can view details and cancel currently running jobs.
Failed Jobs	Provides the total number of jobs currently in the selected Reports Server's Job Queue that were stopped before completion. This includes cancelled jobs as well as those terminated with error. When this number is higher than 0, it links to the Failed Jobs Queue, where you can get detail on why a job failed, view the job's trace file, and resubmit the job.
Finished Jobs	Provides the total number of jobs that have finished running successfully. When this number is higher than 0, it links to the Finished Jobs Queue, where you can get more detail on the finished job, view the job's trace file, view the job result from cache, and resubmit the job.
Scheduled Jobs	Provides the total number of jobs currently in the Scheduled Jobs Queue. When this number is greater than 0, it links to the Scheduled Jobs Queue, where you can view details and canceled the scheduled job.
Other Servers Running in the Cluster Section
Previous/Next Buttons	Click the Previous or Next button to page through the list of other cluster members, or select a range of clusters from the drop-down list.
Server Name	Lists the names of each of the other Reports Servers that are members of the same cluster that the selected Reports Server belongs to. Click the server's name to hyperlink to the OEM home page for that server.
Finished Jobs	Provides the total number of finished jobs currently in the listed Reports Server's Job Queue.
Current Jobs	Provides the total number of currently running jobs in the listed Reports Server's Job Queue.
Scheduled Jobs	Provides the total number of scheduled jobs currently in the listed Reports Server's Job Queue.
Failed Jobs	Provides the total number of jobs for the listed Reports Server that were stopped before completion. This includes cancelled jobs as well as those terminated with error.
Average Response Time	Lists the average number of milliseconds it takes for the listed Reports Server to process a request from the client.
Performance Section
Response Metrics	Provides details about average response time; scheduled, finished, current, and failed jobs in the Job Queue; and number of jobs transferred from one server to another in a clustered environment.
Engine Information	Lists the types and numbers of currently running engines on the selected Reports Server.
System Usage Metrics	Provides percentages of CPU and memory usage on the selected Reports Server.
Administration Section
Configuration	Leads to the selected Reports Server's current configuration file. Here you can alter the file, check file syntax, and save your changes. Changes take effect after the next server restart.
Server Trace	Leads to the results of any trace you ran on jobs running on the selected Reports Server. Specify whether you will use the Trace option in the Reports Server's configuration file, available in OEM through the Configuration link.
Server Log	Leads to a log of general sever events, such as when the selected server was started and stopped.

5.3 Reports Server Performance Page

This page provides performance details about the selected Reports Server.

Table 5-2 Reports Server Performance Page

Setting	Description
System Usage Metrics Section
CPU Usage (%)	Lists the percentage of the host machine's CPU currently employed by the selected Reports Server.
Memory Usage (MB)	Lists the number of megabytes (MB) of the host machine's RAM currently employed by the selected Reports Server.
Response Metrics Section
Average Response Time (ms)	Lists the average number of milliseconds it takes for the selected Reports Server to process a request from the client.
Number of Jobs Transferred	In a clustered server environment, provides the total number of jobs transferred between the selected Reports Server and other cluster members. For example, if the selected Reports Server receives a request for a job that was run earlier on another cluster member, the request is transferred to the cluster member that provided the earlier result and the result is delivered to the client from the cluster member's cache. Such a transaction would be counted as one transfer within the cluster.
Number of Failed Jobs	Provides the total number of jobs currently in the Job Queue that were stopped before completion. This includes cancelled jobs as well as those terminated with error.
Current Jobs	Provides the total number of currently running jobs in the selected Reports Server's Job Queue. When there are jobs currently running, the number in the Value column links to the Current Jobs queue.
Finished Jobs	Provides the total number of finished jobs currently in the selected Reports Server's Job Queue. When there are finished jobs in the queue, the number in the Value column links to the Finished Jobs queue.
Scheduled Jobs	Provides the total number of scheduled jobs currently in the selected Reports Server's Job Queue. When there are scheduled jobs in the queue, the number in the Value column links to the Scheduled Jobs queue.
Engine Information Sections
Engine ID	Lists the type of engines available for processing jobs on the selected Reports Server.
Number of Running Engines	Provides the total number of this type of engine that is currently running on the selected Reports Server.

5.4 Reports Server Queue Page

This page provides a detailed look at all jobs currently running on the selected Reports Server and supplies the means of cancelling a currently running job. Click the Previous or Next button to page through the Current Job Queue, or select a range of records to view from the drop-down list.

To cancel a currently running job:

1. Click the Select radio button next to the job you want to cancel.

2. Click the Cancel Job button.

If you wish, you can resubmit a cancelled job from the Failed Job Queue.

Note: The Cancel Job button does not appear on this page when no jobs are currently running.

Table 5-3 Reports Server Queue Page

Setting	Description
Select	Use this radio button to select a particular job. On this page, this function is most useful when you wish to cancel a job. Click the Select radio button next to a job you wish to cancel, then click the Cancel button near the top of the page.
Id	Displays a unique job identifier assigned to this job by the Reports Server. This number is strictly under the server's control and cannot be reset by a user.
Job Name	If you specified a job name in the command line you used to run this job, that name is listed here. Otherwise, it is the name of the job provided for the "report=" or "module=" parameter of the job request.
Owner	Displays the user ID under which this job is running.
Output Type	Displays the destination type (destype) specified for this job at runtime.
Output Format	Displays the output format (desformat) specified for this job at runtime.
Queued At	Displays the date and time this job request was placed in the Job Queue.
Started At	Displays the date and time this job started running.
Interval	The frequency at which the job will be run, for example, daily, monthly, and so on. This setting only appears on the Reports Server Scheduled Job Queue page.

5.5 Reports Server Scheduled Job Queue Page

This page functions very much like Reports Server Queue page. Refer to the Section 5.4, "Reports Server Queue Page" for more information.

5.6 Reports Server Finished Job Queue Page

This page provides a detailed look at all successfully completed jobs in the Job Queue on the selected Reports Server.

Additionally, it provides a means of viewing a completed job's trace file, displaying job output from cache, or resubmitting a job request.

Click the Previous or Next button to page through the Finished Job Queue, or select a range of records to view from the drop-down list.

To view a job's trace file, the Trace option must have been specified in the Reports Server configuration file or the runtime command line.

To view a job's trace file:

1. In the Select column, click the radio button next to the finished job whose trace file you want to view.

2. Click the View Trace button near the top of the page.

To view a result from cache:

1. In the Select column, click the radio button next to the finished job you want to view.

2. Click the View Result button near the top of the page.

The result opens in a second browser window.

To resubmit a job:

1. In the Select column, click the radio button next to the job you want to resubmit.

2. Click the Rerun Report button near the top of the page.

   Table 5-4 Reports Server Finished Job Queue Page

   Setting	Description
   Select	Use this radio button to select a particular job. On this page, this function is most useful for selecting a report and: Viewing a Web version of its output (click the Select radio button next to a job you want to view, then click the View Result button near the top of the page) Viewing the selected job's trace results (click the Select radio button next to a job with trace results you want to view, and click the View Trace button near the top of the page) Rerunning the job (click the Select radio button next to a job you want to rerun, and click the Rerun Report button near the top of the page)
   Id	Displays a unique job identifier assigned to this report by the Reports Server. This number is strictly under the server's control and cannot be reset by a user. When the job includes the generation of a trace file, the value under Id is linked to the trace file for this job. Click Id to view this job's associated trace file.
   Job Name	If you specified a job name in the command line you used to run this report, that name is listed here. Otherwise, it is the name of the job provided for the "report=" or "module=" parameter of the job request. Job Name is linked to the output of this job. Click Job Name to see a Web version of this job's output (fetched from the Reports Server cache).
   Owner	Displays the user ID under which this job was run.
   Output Type	Displays the destination type (destype) specified for this job at runtime.
   Output Format	Displays the destination format (desformat) specified for this job at runtime.
   Queued At	Displays the date and time this job request was placed in the Job Queue.
   Started At	Displays the date and time this job started running.
   Finished At	Displays the date and time this job completed.
   Status	Displays the finished status of the job. In the Finished Job Queue, Status is always Finished Successfully.

5.7 Reports Server Configuration Page

This page provides a window into the selected Reports Server's configuration file (<server_name>.conf). You can edit the configuration file here as well as check its syntax and save your changes. You must restart the server for your changes to take effect.

To edit the selected Reports Server configuration file, make your changes in the display window.

To check your syntax, click the Check Syntax button below the display window. Note that clicking this button does not validate the values you enter for configuration elements. For example, if an element requires that you specify a directory path, syntax checking does not validate the accuracy of your path. It just validates the XML syntax.

To save your changes, click the Save Changes button below the display window.

Note: You can use your browser's "Find in Page" functionality to search the content of the server configuration file. This is particularly useful if you must locate a syntax error in the file.

5.8 Reports Server Failed Job Queue Page

This page provides a detailed look at all failed jobs in the Job Queue on the selected Reports Server. Additionally, it provides a means of viewing a failed job's trace file or resubmitting a job request.

Note: Failed jobs are jobs that were cancelled by the user or that automatically terminated with error.

Click the Previous or Next button to page through the Failed Job Queue, or select a range of records to view from the drop-down list. To view a job's trace file, the Trace option must have been specified in the Reports Server configuration file or the runtime command line.

To view a job's trace file:

1. In the Select column, click the radio button next to the failed job whose trace file you want to view.

2. Click the View Trace button near the top of the page.

To resubmit a job:

1. In the Select column, click the radio button next to the job you want to resubmit.

2. Click the Rerun Report button near the top of the page.

   Table 5-5 Reports Server Failed Job Queue

   Setting	Description
   Select	Use this radio button to select a particular job. On this page, this function is most useful for selecting a job and: Viewing the selected job's trace results (click the Select radio button next to a job with trace results you want to view, and click the View Trace button near the top of the page) Rerunning the job (click the Select radio button next to a job you want to rerun, and click the Rerun Report button near the top of the page)
   Id	Displays a unique job identifier assigned to this job by the Reports Server. This number is strictly under the server's control and cannot be reset by a user. When the job includes the generation of a trace file, the value under Id is linked to the trace file for this job. Click Id to view this report's associated trace file.
   Job Name	If you specified a job name in the command line you used to run this report, that name is listed here. Otherwise, it is the name of the job provided for the "report=" or "module=" parameter of the report request.
   Owner	Displays the user ID under which this job was run.
   Output Type	Displays the destination type (destype) specified for this job at runtime.
   Output Format	Displays the destination format (desformat) specified for this report at runtime.
   Queued At	Displays the date and time this job request was placed in the Job Queue.
   Started At	Displays the date and time this job started running.
   Finished At	Displays the date and time this job was cancelled or terminated with error.
   Status	Displays the status of the job. Status will either indicate that the job was cancelled by the user or provide some information on why the job was terminated with error.

5.9 Job Trace Page

This page provides a view of the trace results of a particular job, rather than all the jobs run on a particular server. This information can be useful in the event you must call for technical support.

Table 5-6 Job Trace Page

Setting	Description
Job Id n	Identifies the job by the number the Reports Server assigned to it at runtime.
Previous/Next/Drop- down list	Use these buttons and the list of values to navigate through the list of trace events.
Originating Time	The date and time the event occurred.
Module Name	The section in the underlying code where the event occurred.
Error Number	The error code assigned to this event. To look up the meaning associated with this number, see the Reports Builder online help.
Type	The type of event that occurred.
Message	If the developer who wrote the code included a message with this event type, it will appear here.

5.10 Reports Server Trace Page

This page provides a view of the trace results for the selected Reports Server. Depending on whether jobs results are appended to the existing trace file or replace its content, this file shows the trace results for all jobs run on this server (append) or the last job run on the server (replace).

If this page is empty, it means you did not specify any trace options in the server configuration file (<server_name>.conf) or in the runtime command line.

Trace information is useful in the event you must call for technical support.

5.11 Reports Server Log Page

This page provides a view of the Reports Server log file. If the server configuration file contains a <log option="x"/> element, then a log file is created and maintained for the selected Reports Server.

If this page is empty, it means you did not specify any log options in the server configuration file (<server_name>.conf).

Logging is maintained for backward compatibility. Current practice is to capture processing information in a trace file.