crystal_facet_uml user documentation

Andreas Warnke

Table of Contents

Usage Overview
Example Diagrams
Feature List
Example UML Behavioral Views
Example UML Static Views
Example SysML Views
Other Examples
GUI / Usage Manual
Window Area Overview
Tool Bar
Drawing Area
Element Configuration Area
Notification Bar
Modelling Guidelines
crystal_facet_uml Hints
General Hints on Architecture Documentation
A. Download Information
Download Links


crystal_facet_uml is an application to support software architects.


crystal_facet_uml creates a set of uml diagrams.

It ensures consistency of uml elements: Their names and their relationships are in sync in all diagrams.

crystal_facet_uml exports diagrams in various vector and pixel-based image formats.


crystal_facet_uml provides a graphical user interface to

  • create diagrams

    (use-case, deployment, component, composite-structure, package, class, activity, state, timing, communication, sequence)

  • create uml elements

    (actor, system-boundary, use-case, node, component, part, interface, package, class, activity, state, object, artifact, comment, requirement)

  • move, modify and delete uml elements

  • create, modify and delete relationships

    (dependency, association, aggregation, composition, generalization, realization, contains, sync-call, return-call, async-message, communication-path, control-flow, object-flow, deployment, manifest, include, extend)

  • create, modify and delete features

    (port, field, operation)

  • cut, copy, paste uml elements between diagrams

  • undo and redo are supported

  • multiple windows can show different or same parts of the uml model

Diagrams are layouted part-automatically:

  • The user chooses the relative location of uml elements towards others

  • crystal_facet_uml selects the exact locations of uml elements

  • The user controls the positions of messages/transitions in sequence and timing diagrams

  • crystal_facet_uml auto-layouts relationships in other diagrams

crystal_facet_uml manages a meta model:

  • Diagrams are organized as a tree, similar to a book's table-of-contents

  • Uml elements exist only once even if shown in many diagrams

  • Relationships and features are consistent between all diagrams

  • Diagram-local messages/transitions are supported in scenario-based diagrams

    (sequence, communication, timing)

crystal_facet_uml exports diagrams as

  • vector graphics

    (pdf, ps, svg)

  • pixel graphics


  • textual representation

    (utf-8-txt, docbook, xhtml)

crystal_facet_uml can also be started from command line to check and repair database files.

Usage Overview

crystal_facet_uml can be started in graphical mode (see the section called “GUI / Usage Manual”) or from command line (for help run crystal_facet_uml -h).