semarchy/xdi-analytics repository overview

⁠Quick reference

• Maintained by: Semarchy⁠
• Where to get help: Semarchy Community⁠ and Semarchy Support Library⁠.

⁠Version

For the versions available, see the tags on this repository⁠.

See also Global Support Policy⁠ for more information about the available versions, their support and maintenance plan.

⁠Semarchy xDI Analytics

Semarchy, a leader in the data integration and master data management markets, enables organizations to rapidly generate business value from their data. Its unified platform enables organizations of any size, to quickly discover, govern, manage, integrate, and report critical information scattered across applications.

Semarchy xDI is a high-performance, agile, and extensible data integration platform supporting any integration style and use case. Semarchy xDI Analytics is a Java EE application that provides a web-based interface used in production to deploy, manage and monitor the integration flows.

For more information, visit www.semarchy.com⁠.

⁠Base image

The Semarchy xDI Analytics images are using an official tomcat base image⁠ composed of:

• Tomcat version supported by Semarchy xDI Analytics⁠
• Debian image
• OpenJDK version supported by Semarchy xDI Analytics⁠

For example: tomcat:9.0-jdk11-temurin-jammy

⁠Docker Compose Sample

Use the Docker Compose Sample⁠ as a template to create your own Docker Compose file.

The sample compose starts two containers:

• The Semarchy xDI Analytics server.
• The backend database instance, based on the official PostgreSQL Image.

⁠Usage

To run the application server and database containers you need to:

1. Download and uncompress the Tutorial Resources⁠.
   The quick-install/docker/<version>/xdi-analytics/docker-compose/ folder contains the docker-compose.yml file as well as a shared-resources folder with sample configuration files required for Semarchy xDI Analytics.

2. Edit the configuration files to adapt the configuration to your requirements.
   For example, edit the environment variables or configuration files according to your environment.

3. Copy the JDBC Driver required to connect the backend database to the shared-resources/tomcat-additional-libraries folder.
   NOTE: With the Docker Compose Sample, as the backend database is PostgreSQL, copy the PostgreSQL JDBC driver to shared-resources/tomcat-additional-libraries.

4. Copy the JDBC Drivers required to connect the Semarchy xDI Runtime session logs databases to the shared-resources/analytics-webapp-home/jdbc folder.

5. Run the following command from the Docker Compose file location

   $ docker compose -f <your_docker_compose>.yml up

You can access the Semarchy xDI Analytics server at: http://<container-ip>:8098/semarchy-xdi-analytics/.

⁠Documentation

This Docker Compose creates and starts a complete instance of Semarchy xDI Analytics.

See Semarchy xDI Analytics Documentation⁠ for more information and detailed configuration instructions.

⁠Configuration

• Use environment variables to configure Semarchy xDI Analytics Startup (see the Docker Compose sample file).
• Optionally edit the Tomcat server configuration using the context.xml and tomcat-users.xml files in the shared-resources/tomcat-configuration-files/ folder.
  NOTE: These files are already mounted as volumes with the Docker Compose Sample.
• Optionally copy third-party libraries to add to Tomcat to the shared-resources/tomcat-additional-libraries folder.
  NOTE: This folder is mounted to /usr/local/tomcat/additional-libraries in the sample Docker Compose.
• Optionally copy third-party libraries to add to the Semarchy xDI Analytics Web Application Home directory to the shared-resources/analytics-webapp-home/jdbc folder.
  NOTE: This folder is mounted to /opt/semarchy/xdi-analytics/webapphome in the sample Docker Compose.
• Possible changes required on Tomcat's server.xml or other tomcat files require that you create a custom image⁠ based on the Semarchy xDI Analytics base image.

⁠Logs

Semarchy xDI Analytics logs are redirected to the container logs⁠.

Additional log information can be found in the Semarchy xDI Analytics Web Application Home (/opt/semarchy/xdi-analytics/webapphome), which can be mounted as a volume.

⁠Image Tags

The xdi-analytics images are available with different options, each designed for a specific use case.

⁠xdi-analytics:latest

This image contains the latest version of the Semarchy xDI Analytics server (semarchy-xdi-analytics.war). See details about Semarchy xDI Architecture⁠.

Important: this is not recommended to use the latest tag in production, as it will automatically upgrade to the latest version that Semarchy is publishing.

⁠xdi-analytics:<minor_version>

This image contains the latest version for a specific minor version of the Semarchy xDI Analytics server (semarchy-xdi-analytics.war).

For example: semarchy/xdi-analytics:2023.3

Important: this is not recommended to use the minor_version tag in production, as it will automatically upgrade to the latest patch version that Semarchy is publishing.

⁠xdi-analytics:<full_version>

This image contains a specific full version of the Semarchy xDI Analytics server (semarchy-xdi-analytics.war).

For example: semarchy/xdi-analytics:2023.1.4

⁠License

View license information⁠ for the software contained in this image.