Skip to content
🤷

Forgive us! These docs are a work in progress. Some pages may be incomplete or describe features that aren't quite finished yet. Farkitect is in early development and we don't recommend using it for real work just yet. Feel free to explore — just be aware that things are still being built.

How to define properties and enumerations

  1. Select the M2 element type in the Explorer
  2. In the Properties panel, find the properties section
  3. Click to add a new property
  4. Set the name (e.g., “Lifecycle Status”)
  5. Set the data type — String, Integer, Real, Boolean, Date, DateTime, or an enumeration
  6. Set the multiplicity1..1 (required) or 0..1 (optional)
  7. Optionally set a default value

The property now appears on all M1 instances of this element type.

  1. Right-click the Enumerations package in your metamodel
  2. Select New Enumeration
  3. Rename it (e.g., “System Status”)
  4. In the Properties panel, add literal values:
    • Each literal has a name (display label) and a value (stored value)
    • Example: Name = “Active”, Value = “active”

When adding a property to an element type, select your enumeration from the type picker. It appears alongside the primitive types. The property renders as a dropdown in the Properties panel and in catalogs.

String properties support format hints that change how they’re displayed:

HintEffect
multilineRenders as a textarea
urlRenders as a clickable link
emailRenders as a clickable mailto link

The process is identical — select a relationship type and add properties in the same way. Relationship properties appear in the Properties panel when an edge is selected.