Installing and configuring nJAMS Client for ADADB¶

Essential installation steps¶

The installation of nJAMS Client for ADADB consists essentially of the following steps:

Stop service instances of TIBCO Adapter for Database
Copy content of nJAMS Client for ADADB distribution package to plugins folder of home directory of TIBCO Adapter for Database
Adapt template properties file adbagent.tra of TIBCO Adapter for Database with nJAMS Client for ADADB related start settings
Edit connection parameter of nJAMS Client for ADADB configuration file njams.properties
Extend log4j properties file of TIBCO Adapter for Database
(Re-)Deploy adapter instances of TIBCO Adapter for Database in order to start them with nJAMS next time
Start adapter instances of TIBCO Adapter for Database

Planning your installation¶

nJAMS Client for ADADB requires TIBCO Adapter for Database 7.2. Please ensure TIBCO Adapter for Database 7.2 is installed properly.

For viewing monitoring results of nJAMS Client for ADADB use either an nJAMS Server instance or an nJAMS Cloud instance.

For using nJAMS Client for ADADB on-premise the following software is supported:

nJAMS Server 4.4, 5.0

TIBCO EMS 8.3, 8.4, 8.5

Apache ActiveMQ 5.13, 5.15

For using nJAMS Client for ADADB in combination with nJAMS Cloud you need a valid nJAMS Cloud instance.

Installation instructions¶

Please follow these instructions to install nJAMS Client for ADADB on the machine, where TIBCO Adapter for Database is installed and running:

Make sure services instances of TIBCO Adapter for Database are stopped.
Extract nJAMS Client for ADADB package file njams-client-adadb-adapter.zip and copy folder conf and lib from distribution package to <TIBCO_ADADB_HOME>/plugins/. If applicable, create directory plugins. A typical path would be e.g. /opt/tibco/adapter/adadb/7.2/plugins.

Modify TRA file of TIBCO Adapter for Database adbagent.tra as follows:

3.1 Add the following lines to section “common variables”:

# Home directory of nJAMS Client for ADADB:
tibco.env.NJAMS_ADADB_HOME %TIB_ADADB_HOME%/plugins

# Folder of njams configuration file njams.properties:
tibco.env.NJAMS_ADADB_CONF_HOME=%NJAMS_ADADB_HOME%/conf

# Folder of njams custom libraries:
tibco.env.NJAMS_ADADB_LIB_HOME=%NJAMS_ADADB_HOME%/lib

3.2 Append %NJAMS_ADADB_LIB_HOME% to the following env variables:

tibco.env.PATH
tibco.env.STD_CP_EXT

For example:

#Set PATH
tibco.env.PATH %CUSTOM_PATH%;%TIB_ADADB_HOME%/bin;%SDK_HOME%/bin;%TRA_HOME%/hotfix/bin;%TRA_HOME%/bin;%RV_HOME%/bin;%EMS_HOME%/bin;%TPCL_HOME%/bin;%EMS_HOME%/lib;%NJAMS_ADADB_LIB_HOME%;

#Set standard classpath
tibco.env.STD_CP_EXT %SDK_HOME%/lib;%TRA_HOME%/hotfix/lib;%TRA_HOME%/lib;%TPCL_HOME%/lib;%RV_HOME%/lib/tibrvj.jar;%RV_HOME%/lib;%EMS_HOME%/lib;%TPCL_HOME%/lib/entrust;%NJAMS_ADADB_LIB_HOME%

3.3 Add the following lines at the end:

# Used For NJAMS Client for ADADB Adapter Weaving
java.extended.properties=-javaagent\:%NJAMS_ADADB_LIB_HOME%/aspectjweaver.jar -showWeaveInfo -Dlog4j.configuration\=file\:%TIB_ADADB_HOME%/bin/performance.log4j.properties -Dnjams.conf.home\=%NJAMS_ADADB_CONF_HOME%

# Only for using secure connection to nJAMS Cloud add TIBCO security vendor:
#java.property.TIBCO_SECURITY_VENDOR=j2se

Configure connection parameters of nJAMS Client for ADADB:

Go to folder %NJAMS_ADADB_HOME%/conf and edit configuration file njams.properties according to your needs.

Example of nJAMS Client for ADADB configuration for running nJAMS on-premise against TIBCO EMS:

njams.sdk.communication=JMS
njams.sdk.communication.jms.java.naming.factory.initial=com.tibco.tibjms.naming.TibjmsInitialContextFactory
njams.sdk.communication.jms.java.naming.security.principal=njams
njams.sdk.communication.jms.java.naming.security.credentials=njams
njams.sdk.communication.jms.java.naming.provider.url=tibjmsnaming://vslems01:7222
njams.sdk.communication.jms.connectionFactory=ConnectionFactory
njams.sdk.communication.jms.username=njams
njams.sdk.communication.jms.password=njams
njams.sdk.communication.jms.destination=njams

Example of nJAMS Client for ADADB configuration for using nJAMS Cloud instance:

