CodamAIDocs
Themafertig

Vorschau, endgültig, flüchtig

Die drei Modi PREVIEW, FINAL und TRANSIENT: was gespeichert und gesiegelt wird, wie jedes Format sagt, was es ist (Wasserzeichen und Markierung), und wann TRANSIENT erlaubt ist.

Ausprägungen
PREVIEWFINALTRANSIENTFINAL ausgeschaltet → document-revisions-disabledTRANSIENT ausgeschaltet → transient-documents-disabledTRANSIENT aus Mandanten- oder Benutzervorlage → transient-requires-system-templateTRANSIENT als CSV → render-mode-not-for-format

Worum es geht

Jede Render-Anfrage nennt einen Modus. Er entscheidet, ob CRMS das Dokument aufbewahrt und wie das Dokument selbst sagt, was es ist. Es gibt drei Modi:

  • PREVIEW (Vorschau): zum Prüfen beim Bearbeiten. Trägt sichtbar „PREVIEW“, wird nie gespeichert.
  • FINAL (endgültig): ein Nachweis. Wird gesiegelt, als nächste Revision abgelegt und erst dann zurückgegeben.
  • TRANSIENT (flüchtig): eine Arbeitskopie, die jemand herunterlädt, druckt oder weitergibt. Kein Wasserzeichen, wird nicht gespeichert, ist aber in den Metadaten als flüchtig markiert.

Die drei Modi im Vergleich

Was jeder Modus tut
PREVIEWFINALTRANSIENT
Gespeichertneinja, als nächste Revision der Dokumentkettenein
Gesiegeltneinja (PDF, wenn ein Siegel eingerichtet ist)nein
Sichtbares Wasserzeichenja, PREVIEWneinnein
Markierung in den Metadatencrms-previewkeinecrms-transient
Referenz nötigneinjanein
Anhänge erlaubtjaneinja
Header Crms-Document-Revisionneinjanein
Eingeschaltetimmerwenn endgültige Dokumente gespeichert werdennur wenn eingeschaltet, nur für Systemvorlagen

Wie jedes Format den Modus zeigt

FormatPREVIEWTRANSIENTFINAL
HTML<meta name="crms-preview" content="true"/> und ein großes, schräges PREVIEW über der Seite<meta name="crms-transient" content="true"/>nichts
PDFPREVIEW als hellgraues Wasserzeichen, Schlüsselwort crms-preview in Dokumentinfo und XMPSchlüsselwort crms-transient in Dokumentinfo und XMPnichts
DOCXerster Absatz PREVIEW, Schlüsselwort crms-preview in den DokumenteigenschaftenSchlüsselwort crms-transient in den Dokumenteigenschaftennichts
XLSXPREVIEW in der Kopfzeile beim Drucken und als Titel, Schlüsselwort crms-previewSchlüsselwort crms-transientnichts
ODSSchlüsselwort crms-preview in den MetadatenSchlüsselwort crms-transient in den Metadatennichts
CSVerste Zeile PREVIEWabgelehnt: render-mode-not-for-format|csvnichts

XMP sind Metadaten, die in einem PDF stecken und die Archivsysteme lesen. CSV hat keine Metadaten. Es kann nicht sagen, dass es flüchtig ist, darum lehnt CRMS TRANSIENT für CSV ab.

Die Abläufe

Ein Modus, ein Ablauf

Wann: jemand prüft eine Vorlage oder einen Entwurf des Berichts

  1. 1
    Client→CRMS
    schickt mode: PREVIEW
  2. 2
    CRMS
    prüft Anfrage und Payload, rendert
  3. 3
    CRMS
    setzt Wasserzeichen und Markierung crms-preview
  4. 4
    CRMS→Client
    gibt die Bytes zurück
    Ergebnis: Vorschau, nirgends gespeichert

Wann: das Dokument ist ein Nachweis, etwa ein abgeschlossener Prüfbericht

  1. 1
    Client→CRMS
    schickt mode: FINAL mit reference
  2. 2
    CRMS
    prüft Anfrage und Payload, rendert
  3. 3
    CRMS
    siegelt das PDF, wenn ein Siegel eingerichtet ist
  4. 4
    CRMS→Dateispeicher
    legt das Dokument als nächste Revision der Kette ab, in der Transaktion des Aufrufers
  5. 5
    CRMS→Client
    gibt dieselben Bytes zurück, mit Crms-Document-Revision
    Ergebnis: Nachweis abgelegt, Revision bekannt

Wann: eine Arbeitskopie zum Herunterladen, Drucken oder Weitergeben, aus einer Systemvorlage

  1. 1
    Client→CRMS
    schickt mode: TRANSIENT
  2. 2
    CRMS
    Ist TRANSIENT in dieser Installation eingeschaltet?
  3. 3
    CRMS
    Kommt die gefundene Revision aus dem Scope SYSTEM?
  4. 4
    CRMS
    rendert und setzt die Markierung crms-transient, ohne Wasserzeichen
  5. 5
    CRMS→Client
    gibt die Bytes zurück
    Ergebnis: Kopie ohne Wasserzeichen, nirgends gespeichert

Was bei FINAL gespeichert wird und wie die Kette aussieht, steht unter Was ein endgültiges Dokument ist. Das Siegel erklärt Das Siegel.

Wann ein Modus abgelehnt wird

ModusBedingungErgebnis
PREVIEW–erlaubt
FINALohne referencerequired im Feld reference (REST)
FINALInstallation speichert keine endgültigen Dokumente409 document-revisions-disabled
FINALmit Anhängen422 attachments-not-for-final
TRANSIENTnicht eingeschaltet409 transient-documents-disabled
TRANSIENTRevision aus Scope TENANT oder USER422 transient-requires-system-template
TRANSIENTFormat CSV422 render-mode-not-for-format|csv
TRANSIENTeingeschaltet und Systemvorlageerlaubt

TRANSIENT schaltest du mit CODAMAI_CRMS_TRANSIENT_DOCUMENTS=true ein. Standard ist false. Ob endgültige Dokumente gespeichert werden, stellst du am CRMS-Modul im Hub ein, siehe Das CRMS-Modul im Hub.

Warum nur Systemvorlagen? Eine Systemvorlage hat die Freigabe der Plattform durchlaufen. Ein Mandant soll den Modus nicht nutzen können, um aus einer eigenen Vorlage, die die Plattform nie gesehen hat, Dokumente ohne Wasserzeichen zu erzeugen. Woher Systemvorlagen kommen können, steht unter Vorlagen aus dem Build.

Fallen

Weiter

Suchen