How to Use YAKINDU Model Viewer for Statecharts Statecharts are powerful tools for modeling the behavior of complex, reactive systems. However, sharing these models with team members, clients, or stakeholders who do not have full development environments can be a challenge. The YAKINDU Model Viewer (now part of the itemis CREATE ecosystem) solves this problem by providing a lightweight, accessible way to view, navigate, and interact with statechart models.
Here is a comprehensive guide on how to effectively use the YAKINDU Model Viewer for your statecharts. What is YAKINDU Model Viewer?
The YAKINDU Model Viewer is a tool designed specifically for opening, viewing, and simulating statecharts created in YAKINDU Statechart Tools (itemis CREATE). It allows non-developers or distributed teams to inspect the structure, states, transitions, and logic of a model without modifying the underlying source files. Step 1: Setting Up the Viewer
Before you can explore your models, you need to access the software.
Download/Access: Navigate to the official itemis website to download the standalone viewer or access the web-based version if available.
Installation: Follow the platform-specific installation wizard for Windows, macOS, or Linux.
System Check: Ensure your system has a compatible Java Runtime Environment (JRE) if you are using an older desktop version, though modern packages typically include embedded runtimes. Step 2: Importing and Opening Statecharts
The viewer supports standard statechart file formats natively.
File Formats: Look for files with the .sct extension (YAKINDU/itemis Statechart format).
Opening a File: Click on File > Open from the top menu, or simply drag and drop your .sct file directly into the workspace canvas.
Workspace Navigation: If your model relies on external dependencies or custom data types, ensure the workspace folder structure is preserved so the viewer can resolve all references correctly. Step 3: Navigating the User Interface
The interface is optimized for clarity and readability, split into several key regions.
Project Explorer: Located on the left side, this panel displays your file hierarchy and all statechart diagrams within the project.
Diagram Canvas: The central area where your statechart—including regions, states, transitions, and synchronization nodes—is visually rendered.
Definition Section: Usually situated on the left or top-left of the canvas, this text panel displays the variables, events, interfaces, and operations defined within the statechart.
Outline View: A miniature map of the canvas that helps you quickly navigate large, complex diagrams by dragging a viewport box. Step 4: Exploring the Statechart Structure
The viewer makes it easy to audit and understand deep hierarchical models.
Zoom and Pan: Use your mouse wheel to zoom in on specific sub-states or hold the spacebar/middle mouse button to pan across expansive diagrams.
Hierarchical Exploration: Double-click on composite states to drill down into sub-diagrams and inspect localized behavior.
Hover Details: Hover your cursor over transitions or states to view tooltips showing full event triggers, guard conditions, and entry/exit actions. Step 5: Simulating Behavior (Interactive Review)
One of the most powerful features of the viewer is the ability to run simulations to validate system logic.
Start Simulation: Click the green Play button in the toolbar to initialize the statechart. The active state will highlight in a distinct color (usually green or yellow).
Triggering Events: Go to the simulation panel on the right side of the screen. Click on defined input events to manually trigger transitions between states.
Inspecting Variables: Watch the variable values change in real-time within the simulation panel as active states execute their entry, inside, or exit actions.
Control Playback: Use the pause, step-forward, and stop buttons to analyze step-by-step behavior or race conditions. Best Practices for Sharing Models
To get the most utility out of the YAKINDU Model Viewer when collaborating:
Clean Layouts: Always auto-layout or organize your diagrams cleanly in the development environment before sharing them, as the viewer cannot permanently rearrange nodes.
Document with Comments: Use text annotations inside the statechart to explain complex guard conditions or unique state behaviors to viewers.
Isolate Interfaces: Keep your definition section organized with clear interface blocks (e.g., interface User, interface Sensor) so external reviewers can easily find relevant inputs and outputs.
By leveraging the YAKINDU Model Viewer, teams can bridge the gap between system architects and stakeholders, ensuring everyone aligns on system behavior without requiring a full development license.
To help tailor this guide further, could you share a few details?
Are you using the classic desktop version or the newer web-based itemis CREATE viewer?
What specific feature (like simulation, documentation generation, or interface checking) are you most focused on?
Leave a Reply