Give every ArchiMate view, element and relationship a page and an IRI, and draw every view

Write a JSON-LD node and a thin page for each model a layer’s cat-archimate.config.json names and for every view, element and relationship in it — keyed by Archi’s own ids — plus the normalised model the pages’ one loader draws from, and every view drawn as SVG from the model’s own bounds and bendpoints in ArchiMate’s notation, each box a link to its element. --out writes into a site being built — the data at the graph’s path, the pages at the route of the visualiser the layer declares for this Tool, <locale>/<harness>/<id>/; without it the files go into the graph and --check gates them.

Skills it satisfies

A skill states the capability; this Tool is one way to exercise it. Each skill’s declared input and output contract follows, where it has one.

archimate-models

ArchiMate models as knowledge-graph content: how a layer declares the Archi models it holds, what the archimate subgraph gives every model, view, element and relationship (an IRI, a thin page, and every view drawn as SVG from the model’s own diagram, and its metamodel derived and checked), how to version the models, how to wire them into a folio’s staging build and navbar, how to count and lower the crossed lines in a view before committing it, why every view carries a plain-language key, why names are the source’s own terms linked to their SKOS concepts, and why no Java, no Archi CLI and no Archi HTML report is ever part of the pipeline. Read before adding, authoring, publishing or rendering an .archimate file, before citing an ArchiMate element from prose, and before reaching for Archi’s own tooling in CI.

Source: cat-harness/skills/ui/ui-core/archimate-models.md.

Also satisfied by: archimate-actors, archimate-blocks, archimate-check, archimate-crossings, archimate-detangle, archimate-metamodel.

The skill declares no I/O contract (schemas/skills/archimate-models/{input,output}.schema.json).

Inputs and outputs

Each port names a shared type by IRI, so two Tools for one skill can be checked for interchangeability.

porttyperequireddescriptionconstraint
ininstanceRepoPathyesThe layer root.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
inoutRepoPathA site being built: the data lands at <out>/<graph path>/ and the pages at <out>/<locale>/<harness>/<id>/, the route of the layer’s one visualiser renderedBy this Tool (none declared: nothing is written). Absent, they are written into the graph, which must be served: true.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
incheckFlagWithout --out: fail if a committed page is missing, stale or orphaned; write nothing.boolean · A boolean switch — projects to a bare flag, with no value word
outpagesCountPages and view drawings written (or found current).integer · A non-negative count — how many of something, or how many to show. Zero is a real answer.

Processes and tasks

Steps this Tool can carry out, because each names a skill it satisfies:

processsteplanevia skill
Publish an ArchiMate model — every picture derived from itCheck the model parses and resolvesCI/CD Pipelinearchimate-models
Publish an ArchiMate model — every picture derived from itDerive the metamodel in useCI/CD Pipelinearchimate-models
Publish an ArchiMate model — every picture derived from itFix the relationship in ArchiModel authorarchimate-models
Publish an ArchiMate model — every picture derived from itWrite pages, drawings and the metamodel pageCI/CD Pipelinearchimate-models
DTH authoringLink to smart-ra ArchiMateBusiness analystarchimate-models

How it is deployed and reached

  • Command line. From the repository root: bun run cat archimate:pages. cat archimate:pages runs bun run cat-harness-tools/archimate/scripts/gen-archimate-pages.ts (declared in cat-harness-tools/package.json).
  • GitHub Actions. No workflow in this checkout runs its command.

As an API: its operation in the OpenAPI document and the MCP tool list of its layer.

installnone
runtimebun
networkno
when to choose it
whenA folio’s staging or publish build should show its ArchiMate models: run after the document site is built and before the navbar pass.
limitsDraws the notation, not Archi’s icons, custom images or fonts; sketch and canvas views are skipped. Never replaced by Archi’s CLI report (skill archimate-models).
costMilliseconds per view; four models of 5,809 pages and 131 drawings (~24 MB) take about 1.5 s. No network, no JVM.

What it is made of

It draws the viewer for the graph typology archimate.

Linked data

The Tool is published as its own JSON-LD document at its IRI, https://litlfred.github.io/folio-assistant/cat-harness/tools/archimate-pages.jsonld, partOf its layer’s document. The node below is the definition this page was drawn from, and is embedded in the page as application/ld+json.

{
  "@context": "https://litlfred.github.io/folio-assistant/cat-harness/cat-harness.context.jsonld",
  "@id": "https://litlfred.github.io/folio-assistant/cat-harness/tools/archimate-pages.jsonld",
  "@type": "https://litlfred.github.io/cat-harness/v0/ns/Tool",
  "partOf": "https://litlfred.github.io/folio-assistant/cat-harness/cat-harness.jsonld",
  "name": "archimate-pages",
  "title": "Give every ArchiMate view, element and relationship a page and an IRI, and draw every view",
  "description": "Write a JSON-LD node and a thin page for each model a layer's `cat-archimate.config.json` names and for every view, element and relationship in it — keyed by Archi's own ids — plus the normalised model the pages' one loader draws from, and every view drawn as SVG from the model's own bounds and bendpoints in ArchiMate's notation, each box a link to its element. `--out` writes into a site being built — the data at the graph's path, the pages at the route of the visualiser the layer declares for this Tool, `<locale>/<harness>/<id>/`; without it the files go into the graph and `--check` gates them.",
  "install": {
    "none": true
  },
  "invoke": {
    "shell": "bun run cat archimate:pages"
  },
  "io": {
    "inputs": [
      {
        "name": "instance",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "The layer root.",
        "required": true,
        "arg": {
          "flag": "--instance"
        }
      },
      {
        "name": "out",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "A site being built: the data lands at `<out>/<graph path>/` and the pages at `<out>/<locale>/<harness>/<id>/`, the route of the layer's one visualiser `renderedBy` this Tool (none declared: nothing is written). Absent, they are written into the graph, which must be `served: true`.",
        "required": false,
        "arg": {
          "flag": "--out"
        }
      },
      {
        "name": "check",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "description": "Without `--out`: fail if a committed page is missing, stale or orphaned; write nothing.",
        "required": false,
        "arg": {
          "flag": "--check"
        }
      }
    ],
    "outputs": [
      {
        "name": "pages",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Count",
        "description": "Pages and view drawings written (or found current)."
      }
    ]
  },
  "satisfies": [
    "archimate-models"
  ],
  "requirements": {
    "runtime": [
      "bun"
    ],
    "network": false
  },
  "renders": [
    "archimate"
  ],
  "selection": {
    "when": "A folio's staging or publish build should show its ArchiMate models: run after the document site is built and before the navbar pass.",
    "limits": "Draws the notation, not Archi's icons, custom images or fonts; sketch and canvas views are skipped. Never replaced by Archi's CLI report (skill `archimate-models`).",
    "cost": "Milliseconds per view; four models of 5,809 pages and 131 drawings (~24 MB) take about 1.5 s. No network, no JVM."
  }
}

folio-assistant — code under the Apache License 2.0, documentation under CC BY 3.0. Generated schema and API references are rebuilt from source on every push to main.

deployed dev