Running the Dataset Extractor tool

Describes how to run the extractor tool.

Before you begin

Check for the following:
  • The tnpmDatasetExtractor.properties file is updated according to your requirements.
  • The stylesheet JSP files are present or copied to stylesheetsDirectory path that is provided in the properties file.
  • Java path is set correctly.
    Important: Ensure that you are using IBM Java 1.7 or 1.8.

    For example: export PATH=/opt/IBM/java/ibm-java-i386-70/jre/bin:$PATH

  • Jazz™ for Service Management server is up and running.
  • Tivoli® Netcool® Performance Manager Data Provider is installed on Jazz for Service Management.

Procedure

  1. Run the tnpmDatasetExtractor.sh script as follows:
    cd <TEMP_DIR>/Dataset_Extractor/bin 
    ./tnpmDatasetExtractor.sh -file ../resources/tnpmDatasetExtractor.properties
  2. Select the option 1 to generate the metadata at the prompt:
    Press "1" to genereate the Dataprovider metadata, "2" to validate the 
    Dataprovider metadata repository xml
  3. Enter the database password.
    The metadata is extracted into an XML file and the output of the extraction process is as follows:
    [root@apmklz2 bin]# ./tnpmDatasetExtractor.sh -file  ../resources/tnpmDatasetExtractor.properties
    Press "1" to generate the Dataprovider metadata, 
    "2" to validate the Dataprovider metadata repository xml
    1
    Please enter the Database[10.212.6.83] Password
    =====================Configuration Parameters=====================
    GYMCP1006I: Database name:db2
    GYMCP1005I: Database server name: 10.212.6.83
    GYMCP1007I: Database port:60000
    GYMCP1008I: Database schema:QA
    GYMCP1009I: Database user name:PV_ADMIN
    GYMCP1010I: Datasource Id: DataProviderk2
    GYMCP1011I: Dataprovider datasource config location:
    /opt/IBM/JazzSM/profile/installedApps/JazzSMNode01Cell/isc.ear/legacyDataview.war/WEB-INF/resources/
    GYMCP1012I: Dataprovider datasource properties location:/opt/IBM/JazzSM/profile/installedApps/
    JazzSMNode01Cell/isc.ear/legacyDataview.war/WEB-INF/resources/properties
    GYMCP1013I: Stylesheets entries:
    /opt/IBM/JazzSM/products/tnpm/dataview/misc/Dataset_Extractor/resources/apmklz2.txt
    GYMCP1014I: Stylesheets directory location:
    /opt/IBM/JazzSM/profile/installedApps/JazzSMNode01Cell/isc.ear/legacyDataview.war/SilverStream/Pages/
    GYMCP1021I: Reading stylesheets from 
    /opt/IBM/JazzSM/products/tnpm/dataview/misc/Dataset_Extractor/resources/apmklz2.txt
    GYMCP1000I: Caching reporter details.
    GYMCP1020I: Tool running for stylesheets PVLs1ChartDrilldown.jsp,PVLsRatio_MLH_RST.jsp,
    PVLsRatio_ResourcePlanningTable.jsp,PVLsResDistrib_Ratio_MLH_RST.jsp,
    PVLs_AP_2GroupSummary_w_4ResDistrib.jsp,
    PVLs_AP_3ResSummary_w_NoCharts.jsp,PVLs_AP_8ResTimeSeries.jsp,
    PVLs_AP_8ResTimeSeries_w_Ratio.jsp,PVLs_AP_9ResTimeSeries.jsp,PVLs_AP_Baseline.jsp,
    PVLs_AP_Dashboard.jsp,PVLs_AP_Dashboard_Env.jsp,PVLs_AP_Dashboard_Health.jsp,
    PVLs_AP_Dashboard_RV_MIB2.jsp,PVLs_AP_Dashboard_Ratio.jsp,PVLs_AP_GroupSummary_w_2GTS.jsp,
    PVLs_AP_GroupSummary_w_2Ratio.jsp,PVLs_AP_GroupSummary_w_2ResDistrib.jsp,
    PVLs_AP_RankVariation.jsp,PVLs_AP_RankVariation_TopN.jsp,PVLs_AP_ResSummary2_w_2ResDistrib.jsp,
    PVLs_AP_ResSummary_w_2GTS.jsp,PVLs_AP_ResSummary_w_2Ratio.jsp,
    PVLs_AP_ResSummary_w_2ResDistrib.jsp,PVLs_AP_ResSummary_w_GTS.jsp,PVLs_AP_ResSummary_w_Ratio_odd.jsp,
    PVLs_AP_ResSummary_w_ResDistrib_odd.jsp,PVLs_AP_ThresholdViolation.jsp,
    PVLs_AP_ThresholdViolation_DC.jsp,PVLs_AP_TopN.jsp,PVLs_Cisco_VOIP_Global.jsp,PVRsMatrix.jsp
    GYMCP2024I: Calculating the number of datasets...
    Extractor will generate 1987 datasets. Do you want to continue (Y or N)?
    Note: It might take a while to complete the execution of the script and the time taken to complete the execution of the script depends on the number and complexity of reports that must be processed.

What to do next

Verify that the extractor tool is run successfully by following these steps:
  1. Verify that the following files are generated in the path that is specified in the datasetConfigPath parameter setting in the tnpmDatasetExtractor.properties file:
    • TNPM_DS_<DataSource_Name>.xml
      This file contains the data set information. Copy the generated file to <JazzSM_home>/profile/installedApps/JazzSMNode01Cell/isc.ear/tnpmDataProvider.war/WEB-INF/resources/ directory.
      Note: You can find the sample template file by name TNPM_DS_ProvisoSampleDS.xml in <JazzSM_home>/profile/installedApps/JazzSMNode01Cell/isc.ear/legacyDataview.war/WEB-INF/resources folder.
    • TNPM_DS_<DataSource_Name>.properties
      This file contains the extracted metrics. Copy the generated file to <JazzSM_home>/profile/installedApps/JazzSMNode01Cell/isc.ear/tnpmDataProvider.war/WEB-INF/resources/properties directory.
      Note: You can find the sample template file by name TNPM_DS_ProvisoSampleDS.properties in <JazzSM_home>/profile/installedApps/JazzSMNode01Cell/isc.ear/legacyDataview.war/WEB-INF/resources/properties folder
  2. Verify the Dataset Extraction tool log file DataProviderMetadataAutomation_<datasource>_<timestamp>.log at:
    <TEMP_DIR>/Dataset_Extractor/log
  3. Verify Dataset Extraction tool output report DataProviderAutomationLog_<datasource>_<timestamp>.csv generated by tool at <TEMP_DIR>/Dataset_Extractor/resources/generated.

    The output report file gives the information about extracted datasets in CSV format.

  4. Restart the Jazz for Service Management server.