14
Auditing Deployment and Execution

When you use Warehouse Builder to deploy and execute scripts, data about each deployment and execution is stored in a Runtime Repository. This data can be accessed by viewing reports in the Runtime Audit Browser from the client or from Oracle Portal.

This chapter includes the following topics:

• Why Audit Deployments and Executions?

• About the Runtime Audit Browser

• Viewing Runtime Repository Reports

• Runtime Audit Browser Administration

• Available Runtime Audit Reports

Why Audit Deployments and Executions?

Auditing deployment and execution information can provide valuable insight into how your target is being loaded and what you can do to further optimize mapping and process flow settings and parameters. Also it can give you immediate feedback on deployment information to make you aware of the deployment history of an object.

These reports provide access to both high-level and detailed ETL runtime information. This information includes the following:

• Timings per mapping and process flows

• Details of activities for each process flow

• Error details

• Deployment information to manage separate target environments

These reports, available through the Runtime Audit Browser, are built using the Warehouse Builder Public Views and can access all data stored within the Runtime Repository. You can use the pre-built reporting capabilities of the Runtime Audit Browser to view this data, or you can use the Public Views to create your own custom reports. For more information about Public Views, see Appendix D, "Warehouse Builder Public Views".

About the Runtime Audit Browser

Warehouse Builder Runtime Audit Browser is a browser-based reporting tool that you can use to view detailed information about past deployments and executions. Reports are generated from data stored in the Runtime Repositories.

Warehouse Builder provides two versions of this reporting tool:

• Client Browser Version

• Oracle Portal Version

The reports and functionality provided in both of these tools are the same. The only difference is The Client Browser Version is installed with the Warehouse Builder client and can be invoked from the same menu as the client. The Oracle Portal Version does not require a client installation, however, does require installation of the Runtime Audit Browser on an application server running Oracle Portal.

For information about setting up the Runtime Audit Browser and choosing a version, see Oracle9i Warehouse Builder Installation and Configuration Guide.

Starting the Client Browser Version

To start the client browser version:

1. From the Start menu, select Programs, then Oracle9i Developer Suite, then Warehouse Builder, and then Start OWB OC4J Instance.

   The OC4J instance is initialized.

2. From the Start menu, select Programs, then Oracle9i Developer Suite, then Warehouse Builder, and then OWB Runtime Audit Browser.

   The Warehouse Builder Browser opens and displays the connection information page for a Runtime Repository as shown in Figure 14-1. If you receive an error message, the Warehouse Builder Browser window may have been configured incorrectly. Refer to the Oracle9i Warehouse Builder Installation and Configuration Guide for instructions on configuring for the Warehouse Builder Runtime Audit Browser.

Figure 14-1 Client Browser Runtime Connection

Text description of the illustration cbv_star.gif

3. Select a role from the drop-down menu.

   For more information, see "Selecting a Role".

4. Specify the Runtime Repository connection information and click either View Deployment Report or View Execution Report.

   The connection information is verified and the Runtime Repository report displays. For information about using the Runtime Audit Browser after connecting to the repository, see "Viewing Runtime Repository Reports".

Starting the Oracle Portal Version

To start the Oracle9iAS Portal version:

1. Open a browser and connect to Oracle9iAS Portal and login as a user with access to Runtime Audit Browser portlets.

2. Navigate to the page that contains the Runtime Audit Browser Portlet as shown in Figure 14-2.

Figure 14-2 Runtime Audit Browser Portlet

Text description of the illustration opv_rab_.gif

3. Select the Access Warehouse Builder Runtime Audit Browser link.

   The Runtime Repository Report page, as shown in Figure 14-3, displays a list of repositories that you can access.

Figure 14-3 Runtime Repository Report Page

Text description of the illustration opv_rep_.gif

4. Select a role from the drop-down menu.

   For more information, see "Selecting a Role".

5. Locate the Runtime Repository you want to access and click one of the icons under either the View Deployment Report or View Execution Report columns.

   The report you select displays in the next screen.For information about using the Runtime Audit Browser after connecting to the repository, see "Viewing Runtime Repository Reports".

Selecting a Role

When you logon to the Runtime Audit Browser you must select a role. The information and functions available from within the Runtime Audit Browser differ depending on the role you select.

