Before you Begin
This 10-minute tutorial shows you how to set up usage tracking of user queries in Oracle Analytics.
Background
Usage tracking helps to determine which user queries are creating performance bottlenecks based on query frequency and response time. You must have administrator privileges to set up the criteria to track user queries and generate usage reports. You can use the usage report information to assist with database optimization, aggregation strategies, or billing users and departments based on the resources consumed.
Before you can track usage of reports, dashboards, and data visualization workbooks, you must specify the database where you want to store the usage tracking statistics. The database must have a schema defined with permissions to create tables. Usage tracking creates tables in the schema with a name that matches the user name you provided when specifying the connection pool details. For example, if schema name 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. Usage tracking creates the usage tracking-related tables in the schema named Analytics_Usage
.
This is the first tutorial in Track Usage in Oracle Analytics series. Read the tutorials in the order listed.
- Set Up Usage Tracking in Oracle Analytics
- Analyze Usage Tracking Data in Oracle Analytics
What Do You Need?
- Install Oracle Analytics Developer Client Tool
- Access to Oracle Analytics
- Access to an Oracle Database Cloud Service instance with the connection details
Connect to Cloud Instance
In this section, you specify the database and connection pool details in the physical layer of your data model file.
- From Start select Oracle Analytics Client Tools, select the Model Administration Tool to open the Oracle BI Administration Tool.
- In Oracle BI Administration, select the File menu, select Open, and then select In the Cloud.
- In the Open In the Cloud dialog, enter the User and Password credentials for the BI Service Administrator user.
- In Cloud, enter
bootstrap
. - In Host, enter the Oracle Analytics URL without the https:// and /dv/ui portion of URL, for example,
demo.example.com
. - In Port, enter the port number of your Oracle Analytics instance.
- With SSL checked (enabled), in the Trust Store use the default
OAC Client Home\oracle_common\jdk\jre\lib\Security\cacerts
or click Browse to select the location of your trusted certificate authority certificates (cacerts). Enter the Password. - Click Open.
Create a Usage Tracking Database
- In the Physical layer without anything selected, right-click and select New Database.
- In Database, enter
UsageTracking
in Name, select Oracle 12c in Database type, and then click OK. - In the Physical layer, right-click UsageTracking, select New Object, and then select Connection Pool.
- In Connection Pool, enter
UTConnectionPool
as the Name. - In Call interface, select Default (Oracle Call Interface (OCI)).
- In Data Source Name, enter the host, port, and service name for the database connection in 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>)))
- Enter the User name and Password that matches instance you are tracking.
- In Confirm Password, re-enter the password, and then click OK.
- From the File menu, select Save. Click Yes to check global consistency. In the Consistency Checker Manager, click Close.
- From the File menu, select Cloud, and then select Publish to upload the data model file to your Oracle Analytics instance.
- Click OK when you see the message after a few minutes that the repository was published successfully to the cloud.
Set Usage Tracking Parameters
In this section, you 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 apply the changes, 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.
- Sign in to Oracle Analytics with your administrator credentials.
- On the Home page, click Navigator , and then click Console.
- In Console, click System Settings, and then click Usage Tracking.
- In Usage Tracking Maximum Rows, enter
10000
. - In Usage Tracking Connection Pool, enter
UsageTracking.UTConnectionPool
. - In Usage Tracking Physical Query Logging Table, enter
UsageTracking.Analytics_Usage.PhysicalQueries
. Replace "Analytics_Usage" with your usage tracking database schema name. - In Usage Tracking Logical Query Logging Table, enter
UsageTracking.Analytics_Usage.LogicalQueries
. Replace "Analytics_Usage" with your usage tracking database schema name. - Click Apply and then click OK.
Next Steps
Learn More
Set Up Usage Tracking in Oracle Analytics
F18439-06
January 2023
Copyright © 2023, Oracle and/or its affiliates.
Learn how to set up tracking of user queries in Oracle Analytics.
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract. The terms governing the U.S. Government's use of Oracle cloud services are defined by the applicable contract for such services. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.