Friday, July 13, 2012

JBoss BRMS 5.3 - adding on Business Activity Monitoring (BAM) Reporting

One of the most often asked question since the release of the JBoss BRMS 5.3 product which has added the jBPM 5 BPM component is that of Business Activity Monitoring (BAM) and Reporting features. This article will walk you through the process of adding it, but be aware, this is not a supported feature of the product at the time of this writing.


Adding on BAM Reporting to JBoss BRMS 5.3
  1. Install JBoss BRMS 5.3, download from the Customer Portal.
  2. Create a birt directory at the following location JBOSS_HOME/server/default/data/birt/
  3. Create the ReportEngine and output directories in the birt directory from step 2 as follows:
    • JBOSS_HOME/server/default/data/birt/ReportEngine/
    • JBOSS_HOME/server/default/data/birt/ouput/
  4. Download birt-runtime-2_3_2_2 runtime jar from the following location:
  5. Unzip birt-runtime-2_3_2_2/ReportEngine into the JBOSS_HOME/server/default/data/birt/ReportEngine/ directory.
  6. Download overall_activity.rptdesign and process_summary.rptdesign report design files from the following location:
    • https://github.com/droolsjbpm/jbpm/tree/5.3.x/jbpm-installer/report/2_3_2_2
    • Copy the files to JBOSS_HOME/server/default/data/birt/
  7. Copy h2.jar from /jbpm/lib to the JBOSS_HOME/server/default/data/birt/ReportEngine/plugins/org.eclipse.birt.report.data.oda.jdbc_2.3.2.r232_v20090212/drivers/ directory.
  8. Delete report-core-1.4.0-SNAPSHOT.jar and report-shared-1.4.0-SNAPSHOT.jar from the JBOSS_HOME/server/default/deploy/business-central-server.war/WEB-INF/lib/ directory.
  9. Download the following jars and copy them to the JBOSS_HOME/server/default/deploy/business-central-server.war/WEB-INF/lib/ directory.
    • report-core-1.3.0.jar
      • https://repository.jboss.org/nexus/content/repositories/releases/org/jboss/bpm/report-core/1.3.0/report-core-1.3.0.jar
    • report-shared-1.3.0.jar
      • https://repository.jboss.org/nexus/content/repositories/releases/org/jboss/bpm/reportshared/1.3.0/report-shared-1.3.0.jar
    • engineapi-2.3.2.jar
      • http://repository.jboss.org/nexus/content/groups/public/org/eclipse/birt/engineapi/2.3.2/engineapi-2.3.2.jar
    • dteapi-2.3.2.jar
      • http://repository.jboss.org/nexus/content/groups/public/org/eclipse/birt/dteapi/2.3.2/dteapi-2.3.2.jar
    • chartengineapi-2.3.2.jar
      • http://repository.jboss.org/nexus/content/groups/public/org/eclipse/birt/chartengineapi/2.3.2/chartengineapi-2.3.2.jar
    • coreapi-2.3.2.jar
      • http://repository.jboss.org/nexus/content/groups/public/org/eclipse/birt/coreapi/2.3.2/coreapi-2.3.2.jar
    • dataadapterapi-2.3.2.jar
      • http://repository.jboss.org/nexus/content/groups/public/org/eclipse/birt/dataadapterapi/2.3.2/dataadapterapi-2.3.2.jar
    • modelapi-2.3.2.jar
      • http://repository.jboss.org/nexus/content/groups/public/org/eclipse/birt/modelapi/2.3.2/modelapi-2.3.2.jar
    • scriptapi-2.3.2.jar
      • http://repository.jboss.org/nexus/content/groups/public/org/eclipse/birt/scriptapi/2.3.2/scriptapi-2.3.2.jar
    • ecore-2.4.2.jar
      • http://repository.jboss.org/nexus/content/groups/public/org/eclipse/emf/ecore/2.4.2/ecore-2.4.2.jar
    • ecore-xmi-2.4.1.jar
      • http://repository.jboss.org/nexus/content/groups/public/org/eclipse/emf/ecore-xmi/2.4.1/ecorexmi-2.4.1.jar
    • common-2.4.0.jar
      • http://repository.jboss.org/nexus/content/groups/public/org/eclipse/emf/common/2.4.0/common-2.4.0.jar
    • flute-1.2.jar
      • http://repository.jboss.org/nexus/content/groups/public/org/w3c/flute/1.2/flute-1.2.jar
    • sac-1.3.jar
      • http://repository.jboss.org/nexus/content/groups/public/org/w3c/sac/1.3/sac-1.3.jar
    • commons-cli-1.0.jar
      • http://repo1.maven.org/maven2/commons-cli/commons-cli/1.0/commons-cli-1.0.jar
    • commons-discovery-0.2.jar
      • http://repo1.maven.org/maven2/commons-discovery/commons-discovery/0.2/commonsdiscovery-0.2.jar
    • itext-1.3.jar
      • http://repo1.maven.org/maven2/com/lowagie/itext/1.3/itext-1.3.jar
    • icu4j-3.8.1.jar
      • http://repository.jboss.org/nexus/content/groups/public/com/ibm/icu/icu4j/3.8.1/icu4j-3.8.1.jar
    • js-1.6R2.jar
      • http://repo1.maven.org/maven2/rhino/js/1.6R2/js-1.6R2.jar
To view the reports in the Business Central Console go to http://localhost:8080/business-central and
log on, see the JBoss BRMS Getting Started Guide for further details.

To collect the Business Activity Monitoring performance parameters for a task or process, first run
the task or process, and then click on the reports tab on the left pane. This will open the report
configuration tab in the right pane. Select ‘overall_activity’ from the drop down and click create to view
the report on the performance parameters of the executed process.

Install BIRT plugin into JBoss Developer Studio (JBDS)
  1. Open JBDS and select Help → Install New Software.
  2. In the Work with text box enter BIRT Update Site – http://download.eclipse.org/birt/updtae-site/3.7 and click ADD....
  3. The following packages should be listed for selection:
    • BIRT 3.7 Charting SDK
    • BIRT 3.7 Engine OSGI Runtime SDK
    • BIRT 3.7 Reporting SDK
    • BIRT 3.7 WTP Integration SDK
  4. Select all and click next. Follow the instructions on the installation screen.
  5. Restart JBDS
Enjoy!

Chinese translation post by Christina Lin.