You can choose from one of the following three roles:

• QA User

• Warehouse User

• Warehouse Engineer

All roles have access to viewing all of the Runtime Audit Browser reports, however, the data and available functions within certain reports differ. Table 14-1 describes the roles and their main differences.

Table 14-1 Role Descriptions  

Role	Description
QA User Role	If the you select this role, the Purge button is enabled, and you can view source values in error diagnostic data from the Run Error Diagnostic report.
Warehouse User or Warehouse Engineer Roles	If you select one of these roles, the Purge button is disabled, and source values are shown as (not available) from the Run Error Diagnostic report.

Viewing Runtime Repository Reports

Use the Runtime Audit Browser to view the deployment and execution auditing information stored in the Runtime Repository. After you have connected to a Runtime Repository from either the client or Oracle Portal version, select a deployment or execution report from the available repositories.

Viewing Deployment Reports

The deployment reports contain audit data about specific deployments. When you first access a Runtime Repository from the portlet, you are shown a broad report of the entire Runtime Repository. You can then drill down and focus on reports that contain the specific information you want to view.

Use the following tabbed sections to view details:

• Deployment Schedule

• Object Summary

• Location

Deployment Schedule

The Deployment Schedule tabbed section allows you to search for deployment data based on the time of the deployment. Use the Filter Options section to filter for deployments that occurred during a specific data range. You can then drill into a specific deployment and view object information. You can also use the icon under the Focus column to view only the deployment details for a row.

Object Summary

The Object Summary tabbed section allows you to view deployment data based on the type of object. When you first select this tab for the entire Runtime Repository a comprehensive list of all objects display. Use the Filter Options section to filter by object type and deployment status.

The following information displays:

• Name

• Type

• Location

• Latest Deployment

• Object Status

You can then drill down on a specific object or location to view more details.

Location

The Location tabbed section allows you to view deployment data based on the location. When you first select this tab for the entire Runtime Repository a comprehensive list of all registered locations display.

The following information displays:

• Name

• Type

• Type Version

• Latest Deployment

You can then drill down on a specific location to view more details.

Viewing Execution Reports

The execution reports contain audit data about specific executions. When you first access a Runtime Repository from the portlet, you are shown a broad report of the entire Runtime Repository. You can then drill down and focus on reports that contain the specific information you want to view.

Use the following tabbed sections to view details:

• Execution Schedule

• Execution Summary

• Execution

• Trace

Execution Schedule

The Execution Schedule tabbed section allows you to search for execution data based on the time of the execution. Use the Filter Options section to filter for executions that occurred during a specific data range. You can also filter for a specific mapping or process flow.

You can then drill down on a specific execution and view information. You can also use the icon under the Focus column to view only the e details for a row.

Execution Summary

The Execution Summary tabbed section allows you to view execution data based on a mapping or process flow. When you first select this tab for the entire Runtime Repository a comprehensive list of all objects display. Use the Filter Options section to filter by object and execution status.

The following information displays:

• Name

• Type

• Latest Execution

• Execution Status

• Execution Report Icon

Execution

When you click the Execution Report icon, the Execution tabbed section of the Execution Report displays. An Execution Report is provided for each execution of a mapping or process flow.

Use the Execution tabbed section of this report to view the following information:

• Execution Details

• Execution Parameters

• Step Details

• Error Messages

• Audit Details

Trace

The Trace tabbed section of the Execution Report contains detailed trace information about a specific execution of a mapping or process flow.

The following information is provided:

• Rowkey

• Severity

• Source/Target

• Table Name

• Action

• View Diagnostic Report

Purging Audit Data

From time to time you may want to purge data from the Runtime Repository. You can do this by using the Purge button on each of the report pages. This function is useful because it limits the amount of data held in audit tables and makes it easier to find relevant data and maintain performance. To use the Purge buttons you must be logged on as a QA User. The Purge button is disabled if you are logged on as a Warehouse User or Warehouse Engineer.

Note: If you are running mappings with the Audit Level configuration parameter set to Complete, this will generate a large amount of diagnostic trace data. This will cause the tablespace to become full. In this case, use the Purge Error and Trace button.

Runtime Audit Browser Administration

Runtime Audit Browser administration functions are only available using the Oracle Portal version. Access the following functions from the Administer Warehouse Builder Runtime Audit Browser and Maintain Administrator List links from the Runtime Audit Browser Portlet:

