Documents
Verschiedene Dokumente können auf Basis einer Vorlage erstellt werden. Der Kontext von Verweisen kann in Dokumenten geändert werden, falls Verweise vorhanden sind.
Dokumente ermöglichen dir: ✅ Informationen mit konkreten Daten zu einem Domänenobjekt zu speichern ✅ Den Kontext des Domänenobjekts dynamisch zu ändern, um unterschiedliche Daten anzuzeigen ✅ Dokumente zu versionieren und Änderungen nachvollziehbar zu machen
Dokumente erstellen
Beim Erstellen eines neuen Formular-Dokuments sind folgende Angaben erforderlich:
- Ein Titel (Pflichtfeld)
- Der Kontext, der für enthaltene Referenzen benötigt wird
- Eine Gruppen ID, falls das Formular-Template ein Filter Tag definiert
Was ist eine Gruppen ID?
- Eine Gruppen ID dient der logischen Gruppierung mehrerer Dokumente.
- Dokumente, die auf Templates mit demselben Filter Tag basieren, können dieselbe Gruppen ID verwenden.
- Verschiedene Dokumente, die auf demselben Template basieren, dürfen keine identische Gruppen ID haben.
- Dokumente mit derselben Gruppen ID erscheinen in derselben Zeile der QM Liste, wenn der entsprechende Filter Tag aktiv ist.
Über das „Plus“-Symbol kann eine Gruppen ID erstellt werden. Sie erscheint nach dem Erstellen in der Dropdown-Auswahl.
Die Gruppen ID erhält automatisch einen eindeutigen Standardnamen, kann aber bei Bedarf individuell benannt werden.
Bearbeiten der Gruppen ID
Nach Erstellung kann die Gruppen ID jederzeit über die Funktion „Edit Document“ (oben rechts im Dokument) angepasst werden.
Gruppen IDs sind verpflichtend, wenn das zugrunde liegende Template einen Filter Tag enthält, und können nicht gelöscht werden.
Weitere Informationen zur QM Liste finden sich unter: QM Listen
Dokumente verwalten
- Viewing Documents: All Documents are listed in the folder tree.
- Selecting Documents: You can select the Documents from the tree.
- Deleting Documents: Once selected the delete option in the document actions, Documents can be deleted.
- Exporting Documents: Selected Documents can be exported. When you export a Documents, a download starts automatically.
- Importing Documents: Previously exported Documents can be re-imported when needed.
- Filtering Documents: Use the search bar at the top to search for Documents by name. Only Documents that match the specified filter will be displayed.
- Creating a New Documents: Click the "+" button at the top or next to any folder to add a new Documents or create Document from Template.
Dokumentenansicht
Analog zu Templates kann auch ein Formular-Dokument den Kontext des CertHub Objekts ändern.
Dies beeinflusst, wie Referenzen aufgelöst und dargestellt werden.
Dynamische Inhalte basierend auf Kontext
- Durch Anpassung des Abstract Reference Selector ändert sich der angezeigte Inhalt dynamisch.
- Verschiedene Konfigurationen zeigen unterschiedliche Werte, abhängig vom ausgewählten Kontext.
Anzeige zugrundeliegender Referenzen
- Beim Überfahren mit der Maus wird die zugrunde liegende Referenz angezeigt.
Dies erleichtert das Verständnis der Datenverknüpfungen innerhalb des Dokuments.
Versionierung von Dokumenten
Das Versionskontrollsystem ermöglicht es dir, sowohl Entwürfe (Revisionen) als auch freigegebene Versionen deiner Dokumente zu verwalten. Es hilft dabei, den Fortschritt nachzuverfolgen, die Historie zu erhalten und Freigaben zu formalisieren.
🧾 Revisionen vs. Versionen
Um zu verstehen, wie das Versionierungskonzept in CertHub funktioniert, kannst du einen Blick auf Versionierung werfen
✍️ Erstellen einer neuen Revision
So erstellst du einen Entwurf deiner Änderungen:
- Klicke oben im Dokument auf „Neue Revision erstellen“
- Gib eine aussagekräftige *Commit-Nachricht ein
- Klicke auf den Button „Neue Revision erstellen“, um die Revision zu speichern
Dabei wird
- Die zweite Zahl der Versionsnummer erhöht (z. B. 0.2, 0.3 usw.)
- Der vollständige Dokumenteninhalt inklusive Metadaten gespeichert
- Das Dokument in den Entwurfsmodus versetzt
✅ Veröffentlichen einer Revision
So gibst du eine Revision frei und veröffentlichst sie:
- Wähle die gewünschte Revision aus
- Klicke auf den Button „Revision veröffentlichen“
- Das Dokument wird als freigegeben markiert
- Eine neue Versionsnummer wird erstellt (z. B. 1.0, 2.0 usw.)
Nach der Veröffentlichung
- Die Revision wird gesperrt und ist nur noch lesbar
- Die Version erscheint im Dokumentenverlauf als freigegebener Stand
🕓 Vorteile
- Vollständige Nachverfolgbarkeit: Jede Änderung ist nachvollziehbar
- Sicheres Arbeiten: Entwürfe können erstellt werden, ohne freigegebene Inhalte zu überschreiben
- Klarheit: Es ist jederzeit ersichtlich, welche Version gültig ist
📄 Dokument aus einer bestimmten Revision oder Version erstellen
Ein besonders hilfreiches Feature des Revisionssystems ist die Möglichkeit, neue Dokumente oder Vorlagen aus beliebigen früheren Versionen zu erstellen. Dies ist nützlich, wenn du:
- Von einer früheren Version aus weiterarbeiten möchtest
- Varianten eines bestehenden Dokuments benötigst
- Inhalte aus älteren Versionen wiederherstellen willst
Wenn du auf „Dokument duplizieren“ klickst, kannst du eine der verfügbaren Revisionen oder Versionen auswählen, um daraus ein neues Dokument zu erstellen.
🔒 Dokumentensperrung
Um unbeabsichtigte Änderungen zu vermeiden, kannst du ein Dokument sperren:
- Klicke auf das** Schlosssymbol 🔒** neben dem Namen des Dokuments, um die Sperre zu aktivieren
- Nach dem Sperren befindet sich das Dokument im Nur-Lese-Modus.
- In diesem Zustand kann das Dokument:
- nicht bearbeitet werden
- nicht gelöscht werden
Um Änderungen vorzunehmen, muss zunächst eine neue Revision erstellt werden.
ℹ️ Die Sperrfunktion eignet sich ideal, um finale Versionen oder gemeinsame Vorlagen zu schützen.
Bearbeiten von Dokumenten
Weitere Details zur Verwendung des Editors findest du hier:
Text Editor