Setting up nJAMS Client for BW non-invasively

Setting up nJAMS Client for BW non-invasively#

nJAMS Client for BW requires TIBCO BusinessWorks 5.13 or 5.14. Please check your BW version before you install nJAMS Client for BW.

Note

TIBCO BusinessWorks 6 is not supported by nJAMS Client for BW! Please use nJAMS Client for BW6 for monitoring TIBCO BusinessWorks 6 / BWCE.

Make sure TIBCO BusinessWorks is installed properly. Enter Integration Matters Download Portal and download nJAMS Client for BW.

The distribution package of nJAMS Client for BW just consists of a single JAR file: njams.jar. Extract the distribution file and copy the JAR file to TIBCO BusinessWorks palettes folder.

Installation#

The TIBCO BusinessWorks palettes folder on Unix/Linux is usually located here: <TIBCO_HOME>/bw/plugins/lib/palettes

Copy nJAMS Client for BW into this folder

cp njams.jar /opt/tibco/bw/plugins/lib/palettes/

Warning

Make sure there is only one single njams.jar file available in the class path. The presence of multiple versions of njams.jar may cause unexpected results.

Configuration#

nJAMS Client for BW generates event messages for different channels. A channel is called Data Provider. For using nJAMS Client for BW with nJAMS Cloud service configure the Cloud Data Provider accordingly. Login to your Integration Matters account, select your nJAMS Cloud Instance setup, and get the required information for the following configuration:

tibco.clientVar.nJAMS/DataProvider/Cloud/apiKey:

API key of your nJAMS Cloud Instance.

tibco.clientVar.nJAMS/DataProvider/Cloud/enabled:

Enables/disables sending of event messages to nJAMS Cloud Instance.

true enables Cloud Data Provider.

false disables Cloud Data provider (default).

tibco.clientVar.nJAMS/DataProvider/Cloud/endpoint:

Client endpoint of nJAMS Cloud Service.

tibco.clientVar.nJAMS/DataProvider/Cloud/instanceId:

Id of your nJAMS Cloud instance.

tibco.clientVar.nJAMS/DataProvider/Cloud/certificate:

Full path to your certificate file.

tibco.clientVar.nJAMS/DataProvider/Cloud/privateKey:

Full path to your private key file.

Please find below a sample configuration for using Cloud Data Provider. You can paste the following sample to the end of your bwengine.tra file and modify the settings according to your environment:

# Replace TIBCO start class java.start.class=com.tibco.pe.PEMain with:
java.start.class=com.faizsiegeln.njams.client.run
# Configure nJAMS Client for BW:
tibco.clientVar.nJAMS/logMode=complete
tibco.clientVar.nJAMS/DataProvider/Cloud/apiKey=/opt/tibco/njams/api.key
tibco.clientVar.nJAMS/DataProvider/Cloud/enabled=true
tibco.clientVar.nJAMS/DataProvider/Cloud/Client/endpoint=hub.integrationmatters.com
tibco.clientVar.nJAMS/DataProvider/Cloud/Client/instanceId=my_instanceid
tibco.clientVar.nJAMS/DataProvider/Cloud/Client/certificate=/opt/tibco/njams/<id>-certificate.pem
tibco.clientVar.nJAMS/DataProvider/Cloud/Client/privateKey=/opt/tibco/njams/<id>-private.pem.key

Restart TIBCO BusinessWorks engine#

Once you copied njams.jar to the designated location and updated bwengine.tra file with nJAMS Client for BW settings, you have to restart the corresponding TIBCO BusinessWorks engine in order to activate nJAMS Client for BW.

For more information about installation and configuration of nJAMS Client for BW, refer to manual Installing nJAMS Client for BW.