Template Reference

RSL · Requirements Specification Language

Version 1.0 Active

Download starter template All references DSL details

Check your template

Find likely variable, type, and field-name mistakes before generating a document.

Generic context

These variables are available for every templatable DSL.

Variable	Contents
`root`	The parsed entry object (`Model`).
`elements`	All named elements across grammar types.
`by_type`	Named elements grouped by their exact grammar type.
`by_id`	Lookup from an element name to its element.
`schema_version`	Template-context schema version, currently `1.0`.

Uniform element aliases

Every named element keeps its raw fields and gains these aliases.

Alias	Meaning
`id`	The raw `name` value.
`title`	The configured friendly title, falling back to `name`.
`kind`	The exact Langium AST type.

Template Profile aliases

Friendly names are resolved at render time and do not alter the grammar inventory.

project → root

Alias	Raw collection
`actors` →	`by_type["Actor"]`
`constraints` →	`by_type["Constraint"]`
`data_entities` →	`by_type["DataEntity"]`
`functional_requirements` →	`by_type["FR"]`
`glossary` →	`by_type["GlossaryTerm"]`
`goals` →	`by_type["Goal"]`
`quality_requirements` →	`by_type["QR"]`
`stakeholders` →	`by_type["Stakeholder"]`
`use_cases` →	`by_type["UseCase"]`
`user_stories` →	`by_type["UserStory"]`

Named types

These exact names are valid keys in by_type.

93 types

Filter named types

Matches exact grammar type and field names.

AcceptanceCriteria Link

Field	Shape
`criteriaR`	contained → AcceptanceCriteriaRule optional
`criteriaS`	contained → AcceptanceCriteriaScenario optional
`description`	string optional
`isAbstract`	boolean optional
`isConcrete`	boolean optional
`name`	string
`nameAlias`	string optional
`tags`	contained → Tag list optional
`type`	contained → TestType

