Installing and configuring nJAMS Client for ADR3#

Essential installation steps#

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

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

Planning your installation#

nJAMS Client for ADR3 requires TIBCO Adapter for SAP 7.2. Please ensure TIBCO Adapter for SAP 7.2 is installed properly.

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

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

nJAMS Server 4.4, 5.0, 5.1, 5.2

TIBCO EMS 8.5, 8.6

Apache ActiveMQ 5.13, 5.15

Apache Kafka 3.0

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

Installation instructions for using TIBCO SAP Adapter 7.2#

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

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

Modify TRA file of TIBCO Adapter for SAP adr3.tra in ``<TIBCO_SAPADAPTER_HOME>/bin/``as follows:

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

# Home directory of nJAMS Client for ADR3:
tibco.env.NJAMS_ADR3_HOME=%TIB_ADR3_HOME%/plugins
# Folder of njams configuration file njams.properties:
tibco.env.NJAMS_ADR3_CONF_HOME=%NJAMS_ADR3_HOME%/conf
# Folder of njams custom libraries:
tibco.env.NJAMS_ADR3_LIB_HOME=%NJAMS_ADR3_HOME%/lib

3.2 Append %NJAMS_ADR3_LIB_HOME% to the following env variables in section “Custom Properties for adr3”:

tibco.env.PATH
tibco.env.STD_CP_EXT

For example:

#Set PATH
tibco.env.PATH=%CUSTOM_PATH%\:%TIB_ADR3_HOME%/bin\:%SDK_HOME%/hotfix/bin\:%SDK_HOME%/bin\:%TRA_HOME%/hotfix/bin\:%TRA_HOME%/bin\:%RV_HOME%/bin\:%TPCL_HOME%/bin\:%TIB_JAVA_HOME%/bin\:%EMS_HOME%/lib/64\:%EMS_HOME%/lib\:%NJAMS_ADR3_LIB_HOME%:%EMS_HOME%/lib/64:%EMS_HOME%/lib:

#Set standard classpath
tibco.env.STD_CP_EXT=%TIB_SDK_DIR%/hotfix/lib\:%TIB_SDK_DIR%/lib\:%TRA_HOME%/hotfix/lib\:%TRA_HOME%/lib\:%TPCL_HOME%/lib\:%RV_HOME%/lib\:%EMS_HOME%/lib\:%NJAMS_ADR3_LIB_HOME%

3.3 Add the following lines at the end of the file:

# Used For NJAMS Client for SAP Adapter Weaving, setting the default logging properties and setting the path to the config folder
# The default properties file name is njams (without the ending), if you want to change it, use "-Dnjams.properties.name\=njams4" and append it to the line below
java.extended.properties=-javaagent\:%NJAMS_ADR3_LIB_HOME%/aspectjweaver.jar -showWeaveInfo -Dlog4j.configuration\=file\:%TIB_ADR3_HOME%/bin/adr3.log4j.properties -Dnjams.conf.home\=%NJAMS_ADR3_CONF_HOME%

# Load config for nJAMS logging
adr3.trace.extended=ON
adr3.trace.log4j.properties=%NJAMS_ADR3_CONF_HOME%/adr3.log4j.properties

# 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 ADR3:

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

Example of nJAMS Client for ADR3 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://localhost: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 ADR3 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_ADR3_HOME%/bin/ and add the following lines to file adr3.log4j.properties:

# nJAMS Logging to console and its own logfile
log4j.appender.njamsFile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.njamsFile.File=/var/log/njams/adr3.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 SAP.

Installation instructions for using TIBCO SAP Adapter 7.3#

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

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

Modify TRA file of TIBCO Adapter for SAP adr3.tra in ``<TIBCO_SAPADAPTER_HOME>/bin/``as follows:

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

# Home directory of nJAMS Client for ADR3:
tibco.env.NJAMS_ADR3_HOME=%TIB_ADR3_HOME%/plugins
# Folder of njams configuration file njams.properties:
tibco.env.NJAMS_ADR3_CONF_HOME=%NJAMS_ADR3_HOME%/conf
# Folder of njams custom libraries:
tibco.env.NJAMS_ADR3_LIB_HOME=%NJAMS_ADR3_HOME%/lib

3.2 Append %NJAMS_ADR3_LIB_HOME% to the following env variables in section “Custom Properties for adr3”:

tibco.env.PATH
tibco.env.STD_CP_EXT

For example:

#Set PATH
tibco.env.PATH=%CUSTOM_PATH%\:%TIB_ADR3_HOME%/bin\:%SDK_HOME%/hotfix/bin\:%SDK_HOME%/bin\:%TRA_HOME%/hotfix/bin\:%TRA_HOME%/bin\:%RV_HOME%/bin\:%TPCL_HOME%/bin\:%TIB_JAVA_HOME%/bin\:%EMS_HOME%/lib/64\:%EMS_HOME%/lib\:%NJAMS_ADR3_LIB_HOME%:%EMS_HOME%/lib/64:%EMS_HOME%/lib:

