Examples of the Formats of Logged Messages

9 Managing Usage Tracking 9-1 9 Managing Usage Tracking The Oracle BI Server supports the collection of usage tracking data. When usage tracking is enabled, the Oracle BI Server collects usage tracking data for each query and writes statistics to a usage tracking log file or inserts them directly to a database table. It is strongly recommended that you use direct insertion instead of writing to a log file. If you are upgrading from previous versions of Usage Tracking, then see the usage tracking topics in Oracle Fusion Middleware Installation Guide for Oracle Business Intelligence. This chapter includes the following topics: ■ Section 9.1, Setting Up Usage Tracking ■ Section 9.2, Description of the Usage Tracking Data

9.1 Setting Up Usage Tracking

The Oracle BI Server supports the accumulation of usage tracking statistics that can be used in a variety of ways such as database optimization, aggregation strategies, or billing users or departments based on the resources that they consume. The BI Server tracks usage at the detailed query level. When you enable usage tracking, statistics for every query are inserted into a database table or are written to a usage tracking log file. If you use direct insertion, then the BI Server directly inserts the usage tracking data into a relational database table. It is recommended that you use direct insertion to write statistics to a database table. When the BI Server starts, it validates the column names in the metadata against the list of valid columns in the usage tracking table. The following events occur: ■ Column names. If there is a mismatch between the columns in the database table and the columns in the metadata, then it results in a database error on insert. ■ Varchar length. If the length in the metadata and the set length in the table do not match, then an error is written to the nqserver.log file and usage tracking is disabled. Note: A sample usage tracking implementation is provided with the Oracle Business Intelligence installation at: ORACLE_ INSTANCE\bifoundation\OracleBIServerComponent\coreapplicatio n_obisn\sample\usagetracking 9-2 System Administrators Guide for Oracle Business Intelligence Enterprise Edition This section contains the following topics: ■ Section 9.1.1, Setting Up Direct Insertion to Collect Information for Usage Tracking ■ Section 9.1.2, Setting Up a Log File to Collect Information for Usage Tracking

9.1.1 Setting Up Direct Insertion to Collect Information for Usage Tracking

Direct insertion is the recommended method for setting up usage tracking. To set up direct insertion, update the following parameters in the Usage Tracking section of the NQSConfig.INI file: ■ ENABLE. Set this parameter to YES to enable usage tracking. ■ DIRECT_INSERT. This parameter determines whether the query statistics are inserted directly into a database table or are written to a file for subsequent loading. Set this parameter to YES to enable direct insertion. ■ PHYSICAL_TABLE_NAME. To insert query statistic information into a table, you must provide the name of the table and the connection pool that is used to access the table see the CONNECTION_POOL parameter. The fully qualified physical table name consists of as many as four components database name, catalog name, schema name, and table name. Each component is surrounded by double quotation marks and separated by a period .. The physical table name must be fully qualified. This fully qualified physical table name must match a table name in the physical layer of the loaded repository. The following is an example of a physical table name for the Usage Tracking table in the Oracle Business Intelligence repository: PHYSICAL_TABLE_NAME = Oracle BI Usage.Catalog.dbo.S_NQ_ACCT ; In this example, Oracle BI Usage represents the database component, Catalog represents the catalog component, dbo represents the schema component, and S_NQ_ACCT represents the table name. ■ CONNECTION_POOL. The fully specified connection pool name has two parts: database name and connection pool name. Each part is surrounded by double quotation marks and separated by a period .. The fully qualified connection pool name should match a connection pool name in the physical layer of the loaded repository. For an example, see the following connection pool name in the Oracle Business Intelligence repository: CONNECTION_POOL = Oracle BI Usage.Connection Pool ; In this example, Oracle BI Usage represents the database component and Connection Pool represents the actual connection pool name. For Usage Tracking insertions to succeed, the connection pool must be configured with a user ID that has write access to the back-end database. See Oracle Fusion Middleware Metadata Repository Builders Guide for Oracle Business Intelligence Enterprise Edition for information about configuring connection pools. Note: It is recommended that the connectivity type supports international data.