• Managing Available Repositories: Enables you to view connection information for available repositories as well as register new repositories.

• Administering Roles: Enables you to define which user roles and access privileges.

• Maintaining the Administrator List: Enables you to define which users are granted administrator level privileges.

Managing Available Repositories

Use the Repository List page, shown in Figure 14-4, to view the list of all registered Runtime Repositories. All repositories must be registered before you can access the audit reports.

Figure 14-4 Repository List Page

Text description of the illustration opv_repa.gif

To unregister a repository:

• Locate the name of the repository that you want to un-register and click the icon under the Un-register column.

  The repository is immediately un-registered and the page refreshes to display the updated list.

To manage access to a repository:

• Locate the repository and click the icon under the Access Management column.

  The Access Management displays on the next page. Using this you can add or revoke access to a repository by user or group. Additional help and instructions are provided on that page.

To edit repository information:

• Locate the repository and click the icon under the Edit column.

  The Edit Repository page displays next. Additional help and instructions are provided on that page.

To register a repository:

• Click Register a Repository.

  The Register a Repository page displays on the next page. Be prepared to provide connection details for the repository. Additional help and instructions are provided on that page.

  Note: Before you can register a repository, you must have already defined the database link.

To add or view database links:

• Click the Database Links link on the left column.

  The Database Link page displays next. Additional help and instructions are provided on that page.

Registering a Repository

Use the Register a Repository page to register Runtime Repositories. You can only view audit data from registered Runtime Repositories.

To register a repository:

1. Type the name of the Runtime Repository.

2. Specify the database link, or click the flashlight or torch icon to select from a list of previously created database links.

3. Type an optional description.

4. Click Apply to register the repository.

   The Repository List page displays next with an updated list of registered repositories.

Editing Repository Definitions

Use the Edit Repository page to edit the repository registration information. You can only edit one Repository at a time.

You can edit the following fields:

• Name

• Database Link

• Description

Click Apply to save edits. The Repository List page displays next.

Managing Database Links

Use the Database Links page to view, create, edit, and drop database links.

To create a database link:

• Click Create Database Link located about and below the list of database links.

  The Create Database page displays next. Be prepared to provide detailed connection information. Additional help and instructions are available on that page.

To drop a database link:

• Locate the name of the database link that you want to drop and click the icon under the Drop column.

  The database link is immediately dropped and the page refreshes to display the updated list.

To edit a database link:

• Locate the database link and click the icon under the Edit column.

  The Edit Database Link page displays next. Additional help and instructions are provided on that page.

Creating Database Links

Use the Create Database Links page to specify connection information for new database links you are creating.

To create a database link specify the following information:

• Database Link Name

• Warehouse Builder Repository User Name

• Warehouse Builder Repository User Password

• Host Address

• Host Service Name

• Host Protocol

• Host Port Number

Click Apply to submit the database link information. If the information is valid, the Database Links page displays next an updated list database links.

Editing Database Links

Use the Edit Database Link page to view details about a specific database link and make changes.

You can edit the following fields:

• Warehouse Builder Repository User Name

• Warehouse Builder Repository User Password

• Remote Database Information

Click Apply to save edits. The Database Links page displays next.

Viewing the Database Link Error Status Page

Use the Database Link Error Status page to view details about the error. This is for viewing purposes only.

The following information is provided:

• Name: Name of the database link.

• Create On: Timestamp for when the database link was created.

• Status: Error

• Description: Reason why the database link is not valid.

Administering Roles

Use the Role Administration page to define access by role type. Role types determine what how the audit information is displayed in the reports. For more information about roles, see "Selecting a Role".

There are three role types available:

• QA User

• Warehouse User

• Warehouse Engineer

To manage access to role types:

• Choose a role type and select the icon under the Access Management column.

  The Access Management page displays next. From there you can define which user and groups you want to grant or revoke access.

Maintaining the Administrator List

Use the Maintain Administrator List page, shown in Figure 14-5, to add or revoke administrator privileges to users and groups.

Figure 14-5 Maintain Administrator List

Text description of the illustration opv_admn.gif

Note: You must have administrator privileges to make changes to the list of administrators.

To add a user or group:

