JoinedWorkz

Appearance

Licensing & components ​

This page explains how the different JoinedWorkz components fit together and which parts require a license.

In short:

  • JoinedWorkz Studio requires a license file (trial or full).
  • The model transformation, generators and Maven plugin are free to use and do not require a license.

Components overview ​

JoinedWorkz consists of several components that work together:

JoinedWorkz Studio ​

A desktop application for working with Canonical Model Notation (CMN) models.

Studio provides:

  • a rich editor for .cmn files (syntax highlighting, validation, navigation)
  • tools around platforms, cartridges and generators
  • integration with existing Maven projects

Studio is the only component that requires a license.
You add license files via the Add License... function in Studio.

Modeling and generator runtime ​

The core modeling and generation runtime includes:

  • the parser and transformation engine for CMN models
  • shared base models (for example common-base)
  • implementations of platforms, cartridges and generators

These components are distributed as standard Maven dependencies and are loaded by the JoinedWorkz Maven plugin at build time.

JoinedWorkz Maven plugin ​

The Maven plugin integrates JoinedWorkz into your build. It is responsible for:

  1. loading and parsing .cmn model files
  2. transforming them into the canonical internal model
  3. discovering referenced platforms and cartridges on the classpath
  4. executing the configured generators
  5. writing generated artifacts (for example OpenAPI, Java code, resources) into the configured output directories

The plugin itself is generic and does not require a license. It can be used:

  • on developer machines
  • in CI/CD pipelines
  • on build servers

Platforms and cartridges ​

Platforms and cartridges are provided as Maven artifacts. A platform:

  • defines which cartridges belong to it
  • may expose configuration options
  • can be reused across multiple projects

Cartridges bundle one or more generators for a specific aspect of the platform (for example OpenAPI, controllers, persistence).

You add them as normal dependencies in your pom.xml. The Maven plugin will pick them up and execute them according to the platform definition and your model.

Licensing model ​

Studio license files ​

JoinedWorkz Studio uses license files for activation.

  • Licenses are bound to the user (and in some cases to a specific period).

  • License files are stored under your user home directory, for example:

    text
    ~/.joinedsystems/joinedworkz/license

  • You add one or more license files in Studio via Add License....

  • Once a valid license is present, Studio starts normally and all features are available according to the license.

Trial license ​

For evaluation purposes you can use a trial license:

  • The trial license is fully functional and has no technical feature limitations.
  • It is time-limited and expires after a certain period.
  • You can download a trial license directly from the JoinedWorkz website, for example via the trial license link on the resources page.

After the trial expires, Studio may restrict usage until you add another valid license file. Your projects and models are not affected by the license itself.

Commercial licenses and support ​

If you need a non-expiring license or commercial support, please contact JoinedWorkz directly. The current contact options are listed on:

text
https://www.joinedworkz.org/about.html

You can discuss licensing options and support plans there.

What is free to use? ​

The following parts can be used without any license key:

  • model transformation engine
  • standard generators and platforms
  • JoinedWorkz Maven plugin
  • any custom generators and platforms you build yourself

This means you can:

  • run JoinedWorkz in CI/CD pipelines without installing Studio
  • integrate model-based generation into existing Maven projects
  • use plain text editors for .cmn models if you prefer

Studio adds a richer experience on top of this foundation but is not required for automated builds.

Typical usage scenarios ​

  • Developer workstation with Studio

    • Install JoinedWorkz Studio.
    • Add a trial or full license file.
    • Use Studio to edit models and run Maven builds locally.

  • Build server / CI pipeline

    • Install Java and Maven.
    • Add the JoinedWorkz Maven plugin and required platform dependencies to the project pom.xml.
    • Run mvn clean package as part of the pipeline.
      No Studio installation or license is required.

  • Mixed team setup

    • Some team members use Studio for modeling.
    • Others work with the models in a text editor.
    • Everyone shares the same Maven-based build and generated artifacts.