Install the Semarchy xDI Designer

This document details how to install Semarchy xDI Designer.

Before the installation, make sure to understand the architecture and review carefully the system requirements.

Download the Designer

The Designer is shipped as an archive file, named after the operating system it should be used with.

Make sure to download the archive corresponding to your operating system (Windows, macOS or Linux)

You can uncompress this file and directly run the Designer application.

Install the Designer

Windows

To install and run Designer:

  1. Uncompress the archive file to a temporary folder and copy its contents to your Program Files folder.

  2. Run the Designer executable: semarchy-xdi-designer-windows.exe

The user that runs Designer must have write privileges in the installation directory.
When installing Semarchy xDM Data Integration on Windows in the Program Files folder and you do not have such privileges, you must run the executable as an administrator:

  1. Right-click on the executable file.

  2. Select Properties.

  3. Go to the Compatibility tab.

  4. Select Run this program as an administrator.

  5. Click OK.

You can alternately install Designer into a folder where you have write privileges.

Linux

To install and run Designer:

  1. Uncompress the archive file to a temporary folder and copy its contents to your user folder.

  2. Run the Designer executable: semarchy-xdi-designer-linux

Depending on your environement you may need to set the execution permission to this file.

macOS

To install and run Designer:

  1. Uncompress the archive file to a temporary folder and copy its contents to your Applications folder.

  2. Run the Semarchy xDI Designer app.

    Depending on your macOS version, the following popup may open at startup:

    Designer startup error

    To resolve this issue:

    1. In the Applications folder, press and hold control and then select the Semarchy xDI Designer app.

    2. Select Open in the contextual menu.

    3. On the warning popup, click Open to open Semarchy xDI Designer.

Register the Designer

A newly installed Semarchy xDI Designer runs for a limited time - the grace period - without a license. Within that grace period, you should request an evaluation license from Semarchy or register a valid license to keep the Designer running.

When the grace period is over, the Semarchy xDI Designer will stop working: the workspaces will no longer be available to you but will be preserved as-is.

See Manage the Designer License for more information and detailed instructions to activate an instance and manage the license.

Advanced Configuration

Semarchy xDI Designer is configured to work in most situations. However, you can change its startup settings.

The startup settings are defined in the semarchy-xdi-designer-windows.ini (Windows) and semarchy-xdi-designer-linux.ini (Linux) file. It is located in the folder into which you installed Semarchy xDI Designer:

  • For macOS, in the /Contents/Eclipse sub-directory of the application.

  • For Windows and Linux, in the same folder as the executable file.

Memory settings

The following set of parameters allow configuring the Designer memory settings.

#  Minimum Heap size
-Xms512m
#  Maximum Heap size.
-Xmx1024m

Built-in Runtime location

The Designer built-in Runtime is deployed by default in the Designer installation folder, in a subfolder named runtime.

To change this location, edit the following property:

#  Runtime location
-Dxdi.designer.runtime.home=runtime

Module Generation

Modules generation is configured with the following properties:

# Generated modules location
# This path is relative to the Runtime location, but absolute path is also supported.
-Dxdi.designer.module.path.v1=runtime/modules
# Automatic modules creation
-Dxdi.designer.module.automaticCreation=true
If you change the modules location, all your modules will be managed in this folder. The local Runtime will therefore not be able to see and use those Modules unless you configure the Runtime to use the same Modules folder. Refer to Runtime’s installation and configuration guide to learn how to change Runtime’s Modules folder path.

License Configuration

You can pre-configure the License Management for a Semarchy xDI Designer instance by setting the following environement variables prior to starting the Designer

  • XDI_DESIGNER_LICENSE_KEY: Set this variable to define your Licence Key string. When this variable is set, the Online mode is used by default. The Local Server mode is used instead if XDI_DESIGNER_LICENSE_SERVER_URL is set.

  • XDI_DESIGNER_LICENSE_SERVER_URL: Set this variable to define your local license server URL, and use the Local Server mode.

  • XDI_DESIGNER_LICENSE_KEY_FILE: Set this variable to define your License Key File location and use the Offline mode. This variable is taken into account only if XDI_DESIGNER_LICENSE_KEY is unset.