• Type in the name of a user or group in the open fields and click Add. You can also search for a user or group by selecting the flashlight or torch icon.

  If the user or group name you provided is valid, it is added to the list of administrators.

To revoke privileges from a user or group:

• Locate the name of the user or group and click on the icon under the Revoke column.

  The user or group is removed from the list of administrators.

Available Runtime Audit Reports

The following tables list the audit reports available from the Runtime Audit Browser:

• Table 14-2, "Warehouse/Repository Reports"

• Table 14-3, "Process Reports"

• Table 14-4, "Process Run Reports"

• Table 14-5, "Mapping Reports"

• Table 14-6, "Mapping Execution Reports"

• Table 14-7, "Execution Error Reports"

• Table 14-8, "Data Object Reports"

• Table 14-9, "Location Reports"

• Table 14-10, "Deployment Error Reports"Table 14-11, "Management Reports"

Warehouse/Repository Reports

Table 14-2 Warehouse/Repository Reports  

Report	Description
Deployment Schedule	Displays a summary of all the deployment actions that have occurred for the selected repository. This is displayed as a Calendar view based initially on the current date. This report contains hyperlinks to the Deployed Objects.
Execution Schedule	Displays all execution processes, in date/time order, and a summary of their contained tasks. This is displayed as a Calendar view based initially on the current date.This report contains hyperlinks to Process, Map, Process Run and Map Run.
Execution Summary	Displays summary details of all processes in alphabetical or run-date/time order. It includes the Process Run and Mapping Run details. This report contains hyperlinks to Process, Map, Process Run and Map Run.
Object Summary	Displays a summary of all the objects that have been deployed in the selected repository. It displays details of the last deployment of each object. This report contains hyperlinks to the Processes, Maps, and Data Objects that have been deployed.
Location	Displays a list of all locations into which objects have been deployed. This report contains hyperlinks to the various locations.

Process Reports

Table 14-3 Process Reports  

Report	Description
Process Execution	Displays summary details of the Process Runs. This report contains hyperlinks to the Process Run report.
Process Deployment	Displays details of the deployment history. This report contains hyperlinks to the sub-processes and maps that it contains and any deployment errors that occurred.

Process Run Reports

Table 14-4 Process Run Reports  

Report	Description
Process Run Execution	Displays execution details, return status and runtime parameters, and a summary of its contained Mapping runs. This report contains hyperlinks to the Process, Map Run and Run Errors reports.

Mapping Reports

Table 14-5 Mapping Reports  

Report	Description
Map Execution	Displays summary details of its Map Runs. This report contains hyperlinks to the Map Runs report.
Map Deployment	Displays details of its deployment history. This report contains hyperlinks to any Deployment Errors that occurred.

Mapping Execution Reports

Table 14-6 Mapping Execution Reports  

Report	Description
Map Run Execution	Displays execution details, return status and runtime parameters. This report contains hyperlinks to the Run Errors.
Map Run Trace	Displays a diagnostic trace of source and target data values used. This can be useful for diagnostic purposes. It is only available if the Map Run was executed with the appropriate Audit Level parameter setting.

Execution Error Reports

Table 14-7 Execution Error Reports  

Report	Description
Error Diagnostics	Displays details of Run Error messages encountered for a given mapping or process flow execution.

Data Object Reports

Table 14-8 Data Object Reports  

Report	Description
Data Object Deployment	Displays details of the deployment history for a specific object. This report contains hyperlinks to any Deployment Errors that occurred.

Location Reports

Table 14-9 Location Reports  

Report	Description
Deployment Schedule	Displays a summary of all the deployment actions that have occurred for the selected location. This is displayed as a calendar view initially based on the current date. This report contains hyperlinks to the deployed objects.
Object Summary	Displays a summary of all the objects that have been deployed in the selected location. It displays details of the last deployment of each object. This report contains hyperlinks to the processes, maps, and data objects that have been deployed.

Deployment Error Reports

Table 14-10 Deployment Error Reports 

Report	Description
Error Details	For a given Deployment Error this shows details of all related error, warning and information messages that occurred in the deployment.

Management Reports

Table 14-11 Management Reports  

Report	Description
Service Node Report	Displays the current status of cluster nodes for the runtime repository. This report shows whether the nodes are in use or not.