Here is what you need to get started with Xsemble.


You need Java (JDK11 preferred) installed on your machine. Several providers provide these distributions under various license terms, and in principle you should be able to use any one of them. We use the OpenJDK 11 distribution which may be downloaded from here. (Look for 11 GA release.)

The installation is easy. In addition to extracting the binaries, make sure that the bin folder is included in your PATH environment variable, and set the JAVA_HOME environment variable to point to the path of where you extracted the release.

For Java Based Web Applications

Xsemble supports creation of Java based web applications. For this, you need a build tool named gradle. Download latest version of gradle and configure it as per the instructions on the same page.

Optionally, download Apache Tomcat server where you can run the created web application. Version 9 corresponds to Java EE and version 10 corresponds to Jakarta EE. Both are supported in Xsemble 3.1 (see note below). Installing Tomcat server is optional because there is a gradle plugin named gretty that can automatically download and use a Java web server. (The gretty plugin does not work well with JDK 1.8, so use JDK 11 or beyond for this to work.) The process to do that is outlined in the User Guide that comes with Xsemble. Further, keep in mind that on Windows, the XAMPP server bundle contains tomcat, along with useful utilities such as MariaDB database and phpMyAdmin application which is used to manage that.

Note: You are welcome to install separate servers for both Java EE and Jakarta EE. However, if you have to choose one of them, consider the following factors:

  • Most of the demo applications supplied with Xsemble are compatible with Java EE out of the box.
  • Jakarta EE is the latest version, and future improvements to the EE platform will go into Jakarta EE.
  • A migration script is available to automatically migrate Java EE applications to Jakarta EE. (You may use it on the demo applications.)

For PHP Based Web Applications

The new Xsemble3 may be used for creating PHP based applications. The build tool needed for PHP is composer. Follow these instructions to install composer on your system.

To run the web application created, you need a web server that supports PHP. Common choices are Apache2 and nginx. However, it is convenient to install the XAMPP bundle because that contains not just the Apache2 server but also other useful utilities such as the MariaDB database and phpMyAdmin application that is used to manage that. Use PHP version 7.4 or later.


Here is the primary download, the Xsemble distribution itself.

Download the migration script to migrate any existing Java EE applications to the new Jakarta EE platform. This is a bash script. (A bash script can be run natively on the *nix distributions, and may require some utility that provides a bash shell on Windows.) It needs to be executed within a namespace folder to convert all projects and repositories under that namespace. (The namespace folders are the subfolders of Xsemble workspace.) Before converting the files, make sure that you take a backup, so that it can be restored in case of problems.

The demo applications that are supplied with Xsemble are presently compatible with the Java EE platform. You may use this script to convert them and run them on the Jakarta EE platform.

This script is given as is, without any warranty. Use it at your own risk.

Migration Script for Jakarta EE (12 downloads)

Xsemble3 can support additional technologies apart from Java. You need a technology cartridge that supports the technology. While the Web and Java EE technology cartridges are included into Xsemble by default, a PHP technology cartridge is separately provided as an optional download. It will help you create PHP based web applications in addition to Java based web applications. It will also help you create applications containing mixed technologies, such as some microservices being implemented with Java EE and some with PHP.


Extract the downloaded Xsemble distribution archive in a folder. We shall call this folder the Xsemble Home.

In case you have downloaded any additional technology cartridges, add them to the ‘tech’ subfolder under Xsemble home. (If they are provided as zip files, then extract the contents of these files.)

Xsemble is configured through the file located in your Xsemble home. The default settings work for most users to let you launch Xsemble. But in case you face an issue, check out the ‘Onboarding and Configuration’ chapter under ‘Toolset Basics’ section in the Reference manual. The information on how to access the documentation is given below.

Launching Xsemble

Xsemble contains 3 desktop applications. They can be launched by running the launch scripts in Xsemble home. We recommend running them through the command prompt (terminal).

  • For Assembler’s Workbench, use (on Linux/Unix) or run-asm.bat (on Windows).
  • For Developer’s Workbench, use (on Linux/Unix) or run-dev.bat (on Windows).
  • For Monitoring Workbench, use (on Linux/Unix) or run-mon.bat (on Windows).

When Xsemble is launched for the first time, it presents a Registration dialog to you. Upon successful registration, a key that is unique to you and your machine is created and added to your Please preserve this key.

By default you get started with the FREE plan. To upgrade, contact us.

Accessing Xsemble Documentation

Xsemble comes with elaborate documentation in terms of a User Guide and a Reference Manual. The User Guide may be used as a Quick Start. For a detailed overview of concepts as well as explanation of every functionality, refer the Reference Manual.

If an Xsemble application is running, the documentation can be conveniently accessed through Help -> Contents.

The documentation can also be directly opened in the browser. For doing that, go to the doc folder under Xsemble home and double-click on index.html file under the html subfolder.