Overview of the APM CE (CEM) Data Export Tool CEMExportTool

Document ID : KB000048181
Last Modified Date : 14/02/2018
Show Technical Document Details

Description:

The CA APM CE data export tool uses the APM CE Web Services API to retrieve business process and business transaction statistic data, as well as defect and incident data from APM CE. You can easily import the resulting CSV data into any spreadsheet or reporting tool such as Microsoft Excel, Business Objects, SAS, or Crystal Reports.

Solution:

A number of examples can be found in the CA APM API Reference Guide. The CEMWebServicesSDK.zip is available from the CA APM software download area at support.ca.com.

System Requirements:

  • APM Customer Experience Manager (CEM) 9.0.5.0 or above
  • Java Sun SDK 1.5 or higher.

Setup:

  • Unzip CEMExportTool.zip into any directory. Contents:
    • CEMExportTool.jar
    • lib
    • Readme.txt

To use the APM CE Export tool:

  1. Open a command shell.

  2. CD to the directory where APM CE Export Tool was extracted.

  3. Type the following command (make sure Java is in your execution PATH. If not, specify the fully qualified path to the Java executable):

    1. java -jar CEMExportTool.jar -host <cem-tess-hostname> -username <cem-username> -password <cem-password> -port <cem-webservices-port> -command <export-command-number> -output <output-file> <command-specific-parameters>

      • host: CEM hostname
      • username: CEM webservice login username
      • password: CEM webservice password
      • port: CEM webservice port
      • command: Data export command number. There are 44 possible commands:
      • 1: Get all Business Process Statistic data in a time range.
      • 2: Get all Business Transaction Statistic data in a time range.
      • 3: Get Business Process Statistic data for a specified Business Process in a time range.
      • 4: Get Business Transaction Statistic data for a specified Business Transaction in a time range.
      • 5: Get Business Process Statistic data for a specified UserGroup in a time range.
      • 6: Get Business Transaction Statistic data for a specified UserGroup in a time range.
      • 7: Get Business Process Statistic data for a specified Business Process and User Group in a time range.
      • 8: Get Business Transaction Statistic data for a specified Business Transaction and User Group in a time range.
      • 9: Get Business Transaction Statistic data for a specified Business Process, Business Transaction and User Group in a time range.
      • 10: Get Defects for a specified Business Process in a time range.
      • 11: Get Defects for a specified Business Transaction in a time range.
      • 12: Get Defects for a specified User Group in a time range.
      • 13: Get Defects for a specified Defect type in a time range.
      • 14: Get Defects for a specified Business Process, Business Transaction and User Group and Defect Type in a time range.
      • 15: Get Incidents in a time range.
      • 16: Get Business Process Statistic data for a specified Application in a time range.
      • 17: Get Business Transaction Statistic data for a specified Application in a time range.
      • 18: Get Business Process Statistic data for a specified Application and User Group in a time range
      • 19: Get Business Transaction Statistic data for a specified Application and User Group in a time range
      • 20: Close a specified Incident with optional comments. Only an incident in Open status can be closed. Note: there is no output file from this command.
      • 21: Get aggregated Business Process Statistic data for all the Business Processes in a time range. This command returns one row of data per Business Process for the given time range.
      • 22: Get aggregated Business Transaction Statistic data for all the Business Transactions in a time range. This command returns one row of data per Business Transaction for the given time range.
      • 23: Get aggregated Business Process Statistic data for a specified Business Process in a time range. This command returns only one row of data for the specified Business Process in the given time range.
      • 24: Get aggregated Business Transaction Statistic data for a specified Business Transaction in a time range. This command returns only one row of data for the specified Business Transaction in the given time range.
      • 25: Get aggregated Business Process Statistic data for a specified User Group in a time range. This command returns one row of data per Business Process in the specified User Group for the given time range.
      • 26: Get aggregated Business Transaction Statistic data for a specified User Group in a time range. This command returns one row of data per Business Transaction in the specified User Group for the given time range.
      • 27: Get aggregated Business Process Statistic data for a specified Business Process and User Group in a time range. This command returns only one row of data for the specified the Business Process in the specified User Group for the given time range.
      • 28: Get aggregated Business Transaction Statistic data for a specified Business Transaction and User Group in a time range. This command returns only one row of data for the specified Business Transaction in the specified User Group for the given time range.
      • 29: Get aggregated Business Transaction Statistic data for a specified Business Process, Business Transaction and User Group in a time range. This command returns only one row of data for the specified Business Transaction in the specified Business Process and User Group for the given time range.
      • 30: Get aggregated Business Process Statistic data for a specified Application in a time range. This command returns one row of data per Business Process in the specified the Application for the given time range.
      • 31: Get aggregated Business Transaction Statistic data for a specified Application in a time range. This command returns one row of data per Business Transaction in the specified the Application for the given time range.
      • 32: Get aggregated Business Process Statistic data for a specified Application and User Group in a time range. This command returns one row of data per Business Process in the specified Application and User Group for the given time range.
      • 33: Get aggregated Business Transaction Statistic data for a specified Application and User Group in a time range. This command returns one row of data per Business Transaction in the specified Application and User Group for the given time range.
      • 34: Get aggregated Business Process Statistic data for a specified User in a time range. This command returns one row of data per Business Process for the specified User for the given time range.
      • 35: Get aggregated Business Transaction Statistic data for a specified User in a time range. This command returns one row of data per Business Transaction for the specified User for the given time range.
      • 36. Get Defects for a specified Application in a time range.
      • 37. Get Defects that happened in the last X minutes in the system.
      • 38. Get Defects that happened in the last X minutes for a specified Application.
      • 39. Get Defects that happened in the last X minutes for a specified Business Process.
      • 40. Get Defects that happened in the last X minutes for a specified Business Transaction.
      • 41. Get the last N defects in the system.
      • 42. Get the last N defects for a specified Application.
      • 43. Get the last N defects for a specified Business Process.
      • 44. Get the last N defects for a specified Business Transaction
      • output: File name where data is exported to.
      • Different export commands can have different parameters specific to them.
      • interval: statistical data aggregation type.
        • 1: Hourly
        • 2: Daily
        • 3: Weekly
        • 4: Monthly
      • start: query data start time
      • end: query data end time
      • appname: an application name
      • bpname: a Business Process name
      • btname: a Business Transaction name
      • usergroup: a UserGroup name
      • dtype: Defect type
        • 1: slow time
        • 2: fast time
        • 3: high throughput
        • 4: low throughput
        • 5: large size
        • 6: small size
        • 8: http status code
        • 9: missing transaction/component
        • 10: content error
        • 11: missing response
        • 16: partial response
      • pthroughput: percentiles of transaction throughput. Multiple percentiles must be separated by ";", such as "-pthroughput 0.25;0.5;0.75". If "-pthroughput all" is specified, then all the percentiles from 5% - 95% incremented by 5% will be included. If the user doesn't give any percentile value for statistical data, the default percentile used for transaction throughput is 50%.
      • psize: percentiles of transaction size. Multiple percentiles must be separated by ";", such as "-psize 0.25;0.5;0.75". If "-psize all" is specified, then all the percentiles from 5% - 95% incremented by 5% will be included. If the user doesn't give any percentile value for statistic data, the default percentile used for transaction size is 50%.
      • ptime: percentiles of transaction time. Multiple percentiles must be separated by ";", such as "-ptime 0.25;0.5;0.75". If "-ptime all" is specified, then all the percentiles from 5% - 95% incremented by 5% will be included. If the user doesn't give any percentile value for statistic data, the default percentile used for transaction time is 50%.
      • metakeys: the defect meta keys which the values are to be retrieved as part of the Defect data. Mulitple keys must be separated by ";". The keys are case-sensitive. This parameter is optional.
      • includecomptiminginfo: to include the component breakdown timing information for a defective Business Transaction. This parameter is optional.
      • lastxminutes: the number of minutes within which the defects happened.
      • lastndefects: the number of defects that happened most recently.
      • incidentid: the ID of the incident.

Tips

  • Make sure that the Java executable is part of your PATH variable.
  • You can create a batch file (Windows) or shell script (UNIX) to repeatedly run the same report(s).
  • Since the account password is in clear text, use a non-administrative CEM account.