{% for item in by_type["AcceptanceCriteria"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

AcceptanceCriteriaTest Link

Field	Shape
`criteriaR`	contained → AcceptanceCriteriaRule list optional
`criteriaS`	contained → AcceptanceCriteriaScenario list optional
`description`	string optional
`name`	string
`nameAlias`	string optional
`requirement`	reference → Requirement optional
`tags`	contained → Tag list optional
`type`	contained → TestType

{% for item in by_type["AcceptanceCriteriaTest"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

ActionTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["ActionTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

ActiveEvent Link

Field	Shape
`description`	string optional
`isCatch`	boolean optional
`isFinal`	boolean optional
`isInitial`	boolean optional
`isThrow`	boolean optional
`name`	string
`nameAlias`	string optional
`stakeholder`	reference → Stakeholder optional
`tags`	contained → Tag list optional
`type`	contained → ActiveEventType

{% for item in by_type["ActiveEvent"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

ActiveEventTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["ActiveEventTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

ActiveFlow Link

Field	Shape
`activeElements`	contained → RefActiveElement optional
`condition`	string optional
`description`	string optional
`name`	string
`nameAlias`	string optional
`tags`	contained → Tag list optional
`type`	contained → ActiveFlowType

{% for item in by_type["ActiveFlow"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

ActiveFlowTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["ActiveFlowTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

ActiveTask Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`participant`	reference → Stakeholder optional
`participantTarget`	reference → Stakeholder optional
`partOf`	reference → ActiveTask optional
`tags`	contained → Tag list optional
`type`	contained → ActiveTaskType

{% for item in by_type["ActiveTask"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

ActiveTaskTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["ActiveTaskTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

Actor alias: actors Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`stakeholder`	reference → Stakeholder optional
`super`	reference → Actor optional
`tags`	contained → Tag list optional
`type`	contained → ActorType

{% for item in actors %}
{{ item.id }} — {{ item.title }}
{% endfor %}

ActorTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["ActorTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

Check Link

Field	Shape
`checkExpression`	string
`name`	string

{% for item in by_type["Check"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

Constraint alias: constraints Link

Field	Shape
`acceptanceCriteria`	contained → AcceptanceCriteria list optional
`description`	string optional
`isAbstract`	boolean optional
`isConcrete`	boolean optional
`isNegative`	boolean optional
`isPositive`	boolean optional
`isProblem`	boolean optional
`isSolution`	boolean optional
`name`	string
`nameAlias`	string optional
`partOf`	reference → Constraint optional
`priority`	contained → PriorityType optional
`stakeholder`	reference → Stakeholder optional
`subType`	contained → ConstraintSubType optional
`tags`	contained → Tag list optional
`type`	contained → ConstraintType

{% for item in constraints %}
{{ item.id }} — {{ item.title }}
{% endfor %}

ConstraintSubTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["ConstraintSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

ConstraintTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["ConstraintTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

Data Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`table`	contained → DataTable optional
`tags`	contained → Tag list optional
`type`	reference → DataEntity

{% for item in by_type["Data"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

DataAttribute Link

Field	Shape
`constraint`	contained → DataAttributeConstraint optional
`defaultValue`	string optional
`description`	string optional
`helpMessage`	string optional
`name`	string
`nameAlias`	string optional
`tags`	contained → Tag list optional
`type`	contained → DataAttributeType
`values`	string optional
`visualizatione`	string optional

{% for item in by_type["DataAttribute"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

DataAttributeTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["DataAttributeTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

DataEntity alias: data_entities Link

Field	Shape
`attributes`	contained → DataAttribute list optional
`constraint`	contained → DataEntityConstraint optional
`description`	string optional
`name`	string
`nameAlias`	string optional
`subType`	contained → DataEntitySubType optional
`super`	reference → DataEntity optional
`tags`	contained → Tag list optional
`type`	contained → DataEntityType

{% for item in data_entities %}
{{ item.id }} — {{ item.title }}
{% endfor %}

DataEntityCluster Link

Field	Shape
`children`	contained → ChildDataEntity list optional
`description`	string optional
`main`	reference → DataEntity optional
`name`	string
`nameAlias`	string optional
`tags`	contained → Tag list optional
`type`	contained → DataEntityClusterType
`uses`	contained → RefDataEntity optional

{% for item in by_type["DataEntityCluster"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

DataEntityClusterTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["DataEntityClusterTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

DataEntitySubTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["DataEntitySubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

DataEntityTest Link

Field	Shape
`description`	string optional
`entity`	reference → DataEntity optional
`message`	string optional
`name`	string
`nameAlias`	string optional
`table`	contained → DataTable optional
`tags`	contained → Tag list optional
`testDataAttributes`	contained → TestDataAttribute list optional
`type`	contained → TestType

{% for item in by_type["DataEntityTest"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

DataEntityTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["DataEntityTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

DataEnumeration Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`tags`	contained → Tag list optional
`values`	contained → DataEnumerationElement list

{% for item in by_type["DataEnumeration"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

DataEnumerationElement Link

Field	Shape
`name`	string
`nameAlias`	string optional

{% for item in by_type["DataEnumerationElement"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

ElementsRelation Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`source`	reference → SystemElement optional
`tags`	contained → Tag list optional
`target`	reference → SystemElement optional
`type`	contained → ElementsRelationType

{% for item in by_type["ElementsRelation"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

ForeignKeyOnDeleteTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["ForeignKeyOnDeleteTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

FR alias: functional_requirements Link

Field	Shape
`acceptanceCriteria`	contained → AcceptanceCriteria list optional
`description`	string optional
`isAbstract`	boolean optional
`isConcrete`	boolean optional
`isNegative`	boolean optional
`isPositive`	boolean optional
`isProblem`	boolean optional
`isSolution`	boolean optional
`name`	string
`nameAlias`	string optional
`partOf`	reference → FR optional
`priority`	contained → PriorityType optional
`stakeholder`	reference → Stakeholder optional
`tags`	contained → Tag list optional
`type`	contained → FRType

{% for item in functional_requirements %}
{{ item.id }} — {{ item.title }}
{% endfor %}

FRTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["FRTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

GlossaryTerm alias: glossary Link

Field	Shape
`acronym`	string optional
`applicableTo`	contained → RefTermApplicableTo optional
`description`	string optional
`name`	string
`nameAlias`	string optional
`partOf`	reference → GlossaryTerm optional
`super`	reference → GlossaryTerm optional
`synonyms`	string list optional
`tags`	contained → Tag list optional
`type`	contained → GlossaryTermType

{% for item in glossary %}
{{ item.id }} — {{ item.title }}
{% endfor %}

GlossaryTermTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["GlossaryTermTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

Goal alias: goals Link

Field	Shape
`acceptanceCriteria`	contained → AcceptanceCriteria list optional
`description`	string optional
`isAbstract`	boolean optional
`isConcrete`	boolean optional
`isNegative`	boolean optional
`isPositive`	boolean optional
`isProblem`	boolean optional
`isSolution`	boolean optional
`name`	string
`nameAlias`	string optional
`partOf`	reference → Goal optional
`priority`	contained → PriorityType optional
`stakeholder`	reference → Stakeholder optional
`subType`	contained → GoalSubType optional
`tags`	contained → Tag list optional
`type`	contained → GoalType

{% for item in goals %}
{{ item.id }} — {{ item.title }}
{% endfor %}

GoalSubTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["GoalSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

GoalTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["GoalTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

LinguisticFragment Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`options`	contained → LinguisticFragmentPart list

{% for item in by_type["LinguisticFragment"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

LinguisticLanguage Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`type`	contained → LinguisticLanguageType

{% for item in by_type["LinguisticLanguage"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

LinguisticRule Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`pattern`	contained → LinguisticPattern list
`property`	contained → LinguisticRuleElementAndProperty
`severity`	contained → LinguisticRuleSeverityLevel
`type`	contained → LinguisticRuleType

{% for item in by_type["LinguisticRule"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

MainScenario Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`steps`	contained → Step list optional

{% for item in by_type["MainScenario"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

MetricTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["MetricTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

PackageSystem Link

Field	Shape
`imports`	contained → Import list optional
`name`	string
`system`	contained → System optional
`testSuite`	contained → TestSuite optional

{% for item in by_type["PackageSystem"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

PriorityTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["PriorityTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

QR alias: quality_requirements Link

Field	Shape
`acceptanceCriteria`	contained → AcceptanceCriteria list optional
`description`	string optional
`expression`	contained → Expression optional
`isAbstract`	boolean optional
`isConcrete`	boolean optional
`isNegative`	boolean optional
`isPositive`	boolean optional
`isProblem`	boolean optional
`isSolution`	boolean optional
`name`	string
`nameAlias`	string optional
`partOf`	reference → QR optional
`priority`	contained → PriorityType optional
`stakeholder`	reference → Stakeholder optional
`subType`	contained → QRSubType optional
`tags`	contained → Tag list optional
`type`	contained → QRType

{% for item in quality_requirements %}
{{ item.id }} — {{ item.title }}
{% endfor %}

QRSubTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["QRSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

QRTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["QRTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

RelationTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["RelationTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

RequirementsRelation Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`source`	reference → Requirement optional
`tags`	contained → Tag list optional
`target`	reference → Requirement optional
`type`	contained → RequirementsRelationType

{% for item in by_type["RequirementsRelation"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

RequirementsRelationTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["RequirementsRelationTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

Risk Link

Field	Shape
`acceptanceCriteria`	contained → AcceptanceCriteria list optional
`assessment`	contained → RiskAssessment optional
`description`	string optional
`name`	string optional
`nameAlias`	string optional
`negativeRequirement`	reference → Requirement optional
`partOf`	reference → Risk optional
`refVulnerabilities`	reference → Vulnerability list optional
`status`	contained → RiskStatus optional
`subType`	contained → RiskSubType optional
`tags`	contained → Tag list optional
`treatments`	contained → RiskTreatment list optional
`type`	contained → RiskType optional

{% for item in by_type["Risk"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

RiskSubTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["RiskSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

RiskTreatment Link

Field	Shape
`description`	string optional
`name`	string optional
`nameAlias`	string optional
`owner`	reference → Stakeholder optional
`solution`	contained → RefRequirements optional
`type`	contained → RiskTreatmentType optional

{% for item in by_type["RiskTreatment"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

RiskTreatmentTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["RiskTreatmentTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

RiskTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["RiskTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

Scenario Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string
`repeat`	string optional
`steps`	contained → Step list optional
`type`	contained → ScenarioType

{% for item in by_type["Scenario"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

ScenarioTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["ScenarioTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

Stakeholder alias: stakeholders Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`partOf`	reference → Stakeholder optional
`subType`	contained → StakeholderSubType optional
`super`	reference → Stakeholder optional
`tags`	contained → Tag list optional
`type`	contained → StakeholderType

{% for item in stakeholders %}
{{ item.id }} — {{ item.title }}
{% endfor %}

StakeholderSubTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["StakeholderSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

StakeholderTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["StakeholderTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

State Link

Field	Shape
`isFinal`	boolean optional
`isInitial`	boolean optional
`name`	string optional
`nameAlias`	string optional
`onEntry`	string optional
`onExit`	string optional
`states`	contained → State list optional
`transitions`	contained → Transition list optional

{% for item in by_type["State"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

StateMachine Link

Field	Shape
`description`	string optional
`entity`	reference → DataEntityGeneric optional
`name`	string
`nameAlias`	string optional
`states`	contained → States optional
`tags`	contained → Tag list optional
`type`	contained → StateMachineType

{% for item in by_type["StateMachine"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

StateMachineTest Link

Field	Shape
`description`	string optional
`message`	string optional
`name`	string
`nameAlias`	string optional
`stateMachine`	reference → StateMachine optional
`stateSequence`	contained → StateSequence optional
`tags`	contained → Tag list optional
`type`	contained → TestType

{% for item in by_type["StateMachineTest"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

StateMachineTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["StateMachineTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

Step Link

Field	Shape
`actor`	reference → Actor optional
`description`	string optional
`event`	reference → ActiveEvent optional
`name`	string
`nameAlias`	string
`next`	reference → Step optional
`repeat`	string optional
`scenarios`	contained → Scenario list optional
`subType`	contained → StepSubType optional
`type`	contained → StepType optional
`typeUC`	contained → StepOperationUCType optional
`usecase`	reference → UseCase optional

{% for item in by_type["Step"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

StepSubTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["StepSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

StepTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["StepTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

Stereotype Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`tags`	contained → Tag list optional
`type`	contained → StereotypeType

{% for item in by_type["Stereotype"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

StereotypeTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["StereotypeTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

System Link

Field	Shape
`description`	string optional
`isFinal`	boolean optional
`isReusable`	boolean optional
`name`	string
`nameAlias`	string optional
`partOf`	reference → System optional
`subType`	contained → SystemSubType optional
`systemConcepts`	contained → SystemConcept list optional
`tags`	contained → Tag list optional
`type`	contained → SystemType
`vendor`	string optional
`version`	string optional

{% for item in by_type["System"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

SystemsRelation Link

Field	Shape
`category`	contained → SystemsRelationCategory optional
`description`	string optional
`name`	string
`nameAlias`	string optional
`source`	reference → System optional
`tags`	contained → Tag list optional
`target`	reference → System optional
`type`	contained → SystemsRelationType

{% for item in by_type["SystemsRelation"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

SystemsRelationCategoryExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["SystemsRelationCategoryExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

SystemsRelationTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["SystemsRelationTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

SystemSubTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["SystemSubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

SystemTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["SystemTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

TestCase Link

Field	Shape
`description`	string optional
`entity`	reference → DataEntity optional
`entityTable`	contained → DataTable optional
`name`	string
`nameAlias`	string optional
`testParameters`	contained → TestParameter list optional
`testSteps`	contained → TestStep list optional

{% for item in by_type["TestCase"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

TestParameter Link

Field	Shape
`name`	string

{% for item in by_type["TestParameter"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

TestScenarioTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["TestScenarioTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

TestsRelation Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`source`	reference → Test optional
`tags`	contained → Tag list optional
`target`	reference → Test optional
`type`	contained → TestsRelationType

{% for item in by_type["TestsRelation"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

TestsRelationTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["TestsRelationTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

TestSuite Link

Field	Shape
`description`	string optional
`elements`	contained → TestElement list optional
`isFinal`	boolean optional
`isReusable`	boolean optional
`name`	string
`nameAlias`	string optional
`subType`	contained → SystemSubType optional
`sut`	reference → System
`tags`	contained → Tag list optional
`type`	contained → SystemType

{% for item in by_type["TestSuite"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

TestTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["TestTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

Theme Link

Field	Shape
`description`	string optional
`elements`	contained → ReferenceElements
`name`	string
`nameAlias`	string optional
`tags`	contained → Tag list optional
`type`	contained → ThemeType

{% for item in by_type["Theme"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

UCExtensionPoint Link

Field	Shape
`description`	string optional
`name`	string

{% for item in by_type["UCExtensionPoint"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

UseCase alias: use_cases Link

Field	Shape
`acceptanceCriteria`	contained → AcceptanceCriteria list optional
`actions`	contained → UCActions optional
`dataEntity`	reference → DataEntityGeneric optional
`description`	string optional
`extends`	contained → UCExtends list optional
`extensionPoints`	contained → UCExtensionPoints optional
`includes`	contained → UCIncludes optional
`isAbstract`	boolean optional
`isConcrete`	boolean optional
`isNegative`	boolean optional
`isPositive`	boolean optional
`isProblem`	boolean optional
`isSolution`	boolean optional
`mainScenarios`	contained → MainScenario list optional
`name`	string
`nameAlias`	string optional
`postcondition`	string optional
`precondition`	string optional
`primaryActor`	reference → Actor optional
`priority`	contained → PriorityType optional
`stakeholder`	reference → Stakeholder optional
`supportingActors`	contained → RefActor list optional
`tags`	contained → Tag list optional
`triggeredBy`	reference → ActiveEvent optional
`type`	contained → UseCaseType

{% for item in use_cases %}
{{ item.id }} — {{ item.title }}
{% endfor %}

UseCaseTest Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional
`oneTimeSetupSteps`	contained → TestStep list optional
`oneTimeTeardownSteps`	contained → TestStep list optional
`primaryActor`	reference → Actor optional
`supportingActors`	contained → RefActor list optional
`tags`	contained → Tag list optional
`testCases`	contained → TestCase list optional
`useCase`	reference → UseCase optional

{% for item in by_type["UseCaseTest"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

UseCaseTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["UseCaseTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

UserStory alias: user_stories Link

Field	Shape
`acceptanceCriteria`	contained → AcceptanceCriteria list optional
`actor`	reference → Actor optional
`description`	string optional
`goal`	string optional
`isAbstract`	boolean optional
`isConcrete`	boolean optional
`isNegative`	boolean optional
`isPositive`	boolean optional
`isProblem`	boolean optional
`isSolution`	boolean optional
`name`	string
`nameAlias`	string optional
`otherRole`	string optional
`partOf`	reference → UserStory optional
`priority`	contained → PriorityType optional
`reason`	string optional
`stakeholder`	reference → Stakeholder optional
`tags`	contained → Tag list optional
`type`	contained → UserStoryType

{% for item in user_stories %}
{{ item.id }} — {{ item.title }}
{% endfor %}

UserStoryTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["UserStoryTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

VariableTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["VariableTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

View Link

Field	Shape
`description`	string optional
`elements`	contained → ReferenceElements
`name`	string
`nameAlias`	string optional
`tags`	contained → Tag list optional
`type`	contained → ViewType

{% for item in by_type["View"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

Vulnerability Link

Field	Shape
`attack`	string optional
`attackVector`	contained → VulnerabilityAttackVector optional
`description`	string optional
`name`	string
`nameAlias`	string optional
`partOf`	reference → Vulnerability optional
`score`	string \| number optional
`solution`	contained → RefRequirements optional
`subType`	contained → VulnerabilitySubType optional
`super`	reference → Vulnerability optional
`tags`	contained → Tag list optional
`type`	contained → VulnerabilityType

{% for item in by_type["Vulnerability"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

VulnerabilityAttackVectorExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["VulnerabilityAttackVectorExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

VulnerabilitySubTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["VulnerabilitySubTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

VulnerabilityTypeExtended Link

Field	Shape
`description`	string optional
`name`	string
`nameAlias`	string optional

{% for item in by_type["VulnerabilityTypeExtended"] %}
{{ item.id }} — {{ item.title }}
{% endfor %}

Embedded types 155

These types are not indexed in by_type. Reach them through fields on their parent objects.

AcceptanceCriteriaRule

Link

rule

AcceptanceCriteriaScenario

Link

givenscenariothenwhen

ActionTypeExtendedRef

Link

type

ActionTypeOriginal

Link

type

ActiveEventTypeExtendedRef

Link

type

ActiveEventTypeOriginal

Link

type

ActiveFlowTypeExtendedRef

Link

type

ActiveFlowTypeOriginal

Link

type

ActiveTaskTypeExtendedRef

Link

type

ActiveTaskTypeOriginal

Link

type

ActorTypeExtendedRef

Link

type

ActorTypeOriginal

Link

type

AttributeValue

Link

booleandatedateTimedoubleOrIntpercentagestringtime

Boolean

Link

type

ChildDataEntity

Link

childchildUses

ConstraintSubTypeExtendedRef

Link

type

ConstraintSubTypeOriginal

Link

type

ConstraintTypeExtendedRef

Link

type

ConstraintTypeOriginal

Link

type

DataAttributeConstraint

Link

checksexpressionforeignKeyisDerivedisEncryptedisNotNullisNotVisibleisPrimaryKeyisReadOnlyisUniquemanyToManymultiplicity

DataAttributeRefsList

Link

attributeRef

DataAttributeType

Link

sizetype

DataAttributeTypeExtendedRef

Link

sizetype

DataAttributeTypeOriginal

Link

sizetype

DataEntityClusterTypeExtendedRef

Link

type

DataEntityClusterTypeOriginal

Link

type

DataEntityConstraint

Link

checksisEncryptedisReadOnlyshowAsAttribute

DataEntitySubTypeExtendedRef

Link

type

DataEntitySubTypeOriginal

Link

type

DataEntityTypeExtendedRef

Link

type

DataEntityTypeOriginal

Link

type

DataEnumerationRef

Link

dataEntitysizetype

DataTable

Link

tableHeadertableRows

DataTableHeader

Link

attributeRefs

DataTableRow

Link

attributeValues

DateRule

Link

daymonthyear

DateTime

Link

dayhhmmmonthssyear

ElementsRelationType

Link

type

Expression

Link

metricoperatorvalue

ExpressionOperator

Link

value

ForeignKey

Link

defaultValueonDeleteshowAsFieldtargetEntitytoField

ForeignKeyOnDeleteTypeExtendedRef

Link

type

ForeignKeyOnDeleteTypeOriginal

Link

type

FRTypeExtendedRef

Link

type

FRTypeOriginal

Link

type

GlossaryTermTypeExtendedRef

Link

type

GlossaryTermTypeOriginal

Link

type

GoalSubTypeExtendedRef

Link

type

GoalSubTypeOriginal

Link

type

GoalTypeExtendedRef

Link

type

GoalTypeOriginal

Link

type

ImpactLevel

Link

type

Import

Link

importedNamespace

IncludeAll

Link

descriptionsystemtags

IncludeElement

Link

descriptionelementsystemtagstypeupdateFields

IncludeSystemElementType

Link

type

LinguisticFragmentRef

Link

option

LinguisticPattern

Link

parts

LinguisticRuleElement

Link

element

LinguisticRuleElementAndProperty

Link

elementproperty

LinguisticRuleType

Link

type

ManyToMany

Link

targetEntitythroughEntitythroughSourceFieldthroughTargetField

MetricTypeExtendedRef

Link

type

MetricTypeOriginal

Link

type

Model

Link

packages

Month

Link

type

Multiplicity

Link

type

PartOfSpeech

Link

posTag

PriorityTypeExtendedRef

Link

type

PriorityTypeOriginal

Link

type

QRSubTypeExtendedRef

Link

type

QRSubTypeOriginal

Link

type

QRTypeExtendedRef

Link

type

QRTypeOriginal

Link

type

RefActiveElement

Link

refActiveElement

RefActor

Link

refs

RefDataEntity

Link

refDataEntity

ReferenceElements

Link

references

RefRequirements

Link

refs

RefTermApplicableTo

Link

refs

RefUC

Link

refs

RefUCAction

Link

actionuseCase

RelationTypeExtendedRef

Link

type

RelationTypeOriginal

Link

type

RequirementsRelationTypeExtendedRef

Link

type

RequirementsRelationTypeOriginal

Link

type

RiskAssessment

Link

consequenceimpactimpactLevelprobability

RiskStatus

Link

type

RiskSubTypeExtendedRef

Link

type

RiskSubTypeOriginal

Link

type

RiskTreatmentTypeExtendedRef

Link

type

RiskTreatmentTypeOriginal

Link

type

RiskTypeExtendedRef

Link

type

RiskTypeOriginal

Link

type

ScenarioTypeExtendedRef

Link

type

ScenarioTypeOriginal

Link

type

StakeholderSubTypeExtendedRef

Link

type

StakeholderSubTypeOriginal

Link

type

StakeholderTypeExtendedRef

Link

type

StakeholderTypeOriginal

Link

type

StateMachineTypeExtendedRef

Link

type

StateMachineTypeOriginal

Link

type

StateSequence

Link

refState

StepOperationUCType

Link

type

StepSubTypeExtendedRef

Link

type

StepSubTypeOriginal

Link

type

StepTypeExtendedRef

Link

type

StepTypeOriginal

Link

type

StereotypeTypeExtendedRef

Link

type

StereotypeTypeOriginal

Link

type

SystemsRelationCategoryExtendedRef

Link

type

SystemsRelationCategoryOriginal

Link

type

SystemsRelationTypeExtendedRef

Link

type

SystemsRelationTypeOriginal

Link

type

SystemSubTypeExtendedRef

Link

type

SystemSubTypeOriginal

Link

type

SystemTypeExtendedRef

Link

type

SystemTypeOriginal

Link

type

Tag

Link

nameAliasvalue

TermApplicableTo

Link

type

TestDataAttribute

Link

attributeisDerivedisEncryptedisNotNullisReadOnlyisUniquemessagesizetypevalues

TestScenarioTypeExtendedRef

Link

type

TestScenarioTypeOriginal

Link

type

TestsRelationTypeExtendedRef

Link

type

TestsRelationTypeOriginal

Link

type

TestStep

Link

actordescriptioneventnameAliassubTypetestCasetype

TestSuiteSetup

Link

testSteps

TestSuiteTeardown

Link

testSteps

TestTypeExtendedRef

Link

type

TestTypeOriginal

Link

type

ThemeType

Link

type

Threat

Link

value

Time

Link

hhmmss

Transition

Link

nextstateucAction

UCActions

Link

actions

UCExtends

Link

extensionPointusecase

UCExtensionPoints

Link

extensionPoints

UCIncludes

Link

includes

UpdateField

Link

nameFieldvalueField

UpdateFields

Link

updateFields

UseCaseTypeExtendedRef

Link

type

UseCaseTypeOriginal

Link

type

UserStoryTypeExtendedRef

Link

type

UserStoryTypeOriginal

Link

type

VariableType

Link

dataEntitysizetype

VariableTypeExtendedRef

Link

dataEntitysizetype

VariableTypeOriginal

Link

dataEntitysizetype

ViewType

Link

type

VulnerabilityAttackVectorExtendedRef

Link

type

VulnerabilityAttackVectorOriginal

Link

type

VulnerabilitySubTypeExtendedRef

Link

type

VulnerabilitySubTypeOriginal

Link

type

VulnerabilityTypeExtendedRef

Link

type

VulnerabilityTypeOriginal

Link

type

Word

Link

word

RSL compatibility collections

Built-in collections preserved for existing templates.

Variable	Collected types
`stakeholders`	`Stakeholder`
`actors`	`Actor`
`goals`	`Goal`
`functional_requirements`	`FR`
`quality_requirements`	`QR`
`constraints`	`Constraint`
`user_stories`	`UserStory`
`use_cases`	`UseCase`
`glossary`	`GlossaryTerm`
`data_entities`	`DataEntity`
`other`	Other named elements