Deploy Semarchy xDM

The Semarchy xDM Server is a Java EE application that can be deployed to many environments. It requires a Java EE applications server (for example Tomcat, Glassfish, JBoss/WildFly, etc). This document details the steps required to configure the application server and deploy the application in the application server.

The instructions provided describe a generic method to configure the application server:

  • The method may vary depending on the application server version. Please refer to the application server documentation for the up-to-date instructions and instruction details.

  • This method also may vary depending on the best practices used in your information system. Please contact the application server administrator and review these instructions to adapt them to your practices.

Conventions

In the following deployment procedure, the following variables names are used in the tasks:

  • The semarchy-mdm-install-xxx.zip file refers to the xDM - Server Installation file you have downloaded to install Semarchy xDM. The name of this file varies as it includes the Semarchy xDM version and build number.

  • The temp folder refers to a temporary folder of your choice.

Configure the Datasources

Semarchy xDM does not rely on JNDI datasources defined at the application-server level:

  • Two datasources—​a repository datasource and a repository read-only datasource—​defining the connections to the repository are required for the application to start. They are configured as part of the startup configuration.

  • Other datasources, such as those required to deploy data locations, are configured in the Semarchy xDM platform after the installation is complete.

Make sure to install the JDBC Drivers of a database system before configuring a connection to this system. Refer to the instructions for each application server to install a JDBC driver.

Configure JavaMail Session

Semarchy xDM uses email servers for example to send email notifications.
For email features to work, you must configure an email notification server.

A notification server can be configured either:

  • By configuring the SMTP connection to the mail server in Semarchy xDM.

  • By referring to a JavaMail Session resource configured in the application server.

If a JavaMail Session resource is already configured in the application server, you can skip these steps. You can reuse the existing JavaMail Session resource when configuring the notification server.

Configure an HTTP Proxy

Components of Semarchy xDM act as HTTP clients. These components include the REST clients, the HTTP notification servers, the License synchronization process, and the built-in plug-ins using internet-based services.
Depending on your enterprise network configuration, these HTTP client components may need to use a proxy to access the servers they need to connect to.

You can configure the proxy for the application server using system properties.

These system properties include:

  • http.proxyHost or https.proxyHost: the hostname of the proxy server.

  • http.proxyPort or https.proxyPort: the proxy server port number (default: 80 or 443).

  • http.nonProxyHosts: list of hosts that can be reached without the proxy. This list of patterns is separated by |.

For a complete list of proxy parameters, see the reference documentation.

Download Semarchy xDM

The xDM Server Installation package (semarchy-mdm-install-xxx.zip) contains Semarchy xDM passive and active web application archive (WAR) files to deploy in an application server.

Download this file from the Semarchy website, at the following URL: https://www.semarchy.com/get/xdm-server-installation/.

  1. Uncompress this file in the temp folder.

The table below lists the contents of this file for reference.

Table 1. Semarchy xDM - Server Installation file contents
File/Folder Description

README.txt

File describing the package

Installation files for Semarchy xDM
mdm-server/

semarchy.war

Semarchy xDM deployable WAR file.

semarchy-passive.war

Semarchy xDM deployable WAR file for Passive Instances. Use this version for deploying Semarchy xDM in an existing supported application server for Configure Semarchy xDM for High-Availability.

Sample configuration files
mdm-server/samples/

setenv_sample.bat

Sample startup configuration using environment variables set in the Tomcat configuration file (Windows).

setenv_sample.sh

Sample startup configuration using environment variables set in the Tomcat configuration file (Linux/Unix).

config_sample.properties

Sample startup configuration file using properties.

log4j.semarchy.properties

semarchy.xml

Sample configuration for Apache Tomcat.

JDBC Driver and Additional libraries
mdm-server/additional-libraries/

ojdbc8.jar

Oracle JDBC driver for Oracle Database version 12c. If you are using an older Oracle version, it is recommended to review the compatibility of this driver with your Oracle database version and possibly install to an older driver version instead (ojdbc6 or ojdbc7).

org.postgresql.jdbc<postgresql_version>.jar

PostgreSQL JDBC Driver.

com.microsoft.sqlserver.mssql-jdbc_<version>.jar

SQL Server JDBC Driver.

com.sun.mail.jakarta.mail_<version>.jar

Library to install to enable JavaMail for Apache Tomcat. Ignore this file if you are using a different application server.

com.sun.activation.jakarta.activation_*.jar
com.sun.istack.commons-runtime_*.jar
com.sun.xml.fastinfoset.FastInfoset_*.jar
jakarta.jws-api_*.jar
jakarta.xml.bind-api_*.jar
jakarta.xml.soap-api_*.jar
org.apache.servicemix.specs.jaxws-api-*.jar
org.glassfish.jaxb.runtime_*.jar
org.glassfish.jaxb.txw2_*.jar
org.jvnet.staxex.stax-ex_*.jar
org.glassfish.jakarta.json_*.jar

Additional libraries required for Tomcat.

Deploy the Application

Startup checklist

For the Semarchy xDM application to start correctly, make sure that your application server environment is correctly set up.

  • The repository and the data locations database schemas are created.

  • The driver libraries are installed in the application server.

  • The startup configuration is set to connect the repository schema.

  • For an initial startup, the setup token environment variable is set to be able to authenticate and create the repository.

The application is deployed by default with the semarchy context. Therefore it is accessible on the application server on the following URL: http://<application_server_host>:<application_server_port>/semarchy/.

During the application deployment, it is possible to use a different context than semarchy. If you use a different context, make sure to take it into account in the URL to test and connect to the application.