Oracle by Example brandingSet Up Usage Tracking in Oracle Analytics

section 0Before You Begin

This 10-minute tutorial shows you how to set up tracking of user queries to the content in Oracle Analytics.

Background

Track usage to determine which user queries are creating performance bottlenecks, based on query frequency and response time. Administrators set up the criteria to track user queries and generate usage reports that can be used in a variety of ways such as database optimization, aggregation strategies, or billing users and departments based on the resources that they consume.

This is the first tutorial in Track Usage in Oracle Analytics. Read the tutorials in the order listed.

What Do You Need?

  • Install Oracle Analytics Developer Client Tool
  • Access to Oracle Analytics
  • Access to Oracle Database Cloud Service instance and these connection details:
    • Host name
    • Port number
    • Database service name
    • User name and password that match the name of a schema available in the database

section 1Specify the Usage Tracking Database

Before you can track usage of reports, dashboards, and data visualization projects on your system, you must specify the database where you want to store the usage tracking statistics. The database must have a schema defined in it with permissions to create tables. The usage tracking process creates tables in the schema whose name matches the user name that you provide when specifying the connection pool details. For example, if the name of a schema in the usage tracking database is Analytics_Usage, then when specifying the connection pool details, you must enter Analytics_Usage in the User Name field. The usage tracking process creates the usage tracking-related tables in the schema named Analytics_Usage.

In this section, you configure the database and connection pool details in the physical layer of your data model file. 

  1. In Oracle Analytics Developer Client Tool, from the File menu, select Open, then In the Cloud.
  2. Enter the following connection information for your Oracle Analytics instance and click Open:
    • User: The user name of an Oracle Analytics administrator
    • Password: The password for the specified user.
    • Cloud: bootstrap
    • Host: The Oracle Analytics URL without the https:// at the start or the  /dv/ui part at the end of the URL. For example, demo.example.com 
    • Port: Port number of your Oracle Analytics instance.
  3. In the Physical layer of the data model file, right-click and select New Database.
  4. In Database, enter UsageTracking in Name, select Oracle 12c in Database type, and then click OK.
    Description of database.png follows
    Description of the illustration database.png
  5. In the Physical layer of the data model file, right-click UsageTracking, select New Object, and then select Connection Pool.
  6. In Connection Pool, enter UTConnectionPool in Name, specify values for the following, and then click OK:
    • Call interface: Select Default (Oracle Call Interface (OCI)).
    • Data Source Name: Enter your database host, port, and service name using the following format:
      • (DESCRIPTION =(ADDRESS = (PROTOCOL = TCP)(HOST = <Your DB Host>)(PORT = <Your DB port>))(CONNECT_DATA =(SERVER = DEDICATED)(SERVICE_NAME = <Your DB Service name>)))
    • User name and Password: Enter the user name and password that matches the name of a schema available in the usage tracking database.
      Description of connectionpool.png follows
      Description of the illustration connectionpool.png
  7. In Confirm Password, enter the password that you had entered in the Connection Pool dialog, and then click OK.
  8. Click Save and then click Yes to check global consistency. Click OK.
  9. Click FileCloud, and then Publish to upload the data model file that you edited to your Oracle Analytics instance.
  10. Click OK when you see the message after a few minutes that the repository was published successfully to the cloud.
    Description of publishrepository.png follows
    Description of the illustration publishrepository.png

section 2Set Usage Tracking Parameters

To record usage information, specify connection details for the usage tracking database and database table names that include the schema name that matches the user name of your connection pool. Use the database and connection pool names that you specified in the physical layer.

After you set the parameters and restart, Oracle Analytics creates the usage tracking tables in the specified schema with the table names that you provided and starts to log user queries in these tables.

  1. Sign in to Oracle Analytics with your administrator credentials.
  2. On the Home page, click Navigator, and then click Console.
  3. In Console, click System Settings.
  4. Enter these values for the following parameters:
    • Usage Tracking Connection Pool: UsageTracking.UTConnectionPool.
    • Usage Tracking Physical Query Logging Table: UsageTracking.Analytics_Usage.PhysicalQueries. Replace "Analytics_Usager" with your usage tracking database schema name.
    • Usage Tracking Logical Query Logging Table: UsageTracking.Analytics_Usage.LogicalQueries. Replace "Analytics_Usage" with your usage tracking database schema name.
    • Usage Tracking Max Rows: 10000 as the maximum number of rows that you want in the usage tracking tables.
    • Description of utparameters.png follows
      Description of the illustration utparameters.png
  5. Click Restart and then click OK.

next stepNext Tutorial

Analyze Usage Tracking Data in Oracle Analytics


more informationWant to Learn More?