General Workbench Documentation

Logging in (and out)

The workbench requires you to be logged in to allow the workbench to associate models with your personal activity. Signup / Login asks for.

  • Email address - this is what you will be identified with. It needs to be a valid email address that you have access to when you sign up.
  • Name - Your name, as it will be presented on the screen and to other users when you publish your models.
  • Password - a password that you set up during the sign up process.

Public, User and Scratch Models

Within the workbench, model are stored in our database.

Modes are categorized into three types

  • User models are your private models. They cannot be seen by others. They are typically models you have made and want to preserve.

Creating, Editing and Renaming a Model

From the starting page of the various model domains, there are buttons to create a new model. For example, for FSA model.

New FSA Model button

After clicking such a button, you will be prompted for a name of the model. Then it should appear in the list of user models. The model will have a default template body.

The model can be edited by clicking on the edit button.

New FSA Model button

The model can be deleted (permanently!)

New FSA Model button

A model can also be renamed.

New FSA Model button

The Model Editor

The model editor provides feedback on the syntax. In particular, syntax error are highlighted with a red squiggly line. Hovering the mouse above the error provides more information about the problem.

A Syntax Error

If you press Ctrl+Space in the editor you get auto-completion options. This may also help you to produce correct syntax.

A Syntax Error

Ctrl+F and Ctrl+H give Find, or Find and Replace options, respectively. F1 shows a long list of editor commands that you may use.

Generating Artifacts and Reports

From

Acknowledgements

The workbench is based on the following technologies

  • SDF3
  • Eclipse Xtext
  • Microsoft Monaco Editor framework
  • Node.js Express web application
  • MongDB database
  • Graphviz visualization
  • Python textx