Bring in BPMN, C4, docker-compose or Gherkin files

Turn a BPMN process, a Structurizr or C4-PlantUML model, a docker-compose file or a Gherkin feature into a design.

In short

The Designer reads files that architects and testers already keep: a BPMN process, a Structurizr or C4-PlantUML model, a docker-compose file and a Gherkin feature. Each becomes a design you can check and change. The import report says what was mapped, what was guessed and what was left out.

Before you start

• Who: In an organization you need "Create and change designs" (an Organization Admin, Manager or Member holds it). A Viewer holds "See designs" and can read designs and the catalog. In your Personal Workspace you do everything on your own designs.
• Plan: Designer is part of every plan, Free included. The Free plan limits how many designs a workspace keeps; Plan & usage shows the limit and what you hold.
• First: have the .bpmn, Structurizr JSON, .puml, docker-compose or .feature file ready.

Steps

1. On the Designer home, press "Import", then "Choose a file". You can also drop the file on the list.
2. Check that "Read as" names the format, such as "BPMN 2.0" or "Gherkin feature". For a Structurizr file, leave "Also add 3 components to the catalog" ticked so one component stands in every view.
3. Give the design a "Name".
4. Press "Make the design" and read the "Import report". Check the rows marked "Guessed" first.

What each file becomes

Good to know

• BPMN, Structurizr, C4-PlantUML and Gherkin are read on your device. Nothing is uploaded.
• A docker-compose file is sent to {{brand}} to be read, for that one answer only. Nothing in it is kept.
• Where Gherkin scenarios part ways, the workflow asks "Which scenario?" as a decision.
• Gherkin keywords are understood in English, Russian and Azerbaijani.
• A file that places nothing is laid out for you.
• To add a file to a design you already have, use "Merge a file into this design" under "Panels". You see a preview first.

If something goes wrong

• "The Designer cannot read this file. Try Mermaid, draw.io, Excalidraw, BPMN, Structurizr, C4-PlantUML, Gherkin, docker-compose, a picture of a diagram or a {{brand}} file."
• "This compose file names no services." - check that the file has a services section.
• "This file holds 600 shapes; a design holds at most 500." - split the model into smaller files. The numbers in your message will differ.
• "This file declares entities, which the Designer never reads."

Related

• /help/designer/import-a-design
• /help/designer/read-a-picture-of-a-diagram
• /help/designer/import-from-figma
• /help/designer/create-the-plan