data_engine AC GUI Reference

The configuration information and options are available through the Admin Console data_engine Configuration GUI. The navigation pane organizes data_engine configuration into the following nodes:
uimpga-ga
The configuration information and options are available through the Admin Console data_engine Configuration GUI. The navigation pane organizes data_engine configuration into the following nodes:
 
 
To access the data_engine configuration interface, select the robot that the data_engine probe resides on in the Admin Console navigation pane. In the Probes list, click the arrow to the left of the probe and select 
Configure
.
You can view the default settings for all fields in the data_engine.cfx file in the system files: for example, under <UIM_install>\Nimsoft\probes\slm\data_engine.
data_engine
 
Navigation:
 data_engine
This section lets you view probe and QoS information, change the log level, and set data management values.
Probe Information
This section provides the basic probe information and is read-only.
General Setup Configuration
This section provides general configuration details.
  •  
    Log Level:
     Sets the amount of detail that is logged to the log file.
  •  
    Data Management default values:
     The default settings for data maintenance. These settings apply to all QoS settings unless they have been individually overwritten in the Quality of Service settings.
  •  
    Compress data before delete:
     If selected, then by default, data from the raw (RN) tables is summarized into the Hourly (HN) tables, and then deleted from the raw tables. In addition, the data from the Hourly (HN) tables is summarized into Daily (DN) tables, and then deleted from the Hourly tables. This is only completed before a delete is performed.
  •  
    Delete raw data older than:
     Raw data older than the indicated number of days is deleted.
  •  
    Delete historic data older than
    : Hourly table data older than the indicated number of days is deleted.
  •  
    Delete daily average data older than:
     Daily table data older than the indicated number of days is deleted.
     Do not enter a zero for delete raw, historic, or daily average data–this means the data is never deleted.
  •  
    Actions > QoS Status:
     Click the button located on the right side of the page to display a table populated with the QoS status data. This table is read-only
Quality of Service Type Status
Click 
Actions > QoS Status
 (located on the right side of the page) to display a table populated with the QoS status data. This table is read-only.
 The status information is created based on statistics that are generated by the database provider. If incorrect information is displayed, you might need to update the table statistics. For more information, see the "Out-of-date Information in the Quality of Service Type Status Table" section in the Troubleshooting article for more details. 
Database Configuration
 The database connection properties should only be changed in limited circumstances such as recovery operations. Changing the Database Vendor can cause connection issues. If you are changing database vendors, CA recommends reinstalling CA UIM.
The Database Configuration section allows you to specify the database connection settings. These settings are different for each database vendor (MySQL, MS SQL Server, and Oracle).
To test the connection for all vendors, select 
Actions
>
Test Connection
 at the top of the page.
MySQL 5.6
 
Navigation:
 data_engine > Database configuration > MySQL
This section lets you configure the connection options for a MySQL database.
  •  
    Schema:
     The database schema name.
  •  
    Server Host:
     The database server name or IP address.
  •  
    Port:
     The port number to connect to the database server. The default port number is 3306.
  •  
    Username:
     The login user name.
  •  
    Password:
     The login user password.
 The password cannot have any special characters, such as ";".
  •  
    Partition Data Tables:
     Select this check box to perform partitioning on the raw sample data tables.
Microsoft SQL Server
The following limitations are applicable for the Standard Edition of Microsoft SQL Server:
  • Table partitioning is not supported in the Standard Edition of Microsoft SQL Server. Therefore, the data maintenance jobs and the index maintenance jobs, which are scheduled from the data_engine probe UI, will not be effective because of the unsupported version.
  • During the scheduled data maintenance job, the data is deleted in batches based on the values set in the data_engine configuration file. Ensure that enough space is available on the drive where the transaction log file is located to avoid space issues.
  • During the table maintenance and the index maintenance, you must use the offline option in the data_engine UI before scheduling the index maintenance. The online index maintenance is not supported in the Standard Edition of Microsoft SQL Server.
 
Navigation:
 data_engine > Database configuration > Microsoft
