View Description

Before you Start

🔥 This feature is currently considered experimental. Try it out and give feedback by reporting bugs and suggesting new features. It’s not recommended for production use.

🛠️ This feature is available to studio makers.

Use this feature to configure diagrams, tables, or other representations without leaving your web browser.

1. Introduction

View descriptions use the domain you modeled earlier to let you configure one or more representation descriptions. View description models live inside Studio projects, just like domains, and they can be edited live without restarting the application. Each view description is an EMF model under the hood, so advanced users can still version it, compare it, or extend it programmatically, but studio makers will only interact with it thanks to the web interface.

View descriptions can be configured inside a Studio project by using both the Explorer View and the Details View. In the Details View, all textfields with a yellow background should be used to enter AQL expressions. On the other hand, green textfields are used for the qualified name of an entity from your domain.

2. Live deployment model

  • Studio makers author, test, and validate their view descriptions in the same running instance as end users—no code generation or packaging loop is required during design time.

  • Once satisfied, export the studio project or package it into your Sirius Web based application; the same view descriptions will be loaded at runtime.

  • Because view descriptions are stored as models, they can be processed by EMF tooling (compare, merge, document generation) if your team needs deeper governance.

3. Best practices

  • Keep representation descriptions focused: one view description per persona or task prevents cluttered palettes.

  • Reuse color/text palettes across representation descriptions to ensure consistent branding.

  • Combine the Query View or any scratch project to validate complex AQL expressions before you wire them into descriptions.

For a step-by-step walkthrough, see Create your first view description.