Skip to main content

µRadiant Plugins

Once you have created a metamodel, it is possible to create a µRadiant plugin for it. This allows you to use the µRadiant as a modelling tool for your custom metamodel as well. With a plugin, you can model within the framework of your metamodel, expand your model using expandersExpanderA unit of generation that combines a data tree instance (functional M1 model) with a template to generate an artifact., and create visual representations directly inside µRadiant. Technically, a µRadiant plugin is an Angular applicationApplicationThe overarching model container grouping all components, domain logic, and configurations for an enterprise solution.. It uses Angular components to render specific UI elements like detail panels, tree views, and custom diagrams.

Plugins are expanded artifactsArtifactA build or deployment result, such as a Docker container image or Java archive, produced by a software project. as well, built from a plugin model. Therefore, to build your plugin, you must first model it. To do this, it is essential to understand the plugin metamodel that defines how our plugins are structured.

The plugin docs are composed of three categories:

  • Plugin Model docs: In this section, the plugin metamodel is introduced to give you an idea of the components a plugin exists of.
  • Plugin SetUp docs: This section is a step-by-step guide on how to set up a plugin.
  • Plugin Reference docs: This section in the reference guides discusses al possibilities for the plugin in greater detail.
info

Because our plugin tooling can generate a complete default plugin setup, you can start by reading, or even solely focus on, the Plugin Setup Docs. That guide provides everything you need to generate a working plugin. The Plugin Model Docs, and the reference docs, on the other hand, explain what gets generated and how to add extra functionality through modeling.