Skip to content

Configuration ​

All settings live under the miragon.bpmnModeler namespace. Edit them in VS Code's settings UI (search for "BPMN Modeler") or directly in settings.json.

Settings reference ​

SettingTypeDefaultDescription
miragon.bpmnModeler.languageenumenUI language for palette, context pad, and properties panel. One of de, en, es, fr, nl-nl, pt-br, ru, zh-Hans, zh-Hant.
miragon.bpmnModeler.configFolderstring.camundaName of the config folder searched from each BPMN file up to the workspace root. Element templates live under <configFolder>/element-templates/.
miragon.bpmnModeler.alignToOriginbooleanfalseAlign the diagram to the top-left origin when opening. See bpmn-io/align-to-origin.
miragon.bpmnModeler.colorThemeenumautomaticautomatic follows the active VS Code theme; light always uses the default bpmn-js light theme.
miragon.bpmnModeler.defaultModeenumimplementMode a BPMN editor opens in when it has no remembered mode. One of implement (full Camunda modeler), design (engine-neutral editable surface), view (readonly viewer). On an untagged (engine-neutral) model, implement is unavailable and falls back to design. See Editor Modes.
miragon.bpmnModeler.showTransactionBoundariesbooleantrueShow transaction boundaries on the canvas (Camunda 7 only).
miragon.bpmnModeler.favouriteBpmnElementsstring[]["bpmn:ServiceTask","bpmn:UserTask","bpmn:CallActivity","bpmn:ExclusiveGateway"]BPMN element types pinned at the top of the append menu (max 6).
miragon.bpmnModeler.c8ApiVersionstringv2REST API version prefix for Camunda 8 endpoints. Change this if your cluster exposes a different API version.
miragon.bpmnModeler.marketplaces(string | object)[][]Registered template marketplaces: GitHub/GitLab URLs, local folder paths, or object entries for self-hosted instances. The User- and Workspace-level lists are merged (User = "all my projects", Workspace = project-specific); usually managed via the Add Marketplace command, which asks for the scope (This workspace / All my projects) when a folder is open — user-level entries apply to all projects.

Example settings.json ​

json
{
    "miragon.bpmnModeler.language": "de",
    "miragon.bpmnModeler.configFolder": ".camunda",
    "miragon.bpmnModeler.alignToOrigin": true,
    "miragon.bpmnModeler.defaultMode": "design",
    "miragon.bpmnModeler.favouriteBpmnElements": [
        "bpmn:ServiceTask",
        "bpmn:UserTask",
        "bpmn:CallActivity",
        "bpmn:SubProcess",
        "bpmn:ExclusiveGateway",
        "bpmn:ParallelGateway"
    ]
}

File and editor associations ​

.bpmn and .dmn files open in the graphical modeler by default and are registered as their own BPMN / DMN languages — that is what powers the file-explorer icons and the language-mode label. The text view (BPMN Modeler: Toggle Standard Text Editor) keeps full XML syntax highlighting and editing behaviour.

XML extensions

Extensions that activate on the xml language (e.g. Red Hat's XML extension) no longer auto-activate on .bpmn/.dmn files in the text view. To get that behaviour back, remap the files to XML in your user or workspace settings:

json
"files.associations": {
    "*.bpmn": "xml",
    "*.dmn": "xml"
}

Trade-off: the files are then plain XML to VS Code, so the BPMN/DMN file icons and language-mode label are replaced by the XML ones.

To open these files in the text editor by default instead of the modeler, override the editor association:

json
"workbench.editorAssociations": {
    "*.bpmn": "default",
    "*.dmn": "default"
}

Commands ​

Beyond settings, the extension contributes several commands to the palette — all prefixed BPMN Modeler:. See Getting Started for the common ones.

Element templates ​

Element templates follow the Camunda element-templates schema and are resolved by convention. No project config file required. See the Element Template Chooser page for details on template discovery and the UI for applying them.

Linting ​

.bpmnlintrc discovery reuses the same configFolder walk: at each level from the BPMN file up to the workspace root, <dir>/.bpmnlintrc then <dir>/<configFolder>/.bpmnlintrc is checked, nearest match wins. See the Linting page for details.