Versions Compared

Version Old Version 3 New Version 4
Changes made by

Aleksei Melnikov

Aleksei Melnikov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This document describes the message format for TermWeb Business Integration Message Adapter (BIMA). BIMA is used for integration of TermWeb with other enterprise systems via a message broker middleware, such as WebSphere MQ, ActiveMQ, RabbitMQ, Apache Kafka.
BIMA uses the Java Message Service (JMS) standard and Kafka Streams.

Introduction

There are two TermWeb operations that causes BIMA to generate messages: initial transfer (export of term database) and update of term data. When such an operation occurs, BIMA generates one or more messages and publishes them to the message broker's publish/subscribe topics defined in BIMA's configuration file. Each message consists of several properties and a message body, which is an XML structure. The properties are useful for applications when filtering messages to avoid unnecessary XML parsing from the body.

Installation

  • Copy the sample configuration file BimaAdapter.properties to [TERMWEB_HOME] and edit it as necessary

  • Edit [TERMWEB_HOME]/termweb.properties and add the following lines:

    Code Block
    adapter.class.1=com.termweb4.bima.BimaAdapter
adapter.config.1=[TERMWEB_HOME]/BimaAdapter.properties

  • If you’re going to use JMS you may replace activemq libraries with another: RabbitMQ, IBM MQ. If you’re going use another implementation copy any message broker specific jar files to [TOMCAT_HOME]/webapps/ROOT/WEB-INF/lib that BIMA needs to create instances of TopicConnectionFactory and Topic. By default, TermWeb 4 comes with ActiveMQ implementation files, don’t forget to delete to avoid any conflicts:

    • activemq-client-*.jar

      • Code Block
        languagecpp
        // And its transitive dependencies
org.apache.geronimo.specs:geronimo-jms_1.1_spec:1.1.1
org.apache.geronimo.specs:geronimo-j2ee-management_1.1_spec:1.0.1
org.fusesource.hawtbuf:hawtbuf:1.11

Configuration

Text

Name pattern

Text

Adapter administration

Text

General panel

Text

Export panel

Text

Select settings and topic

Text

Confirm your selection

Text

Export progress

Text

Export summary

Text

Message structure

Text

Message properties

Text

Initial transmission

Text

Update transmissions

Text

Section updates

Text

Term data updates

Text

Description of term data update transmissions

Text

Creation of a new concept

Text

Deletion of a concept

Text

Modification of a concept

Text

XML structure

Text

Kafka integration

Text

Table of Contents