Skip to content

Workspace Modes

The workspace mode controls which panels, tools and gizmos are available. Switching modes does not change the document.

ModeUse it to
ViewerView a twin and watch it run, without changing its configuration. The spectator workspace: the model and its running kinematics, the view controls and the settings. Nothing to author, no panels, no signals
HMIOperate a machine: key figures, messages, alarms, live signals. The usual default, and the default where a delivery says nothing else
CommissioningPut a machine into operation: the Viewer interface without the operator HMI, plus the tools an integrator needs: inspector, hierarchy, signals, CONNECT and the AI bridge
PlannerBuild a line from library objects in the Layout Planner
DESStudy throughput and material flow with discrete event simulation
EditorTurn CAD into a working asset by editing its structure, axes, drives, materials and signals. The simulation does not run here. See Your First Twin from CAD and the Editor

Click the mode name in the top left corner (1 in the interface) and select another mode. The model stays loaded while the tools change.

The workspace mode selector opened in the top bar: Viewer, HMI, DES, Planner, Commissioning and Editor, with Planner ticked as the active one

To share a twin in a specific mode, include the mode in the link:

https://web.realvirtual.io/demo/?mode=commissioning

The values are viewer, hmi, commissioning, planner, des and editor. If a mode is unavailable in this delivery, the viewer ignores it without an error. It uses the document’s mode, then the last session’s mode, or HMI if neither is set.

Use ?doc=new&mode=editor to create a new asset in the open project. It opens in the Editor with the CAD import dialog open.

https://<your-deploy>/?doc=new&mode=editor

The full set of link parameters is under sharing models.

Available modes depend on:

  • The delivery. A twin for an operator is often locked to one mode. In this case, the selector is hidden.
  • The document. A document can name the modes it is meant for. While it is open, the selector offers only those, and the document opens in its default mode. A link with another mode, such as ?mode=hmi, opens it in the default mode instead. The Editor stays available so that the document can still be edited.
  • The licence. The Editor is commercial. It is available in the public demo, but not in an open-source deployment. The DES core is part of the open-source Community edition; the experiment manager is commercial. See Editions.

To restrict a document, add modes to its entry in the project’s project.json. mode sets the mode the document opens in and must be one of the listed modes. Without modes, every mode is available:

{ "id": "doc_walker", "path": "MuJoCoWalker.glb", "mode": "commissioning", "modes": ["commissioning", "viewer"] }

A delivery can lock the workspace, hiding the mode selector and always opening the twin in its configured interface. Examples include a panel PC at the machine, a wall display or a booth. This is set once in the delivery configuration, not by the person at the screen. See server deployment.