Generic - Database extractor (Java)
Use the Generic - Database extractor (Java) ETL to collect configuration and performance data from your database using SQL query.
Collecting data by using the Generic - Database (Java) ETL
To collect data by using the Generic - Database (Java) ETL, do the following tasks:
I. Complete the preconfiguration tasks.
II. Configure the ETL.
III. Run the ETL.
- Ensure that you can reach your database server from the ETL engine machine by running the
ping <your_db_server_ip>
command - Ensure that you can remotely access your database server using telnet from the ETL engine machine, by running the
telnet <your_db_server_ip> <your_db_server_port>
command - Connect to your database using a software client
- If the username is part of a Windows domain, verify that the username is specified in the YOURDOMAIN\username format. Verify that your settings match to the settings that are used to connect to the same database with a software client.
You must configure the ETL to connect to the generic database for data collection. ETL configuration includes specifying the basic and optional advanced properties. While configuring the basic properties is sufficient, you can optionally configure the advanced properties for additional customization.
A. Configuring the basic properties
Some of the basic properties display default values. You can modify these values if required.
To configure the basic properties:
- In the Helix Capacity Optimization Console, navigate to Administration > ETL & System Tasks > and select ETL tasks.
- On the ETL tasks page, click Add > Add ETL under the Last run tab. The Add ETL page displays the configuration properties. You must configure properties in the following tabs: Run configuration, Entity catalog, SQL query, and Connection parameters.
- On the Run configuration tab, select Generic - Database Extractor (Java). The name of the ETL is displayed in the ETL task name field. You can edit this field to customize the name.
Click the Entity catalog tab, and select one of the following options:
Shared Entity Catalog: Select if the other ETLs access the same entities that are used by this ETL.
- From the Sharing with Entity Catalog list, select an entity catalog name that is shared between ETLs.
- Private Entity Catalog: Select if you want to use this ETL independently.
On the SQL query tab, build the SQL extraction query.
SQL query hints: Provides hints for including the mandatory and optional parameters in the SQL extraction query.
SQL query: Specify the SQL extraction query. You can select the required parameter and operator from the list and add them to the text area. This tab is only available when a custom database query has to be built in order to get the data from a generic source. The query must be formatted using the format supported by the database extractor. Do not add comments in the SQL query. Commenting is based on line formatting, and it is not maintained when the query is stored and then executed from the database.
SQL parameters number: Select the number of custom parameters that you need to add to the query. You can add up to 10 custom parameters to the query.
Click the Connection parameters tab, and configure the following properties:
Property Description Datasource type Select one of the following options: - Select existing datasource:
- Datasource: From the Datasource list, select a datasource.
- Custom datasource:
Database type: Select a database type from the drop down list.
- Oracle
- Oracle Advanced
- Microsoft SQL Server
- Microsoft SQL Server (JTDS)
- Other database
Database user: Type the user name to connect to the database.
Database password: Type the user name to connect to the database.
JDBC driver: Based on your database type selection, the JDBC driver information gets displayed.
For example:
- Oracle -
oracle.jdbc.driver.OracleDriver
- Oracle Advanced -
oracle.jdbc.driver.OracleDriver
- Microsoft SQL Server -
com.microsoft.sqlserver.jdbc.SQLServerDriver
- Microsoft SQL Server (JTDS) -
net.sourceforge.jtds.jdbc.Driver
- Other database - Specify the value. For example, for DB2 database, the value can be specified as
com.ibm.db2.jcc.DB2Driver
Note: Ensure that the JDBC driver file (.jar file) is stored in the <Installation_directory_of_Capacity_Optimization>/etl/libext directory on the ETL server that runs the ETL task.
- Oracle -
- Host name: Specify the host name.
- Port: Specify the port number.
- Service name (Applicable to Oracle): Specify the service name.
- Database name (Applicable to Microsoft SQL Server and Microsoft SQL Server(JTDS)): Specify the database name.
- Domain name (Applicable to Microsoft SQL Server(JTDS)): Specify the domain name.
- Connection URL (Applicable to Oracle Advanced and Other database): Enter the connection URL. If you select Other database in the Database type property, then you must type a value. For example, for DB2 database, the value can be specified as
jdbc:db2://<host>[:<port>]/<database_name>
The following image shows the basic properties configuration.- Select existing datasource:
(Optional) Override the default values of properties in the following tabs:
- Click Save.
The ETL tasks page shows the details of the newly configured Generic - Database (Java) ETL.
(Optional) B. Configuring the advanced properties
You can configure the advanced properties to change the way the ETL works.
To configure the advanced properties:
- On the Add ETL page, click Advanced.
Configure the following properties:
Click Save.
The ETL tasks page shows the details of the newly configured Generic - Database (Java) ETL.
After you configure the ETL, you can run it to collect data. You can run the ETL in the following modes:
A. Simulation mode: Only validates connection to the data source, does not collect data. Use this mode when you want to run the ETL for the first time or after you make any changes to the ETL configuration.
B. Production mode: Collects data from the data source.
A. To run the ETL in the simulation mode
To run the ETL in the simulation mode:
- Navigate to Administration > ETL & System Tasks, and select ETL tasks.
- On the ETL tasks page, click the ETL. The ETL details are displayed.
- In the Run configurations table, click Edit to modify the ETL configuration settings.
- On the Run configuration tab, ensure that the Execute in simulation mode option is set to Yes, and click Save.
- Click Run active configuration. A confirmation message about the ETL run job submission is displayed.
- On the ETL tasks page, check the ETL run status in the Last exit column.
OK Indicates that the ETL ran without any error. You are ready to run the ETL in the production mode. - If the ETL run status is Warning, Error, or Failed:
- On the ETL tasks page, clickin the last column of the ETL name row.
- Check the log and reconfigure the ETL if required.
- Run the ETL again.
- Repeat these steps until the ETL run status changes to OK.
B. To run the ETL in the production mode
You can run the ETL manually when required or schedule it to run at a specified time.
To run the ETL manually
- On the ETL tasks page, click the ETL. The ETL details are displayed.
- In the Run configurations table, click Edit to modify the ETL configuration settings. The Edit run configuration page is displayed.
- On the Run configuration tab, select No for the Execute in simulation mode option, and click Save.
- To run the ETL immediately, click Run active configuration. A confirmation message about the ETL run job submission is displayed.
When the ETL runs, it collects data from the source and transfers it to the BMC Helix Continuous Optimization database.
To schedule the ETL run in the production mode
By default, the ETL is scheduled to run daily. You can customize this schedule by changing the frequency and period of running the ETL.
To configure the ETL run schedule:
- On the ETL tasks page, click the ETL, and click Edit task. The ETL details are displayed.
On the Edit task page, do the following, and click Save:
- Specify a unique name and description for the ETL task.
- In the Maximum execution time before warning field, specify the duration for which the ETL must run before generating warnings or alerts, if any.
- Select a predefined or custom frequency for starting the ETL run. The default selection is Predefined.
- Select the task group and the scheduler to which you want to assign the ETL task.
Click Schedule. A message confirming the scheduling job submission is displayed.
When the ETL runs as scheduled, it collects data from the source and transfers it to the BMC Helix Continuous Optimization database.
Verify that the ETL ran successfully and check whether the Generic Database (Java) data is refreshed in the Workspace.
To verify whether the ETL ran successfully
- Click Administration > ETL and System Tasks > ETL tasks.
- In the Last exec time column corresponding to the ETL name, verify that the current date and time are displayed.
- In the Last exit column corresponding to the ETL name, verify that the status is OK.
In case of WARNING or ERROR, click in the last column of the ETL name row to review the log files.
To verify that the Generic Database data is refreshed:
- In the Helix Capacity Optimization Console, click Workspace.
- Expand Generic - Database extractor (Java) > Systems.
- In the left pane, verify that the hierarchy displays the database instances.
- Click an instance, and click the Metrics tab in the right pane.
- Check if the Last Activity column in the Configuration metrics and Performance metrics tables displays the current date.
The following image shows sample metrics data.
Comments
Log in or register to comment.