Oracle Enterprise Manager Oracle Trace Developer's Guide
Release 1.4.0
A53697_01

Library

Product

Contents

Index


Prev Next

5
Creating Product Definitions

This chapter explains how to create product definitions for an application. The following topics are covered:

Running Oracle Trace in Administrative Mode

The create and edit product definition functions are available only in the Administrative mode of Oracle Trace. If the Oracle Trace main window does not have the Product=>Edit and Product=>Create menu options, you must take the following steps to run Oracle Trace in Administrative mode:

  1. Highlight the Oracle Trace icon in the Oracle Enterprise Manager (OEM) program group.
  2. Choose File=>Properties...
  3. In the Command Line field, append /a at the end of the line. For example,
  4. C:\ORANT\BIN\EPC.EXE  /a
    
    
    
  5. Click OK.
  6. Launch Oracle Trace using this program item rather than through Oracle Enterprise Manager.

The Administrative mode allows you to run Oracle Trace without running Oracle Enterprise Manager.

What Is a Product Definition?

A product definition is a file that describes a single event set for a product. You cannot collect data for a product unless there is at least one product definition file (.fdf) for the product.

If you are using a product that was instrumented before you began using it, at least one product definition file should already exist. Product definition files can be found in $ORACLE_HOME/otracexx/admin on the server machine.

If you have developed and instrumented your own product, you need to create a product definition file for it, using the directions given in this chapter.

Create Product Property Page

To create a product definition file, select Product=>Create on the Oracle Trace Manager main window. The Create Product property page is displayed, as shown in Figure 5-1.

Figure 5-1 Create Product Property Page

Provide the following:

Adding Items to a Product Definition

Once you provide the general information, you can add items to a product definition by selecting the Items tab in the Create Product property page. Select the Add button. The Add Item dialog box is displayed, as shown in Figure 5-2. The Oracle Trace Help for this dialog box provides the detailed information for each field.

Figure 5-2 Add Item Dialog Box

Provide the following information:

Editing Items

To edit an item's description, select the item from the Product Items list box and select the Edit/View button. The guidelines for each field are the same as for adding a new item, except that existing information is displayed for you to edit.

Removing Items from a Product Definition

To remove an item from a product definition, select the item from the Product Items list box in the Items page of the Create Product dialog box and select the Remove button.

You cannot delete an item if it is part of an event or if it is defined by Oracle Trace.

MSB

MSB is an Oracle internal product. MSB (message binary) codes are used in conjunction with an external precompiled MSB file to allow applications to fetch message strings in user-specified or default language. An MSB code is an unsigned 4-byte datatype with no parameters. An MSB code with parameters is an ASCIW datatype. The parameters are format strings used to convert variable datatypes that follow.

To display the MSB dialog box, select the MSB Path button in the Items page of the Create Product dialog box. This button is active only when the usage type is a MSB usage type.

Supply the name of the MSB file and the three-letter facility that message mechanisms use to identify the products.

Adding Events

To work with events, select the Events tab from the Create Product property page. From here you can do the following:

Adding Duration Events

To add duration events, select the Add Duration button on the Events tab. The Add Duration Event dialog box is displayed, as shown in Figure 5-3.

Figure 5-3 Add Duration Event Dialog Box

Provide the following information:

Removing Start Event and End Event Items

To remove Start Event and End Event items from a duration event, select the item name in the Start Event Items or End Event Items list box and click the Remove button.

Ordering Event Items

Once items have been added to the Start Event Items or End Event Items list boxes, their order can be changed within the list. This allows you to specify the event record order.

Select an item in either list box and use the up and down arrows to move the item up or down in the list.

Adding Point Events

To add point events, select the Add Point button on the Events tab. Provide the following information.

Removing Event-Specific Items

To remove an item from a point event, select it from the Event-Specific Items list box and click the << button.

Ordering Event Items

Once items have been added to the Start Event Items or End Event Items list boxes, their order can be changed within the list. This allows you to specify the event record order.

Select an item in either list box and use the up and down arrows to move the item up or down in the list.

Note:

The order of the items in this list box must match the order of the items in the record passed to Oracle Trace within the instrumented product.  

Editing Events

To edit events, select an event name from the Product Events list box in the Events page of the Create Product dialog box and select the Edit/View button. The guidelines for each field are the same as when adding a new event, except that existing information is displayed for you to edit.

Removing Events from a Product Definition

To remove an event from a product definition, select the event from the Product Events list box of the Events page of the Create Product dialog box and select the Remove button.

You cannot remove an event if it is currently part of an event set. This protects you from inadvertently deleting an event for which you still want to collect data. Oracle Trace displays an error message if you try to do this.

Adding Event Sets to a Product Definition

To create an event set for a product definition, select the Event Sets tab in the Create Product property page. Existing event sets are listed in the Product Event Sets list box. The All event set is always the first event set listed; it cannot be deleted.

To define an event set, select the Add button in the Event Sets tab. The Add Event Set dialog box is displayed in Figure 5-4.

Figure 5-4 Add Event Set Dialog Box

Provide the following information.

Removing Events from an Event Set

To remove events from an event set, select an event from the Event Set Specific Events list box and then select the Remove button.

To keep an event as part of a event set, but remove specific items from the event, select the item from the Event Set Specific Event Items list box and then click the Remove button.

Editing Event Sets for a Product Definition

To edit an event set definition, select an event set name from the Product Event Sets list box in the Event Sets page of the Create Product dialog box and select the Edit/View button. The steps are then the same as when you add a new event set, except that existing information is displayed for you to edit.

Removing Event Sets from a Product Definition

To remove an event set from a product definition, select the event set from the Product Event Sets list box in the Event Sets page of the Create Product dialog box and select the Remove button.

Editing Existing Product Definitions

To edit an existing set of product definitions, choose Product=>Edit. This displays an Open File dialog box, which allows you to select one or more product definition files (.fdf).

After selecting all the product definition files for a product, click the OK button. This brings up the Edit Product dialog box, which is the same as the Create Product dialog box except that the existing product information has been filled in. Proceed as described in earlier sections in this chapter, except use the Edit function to modify existing items, events, and event sets. You will need to change the file names of event sets because Oracle Trace will not let you overwrite existing files.

Note:

You should always edit all product definitions files for a product at the same time because item and event information for the entire product is replicated in each file. If one product definition file is modified by itself, it will not be in synchronization with all the other files. This will cause inconsistent results when you run Oracle Trace on different event sets within the same product.  




Prev

Next
Oracle
Copyright © 1997 Oracle Corporation.
All Rights Reserved.

Library

Product

Contents

Index