Install Semarchy xDM

This page provides an overview of the steps to install Semarchy xDM.

Before installing, make sure you are familiar with the xDM architecture and have thoroughly reviewed the system requirements.

The xDM installation process includes the following steps:

  1. Review the pre-installation checklist

  2. Download xDM

  3. Prepare the infrastructure

  4. Configure the database schemas

  5. Define the startup configuration

  6. Deploy xDM

  7. Create the repository

  8. Perform the post-installation steps

Pre-installation checklist

Review the checklist below before installing xDM. It includes components that may need to be integrated or configured. Preparing these items beforehand will help prevent delays and complications during the installation process.

  • Single sign-on (SSO): SSO allows users to authenticate once and gain access to multiple systems without needing to log in again. Using SSO with xDM enhances security and simplifies user management. Supported identity providers (IDPs) include a built-in IDP, SAML, OpenID Connect, LDAP, and more. Make sure that the selected IDP is configured and accessible before installation. For configuration details, see Configure authentication and SSO.

  • Secrets management: To manage secrets in xDM, administrators have two main options:

    • Using a key management system (KMS): administrators can use a KMS to encrypt secrets and store the encrypted secrets directly in xDM.

    • Using an external secrets manager: alternatively, administrators can store secrets in an external secrets manager and reference these secrets in xDM. In this case, proper configuration and accessibility of the KMS are essential. For configuration details, see Configure a key management service.

  • Proxy connection for web access (REST client): xDM may require a proxy to securely access external web services or APIs. Ensure the network firewall permits outbound connections and the proxy settings are properly configured. For setup instructions, see REST clients.

  • Secure sockets layer (SSL): SSL encrypts data transmitted between xDM and other systems, ensuring secure communications. If you choose to use SSL, obtain the necessary SSL certificates and make sure they are properly installed on the server.

Installation process

Download xDM

Multiple versions of xDM are available for download from the Semarchy website. You should preferably download the latest LTS release to get started. Make sure you understand the release versions and types to select the version that suits your needs.

xDM ships as two different packages, available on the Semarchy website:

  • xDM - Server Installation (semarchy-mdm-install-xxx.zip).
    This package contains the xDM passive and active Web Application Archive (WAR) files to deploy on an application server. Use this package to deploy Semarchy on an existing application server, for complex and clustered configurations.

  • xDM - Preconfigured with Apache Tomcat (semarchy-mdm-preconfigured-xxx.zip).
    This package contains xDM with a bundled Apache Tomcat application server. Use this package for a trial or simple development setup. You may also want to use this package to avoid installing and configuring an application server.

Using the xDM - Preconfigured with Apache Tomcat package is recommended solely for evaluation purposes. For production environments, opt for the Server Installation package to have full control over its configuration.

Prepare the infrastructure

Install the following infrastructure components required by xDM:

  • The Java virtual machine, which is required to run the application server.

  • The application server to deploy xDM. The recommended application server is Apache Tomcat. You can skip this step when using the xDM - Preconfigured with Apache Tomcat package.

  • The database server, which is required to host the repository and data locations (PostgreSQL, Oracle or Microsoft SQL Server).

Make sure to review the system requirements to install supported versions of these components.
Installing xDM in a cloud infrastructure does not differ from an on-premises installation. The Java machine and application server should be deployed in a virtual machine resource, and the database server should be one of the supported cloud database engines.

Configure the database schemas

Before installing xDM, you must create the databases and schemas that will host the repository and data locations, as well as the credentials to access these storages.

You can create them manually or use your database administration interface for this purpose. For sample scripts to create these databases, schemas, and credentials, see Configure the database schemas.

Define the startup configuration

The startup configuration is required to start xDM. It provides:

  • The connection information (i.e., repository datasource and repository read-only datasource) to connect the repository schema. This information is required to install and access the repository contents.

  • A setup token, which is required to perform the installation and seed the first user in the repository.

For instructions on how to define this configuration, see Startup configuration.

Deploy xDM

Deploy the xDM web application archive (WAR file) on an existing application server.
You can skip this step if using the xDM - Preconfigured with Apache Tomcat package.

For instructions on how to deploy xDM on a supported application server, see Deploy Semarchy xDM.

Create the repository

Create a repository once xDM is up and running.

Post-installation steps

After creating a repository, finalize the installation and perform the post-installation steps.