Basic Setup

This section targets the basic installation. At the end, you will be able to run Xsemble.

Download and Install Java

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.) Download and extract the archive into some folder on your machine (we shall call it Java home).

Set the following two environment variables:

  1. Define an environment variable JAVA_HOME and the value will be the path of Java home.
  2. Append to an existing environment variable PATH the path to the ‘bin’ subdirectory of Java home.

Download and Install Xsemble

Click the above button and enter your information in the popup. You will get an email to download Xsemble distribution. Download it and extract the archive in a folder. We shall call this folder the Xsemble home.

Xsemble uses technology cartridges to support technologies. The distribution includes technology cartridges for web applications with the following technologies:

  • Java technology
    • Java EE (Java Enterprise Edition)
    • Jakarta EE (newer versions of Java EE)
    • Spring Boot (a popular framework for Java based web applications)
  • PHP technology
    • Core PHP (supports PHP version > 7.4)

Launch 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 run-asm.sh (on Linux/Unix) or run-asm.bat (on Windows).
  • For Developer’s Workbench, use run-dev.sh (on Linux/Unix) or run-dev.bat (on Windows).
  • For Monitoring Workbench, use run-mon.sh (on Linux/Unix) or run-mon.bat (on Windows).

When Xsemble is launched for the first time, it presents a Registration dialog. Upon successful registration, a key that is unique to you and your machine is created and added to your xsemble.properties. Please preserve this key to troubleshoot in case there is any problem.

Once this key is added, it prompts you to re-launch Xsemble application. Now you can launch all the applications successfully.

Access Xsemble Documentation

Xsemble comes with elaborate documentation in terms of a User Guide and a Reference Manual. To access it, use one of the following ways:

  • If an Xsemble application is running, the documentation can be accessed through Help -> Contents. It opens the documentation in your web browser. This is the easiest way to open the documentation.
  • In case the above is not successful for some reason, then you can open the documentation directly. For doing that, using your file explorer, go to the doc folder under Xsemble home and double-click on index.html file under the html subfolder. That will open it in your web browser.

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.

Advanced Setup

While the basic setup is good enough for most uses of Xsemble, you will additionally need further set up — especially if you want to compile and run applications locally.

That involves development environment setup and Xsemble configuration. These steps are covered in detail in “Onboarding and Configuration” chapter of the Reference Manual (supplied with the distribution).