When selecting options, use the following table to determine the appropriate settings for your environment. Go here for up to date information about the features supported for each edition of Microsoft SQL Server.
Edition
Partition Data Tables
Index Maintenance
Index Maintenance Mode
Mode for Index Maintenance
SQL Server Enterprise 2008 and 2012 Edition
Online or offline
Supported♦
 
Dynamic
 - select dynamic when you're not sure which edition of SQL Server is used in your environment, or you want data_engine to choose the 
reorganize
 or 
rebuild
 mode based on the Fragmentation Level threshold settings.
 
Reorganize
 - a 
partition
 or an entire 
index for a table
 can be reorganized 
online
 or 
offline
 when the Partition Data Table option is selected.
 
Rebuild
 - only an entire 
index for a 
 
table
 can be rebuilt 
online
 (this process can take some time), but a 
partition
 or an entire 
index for a 
 
table
 can be rebuilt 
offline
 when the Partition Data Table option is selected.
Online or offline
SQL Server Enterprise 2014 Edition
Online or offline
Supported♦
 
Dynamic
 - select dynamic when you're not sure which edition of SQL Server is used in your environment, or you want data_engine to choose the 
reorganize
 or 
rebuild
 mode based on the Fragmentation Level threshold settings.
 
Reorganize
 - a 
partition
 or an entire 
index for a table
 can be reorganized 
online
 or 
offline
 when the Partition Data Table option is selected.
 
Rebuild
 - a 
partition
 or an entire 
index for a table
 can be rebuilt 
online
 or 
offline
 (this process can take some time) when the Partition Data Table option is selected.
Online or offline
SQL Server 2014 Standard Edition and earlier
Offline
Supported♦
 
Dynamic 
 - select dynamic when you're not sure which edition of SQL Server is used in your environment, or you want data_engine to choose the 
reorganize
 or 
rebuild
 mode based on the Fragmentation Level threshold settings.
 
Reorganize
 - only an 
 
 
index for a 
 
table
 can be rebuilt 
offline
 when the Partition Data Table option is selected.
 
Rebuild
 - only an 
index for a 
 
table
 can be rebuilt 
offline
 when the Partition Data Table option is selected.
