X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

X4 Installation

In this section of the help you will find all information about the installation of the X4 BPMS.

On the SoftProject website, you can request the following installation packages in the Resources > X4 Downloads section:

Installation packages for Windows:

  • All-in-One – Interactive Installation

  • X4 Designer – Interactive Installation

  • X4 Designer – ZIP archive for Windows

  • X4 Designer – ZIP archive for Windows

Installation packages for macOS:

  • X4 Designer – ZIP archive for macOS

Installation packages for Linux:

  • X4 Server and Keycloak – ZIP archive for Linux

  • X4 Server and Keycloak – RPM package for Red Hat Enterprise Linux

  • X4 Server and Keycloak – RPM package for SUSE Linux Enterprise Server

  • X4 Server and Keycloak – Debian Package for Ubuntu Linux

In addition, you can download various Docker images from the download area of the SoftProject website, as well as the Update Tool, which allows you to run an update from version 5.5.4 of the X4 BPMS.

Note:

Before downloading an installation package, please check the system requirements.

Components of the X4 BPMS installation packages

The X4 BPMS installation packages contain a combination of the following components:

  • X4 Server – management and process control in the background

  • X4 Designer – graphical user interface

X4 Server

The X4 Server is at the heart of the X4 BPMS. As a central building block in the X4 BPMS architecture, the X4 Server is the central memory for projects and Business Processes, and is responsible for executing and controlling all processes.

You cannot use all functions of the X4 Designer without connecting to the X4 Server as the X4 Server controls the necessary background processes for using the X4 Designer.

X4 Designer

The X4 Designer as an integrated developer tool represents the graphical user interface of the X4 BPMS. Using the X4 Designer, Business Processes can be modeled based on BPMN 2.0 (Business Process Model and Notation) and business rules according to DMN 1.1 (Decision Model and Notation). With the X4 Designer, processes can be graphically created using drag-and-drop. Moreover, the user can use appropriate input masks to configure the individual process components.

Note:

To use the X4 BPMS, an OIDC-compliant identity provider must be installed and running.


Folder structure after installing the X4 Server

After the X4 Server has been successfully installed, the installation folder contains the following items:

Folder

Explanation

apache-maven

Contains Maven plugins for X4.

configurations

Folder for storing your own configurations, e.g. the keycloak_config.json file for attaching your own Keycloak installation.

deployments

Contains the X4 Apps you configured.

jdk

Contains the current Java Runtime version as the runtime environment for the WildFly application server.

SQL

Contains the supplied in-memory database for test purposes in the H2DB subfolder.

wildfly

Contains the preconfigured WildFly application server.

X4DB

Contains the central X4 repository.

installation.checksum

Contains a checksum that validates the validity of the installed instance.

version.txt

Contains the X4 version number.

x4.license

License file for the X4 Server. You must manually copy the license file to the folder; it does not exist automatically. For more information, see License Information.

X4config.xml

Central configuration file of the X4 Server. For more information, see Configuration via X4config.xml.

Windows installation packages

startX4.bat

Script for starting the X4 Server.

stopX4.bat

Script to stop the X4 Server.

Linux installation packages

startX4.sh

Script for starting the X4 Server.

stopX4.sh

Script to stop the X4 Server.

Note:

If you have any questions or problems, you can always contact your SoftProject representative or contact the support at support@softproject.de.