Create CML Project

This page describes how you can start with Context Mapper and create your first CML model. Getting started with Context Mapper is easy and includes the following first steps:

  1. Install Context Mapper plugin
  2. Create an Eclipse project
  3. Enable the Xtext project nature
  4. Create a file with the file extension .cml

1. Install Context Mapper Plugin

Follow this procedure to install the Context Mapper plugin:

  1. Open the plugin installation dialog in Eclipse with the menu entry Help -> Install New Software…
  2. Enter the following update site URL to the field Work with: on the top of the dialog:
  3. Select the two features ContextMappingDSL and ContextMappingDSL (Sources) and continue with Next.
  4. Finish the plugin installation by completing the wizard.

2. Create an Eclipse Project

In order to create a CML model, you need an Eclipse project. You can use any project type such as Java Project, Maven Project, Gradle Project or just a general Project. Use the File -> New menu or the context menu in the project explorer to create a project.

Note: You can also use one of your existing projects and create a CML model there. In this case go to the next step.

3. Enable the Xtext Project Nature

As mentioned above, it does not matter which project type you use. However, your project has to be an Xtext project which means it needs the Xtext nature. There are two easy possibilities to enable the Xtext nature on your project:

  • Option 1: Open the context menu on your project (right-click) and use the menu entry Configure -> Convert to Xtext Project. Enable Xtext nature on Eclipse project
  • Option 2: Just jump to step four and create a file with the extension .cml. Eclipse will ask you if you want to enable the Xtext nature. Press Yes.

4. Create .cml File

Once you created your project, you can create a file with the extension .cml in order to start modeling with Context Mapper. Use the New File wizard: Create CML file

Note: If you already enabled the Xtext nature in step three, the file opens and you can start modeling. Otherwise Eclipse will ask you now if you want to enable it: Enable Xtext nature at CML file creation

In this case you have to confirm with Yes.

Ready to Model

You can now start with writing CML in the Context Mapper editor. Use the following resources to get started:

Note that a CML Context Map with all Bounded Contexts etc. currently has to be modeled within one single .cml file. Splitting the model into multiple files is not yet supported but we have an open issue on Github for this. Currently each .cml file contains its own model and cannot reference objects located in other files. In addition, each .cml file (model) can only contain one Context Map.

Once you have modeled your system with CML you may want use our generators to produce other representations or evolve the model by using out Architectural Refactorings (ARs):