Offline
SQL Server Express Edition
Not supported
♦ Index Maintenance in not recommended for large tables (over 10 GB).
This section lets you configure the connection and maintenance options for a Microsoft SQL Server database.
  •  
    Provider:
     The SQL server provider.
  •  
    Initial Catalog:
     The database name.
  •  
    Data Source:
     The database server.
  •  
    User ID:
     The login user.
  •  
    Password:
     The login user password.
     The password cannot have any special characters, such as ";".
  •  
    Parameters:
     Other parameters for the OLEDB connection.
  •  
    Partition Data Tables:
     Select this check box to perform partitioning on the raw sample data tables.
    For SQL Server 2014 databases, and prior versions, if you select this option set maintenance mode to reorganize.
     This option is not available in the Microsoft SQL Express edition.
  •  
    Index Maintenance:
     Perform table re-indexing with other maintenance routines, which by default are executed every 24 hours.
     On very large tables (over 10 GB), running index maintenance may not complete in a reasonable amount of time.
  •  
    Compression mode:
     The method that is used for data compression:
    •  
      None:
       No compression occurs.
    •  
      Page:
       Optimizes storage of multiple rows in a page, a super-set of row compression.
    •  
      Row:
       Stores fixed-length data types in variable-length storage format.
  •  
    Maintenance mode:
     How the indexes are maintained:
    •  
      Dynamic:
       Maintenance is performed based on the index statistics.
    •  
      Reorganize:
       Maintenance is performed using the "alter index ... reorganize" SQL Server script.
    •  
      Rebuild:
       Maintenance is performed using the "alter index ... rebuild" SQL Server script.
  •  
    Online mode:
     The effect of maintenance on concurrent use of the QoS tables:
    •  
      Dynamic:
       The maintenance is determined by the edition of SQL Server. If you're using SQL Server Enterprise Edition, then Online mode is used for maintenance (if the chosen maintenance mode supports it); otherwise, Offline mode is used.
    •  
      Online:
       The QoS tables are available for update and query during the data maintenance period. Online mode offers greater concurrency but demands more resources. Choosing "Rebuild" above, and "Online" here requires SQL Server Enterprise Edition (SQL Server Standard Edition and earlier do not support online index rebuilding).
    •  
      Offline:
       The QoS tables are unavailable for update and query during the data maintenance period. Benign alarms may be generated about failures to insert QoS data during the maintenance period, but the data will be re-inserted by data_engine at a later time when the tables are once again made available for update.
  •  
    Fragmentation level:
     Low threshold: If the fragmentation for an index is less than the low threshold percent value, then no maintenance is performed.
  •  
    Fragmentation level:
     High threshold: If dynamic maintenance mode is selected and fragmentation is between the low and high threshold percentages, then the Reorganize mode is used; otherwise the Rebuild mode is used.
  •  
    Index name pattern
    : The indexes that are maintained. The default is Blank (a blank entry results in all indexes being considered for maintenance).
  •  
    Enable TLS
    : Select the option to enable TLS v1.2 in CA UIM, which lets the UIM Server to establish a secure communication with Microsoft SQL Server (UIM database). For more information about TLS v1.2 support, see Support for TLS v1.2 (Microsoft SQL Server).
     Ensure that the ppm probe version is 3.48 and the robot version is 7.96 to display TLS v1.2 configuration options in Admin Console.
  •  
    Always Trust Server Certificate
    : Select the option to allow the system to trust the server certificate. If you select this option, you do not need to provide the TrustStore file location and associated password.
  •  
    Trust Store File (.jks)
    : Browse to the location where you have created the source .jks file. This file includes your database server security certificate. You can use keytool to create your source .jks file. For more information about how to create the source .jks file using keytool, see "Create Java KeyStore (.jks File) for Server Certificate" in Support for TLS v1.2 (Microsoft SQL Server). For additional information about keytool, see keytool - Key and Certificate Management Tool.When you click 
    Apply
     or 
    OK
     after providing the TrustStore file and password information, the data_engine probe copies the source .jks file and places it in the
    <uim>\Nimsoft\security
    folder as truststore.jks. The
    <uim>\Nimsoft\security
    location is then displayed in the 
    Trust Store File (.jks)
     field.
    Additionally, see the "Additional Information" section in Support for TLS v1.2 (Microsoft SQL Server) to review the steps that are required to enable TLS v1.2 in upgrade scenarios and in situations where you want to enable TLS v1.2 support after the UIM Server installation.
  •  
    Trust Store Password
    : Specify the password to access the source .jks file.
     When you click the 
    Test Connection
     option, CA UIM does not verify the validity of the specified .jks file. Instead, it verifies the validity of the certificate that you have imported into the Microsoft Management Console (MMC) on the UIM Server.
The following screenshot shows all the options, including TLS v1.2 options (
Enable TLS
Trust Store File (.jks)
TrustStore Password
Always Trust Server Certificate
):
  SQL_Server_AC_TLS_Options.jpg  
Oracle
 
Navigation:
 data_engine > Database configuration > Oracle