njams.sdk.communication.cloud.endpoint=ingest.integrationmatters.com
njams.sdk.communication.cloud.apikey=/opt/tibco/njams/certificates/myId-api.key
njams.sdk.communication.cloud.client.instanceId=myId
njams.sdk.communication.cloud.client.certificate=/opt/tibco/njams/certificates/myId-certificate.pem
njams.sdk.communication.cloud.client.privatekey=/opt/tibco/njams/certificates/myId-private.pem.key

Extend log4j properties:

Go to folder %TIB_ADADB_HOME%/bin/ and add the following lines to file performance.log4j.properties:

# nJAMS Logging to console and its own logfile
log4j.appender.njamsFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.njamsFile.File=/var/log/njams/adadb.log
log4j.appender.njamsFile.DatePattern='.'yyyy-MM-dd
log4j.appender.njamsFile.layout=org.apache.log4j.PatternLayout
log4j.appender.njamsFile.layout.ConversionPattern=[%p] %d %c %M - %m%n

log4j.appender.njams=org.apache.log4j.ConsoleAppender
log4j.appender.njams.layout=org.apache.log4j.PatternLayout
log4j.appender.njams.layout.ConversionPattern=%-5p %d [%t] %c: %m%n

log4j.logger.com.im=INFO, njams, njamsFile

Note

Change log4j.appender.njamsFile.File according to your needs.

(Re-)Deploy adapter instances of TIBCO Adapter for Database.

Start nJAMS Client for ADADB¶

Start service instances of TIBCO Adapter for Database. As soon as the adapters start processing, nJAMS Client for ADADB begins to monitor and creates log messages. Check log file of adapter instance and verify the banner text information to make sure that nJAMS Client for ADADB has been initialized successfully.

(...)
[main] com.im.njams.sdk.Njams: ************************************************************
[main] com.im.njams.sdk.Njams: ***      nJAMS SDK: Copyright (c) 2019 Faiz & Siegeln Software GmbH
[main] com.im.njams.sdk.Njams: ***
[main] com.im.njams.sdk.Njams: ***      Version Info:
[main] com.im.njams.sdk.Njams: ***      scmBranch: origin/master
[main] com.im.njams.sdk.Njams: ***      scmCommit: d20989d3b4a472c0085e677d487fd9854c2844a8
[main] com.im.njams.sdk.Njams: ***      sdkVersion: 4.0.10
[main] com.im.njams.sdk.Njams: ***      clientVersion: 4.0.1 (${revisionNumberPlugin.revision})
[main] com.im.njams.sdk.Njams: ***
[main] com.im.njams.sdk.Njams: ***      Settings:
[main] com.im.njams.sdk.settings.Settings: ***      njams.adadb.engine = adadb_rpc-jmsServer
[main] com.im.njams.sdk.settings.Settings: ***      njams.sdk.communication = JMS
[main] com.im.njams.sdk.settings.Settings: ***      njams.sdk.configuration.file.file = /opt/tibco/adapter/adadb/7.2/plugins/conf/adadb_rpc-jmsServer_njams.json
[main] com.im.njams.sdk.settings.Settings: ***      njams.sdk.communication.jms.java.naming.security.credentials = ****
[main] com.im.njams.sdk.settings.Settings: ***      njams.sdk.settings.properties.parent = /opt/tibco/adapter/adadb/plugins/conf/njams.properties
[main] com.im.njams.sdk.settings.Settings: ***      njams.sdk.communication.jms.password = ****
[main] com.im.njams.sdk.settings.Settings: ***      njams.sdk.communication.jms.destination = njams.endurance
[main] com.im.njams.sdk.settings.Settings: ***      njams.adadb.domain = fs_endurance
[main] com.im.njams.sdk.settings.Settings: ***      njams.sdk.communication.jms.java.naming.security.principal = njams
[main] com.im.njams.sdk.settings.Settings: ***      njams.sdk.communication.jms.java.naming.provider.url = tibjmsnaming://vslems01:7222
[main] com.im.njams.sdk.settings.Settings: ***      njams.sdk.configuration.provider = file
[main] com.im.njams.sdk.settings.Settings: ***      njams.sdk.communication.jms.connectionFactory = ConnectionFactory
[main] com.im.njams.sdk.settings.Settings: ***      njams.adadb.deployment = adadb_rpc
[main] com.im.njams.sdk.settings.Settings: ***      njams.sdk.communication.jms.username = njams
[main] com.im.njams.sdk.settings.Settings: ***      njams.sdk.communication.jms.java.naming.factory.initial = com.tibco.tibjms.naming.TibjmsInitialContextFactory
[main] com.im.njams.sdk.Njams: ************************************************************
(...)

See monitoring results of nJAMS Client for ADADB in nJAMS GUI.

Uninstallation¶

Stop all service instances of TIBCO Adapter for Database that make use of nJAMS Client for ADADB.
Remove nJAMS Client for ADADB additions in log4j properties file %TIB_ADADB_HOME%/bin/adadb.log4j.properties.
Remove nJAMS Client for ADADB additions from file ${TIBCO_ADADB_HOME}/bin/adadb.tra.
Delete directories ${NJAMS_ADADB_HOME}/conf/ and ${NJAMS_ADADB_HOME}/conf/ including content.
Re-deploy and start adapter service instances that made use of nJAMS Client for ADADB before.