This is the multi-page printable view of this section.
Click here to print.
Return to the regular view of this page.
OpenText Core Analytics Database
This topic provides an overview of OTCAD.
OpenText™ Core Analytics Database (OTCAD) is a managed database service that delivers a unified, high performance advanced analytics and machine learning platform in the cloud. The database gets automatically provisioned in an OpenText AWS account. OpenText manages the database hardware and environment. OTCAD is optimized for efficiency and query performance, ensuring you meet your service level agreements within your budget.
OTCAD enhances the speed and scalability of a database without the need to manage hardware. OTCAD is a data warehouse and data lake platform that enables organizations to deploy databases securely. To get access to OTCAD, contact your sales representative or contact us.
OTCAD UI tour
You can view and manage the provisioned database. After logging in to the OTCAD application, the home page appears. This page displays the three-dot menu and other SQL editor options as shown in this image:

|
Option |
Description |
|
a |
More options: Displays the More options button with options to access the SQL editor, Settings, Data pipelines, and the Integrations page. |
|
b |
Stop: Displays the option to stop the database. |
|
c |
History view: Displays the queries run previously. |
|
d |
Favorite view: Displays the bookmarked SQL queries. |
|
e |
Help: Displays OpenText™ Analytics Database user documentation. |
|
f |
View profile: Displays the user profile and option to sign out of the application. |
More options
When you log in to the application, the More options button is displayed with these options:
- SQL editor: Select this option to work with the SQL editor.
- Settings: Select this option to configure the database settings.
- Data pipeline: Select this option to work with data pipelines.
- Integrations: Select this option to display the Integrations page.
Database connection options
The Home page displays the option to stop an active database.
- To stop OTCAD, select Stop.
<--Or-->
- To re-start an inactive database, select Start.
SQL Editor
Use OTCAD SQL editor to write, edit, and execute SQL statements in a query view. You can write and execute analytical queries without using any external tools.
You can use the SQL editor to:
- gain valuable insights from your data without needing expertise to set up database connections.
- write, execute, and save queries that need to be repeated.
- view sample data returned from your queries.
- validate the execution of SQL queries.
- view data about the execution of SQL queries.
- export queries into a spread sheet.
- execute SQL commands for OTCAD operations, such as creation of schemas, tables, and so on.
Working with SQL editor
After logging in to the OTCAD application, the home page appears.
To launch the SQL editor, select SQL Editor in the three-dots menu.
The Schema view displays with a list of available schemas and tables. You can either select a table or create an SQL query.
Create an SQL query
You create SQL queries either in the Home page or the Schema view.
Do one of the following:
-
Select a table:
- Select Create query in the Schema view.
--Or-->
- Select Create new query in the Home page.
-
Enter your query in the SQL editor.
-
Select Run.
-
Enter the name of the query at the top.
-
To view the schema details of a table, select View Schema.
The table columns display along with the datatypes.
-
To filter the SQL query results, select the filter icon.
You can add a filter. search the results by the column name and the match type, and select Apply.
-
To save the SQL query results, do the following:
a. Select Export CSV.
b. Enter the file name and select Export.
You can export upto a maximum of 10 thousand records. To import data that exceeds 10 thousand records, modify the SQL query and export again.
History view
The History view tab stores the queries run previously. When you run a query, it appears in the Query History list. Queries of the last 2 weeks only are displayed.
To run a SQL query:
- Select ….
- Select Run.
To remove a SQL query:
- Select ….
- Select Remove.
Favorite view
You can bookmark SQL queries and run them again later in the Favorite view tab. Saved SQL queries display as a list of favorites next to the History view tab.
To bookmark a SQL query as a favorite:
- Select the SQL query.
- Select Run.
- Select Favorite.
- Enter a name and select Add.
To run a SQL query from the Favorites view:
- Select ….
- Select Run.
After successful execution of the query, the results are displayed in the SQL editor.
To rename a favorite SQL query:
- Select the SQL query.
- Select ….
- Select Rename.
- Enter the new name and select Update.
To remove a favorite SQL query:
- Select the query.
- Select ….
- Select Remove.
- When prompted for confirmation, select Remove.
1 - OpenText Core Analytics Database Settings Overview
This topic provides an overview of database configuration settings in OTCAD.
You can configure the default database configuration settings in OpenText™ Core Analytics Database (OTCAD).
- Log in to OTCAD.
- Select Settings from More options.
The Settings Overview page opens. In this page, you can configure the following OTCAD settings:
- Connection data: You can configure the default connection data settings in OTCAD.
- CIDR: CIDR is fundamental to subnetting, the process of dividing a large network into smaller, more manageable subnetworks. By using different prefix lengths, you can create subnets with varying numbers of host addresses, enabling efficient use of IP address space.
- Scaling: Database scaling is the ability of a database to obtain or reduce resources depending on the system's load, establishing a direct correlation between the allocation of resources and their demand. Scaling ensures consistency in the database server quality while maximizing resource usage.
- Select Connection Data.
- Copy this information to connect your database with other applications or clients:
- Host DNS: The DNS host provides the authoritative nameservers that answer or resolve queries for your website. This is how your site is found on the web.
- Host Port: The host port is a network port on a computer or device that is used to establish a connection with another device or service, often for communication or data transfer.
- Database Name: The unique name of the database.
- Refresh Token: The refresh token is a special type of token used in authentication flows, particularly in OAuth 2.0, to obtain new access tokens when the current ones expire.
- Access Token: An access token is a security credential that allows an application or user to access protected resources on a server. It acts as a digital key, verifying the user's or application's identity and authorization level, and is used to grant access without requiring the user to repeatedly provide their credentials.
- Select Close to close the Connection Details page.
1.1 - Connection Data Settings
This topic provides an overview of connection data settings in OTCAD.
You can configure the default connection data settings in OTCAD. You can manage IP addresses with Classless Inter-Domain Routing (CIDR) and scale your plan to suit your requirements.
1.2 - CIDR
This topic provides an overview of managing IP addresses with Classless Inter-Domain Routing (CIDR) in OTCAD.
CIDR
Cloud infrastructure engineers use CIDR notation to manage IP address ranges for cloud-based networks. IP addresses enable resources in your Virtual Private Cloud (VPC) to communicate with each other and with resources over the Internet. CIDR notation is a way to represent an IP address and its network mask.
OpenText supports ranges of IP addresses using Classless Inter-Domain Routing (CIDR) notation. For example, 192.168.1.0/24 represents all IPv4 addresses in the range of 192.168.1.0 to 192.168.1.255.
The format of these addresses is as follows:
- An individual IPv4 address is 32 bits, with 4 groups of up to 3 decimal digits. For example, 10.0.1.0.
- An individual IPv6 address is 128 bits, with 8 groups of 4 hexadecimal digits. For example, 2001:0db8:85a3:0000:0000:8a2e:0370:7334.
Public IPv4 and IPv6 addresses
All subnets have an attribute that determines whether a network interface created in the subnet automatically receives a public IPv4 address. Therefore, when you launch an instance into a subnet that has this attribute enabled, a public IP address is assigned to the primary network interface that's created for the instance.
You can control whether your instance receives a public IP address by doing the following:
- Modifying the public IP addressing attribute of your subnet.
- Enabling or disabling the public IP addressing feature during instance launch, which overrides the subnet's public IP addressing attribute.
- Unassigning a public IP address from your instance after launch by managing the IP addresses associated with a network interface.
Public IPv6 addresses are IPv6 addresses that can be configured to remain private or configured to be reachable over the Internet.
Private IPv4 and IPv6 addresses
Private IPv4 addresses are not reachable over the Internet and can be used for communication between the instances in your VPC. When you launch an instance into a VPC, a primary private IP address from the IPv4 address range of the subnet is assigned to the primary network interface (for example, eth0) of the instance. Each instance is also given a private (internal) DNS hostname that resolves to the private IP address of the instance.
You cannot share private IPv6 addresses on the Internet. You can use a private IPv6 address if you want your private networks to support IPv6 and you have no intention of routing traffic from these addresses to the Internet. You can connect to the internet from a resource that has a private IPv6 address. But you must route traffic through a resource in another subnet with a public IPv6 address.
To configure CIDR settings:
- In the Settings Overview page, select View CIDR.
The CIDR page displays.
- Select Private.
- To add an IP address, select Add IP.
- From the Value drop-down list, select either IPv4 or IPv6 depending on the IP address you want to add.
Do one of the following:
a. Enter a valid IPv4 or IPv6 address.
b. Copy a valid IPv4 or IPv6 address from another source and select Paste.
- Select √.
1.3 - Connection Data Settings
This topic provides an overview of scaling your database in OTCAD.
Scaling
Workload scaling enhances application performance and resource efficiency in dynamic environments. Scaling ensures that applications can handle varying workloads without performance degradation. OpenText provides the ability to automatically scale resources up or down based on real-time metrics, allowing organizations to respond quickly to changes in traffic. This elasticity not only improves user experience but also optimizes resource utilization, helping to minimize costs associated with underused or overprovisioned resources.
You cam manage compute to your database to improve the performance of complex analytic queries that have been running for a long time. Adding compute helps these queries run faster.
Configure the compute of your database to suit your query requirements and workload performance needs.
To manage compute for your database:
- In the Settings Overview page, select Scaling.
- Select View Scaling.
The horizontal database scaling options are displayed. You can scale the database either manually or automatically. Do one of the following:
a. To manually scale the database, select Manual.
b. Slide across the slider horizontally to scale the database depending on the size - small, small-medium, medium, medium-large, or large.
c. Select Apply changes.
d. In the View scaling log area, click the Audit log and Scaling log tabs to view the log details.
<-Or->
a. To automatically scale the database, select Auto.
Select this option only if you need to automatically scale the database based on defined parameters.
b. From the Scale up to drop-down list, select either Large or Medium depending on the size of your database.
Note
Define the maximum compute beyond which the system cannot add anything and balance the loads automatically.
c. Use the CPU usage toggle button to scale out the database when the CPU usage exceeds a value in the range 1% to 100%.
d. Use the Memory usage toggle button to scale out the database when the memory usage exceeeds a value in the range 1% to 100%.
Note
When you apply both CPU usage and Memory usage, the system adds additional compute when either of the thresholds are reached.
e. Select Apply changes.
f. In the View scaling log area, click the Audit log and Scaling log tabs to view the log details.
The Audit log provides information about the following:
- Date & time
- Event
- Performed by
The Scaling log provides information about the following:
- Date & time
- Scale event
- Compute (units)
- Triggered
- Performed by
2 - Overview of Data Pipelines
This topic provides an overview of data pipelines in OTCAD.
Data pipelines allow you to define where, when, and how you need to load data into OpenText™ Analytics Database with minimal manual intervention.
2.1 - Data Pipelines
This topic provides an overview of data pipelines in OTCAD.
Data pipeline
A data pipeline also known as a data loader is a declarative, automated way to process data continuously from external sources like Amazon S3. They allow you to define where, when, and how you need to load data into OTCAD with minimal manual intervention.
Data pipelines UI tour
You can view and manage data pipelines. After logging in to the OTCAD application, you land on the home page. Select the More options button and Data Pipeline. The Data pipeline page appears as shown in this image:

This page displays the following information in the Overview card:
- Total number of pipelines - The Total Pipelines card displays the total number of pipelines configured in the system.
- Pipelines that failed execution - Select the Failed Execution drop-down list and the period for which you need to view the pipelines that failed to execute.
- Active pipelines - The Active Pipelines card displays the total number of pipelines that are in the Active status.
The Pipelines area displays the following information:
- Pipeline name - The name of the data pipeline.
- Created by - The user ID of the person who created the data pipeline.
- Data source - The source location of the files that contain the data to be loaded.
- Schema - The tables, columns (fields), data types, and relationships among different tables in the database.
- Destination table - The database table where data is written after it has been processed or transformed from a source table or other data source.
- Last run on - The timestamp at which the data pipeline was last run.
- Last run status - Indicates the status of the data pipeline when it was last run.
- Pipeline status - Indicates the present status of the data pipeline.
|
Option |
Description |
|
a |
Create a pipeline: Select this option to create a data pipeline. |
|
b |
Filter by: Select this option to filter data by different criteria. |
|
c |
Search pipeline name or schema: Search for a data pipeline based on the pipeline name or schema. |
|
d |
View details: Select this option to view the pipeline details. |
|
e |
Edit pipeline: Select this option to edit the data pipeline. |
|
f |
Clone pipeline: Select this option to clone a data pipeline. |
|
g |
Remove pipeline: Select this option to delete a data pipeline. |
Create a data pipeline
To create a data pipeline, do the following:
- In the Data Pipelines page, select +Create a pipeline.
The Create a pipeline page displays.
- In the Pipeline name field, enter the name of the pipeline.
- In the Access key ID field, enter your AWS account access key id.
- In the Secret access key field, enter your AWS account secret access key.
Note
Provide valid AWS credentials for the Access key ID and Secret access key. Invalid AWS credentials do not allow you to create a data pipeline.
- From the Region drop-down list, select the region (geography) of the S3 bucket where the files are present.
- In the S3 Bucket/File/Folder path field, enter the name or the folder path where the files are present.
- Select the Data is encrypted option to specify the following parameters:
- Select either AWS Key Management Service Key or Customer managed keys if you wish to encrypt and load data into the S3 bucket.
- Select Encryption key ID.
- Select Next.
- In the Retry limit field, specify the number of times for which the system needs to retry a failed file load.
- In the Parameters field, specify the copy parameters. For more information, see Parameters.
- Select Next.
- From the Destination table drop-down list, select the destination table to which you need to load the data.
- Select Next.
- Specify the schedule at which the data pipeline needs to run. Do one of the following:
- Select Schedule.
- From the date pickers, select the Start date and End date.
- In the Repeat every field, specify the duration at which the data pipeline needs to run.
- From the Unit drop-down list, select the minute, hour, day, week, or month at which the data pipeline needs to run.
- Select the On day radio button and specify the day on which the data pipeline needs to run.
- Select the On radio button and specify the exact day and month on which the data pipeline needs to run.
- Select the option Trigger when something is added to run the data pipeline when a file is added to the S3 bucket.
- Enter the SQS credentials in the Access key ID, Secret access key, and Resource URL fields.
<--Or-->
- Select Execute once.
- Select Finish.
The data pipeline is created and displayed in the Data Pipelines page.
Filter a data pipeline
You can filter data pipelines based on certain criteria. Filter data pipelines in one of these ways:
- A date range on which the data pipelines last ran.
- Select the Filter icon in the Data Pipelines page.
- Expand the Last run range drop-down list.
- In the date picker, select a date range (start date and end date) for which you need to view the data pipelines. For example, select a range from 1 May to 31 May to view data pipelines that were created in the month of May.
- Schema
- Select the Filter icon in the Data Pipelines page.
- Expand the Schema drop-down list.
- Select the required schema.
- Data source
- Select the Filter icon in the Data Pipelines page.
- Expand the Data source drop-down list.
- Select the data source or data sources for which you wish to view the data pipeline.
- Pipeline status
- Select the Filter icon in the Data Pipelines page.
- Expand the Pipeline status drop-down list.
- Select Active to view the data pipelines that are active.
A data pipeline is in the
Active status when the schedule end date is a future date and there are one or more ingestions that are yet to complete.
- Select Inactive to view the data pipelines that are inactive.
A data pipeline is in the
Inactive status either when the end date is past or there are no ingestions that are yet to complete.
- Id of the person who created the pipeline
- Select the Filter icon in the Data Pipelines page.
- Expand the Created by drop-down list.
- Select the user Id of the person who created the data pipeline.
Search a data pipeline
All data pipelines are displayed by default. You can search data pipelines using specific search criteria. To search data pipelines, do the following:
- In the Data pipelines page, select +Search pipeline name or schema.
- Enter one of the following search criteria:
- Pipeline name
- Owner of the data pipeline (Created by)
- Schema
- Destination table
- You can sort the data pipeline by the pipeline name or the date on which it was last run. To sort the data pipelines in the ascending or descending order, select the Sort icon for the Pipeline name or Last run on column in the Data Pipelines page.
View pipeline details
You can view pipeline details in the Data pipelines page. To view the details of a data pipeline, do the following:
- In the Data pipeline page, mouse over the Pipeline name column and select the +View details icon for a data pipeline.
You can view the following details of the data pipeline in this page.
- Overview - Displays the owner (user ID) of the data pipeline.
- Configurations - Displays the source and destination paths of the data pipeline. In the Configurations card, click the Edit icon to edit the data source and destination paths of the data pipeline.
For more information, see Creating a data pipeline.
- Total instances - Displays the total number of jobs. Select the drop-down list and view information about the instances for the last 24 hours, last week, last month, last 6 months, last one year, or all time.
- To view the reasons for the failure of a job, mouse over an instance with job status Failed and select the View error logs icon that appears for a file name.
The error log provides information about the row that failed execution, reason for failure, and rejected data. You can troubleshoot the job with this information and ensure that this job is successfully executed.
- Incident Overview - Displays information about the data pipeline job in a pie chart. Select the drop-down list and view information about the jobs for the last 24 hours, last week, last month, last 6 months, last one year, or all time.
- Select Execute pipeline to execute the selected data pipeline.
Executing a data pipeline loads all files that have not already been loaded and that have not reached the retry limit. Executing the data pipeline commits the transaction.
- Select Edit pipeline to edit the data pipeline.
- In the Access key ID field, enter your AWS account access key id.
- In the Secret access key field, enter your AWS account secret access key.
All the details about the data pipeline are populated, except the Access key ID and Secret access key.
Note
Provide valid AWS credentials for the **Access key ID** and **Secret access key**. Invalid AWS credentials do not allow you to edit a data pipeline.
For more information about editing a data pipeline, see Creating a data pipeline.
Edit a data pipeline
After creating a data pipeline, you can edit the details to suit your requirements. To edit a data pipeline, do the following:
- In the Data Pipelines page, mouse over the Pipeline name column and select the +Edit pipeline icon for a data pipeline.
- In the Access key ID field, enter your AWS account access key id.
- In the Secret access key field, enter your AWS account secret access key.
All the details about the data pipeline are populated, except the Access key ID and Secret access key.
Note
Provide valid AWS credentials for the **Access key ID** and **Secret access key**. Invalid AWS credentials do not allow you to edit a data pipeline.
For more information about editing a data pipeline, see Creating a data pipeline.
Clone a data pipeline
You can create a clone or replica of an existing data pipeline. The configurations of the existing data pipeline are copied to the cloned data pipeline. You can edit these configuration settings in the cloned data pipeline.
- In the Data Pipelines page, mouse over the Pipeline name column and select the Clone pipeline icon for a data pipeline.
- In the Confirmation dialog, select Confirm.
The Create a pipeline page displays.
- In the Pipeline name field, enter the name of the pipeline.
- In the Access key ID field, enter your AWS account access key id.
- In the Secret access key field, enter your AWS account secret access key.
Note
Provide valid AWS credentials for the **Access key ID** and **Secret access key**. Invalid AWS credentials do not allow you to edit a data pipeline.
Information in all other fields is pre-populated. You can edit this information.
Remove a data pipeline
You can delete a data pipeline that is no longer in use or required.
- In the Data Pipelines page, mouse over the Pipeline name column and select the +Remove pipeline icon for a data pipeline.
- In the Confirmation dialog, select Remove.
3 - Overview of UDx
This topic provides an overview of UDx in OTCAD.
A user-defined extension (UDx) is a component that expands OTCAD functionality—for example, new types of data analysis and the ability to parse and load new types of data.
3.1 - Developing user-defined extensions (UDx)
The primary strengths of UDxs are:.
The primary strengths of UDx are:
-
You can use them wherever you use internal functions.
-
They take full advantage of the distributed computing feature of the system. The extensions usually execute in parallel on each node in the cluster.
-
The complicated aspects of developing a distributed piece of analytic code are handled by the system. Your main programming task is to read in data, process it, and then write it out using the SDK APIs.
Fenced mode
Fenced mode runs the UDx code outside of the main system process. Fenced UDx crashes do not impact the core system process. There is a small performance impact when running UDx code in fenced mode. On average, using fenced mode adds about 10% more time to execution.
Fenced mode is currently available for all UDx with the exception of user-defined aggregates. All UDx run in fenced mode, since the Python runtimes cannot run directly within the system process. Using fenced mode does not affect the development of your UDx. Fenced mode is enabled by default for all UDx.
OTCAD does not support the unfenced mode.
Scalar functions (UDSFs)
A user-defined scalar function (UDSF) returns a single value for each row of data it reads. You can use a UDSF anywhere you can use a built-in database function. For more information about UDSF, see Scalar functions (UDSFs).
3.2 - UDx
This topic provides an overview of UDx in OTCAD.
OTCAD enables you to create, list, and delete custom UDx, so that you can integrate them with existing database tables. UDx allow you to reuse and share code that extends built-in functionality. Use UDx to perform specific tasks such as complex calculations, transformations, or custom data manipulations.
You can reuse a UDx several times. A function always returns a value explicitly by specifying an expression. It is a good choice to calculate and return a value. You can use UDFs to extend built-in functions or to encapsulate calculations that are standard for your organization. UDFs you create can be called in a way similar to built-in functions.
In the present OTCAD release, you write a UDF’s logic (it's handler) – in python.
About UDx
You can view and manage UDx. After logging in to OTCAD, the home page appears. Select the More options button and UDx. The User-defined extensions page appears with the Functions and UDx jobs tabs.
The Functions tab lists the functions that are available in the system. The following columns are displayed:
- Schema name - The name of the schema.
- Function name - The name of the function.
- Language - The language in which the function is developed. For e.g, Python.
- Library - The name of the library to which the UDx is associated.
- Created by - The user ID of the person who created the function.
- Actions - Option to delete the function.
The UDx jobs tab lists the UDx along with the status that are available in the system. The following columns are displayed:
- Library - The name of the library containing the UDx.
- Language - The language in which the library is developed. For e.g, Python.
- Functions - The number of functions associated with the UDx.
- Created by -The user ID of the person who created the library.
- Creation date - The date and time of creation of the library.
- Status - The present status of the UDx job.
- Details - Details about the UDx in the system.
Create a library
To create a library, do the following in the User-defined extensions page:
-
Select +Add new.
The Create a library page appears.
-
In the Library name field, enter the name of the library.
-
In the Schema list, choose the required schema.
-
In the Language list, choose the required language. For e.g, Python.
-
In the File name field, enter the name of the python file.
Note
Ensure that the class names are present in the python file and this file is available in the .zip file.
-
Select Browse and choose the zip file that contains the python file you selected in the previous step.
Note
You can upload only .zip files. The maximum file size allowed is 300 MB. Ensure that the python file is available immediately in the root folder. For example, root/my_file.py. Uploaded files are quarantined for antivirus scanning. If no threats are found, OTCAD creates the function.
Note
The uploading party is solely responsible for any code or content they submit. OpenText does not review or endorse uploads and assumes no liability for them. By uploading, users acknowledge and accept full responsibility for any consequences that may arise.
-
In the Function area, for the Name field, enter the name of the function.
Note
Only UDSF functions are supported in this release.
For more information about UDSF, see Scalar functions (UDSFs).
-
In the Function area, for the Define class field, enter the name of the class that is defined in the python file selected in step 5. For e.g, MultiplyAndSumFactory.
-
Click +Add new function to add another function.
The newly added functions appear in the UDx jobs tab.
Note
You need to have super user privilege to create the library.
-
Click Create.
The library is created and displayed in the UDx Jobs tab of the User-defined extensions page.
Delete a function
You can delete functions that are no longer used or needed.
- In the User defined extensions page, select ⋮ in the Action column.
- Select Delete.
Note
Deleting a function removes it from the database. However, references to the function are not deleted. For example, SQL query.
- In the Confirmation dialog, select Delete.
4 - Overview of Integrations
This topic provides an overview of third party integrations in OTCAD.
OTCAD integrates with third party applications. This topic provides information about OTCAD integration with third party applications.
4.1 - Integrations
This topic provides an overview of OTCAD integration with third party applications.
OTCAD is a cloud solution that enhances the speed and scalability of an "OpenText™ Analytics Database without the need to manage hardware. Use OTCAD to build databases securely and scale them to large amounts of data in the cloud.
Integrations
When you log in to the application, the More options button is displayed.
- Expand More options.
- Select Integrations.
The Integrations page displays. OTCAD supports machine learning with VerticaPy for data science and AI-driven data science applications. It also supports the following third-party applications:
- For each third-party application, select View Docs to view the Connection guide.
5 - Overview of Dashboards
This topic provides an overview of dashboards in OTCAD.
Dashboards identify system bottlenecks on specific clusters and improve the performance of the system.
5.1 - Dashboards
This topic provides an overview of dashboards in OTCAD.
Dashboards
Dashboards enable you to view health metrics for your database.
Dashboards UI tour
You can view and manage dashboards. After signing in to the OTCAD application, the home page appears. Select the More options button and Dashboard. The Dashboard page appears as shown in this image:

The dashboard displays key metrics and events, including details about long-running queries, average query execution time, and memory-intensive queries.
This page displays the following information:
|
Option |
Description |
|
a |
More options: Select this option to view the More menu options. |
|
b |
Dashboard: View the dashboards in OTCAD by different criteria. |
|
c |
Active users: This card displays the total number of users who are active over the last 24 hours. Select > to view the list of active users. For more information about active users, see Active users. |
|
d |
Data storage: This card displays the aggregate data storage in the database from the first day of the current month till date. |
|
e |
Query overview: This card displays the total count of queries that completed and the queries that failed to execute over the last 24 hours. |
|
f |
Cluster performance: This card displays information about the overall cluster performance. It provides information about average CPU usage, average memory usage, and disk I/O usage over the last 24 hours.
- Select Average CPU usage to view the CPU percentage used by the database server across the primary cluster over the last 24 hours.
Select > to view the average CPU usage and maximum CPU usage over a duration of time. For more information about CPU usage, see CPU usage.
- Select Average Memory usage to view the memory percentage usage information over the last 24 hours.
Select > to view the average memory usage and maximum usage over a duration of time. For more information about average memory usage, see Memory usage.
- Select Disk I/O usage to view the percentage of time a disk is actively engaged in processing I/O requests over the last 24 hours.
Select > to view the average disk I/O usage and maximum usage over a duration of time. For more information about average disk I/O usage, see Disk I/O usage.
|
|
g |
Query insights: This card displays information about open sessions, queued queries, memory intensive queries, and long running queries.
- Select Open sessions to view information about the top 5 sessions that are active over the last 1 hour. Select > to view all the sessions that are active over the last 1 hour. For more information about open sessions, see Sessions.
- Select Queued queries to view information about the top 5 queries in the queue over the last 1 hour. Select > to view all the queries in the queue over the last 1 hour. For more information about queued queries, see Queued queries.
- Select Memory intensive queries to view information about the top 5 queries that consume more than 25% memory over the last 24 hours. Select > to view information about all queries that consume more than 25% memory over the last 24 hours. For more information about memory intensive queries, see Memory intensive queries.
- Select Long running queries to view information about the top 5 queries that took more than 10 minutes to execute over the last 24 hours. Select > to view information about all the queries that took more than 10 minutes to execute over the last 24 hours. For more information about long running queries, see Queries by duration.
|
Expand Cluster performance in the Dashboard page. The following dashboards are displayed:
- CPU usage - The Average CPU Usage card displays information about the average cluster CPU usage trends in the system over a time duration. The Maximum Usage card displays information about the maximum CPU usage over a duration of time. Identify CPU usage and address system bottlenecks proactively.
In the Visualization tab, do the following:
-
In the Duration list, do one of the following:
- Choose the time duration in minutes, hours, or days to visualize the CPU usage history.
<--or-->
- Choose Custom. From the date pickers, select the start date and end date. Ensure that the start date does not exceed the end date by more than 30 days.
-
In the View list, choose one of the values: Average, Minimum, or Maximum. Choose Average to view the average CPU usage for every minute over the selected duration of time. Choose Minimum to view the minimum CPU usage for every minute over the selected duration of time. Choose Maximum to view the maximum CPU usage for every minute over the selected duration of time.
-
In the List view tab, information about the minute-wise time, average CPU usage, maximum CPU usage, and minimum CPU usage is displayed over the selected duration. Choose the Download button to export this information in a spreadsheet.
- Memory usage - The Average Memory Usage card displays information about the average memory usage trends in the system over the selected duration. The Maximum Usage card displays information about the maximum memory usage over the selected duration of time. This helps you compare memory that OTCAD uses versus memory in use by the entire system.
In the Visualization tab, do the following:
-
In the Duration list, do one of the following:
- Choose the time duration in minutes, hours, or days to visualize the memory usage.
<--or-->
- Choose Custom. From the date pickers, select the start date and end date for which you need to visualize the memory usage. Ensure that the start date does not exceed the end date by more than 30 days.
-
In the View list, choose one of the values: Average, Minimum, or Maximum. Choose Average to view the average memory usage for every minute over the selected duration. Choose Minimum to view the minimum memory usage for every minute over the selected duration of time. Choose Maximum to view the maximum memory usage for every minute over the selected duration of time.
-
In the List view tab, information about the minute-wise time, average memory usage, maximum memory usage, and minimum memory usage is displayed over the selected duration. Choose the Download button to export this information in a spreadsheet.
- Disk I/O usage - The Disk I/O Usage card displays information about the disk I/O usage in the system over the selected duration. Identify and address disk I/O bottlenecks for resource optimization, capacity planning, and so on. The Maximum Usage card displays information about the maximum disk I/O usage over the selected duration.
In the Visualization tab, do the following:
-
In the Duration list, do one of the following:
- Choose the time duration in minutes, hours, or days to visualize the disk I/O usage.
<--or-->
- Choose Custom. From the date pickers, select the start date and end date for which you need to visualize the disk I/O usage. Ensure that the start date does not exceed the end date by more than 30 days.
-
In the View list, choose one of the values: Average, Minimum, or Maximum. Choose Average to view the average disk I/O usage for every minute over the selected duration. Choose Minimum to view the minimum disk I/O usage for every minute over the selected duration of time. Choose Maximum to view the maximum disk I/O usage for every minute over the selected duration.
-
In the List view tab, information about the minute-wise time, average disk I/O usage, maximum disk I/O usage, and minimum disk I/O usage is displayed over the selected duration of time. Choose the Download button to export this information in a spreadsheet.
- Scaling activity - View the utilization of additional compute units over the last 24 hours. Use this metric to identify and analyze the potential cost impact due to scaling. The Current Scale Instance card displays information about the current compute units in the system over the selected duration of time. The Maximum Scale card displays information about the maximum compute units over the selected duration of time.
In the Visualization tab, do the following:
-
In the Duration list, do one of the following:
- Choose the time duration in minutes, hours, or days to visualize the scaling activity.
<--or-->
- Choose Custom. From the date pickers, select the start date and end date for which you need to visualize the scaling activity. You can select a start date that is more than one month prior to the end date.
-
In the List view tab, information about the date and time, scale event, compute (units), trigger, and user ID of the person who performed the scaling is displayed. Choose Download to export this information in a spreadsheet.
Query insights
Expand Query insights in the Dashboards page. The following dashboards are displayed:
-
Queries by duration - Analyze the count of queries that executed over the last 24 hours. Slow-running queries hinder overall database efficiency. Analyze the count of queries in the given interval by execution time. This dashboard displays only those queries that took more than 10 minutes to execute over the last 24 hours.
In the List view tab, information about the query, duration, and average memory usage is displayed. Choose Download to export this information in a spreadsheet. Hover over the query results to view the details of the query. Select the Copy icon to copy the query to the clipboard.
-
Queries by memory usage - Analyze the count of queries over the last 24 hours by memory consumption. When a query uses a large share of memory, it can hinder the execution of other simultaneous queries by restricting access to shared resources.
In the List view tab, information about the query ID, average memory usage, and duration is displayed. Choose Download to export this information in a spreadsheet. Hover over the query results to view the details of the query. Select the Copy icon to copy the query to the clipboard.
-
Queries in queue - Identify queries awaiting allocation of system resources in the last 1 hour.
In the List view tab, information about the initiation time, query ID, and time in queue is displayed. Choose Download to export this information in a spreadsheet. Hover over the query results to view the details of the query. Select the Copy icon to copy the query to the clipboard.
System metrics
Expand System metrics in the Dashboards page. The following dashboards are displayed:
-
Sessions - Identify the total sessions over the last 1 hour to understand the database performance, identify bottlenecks, and optimize resource utilization.
In the List view tab, information about the session time, session type, session duration, client type, and user name is displayed. Choose Download to export this information in a spreadsheet.
-
Active users - Identify active users logged into the database over the last 24 hours.
In the List view tab, information about the user name, super user, roles, and last login time is displayed. Choose Download to export this information in a spreadsheet.