Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

Registry v2

A simplified registry structure aligned 1:1 with the Enterprise Meta Model.

Design Principles

  1. EMM-aligned structure — 4 layers matching the meta model
  2. Machine-readable frontmatter — YAML with typed relationship fields
  3. ArchiMate-derived relationships — Singular/plural based on arrow cardinality
  4. Automation-readyregistered field distinguishes source-system imports from manual entries
  5. Agent-navigable — Relationship fields enable Claude agents to traverse the graph

Structure Overview

registry-v2/
├── 1-business/                        # Layer 1: Business
│   ├── market-segments/
│   ├── products/
│   └── business-services/
│
├── 2-organization/                    # Layer 2: Organization
│   ├── actors/
│   ├── roles/
│   ├── capabilities/
│   ├── events/
│   ├── information-objects/
│   ├── value-streams/
│   ├── processes/                     # E2E, Module, Task via process_level field
│   └── organisation-units/
│
├── 3-application/                     # Layer 3: Application
│   ├── domains/
│   ├── components/
│   ├── software-systems/
│   ├── software-subsystems/
│   ├── software-components/
│   ├── domain-events/
│   ├── api-contracts/
│   ├── api-endpoints/
│   ├── data-concepts/
│   ├── data-aggregates/
│   └── data-entities/
│
└── 4-technology/                      # Layer 4: Technology
    ├── infrastructure-functions/
    ├── application-infrastructure/
    ├── cloud-services/
    ├── infrastructure-apis/
    ├── infra-nodes/
    ├── network-zones/
    └── networking-equipment/

Template Structure

Each _template.md follows this pattern:

---
# ── Core Fields ──────────────────────────────────────────────
type: <element-type>           # EMM element type
name:                          # Display name
description:                   # Brief description
owner:                         # Owning team
status: draft                  # draft | active | deprecated
registered: false              # true if from source system

# ── Relationships (from EMM arrows) ──────────────────────────
# Composition: parent (singular)
parent_<element>: 

# Composition: children (array)
child_<elements>: []

# Realization: what this realizes (singular or array)
realizes_<element>: 
realized_by_<elements>: []

# Assignment/Owns (array)
owns_<elements>: []

# ── Alignment ────────────────────────────────────────────────
archimate_type: <archimate-element>
togaf_type: <togaf-element>
# ... other framework alignments
---

<!-- Extended description, diagrams, notes, etc. -->

Relationship Cardinality Rules

Based on ArchiMate arrow types in the EMM diagram:

Arrow Type Meaning Cardinality Field Format
◇─ (hollow diamond) Aggregation 1:N aggregates_<elements>: []
◆─ (filled diamond) Composition 1:N composes_<elements>: []
─▷ (dashed) Realization N:1 realizes_<element>: (singular)
─▷ (dashed, reverse) Realized by 1:N realized_by_<elements>: []
─► (serving) Serving/Used by N:N serves_<elements>: []
●─► (assignment) Assignment/Owns 1:N owns_<elements>: []
─► (flow/triggering) Triggering N:N triggers_<elements>: []

Usage

Creating a new entry

cp registry-v2/3-application/software-systems/_template.md \
   registry-v2/3-application/software-systems/my-system.md

Automation pipeline

Source Systems (Catalogs, etc.)
       │
       ▼
   Registry (YAML frontmatter)  ◄── Manual entries (registered: false)
       │
       ├──► XML Shape Library (via generate_library.py)
       │         │
       │         ▼
       │    Draw.io / Archi (shapes with properties)
       │
       └──► Claude Agents (navigation, diagram generation)

Key fields for automation

  • registered: true — Imported from source system, don't manually edit
  • registered: false — Manually created, can be edited
  • status: deprecated — Soft delete, exclude from shape library
  • Relationship fields — Used by agents for graph traversal

Process Levels (APQC Alignment)

The processes/ folder handles 3 EMM elements via the process_level field:

process_level apqc_level EMM Element Description
e2e L3 E2E Process How a Business Service is offered
module L4 Business Process Module Reusable tasks within a capability
task L5 Process Task Smallest unit (OTOPOP)

Hierarchy is maintained via parent_process and child_processes relationships.

Quick Reference

EMM Element Folder Template
Market Segment 1-business/market-segments/ _template.md
Product 1-business/products/ _template.md
Business Service 1-business/business-services/ _template.md
Actor 2-organization/actors/ _template.md
Business Role 2-organization/roles/ _template.md
Business Capability 2-organization/capabilities/ _template.md
Business Event 2-organization/events/ _template.md
Business Information Object 2-organization/information-objects/ _template.md
Value Stream 2-organization/value-streams/ _template.md
Process (E2E/Module/Task) 2-organization/processes/ _template.md
Organization Unit 2-organization/organisation-units/ _template.md
Domain 3-application/domains/ _template.md
Component 3-application/components/ _template.md
Software System 3-application/software-systems/ _template.md
Software SubSystem 3-application/software-subsystems/ _template.md
Software Component 3-application/software-components/ _template.md
Domain Event 3-application/domain-events/ _template.md
API Contract 3-application/api-contracts/ _template.md
API Endpoint 3-application/api-endpoints/ _template.md
Data Concept 3-application/data-concepts/ _template.md
Data Aggregate 3-application/data-aggregates/ _template.md
Data Entity 3-application/data-entities/ _template.md
Infrastructure Function 4-technology/infrastructure-functions/ _template.md
Application Infrastructure 4-technology/application-infrastructure/ _template.md
Cloud Service 4-technology/cloud-services/ _template.md
Infrastructure API 4-technology/infrastructure-apis/ _template.md
Infrastructure Node 4-technology/infra-nodes/ _template.md
Network Zone 4-technology/network-zones/ _template.md
Networking Equipment 4-technology/networking-equipment/ _template.md