This section lets you configure the connection and database maintenance options for an Oracle database.
  •  
    Hostname:
     The database server name or IP address
  •  
    Port:
     The port number to connect to the database server
  •  
    Username:
     The login user name
  •  
    Password:
     The login user password.
 The password cannot have any special characters, such as ";".
  •  
    Service Name:
     The Oracle SID or Service name.
  •  
    Partition Data Tables:
     Select this check box to perform partitioning on the raw sample data tables.
  •  
    Index Maintenance:
     Perform table re-indexing with other maintenance routines, which by default are executed every 24 hours.
  •  
    Online mode:
     The effect of maintenance on concurrent use of the QoS tables:
    •  
      Dynamic:
       The maintenance is determined by the edition of Oracle. If Oracle is the Enterprise Edition, then Online mode is used for maintenance; otherwise, Offline mode is used.
    •  
      Online:
       The QoS tables are available for update and query during the data maintenance period. Online mode offers greater concurrency but demands more resources.
    •  
      Offline:
       The QoS tables are unavailable for update and query during the data maintenance period.
  •  
    Fragmentation Level (%):
     The percentage of fragmentation required before index maintenance is performed.
  •  
    Enable TLS
    : Select the option to enable TLS v1.2 in CA UIM, which lets the UIM Server to establish a secure communication with Oracle (UIM database). For more information about TLS v1.2 support, see Support for TLS v1.2 (Oracle).
     Ensure that the ppm probe version is 3.48 and the robot version is 7.96 to display TLS v1.2 configuration options in Admin Console.
  •  
    Wallet Location
    : Specify the location of the client wallet where your trusted security certificates are available. This location includes your trusted security certificates. data_engine copies the required wallet files from this location and places them in the 
    <uim>\Nimsoft\security
     folder. For more information about how to work with certificates using wallets, see Support for TLS v1.2 (Oracle).
    Additionally, see the "Additional Information" section in Support for TLS v1.2 (Oracle) to review the steps that are required to enable TLS v1.2 in upgrade scenarios and in situations where you want to enable TLS v1.2 support after the UIM Server installation.
  •  
    Wallet Type
    : Select the wallet type from the drop-down list. The selected wallet type takes the precedence. Note that both SSO and PKCS12 are copied to the UIM Server (
    <uim>\Nimsoft\security
    ) irrespective of the wallet type you select.
  •  
    Wallet Password
    : Specify the password to access the wallet information.
    You need not specify the password if the wallet type is SSO.
  •  
    Need Client Authentication
    : Select the option to specify whether you want to enable client authentication.
The following screenshot shows all the configuration options, including TLS v1.2 options (
Enable TLS
Wallet Type, 
 
Wallet Location
,
 
Wallet Password
Need Client Authentication
):
Oracle_TLS options.jpg  
Quality of Service
 
Navigation:
 data_engine > Quality of Service
The Quality of Service section displays the attributes for the QoS metrics.
  •  
    Name:
     The QoS type name.
  •  
    Description:
     Description of the QoS type.
  •  
    QoS Group:
     The QoS group is a logical group to which the QoS belongs (optional).
  •  
    Unit:
     The unit of the QoS data (the abbreviated form of the QoS data unit).
  •  
    Has Max Value:
     The data type has an absolute maximum. For example, disk size or memory usage have absolute maximums.
  •  
    Is Boolean:
     The data type is logical (yes/no). For example, a host is available/unavailable or printer is up/down.
  •  
    Type:
     Different data types:
    • 0 = Automatic (The sample value is read at fixed intervals, which are set individually for each probe).
    • 1 = Asynchronous (The sample value is read only when the value changes, and the new value is read).
  •  
    Override Raw Age:
     Select this check box to override the raw age of the QoS metric.
  •  
    Raw Age:
     The number of days you want to retain the QoS metric information.
  •  
    Override History Age:
     Select this check box to override the history age for the QoS metric.
  •  
    History Age:
     The number of days you want to retain the history information.
  •  
    Override Daily Average Age:
     Select this check box to override the daily average age for the QoS metric.
  •  
    Daily Average Age:
     The number of days you want to retain the daily average information.
  •  
    Override Compression:
     Select this check box to override compression settings for data in RN and HN tables.
  •  
    Compress:
     Raw data is summarized and aggregated into Hourly (or historic) data before it is deleted from the RN tables. This Hourly data is then summarized and aggregated into Daily data before it is deleted from the HN tables.
Scheduler
 
Navigation:
 data_engine > Scheduler
This section allows you to schedule database maintenance.
  •  
    Start time
     - Select Now or a specific date and time. Selecting now begins the new database maintenance schedule immediately.
  •  
    Ending
     - Select Never, After x occurrences, or By a specific date and time.
  •  
    Recurring
     - select one of the following occurrence patterns:
    • Minutely
    • Hourly
    • Daily (including a specific time)
    • Weekly (including a specific time and days of the week)
    • Monthly (including pattern, occurrence, calendar day, and specific time)
    • Yearly (including pattern, month and specific time)