Introduction

Introduction#

Planning your installation#

An nJAMS Server instance consists of a set of software components for providing the user interface, the event message processing, and the event message persistence:

  1. nJAMS Server application runs within a WildFly Application Server.

  2. Event message processing is possible either via the built-in HTTP/S protocol, or via an external messaging server, such as TIBCO EMS, Apache ActiveMQ, or Kafka, etc.

  3. The event messages are persisted in an Elasticsearch node/cluster. Alternatively, AWS OpenSearch can be used.

  4. For storing the metadata a relational database is required like the built-in H2 database. Alternatively, an external relational database system such as Oracle, SQL Server, or PostgreSQL can be used.

The nJAMS Server installer contains all the necessary components to setup a complete instance. In addition, it is also possible to use alternative pre-installed systems provided by the customer. For example, an already installed Elasticsearch cluster or an existing Oracle database can be used with nJAMS Server.

nJAMS Server comes with two different installer packages: core installer and full installer.

The core installer installs the WildFly application server and deploys nJAMS Server. In addition, the core installer also comes with the internal H2 database as well as allows to configure a connection to an external database. Using the core installer requires the customer to provide a pre-existing Elasticsearch/OpenSearch cluster for the setup of a complete instance.

The full installer additionally offers to install an Elasticsearch node on the same machine.

Depending on your needs, you can either use the core installer or the full installer. If you prefer to use your own existing Elasticsearch / OpenSearch cluster, or your own messaging server, or your own database, you can use nJAMS Server core installer. If you instead want to setup a complete nJAMS Server instance out of the box, you should use the nJAMS Server full installer.

Software component:

Software provided by core installer:

Software provided by full installer:

nJAMS Server (WildFly)

yes

yes

Internal database

yes

yes

Elasticsearch

no

yes

Cerebro

no

yes

HTTP/S messaging

built-in

built-in

Hardware requirements#

  • Computer and processor: A computer with Intel x86, 64 Bit, 2 GHz, multi-core recommended or divergent architecture with comparable performance characteristics.

  • Memory: 4 GB RAM minimum, required RAM capacity depends on the setup of the nJAMS instance. For production setup we strongly recommend to distribute all components on separate machines. For development or demonstration purposes it might be possible to install all components on the same machine.

Supported Platforms#

Linux:

  • Ubuntu Server 18.04, 20.04, 22.04 on x86-64

  • Red Hat Enterprise Linux (RHEL) 7, 8, 9 on x86-64

  • openSUSE on x86-64, please contact Integration Matters for supported version

Windows:

  • Microsoft Windows 10, 11 64-bit on x86-64 including most recent updates

  • Microsoft Windows Server 2016, 2019, 2022 64-bit on x86-64 including most recent updates

Others:

Please contact Integration Matters

Indexing Engine Requirements#

Elasticsearch 7.17, 8.7 as well as AWS OpenSearch 1.3, 2.6 are supported by this nJAMS Server version.

If you plan to use a separate Elasticsearch cluster for nJAMS Server, you should use the Elasticsearch installer. Although you can use nJAMS installer to install a single Elasticsearch node, it is not suitable for the installation of a larger cluster.

Note

If you install Elasticsearch separately, make sure to only use supported versions of Elasticsearch.

Database Requirements#

By default, nJAMS Server 6 uses the build-in database for storing meta data.

Alternatively, you can use one of the following external relational database systems:

  • PostgreSQL 13 [1]

  • Oracle Database 19c

  • Microsoft SQL Server 2014, 2016, 2017, 2019, 2022

JMS Provider#

nJAMS Server supports JMS to receive event messages from nJAMS Clients. The following JMS Providers are supported:

  • Apache ActiveMQ Classic 5.15, 5.16, 5.17, 5.18

  • Apache ActiveMQ Artemis 2.27

  • TIBCO EMS 8.6, 10.1, 10.2

  • other: Please contact Integration Matters for other supported JMS providers

Kafka#

nJAMS Server supports Kafka to receive event messages from nJAMS Clients. The following version is supported:

  • Apache Kafka 3.0

LDAP#

nJAMS Server supports the following supported LDAP servers:

  • Microsoft Active Directory 2016, 2019, 2022

  • other: Please contact Integration Matters for other supported LDAP servers.

Web Browser Support#

nJAMS Server supports the following browsers in the latest version:

  • Google Chrome

  • Microsoft Edge

  • Mozilla Firefox

Screen resolution#

The design of nJAMS UI requires a horizontal resolution that is not lower than 1280 pixel.

Java Requirements#

nJAMS Server 6.0 comes with OpenJDK 17. That means all used 3rd party libraries must be Java 17 compatible. If you want to use nJAMS Server with your own relational database system, make sure the jdbc driver is Java 17 compatible.

Optional Software requirements#

The following Java libraries must be available in the WildFly classpath. Please check the WildFly manual for further information.

JDBC Driver for Oracle:

In case you want to use Oracle RDBMS you have to make sure Oracle JDBC driver is available. The JDBC Driver for Oracle is not part of nJAMS Distribution Package. Please go to the Oracle website for downloading ojdbc8.jar, ojdbc9.jar, ojdbc11.jar. Oracle JDBC driver download: http://www.oracle.com/technetwork/database/features/jdbc/index-091264.html

JDBC Driver for Microsoft SQL Server:

In case you want to use Microsoft SQL Server you have to make sure SQL Server JDBC driver is available. The JDBC Driver for Microsoft SQL Server is not part of the nJAMS Server Distribution Package. Please go to the Microsoft website for downloading the corresponding JDBC driver. Microsoft JDBC driver download: http://www.microsoft.com/en-us/download/details.aspx?id=11774

JDBC Driver for PostgreSQL:

Please enter PostgreSQL download page at https://jdbc.postgresql.org/download.html and download the corresponding JDBC driver.

TIBCO EMS Client libraries:

In case you want to use TIBCO Enterprise Messaging Service make sure TIBCO EMS libraries are available. The following TIBCO EMS client libraries are required by the nJAMS Server to communicate with the TIBCO EMS server:

  • jakarta.jms-tibjmsadmin.jar

  • jakarta.jms-tibjms.jar

Check your TIBCO EMS 10.2 installation for those files.