Introduction#

Planning your installation#

nJAMS Server requires several software products either to be installed by nJAMS Server Installer or to be provided by customer in advance. The following table lists the required software components that belong to an nJAMS instance.

You can decide to install these components by nJAMS Server Installer or to use already installed software:

Required software:

Software provided by installer:

Support of pre-installed software:

nJAMS Server

WildFly, nJAMS Server

Elasticsearch

Elasticsearch 7.17

Elasticsearch, OpenSearch

RDBMS

Internal DB

Oracle DB, MS SQL Server, PostgreSQL

JMS Provider

Apache ActiveMQ

Apache ActiveMQ, TIBCO EMS

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 on x86-64

  • CentOS 8 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 64-bit on x86-64 including most recent updates

Others:

Please contact Integration Matters

Indexing Engine Requirements#

Elasticsearch:

Elasticsearch 7.7, 7.13, 7.16, 7.17 as well as OpenSearch 1.3 are supported by this nJAMS Server version.

If you plan to use a separate Elasticsearch cluster for nJAMS Server, you should use the Elastisearch 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#

Whereas earlier versions of nJAMS Server required a database system, nJAMS Server 5 uses a build-in database for storing meta data. If you plan a new installation of an nJAMS Server instance, it is recommended to use the internal database instead of an external RDBMS.

Note

It is recommended to frequently create backups of the H2 database file njams-v2.mv.db. You can find H2 database file at <njams-install>/data.

Alternatively, the following RDBMS can still be used with nJAMS Server:

  • PostgreSQL 13 [1]

  • Oracle Database 19c

  • Microsoft SQL Server 2014, 2016, 2017, 2019

JMS Provider#

nJAMS Server supports JMS to communicate with nJAMS Clients. The following JMS Providers are supported:

  • Apache ActiveMQ 5.16

  • TIBCO EMS 8.6, 10.1

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

Kafka#

nJAMS Server supports Kafka to communicate with nJAMS Clients:

  • Apache Kafka 3.0

LDAP (optional)#

nJAMS Server optionally makes use of the following supported LDAP servers:

  • Microsoft Active Directory 2016, 2019

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

Web Browser Support#

Web Browser

Tested version

Compatibility

Performance

Google Chrome

105

Best

Fast

Microsoft Edge

105

Best

Fast

Mozilla Firefox

105

Good

Good

Screen resolution#

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

Java Requirements#

nJAMS Server 5.3 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 The following JDBC driver versions are supported with this release of nJAMS Server:

For Oracle 19c:

  • 19.14.0.0

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 mssql-jdbc-11.2.0.jre17.jar. Microsoft JDBC driver download: http://www.microsoft.com/en-us/download/details.aspx?id=11774 The following JDBC driver version is supported with this release of nJAMS Server:

  • mssql-jdbc-11.2.0.jre17.jar

JDBC Driver for PostgreSQL:

Please enter PostgreSQL download page at https://jdbc.postgresql.org/download.html and download the JDBC driver. The following JDBC driver version is supported with this release of nJAMS Server:

  • postgresql-42.2.8.jar

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:

  • tibjmsadmin.jar

  • tibjms.jar

Check your TIBCO EMS installation for those files. Typically they can be found in:

<TIBCO_EMS_HOME>/<VERSION>/client

or alternatively in:

<TIBCO_EMS_HOME>/<VERSION>/lib

For example:

/opt/tibco/ems/8.6/client