Versionierung


Die Versionierung in primedocs erlaubt es, auch komplexere Änderungen in den Vorlagen vorzunehmen und zu testen, ohne die produktiven Vorlagen zu gefährden.

Generell gilt, dass eine Vorlage mehrere Versionen besitzen kann, wobei alle Versionen über die eindeutige TemplateId verbunden sind. Wird eine neue Version einer vorhanden Vorlage erstellt, werden alle Daten kopiert. Eine Version wird manuell angelegt.


Freigabemodus

Um die richtige Vorlagenversion während der Dokumenterzeugung zu wählen, muss eine Version entsprechend markiert werden:

  • Veröffentlicht/Published: Diese Vorlagenversion ist die öffentliche Version, die für alle Benutzer sichtbar ist.

  • Entwurf/Draft: Diese Vorlagenversion wird zum Testen benutzt und ist nur für Vorlagen-Administratoren sichtbar.

  • Unspecified: Diese Vorlage ist weder als "Draft" noch "Published" definiert (in der Regel eine alte Vorlagenversion).

"Veröffentlicht" und "Entwurf" können gleichzeitig gesetzt sein. "Veröffentlicht" und "Entwurf" zusammen verhalten sich wie "Veröffentlicht" alleine.


Erzeugungsarten

Für die Document Engine gibt es drei verschiedene Arten, eine Vorlage zu öffnen:

  • Dokument: Die Vorlage wird benutzt, um ein neues Dokument zu erstellen. Beispielsweise wird sie direkt im Client ausgewählt und ein neues Dokument generiert.

  • Editor: Die Vorlage wird aus dem Vorlageneditor im entsprechenden Editor geöffnet.

  • Dokument testen: Um eine Vorlage zu testen, wird ein Dokument aus dem Vorlageneditor mittels “Dokument testen" erzeugt. Technisch gesehen, ist das der genau gleiche Vorgang, wie wenn ein Dokument generiert wird.


Vererbung und Unterdokumente

Je nach Erzeugungsart (Dokument/Editor/Dokument testen) und Freigabemodus (Veröffentlicht/Entwurf/Unspecified) wird die Vererbung oder die Unterdokument-Relation unterschiedlich aufgelöst.

Erzeugungsart

Version der ausgewählen Vorlage

Aufgelöste Version der Abhängigkeiten

Erzeugungsart

Version der ausgewählen Vorlage

Aufgelöste Version der Abhängigkeiten

Dokument

Veröffentlicht

Veröffentlicht

Dokument

Entwurf

(nicht möglich)

Dokument

Unspecified

(nicht möglich)

Editor

Veröffentlicht

Veröffentlicht

Editor

Entwurf

Entwurf

Editor

Unspecified

Entwurf

Dokument testen

Veröffentlicht

Entwurf

Dokument testen

Entwurf

Entwurf

Dokument testen

Unspecified

Entwurf


Nutzungsszenarien

Normale Dokumenterzeugung – "Dokument"

Generiert man als Benutzer ein Dokument (= Erzeugungsart "Dokument") wird die als "veröffentlicht" markierte Version der Vorlage genommen. Etwaige Abhängigkeiten, z. B. Layoutvorlagen oder Style-Vorlagen, werden auch als "veröffentlicht" aufgelöst. Die Erzeugungsart "Dokument" ist nur mit "veröffentlicht" markierten Vorlagen erlaubt. Möchte man Änderungen testen, gibt es den "Dokument testen"-Button.

Änderung an einer aktuell freigegebenen Vorlage – "Editor" und "Veröffentlicht"

Editiert der Vorlagenbearbeiter eine bereits freigegebene Vorlagenversion (= "veröffentlicht") werden alle Abhängigkeiten ebenfalls als "veröffentlicht" aufgelöst. Die Variante hier ist nur für überschaubare Änderungen empfohlen. Bei grösseren Änderungen sollte stets eine neue Version angelegt werden.

Änderung an einem Style und Testen der Auswirkungen

Der Vorlagenbearbeiter kann eine neue Version der Style-Vorlage anlegen. Diese Version wird automatisch als "Entwurf" markiert. Um die Änderungen in einer Inhaltsvorlage zu prüfen, kann der Vorlagenbearbeiter nun über "Dokument testen" ein Testdokument erzeugen. Dadurch wird der "Entwurf"-Style als Abhängigkeit aufgelöst.

Hinzufügen eines neuen Styles und nutzen des Styles in einer neuen Layoutversion

Möchte man einen neuen Style zu einer bestehenden Style-Vorlage hinzufügen und den Style auch in einer übergeordneten Layoutvorlage nutzen, kann vom Style als auch von der Layoutvorlage jeweils eine neue Version angelegt werden. Beide neuen Versionen sind automatisch als "Entwurf" gekennzeichnet. Wird nun der "Editor" von der Layoutvorlage gestartet, wird der geänderte ebenfalls im "Entwurf"-Modus befindliche Style geladen. Wenn die Änderungen abgeschlossen sind, können beide Versionen gemeinsam als "veröffentlicht" gekennzeichnet werden.

PrimeSoft AG, Bahnhofstrasse 4, 8360 Eschlikon, Switzerland