Generating The LiveView Project Based on SPM Schemas

TIBCO Service Performance Manager provides a utility, tibspmgenerator4lv, using which you can generate the necessary artifacts for LiveView dashboards for your own custom Service Performance Manager XML schema defined for KPI aggregation.

This utility takes the Service Performance Manager XML schema as an input and creates the appropriate folder structure required for the LiveView project with all the necessary artifacts. With the help of these generated LiveView projects, you can view the data in LiveView Desktop.

Procedure

  1. Open the SPM_HOME/adapter/liveview/lv-projectgenerator folder.
  2. Execute tibspmgenerator4lv as follows:

    tibspmgenerator4lv –f <input_directory or file -0 <output_directory

    • <input-directory or file>: the path to a directory containing schema files or a schema file itself [Mandatory]
    • <output-directory> the directory where the LiveView project is generated. Default is current directory.

      For example, tibspmgenerator4lv –f ../../config –o ./TopLevel/

      It creates one folder per schema as shown in the following snippet:.

      ./DataPurge
      ./DataPurge/DataPurge.sbapp
      ./lv-interfaces
      ./lv-interfaces/AssetHierarchyDemoServiceHitCountPublisher.sbint
      ./lv-interfaces/AssetHierarchySchemas.sbint
      ./lv-interfaces/DemoServiceHitCountSchemas.sbint
      ./lv-systemdata
      ./SPMDataPublisher
      ./SPMDataPublisher/SPMDataPublisher.sbapp
      AssetHierarchy.lvconf
      DataPurge.lvconf
      DemoServiceHitCount.lvconf
      sbd.sbconf
      SPM_Example_Schema.xml
      SPMDataPublisher.lvconf
      spm-liveview-config.properties
      SPMTableSpace.lvconf
      LV_SPM_Logback.xml

      Each of the generated folders contain an lv-systemdata subfolder where the preconfigured dashboards are provided. The folder structure adheres to the LiveView server requirement.

  3. Replace the variables in sbd.sbconf with actual values:
    • %TIBCO_JAVA_HOME_ESC%: Replace it with TIBCO JRE path which is included with Service Performance Manager installation.
    • %TIBCO_SPM_HOME_ESC%: Replace it with SPM_HOME path.
    • %TIBCO_EMS_HOME_ESC%: Replace it with EMS_HOME path.
    • Do not change ${STREAMBASE_HOME} variable. The value automatically gets replaced with running the project using StreamBase command prompt.
  4. Compare the generated folder structure with the examples distributed at SPM_HOME/adapters/liveview/lv-examples.