CodamAIDocs
Themafertig

Mitgelieferte Vorlagen

Vorlagen, die mit einem Build ausgeliefert werden, kommen über denselben Weg ins System wie jede andere: als Entwurf, eingereicht von einem Plattform-Administrator. Am Beispiel der Berichte des Hubs.

Ausprägungen
erster StartStart mit unveränderter VorlageStart mit geänderter VorlageSYSTEM-Scope mit Freigabestufen

Worum es geht

Manche Vorlagen gehören zu einem Build. Sie liegen im Quellcode einer Anwendung, werden mit ihr geprüft und getestet und sollen nach dem Start einfach da sein. CRMS hat dafür keinen Sonderweg: keinen Vorlagenordner, den es selbst liest, und keine Vorlage, die an der Kette vorbeigeht.

Der Ablauf

Einspielen beim Start
  1. 1
    Anwendung→CRMS
    meldet sich als Plattform-Administrator an: eine feste Kennung als Autor, die Administrator-Rollen aus CIAS, kein Mandant
  2. 2
    Anwendung→CRMS
    legt die System-Ausgabe an, falls es sie noch nicht gibt, und je Sprache die Variante
  3. 3
    Anwendung→CRMS
    liest die veröffentlichte Revision der Variante
  4. 4
    Anwendung
    Ist ihr Quelltext gleich dem aus dem Build?
  5. 5
    Anwendung
    gleich → nichts tun, keine neue Revision
  6. 6
    Anwendung→CRMS
    anders oder noch nichts veröffentlicht → Entwurf speichern und mit Grund einreichen
  7. 7
    CRMS
    die Freigabekette des Scopes SYSTEM entscheidet, wie bei jeder Vorlage
    Ergebnis: ohne Stufen sofort PUBLISHED, sonst IN_REVIEW

Weil die Anwendung nur bei einem Unterschied einreicht, ändert ein Start mit unverändertem Build nichts an der Kette. Eine geänderte Vorlage im neuen Build wird genau eine neue Revision.

Was ein Start bewirkt

Wann: es gibt die Vorlage noch nicht

Ausgabe und Varianten entstehen, jede Variante bekommt ihre erste Revision.

Ergebnis: Revision 1 je Sprache, ohne Freigabestufen PUBLISHED

Wann: der Quelltext im Build ist gleich der veröffentlichten Revision

Die Anwendung reicht nichts ein.

Ergebnis: keine neuen Einträge

Wann: ein neuer Build bringt einen anderen Quelltext

Nur die geänderte Variante bekommt eine neue Revision. Die übrigen bleiben, wie sie sind.

Ergebnis: neue Revision, die vorige wird SUPERSEDED

Wann: das Projekt hat für SYSTEM eine Freigabekette

Die eingereichte Revision wartet in IN_REVIEW, bis Menschen sie freigeben. Bis dahin rendert die vorige Revision. Solange eine Revision in Prüfung ist, endet ein weiteres Einreichen mit 409 template-review-pending.

Ergebnis: Freigabe wie bei jeder System-Vorlage

Das Beispiel: die Berichte des Hubs

Der Hub rendert seine Projektdokumente mit einem eingebetteten CRMS: die arc42-Architekturdokumentation, die Datenklassifizierung und das Betriebshandbuch. Die Vorlagen liegen im Build unter crms-templates/.

BerichtSchlüssel DOCUMENT (PDF, HTML)Schlüssel WORD (DOCX)Sprachen
arc42arc42arc42-wordde (Standard), en
Datenklassifizierungprivacyprivacy-wordde (Standard), en
Betriebshandbuchrunbookrunbook-wordde (Standard), en

Jeder Bericht sind zwei Schlüssel, weil die Ausgabeart die Formate festlegt. Die Dateien heißen <schlüssel>/<sprache>.xhtml.ftl für DOCUMENT und <schlüssel>-word/<sprache>.xml.ftl für WORD.

Als Autor steht hub-backend in der Kette, als Grund „Template shipped with the hub-backend build”. Der Hub legt für SYSTEM keine Freigabestufen fest. Seine Vorlagen sind also nach dem Einreichen sofort veröffentlicht. Wie der Hub sie dann rendert, steht unter Beispiel: die Berichte des Hubs.

Fallen

Weiter

Suchen