Skip to content

Export the model

Export gives you the model as a file you can keep, put in a repository, hand to a colleague or open in another tool. The board is not changed by an export.

Open the event model you want to export. Export works on the open event model.

  1. Select Project options at the top left, then Export.

    The Project options menu with the Export submenu open
    The Export submenu lists every format Studio can write.
  2. Choose a format from the table below.

  3. Your browser downloads the file. A notice says Export ready, or Export ready - some of the model could not be carried when the file leaves something out.

Choice What you get Use it for
Screenplay file One Cratis Screenplay (.play) file for the whole event model. Handing the model to a person or a tool in one piece.
Screenplay folder A ZIP of .play files, one for each module, feature and slice, laid out as folders. Keeping the model in a repository: small files give small differences and sensible merges.
Mermaid A Mermaid event modeling diagram, as text. Putting a picture of the model in a README or a wiki that renders Mermaid.
Event Modeling JSON A document in the official Event Modeling Specification format. Moving the model to another event modeling tool.

Screenplay is the text format that describes a model. The Screenplay files page shows what is inside and how it round-trips with a repository. To read a file back into a board, see Import a model.

For Mermaid you can narrow down. Open the options of a module or a feature on the board and choose Export module to Mermaid or Export feature to Mermaid.

A model on the board can hold more than a file format can express. Studio tells you when that happens, in the Export ready - some of the model could not be carried notice and in the file’s diagnostics. Read them before you treat a file as a complete copy.

Typical causes you may meet:

  • two specifications in one slice whose names are the same once generated: rename one, then export again (see names);
  • a redelivery in a specification that cannot be pinned to one given event;
  • a rule on a concept that can never hold: the concept is left out and the rest still exports.

Project options also has Diagrams, which draws the model as a UML state diagram, UML activity diagram, UML sequence diagram or Entity data model on screen.

The Project options menu with the Diagrams submenu open, listing four UML and entity diagrams
Diagrams are drawn inside Studio from the model.

They are for looking at, and they follow the model as it changes. See Context map and diagrams.

The Export submenu has more than files:

Open the downloaded file. A Screenplay file is plain text, and a folder export unzips into folders that mirror the board’s modules, features and slices. If you want to be sure it is whole, import it into an empty project and compare.