CodamAIDocs
Modul

CRMS – Berichte und Dokumente

CRMS macht aus einer Vorlage und Daten einen Bericht: PDF, HTML, Word oder Excel. Vorlagen ändern sich nur über freigegebene Revisionen, und endgültige Dokumente werden fälschungssicher abgelegt.

CRMS heißt CodamAI Reporting Management System. Der wichtigste Satz vorab:

Wer macht was?
Die Anwendung (z. B. CDMS)
Daten
  • sammelt die Daten für den Bericht
  • schickt eine Render-Anfrage mit Payload
  • entscheidet, wann ein Bericht entsteht
CRMS
Vorlagen und Dokumente
  • verwaltet Vorlagen mit Revisionen und Freigabe
  • prüft die Payload
  • rendert PDF, HTML, Word, Excel
  • legt endgültige Dokumente mit Nachweis ab
CIAS
Identität
  • sagt, wer anfragt
  • liefert Mandant und Rollen
  • CRMS vermerkt die Person an jeder Revision

Drei Arten, ein Dokument zu erzeugen

Vorschau
PREVIEW
  • trägt ein sichtbares Wasserzeichen
  • wird nie gespeichert
  • zum Prüfen beim Bearbeiten
Endgültig
FINAL
  • wird als Revision abgelegt
  • Hash-Kette und Zeitstempel
  • auf WORM-Speicher
Flüchtig
TRANSIENT
  • ohne Wasserzeichen
  • wird nicht gespeichert
  • nur für Systemvorlagen und wenn eingeschaltet

Was die drei genau unterscheidet, steht unter Vorschau, endgültig, flüchtig.

Eingebettet oder als eigener Dienst

CRMS läuft wie CIAS auf zwei Arten: eingebettet in eine Anwendung, die auch CDMS enthält, oder als eigener Dienst, den andere Anwendungen über HTTP aufrufen. Fachlich verhält es sich in beiden Fällen gleich. Welche Art ein Projekt bekommt, leitet der Hub aus der Laufzeit ab, in die das CRMS-Modul gelegt wird. Mehr unter Eingebettet oder getrennt.

Wo du anfängst

Fachlichkeiten

Grundlagen: was CRMS ist

Was CRMS tut und was nicht, die Begriffe, aus denen jede Seite besteht, der Schnitt in Module und Ports und die zwei Betriebsarten: eingebettet oder als eigener Dienst.

Was CRMS istDie BegriffeEingebettet oder als eigener Dienst
Vorlagen

Wie eine Vorlage aufgebaut ist, wie CRMS sie für eine Anfrage findet, wie sie sich über Revisionen und Freigaben ändert, welche FreeMarker-Sprache sie spricht und wie Vorlagen aus einem Build ins System kommen.

Wie eine Vorlage aufgebaut istWie CRMS die Vorlage findetLebenszyklus einer RevisionFreigabekettenDie VorlagenspracheMitgelieferte Vorlagen
Berichte erzeugen

Wie du ein Dokument anforderst: die Render-Anfrage, die Prüfung der Payload, Ausgabetypen und Formate, die drei Modi, Bilder und SVG, die Grenzen beim Rendern sowie Sprache und Zeitzone.

Die Render-AnfrageDie Payload und ihre PrüfungAusgabetypen und FormateVorschau, endgültig, flüchtigBilder und SVGAusführung und GrenzenSprache und Zeitzone
Endgültige Dokumente und Nachweis

Was ein endgültiges Dokument ist, wie Hash-Ketten und Zeitstempel es gegen Änderungen absichern, wie das Siegel wirkt, wo die Bytes liegen, wie lange sie bleiben und wie du alles prüfst.

Was ein endgültiges Dokument istDie zwei Hash-KettenZeitstempel und AnkerDas SiegelAblage auf WORM-SpeicherAufbewahrung, Legal Hold und LöschungPrüfen und lesen
REST-Schnittstelle und Rechte

Die HTTP-Routen unter /crms, die Rollen, mit denen CRMS entscheidet, die eine Fehlerform mit Schlüsseln und der Client, mit dem eine Anwendung einen eigenen CRMS-Dienst aufruft.

Die EndpunkteDie RollenDie FehlerantwortDer Client für den eigenen Dienst
Einrichten und betreiben

Das CRMS-Modul eines Projekts im Hub und seine Optionen, die Umgebungsvariablen, die Datenbank und als Beispiel die Berichte des Hubs.

Das CRMS-Modul im HubUmgebungsvariablenDie DatenbankBeispiel: die Berichte des Hubs
Suchen