#Set standard classpath
tibco.env.STD_CP_EXT=%TIB_SDK_DIR%/hotfix/lib\:%TIB_SDK_DIR%/lib\:%TRA_HOME%/hotfix/lib\:%TRA_HOME%/lib\:%TPCL_HOME%/lib\:%RV_HOME%/lib\:%EMS_HOME%/lib\:%NJAMS_ADR3_LIB_HOME%

3.3 Add the following Java options to java.extended.properties:

-javaagent:%NJAMS_ADR3_LIB_HOME%/aspectjweaver.jar

-showWeaveInfo -Dnjams.conf.home=%NJAMS_ADR3_CONF_HOME%

-Dlog4j.configurationFile=file:%NJAMS_ADR3_CONF_HOME%/adr3.log4j2.xml

-Dnjams.sdk.settings.properties.file=%NJAMS_ADR3_CONF_HOME%

For example:

# Used For NJAMS Client for SAP Adapter Weaving, setting the default logging properties and setting the path to the config folder
# The default properties file name is njams (without the ending), if you want to change it, use "-Dnjams.properties.name\=njams4" and append it to the line below
java.extended.properties=-javaagent:%NJAMS_ADR3_LIB_HOME%/aspectjweaver.jar -showWeaveInfo -Dnjams.conf.home=%NJAMS_ADR3_CONF_HOME% -Dlog4j.configurationFile=file:%NJAMS_ADR3_CONF_HOME%/adr3.log4j2.xml -Dnjams.sdk.settings.properties.file=%NJAMS_ADR3_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 ADR3:

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

Example of nJAMS Client for ADR3 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://localhost: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 ADR3 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

Change log4j2.xml:

Go to folder %NJAMS_ADR3_HOME%/conf and edit adr3.log4j2.xml according to your needs, e.g.:

<?xml version="1.0" encoding="UTF-8"?>
<configuration status="INFO">
    <appenders>
        <Console name="NjamsConsoleAppender" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{ISO8601} %-5p [%t] %c: %m%n" />
        </Console>
        <RollingFile name="NjamsFileAppender"
                    fileName="/var/log/njams/adr3.log"
                    filePattern="/var/log/njams/adr3.log-%i.log"
                    ignoreExceptions="false">
            <PatternLayout>
                <Pattern>[%p] %d{yyyy-MM-dd HH:mm:ss:SSS} %c %M - %m%n</Pattern>
            </PatternLayout>
            <Policies>
                <SizeBasedTriggeringPolicy size="100MB" />
            </Policies>
            <DefaultRolloverStrategy max="10" />
        </RollingFile>
    </appenders>

    <loggers>
        <Logger name="com.im" level="INFO">
            <appender-ref ref="NjamsConsoleAppender" />
            <appender-ref ref="NjamsFileAppender"/>
        </Logger>
    </loggers>
</configuration>

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

Start nJAMS Client for ADR3#

Start service instances of TIBCO Adapter for SAP. As soon as the adapters start processing, nJAMS Client for ADR3 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 ADR3 has been initialized successfully.

(...)
[main] com.im.njams.sdk.Njams: ************************************************************
[main] com.im.njams.sdk.Njams: ***      nJAMS SDK: Copyright (c) 2022 Faiz & Siegeln Software GmbH
[main] com.im.njams.sdk.Njams: ***
[main] com.im.njams.sdk.Njams: ***      Version Info:
[main] com.im.njams.sdk.Njams: ***      clientVersion: 4.2.0
[main] com.im.njams.sdk.Njams: ***      cloudCommunicationVersion: 4.2.1 (5)
[main] com.im.njams.sdk.Njams: ***      scmBranch: origin/master
[main] com.im.njams.sdk.Njams: ***      sdkVersion: 4.2.1
[main] com.im.njams.sdk.Njams: ***
[main] com.im.njams.sdk.Njams: ***      Settings:
[main] com.im.njams.sdk.settings.Settings: ***      njams.adr3.engine = SAPAdapterServices-OrderService_SAPADR3_IN
[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/adr3/plugins/conf/SAPAdapterServices-OrderService_SAPADR3_IN_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/adr3/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.adr3.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.adr3.deployment = SAPAdapterServices
[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 ADR3 in nJAMS GUI.

Uninstallation#

Stop all service instances of TIBCO Adapter for SAP that make use of nJAMS Client for ADR3.
Remove nJAMS Client for ADR3 additions in log4j properties file %TIB_ADR3_HOME%/bin/adr3.log4j.properties.
Remove nJAMS Client for ADR3 additions from file ${TIBCO_SAP_ADAPTER_HOME}/bin/adr3.tra.
Delete directories ${NJAMS_ADR3_HOME}/conf/ and ${NJAMS_ADR3_HOME}/conf/ including content.
Re-deploy and start adapter service instances that made use of nJAMS Client for ADR3 before.

Installing and configuring nJAMS Client for ADR3

Contents

Installing and configuring nJAMS Client for ADR3#

Essential installation steps#

Planning your installation#

Installation instructions for using TIBCO SAP Adapter 7.2#

Installation instructions for using TIBCO SAP Adapter 7.3#

Start nJAMS Client for ADR3#

Uninstallation#