modale Vorlagen
docx-Vorlagen
Verwalten und konfigurieren Sie Vorlagen und Teil‑Vorlagen
Die Vorlagen-Verwaltung ist der zentrale Ort für alle .docx‑Vorlagen in Output.Rocks. Diese Vorlagen sind der Kern Ihrer Dokumentenerstellung und definieren die Struktur und den Inhalt Ihrer Dokumente. Sie werden lokal mit Word oder Libre-Office erstellt und hier verwaltet.
In diesen Dokumenten können sie über Output.Rocks Platzhalter verwenden, um die Dokumente mit dynamischen Daten zu füllen. Siehe Output.Rocks-Syntax für eine vollständige Liste der verfügbaren Platzhalter.
Sie können auch Standardwerte, Komponenten, Bilder, Diagramme, QR-Codes und andere Grafiken in die Vorlagen integrieren. Schauen Sie dafür am besten in unsere Einführung in Templating.
Hier sehen Sie alle bereits angelegten .docx‑Vorlagen. Laden Sie hier neue Vorlagen hoch, konfigurieren Sie Identifier (eindeutige System-Bezeichnungen für die Vorlage) und organisieren Sie ähnliche oder verwandte .docx‑Vorlagen mit Gruppen-Identifier und Gruppen-Bedingungen:
Diese Seite zeigt eine Liste aller Elemente, und darüber diverse Aktionen, die du ausführen kannst:
.docx-Vorlagen können über verschiedene Kanäle erstellt werden: Upload hier oder programmatisch über die API.
Jede docx-Vorlage benötigt einen eindeutigen Identifier zur Verwendung in der API. Verwenden Sie aussagekräftige Namen wie rechnung_standard oder mahnung_stufe1.
Vorlagen-Liste
Die Vorlagen-Übersicht zeigt alle verfügbaren .docx-Vorlagen mit ihren wichtigsten Eigenschaften und Status-Informationen:
| ID | Identifier | Gruppen-Identifier | Aktiv ab | Aktiv |
|---|---|---|---|---|
| identifier_name | Null | Aktiv |
ID
Eindeutige Nummer zur internen Identifikation des docx-Vorlages.
Identifier
Eindeutiger Name des docx-Vorlages für Rendering und API-Aufrufe.
Eindeutiger Name für eine optionale Gruppierung von verwandten docx-Vorlagen. Elemente einer Gruppe werden gemeinsam verarbeitet und optionale Validatoren können dabei einzelne Elemente aktivieren oder ignorieren.
Aktiv ab
Startdatum eines docx-Vorlages. docx-Vorlages werden erst ab diesem Datum beim Rendern beachtet.
Aktiv
Schnellübersicht, ob das docx-Vorlage derzeit freigegeben ist. Deaktivierte Elemente behalten ihre Historie, werden aber nicht mehr automatisch verwendet.
Validatoren, Pausiert, Erstellt am, Aktualisiert am
| Validatoren | Pausiert | Erstellt am | Aktualisiert am |
|---|---|---|---|
| Null | NO | ||
| missing_street | YES |
Zugewiesene Validierungsregeln für das docx-Vorlage. Prüfen Ihre Bedingungen vor der Verarbeitung und aktivieren/deaktivieren das Rendering entsprechend.
Temporäre Deaktivierung des docx-Vorlages. Pausierte Elemente werden nicht verarbeitet.
Erstellt am
Zeitstempel der docx-Vorlage-Erstellung.
Aktualisiert am
Zeitstempel der letzten Änderung. Zeigt wann docx-Vorlage-Konfiguration zuletzt bearbeitet wurde.
Diagramme, QR-Codes, Erwartete max. Seitenanzahl, Max. blockierte Prozesse
| Diagramme | QR-Codes | Erwartete max. Seitenanzahl | Max. blockierte Prozesse |
|---|---|---|---|
| Null | Null | 10 | 100 |
| usagechart | qrbank | 15 | 100 |
Zugewiesene Diagramme für das docx-Vorlage. Ermöglichen Datenvisualisierung, Diagramme werden ohne diese Zuweisung nicht vorgerendert.
Konfigurierte QR-Codes für das docx-Vorlage. Dynamische QR-Code-Generierung, werden ohne diese Zuweisung nicht vorgerendert.
Benutzerdefinierte maximale Seitenzahl beim Rendern des docx-Vorlages. Bei Überschreiten wird der Prozess abgebrochen und eine Fehlermeldung ausgegeben.
Limit für abgebrochene Rendering-Prozesse des docx-Vorlages. Bei Überschreiten wird das Element nicht mehr verarbeitet (ignoriert) und ein Fehler im Dashboard ausgegeben.
Mandant, Standard für Untermandanten, Benutzerdefinierte ID, Farbe
| Umgebungs-Mandant | Standard für Umgebungs-Mandanten | Benutzerdefinierte ID | Farbe |
|---|---|---|---|
| (1880) Submarke 1 | NO | Null | |
| Null | YES | <<payload.value>> |
Zugeordneter Mandant des/der docx-Vorlage. Ermöglicht Mandanten-spezifische Konfiguration.
Kennzeichnet docx-Vorlage als Standard und vererbt (verfügbar) für alle Umgebungs-Mandanten.
Optionale benutzerdefinierte Kennung nach dem Rendering für externe Systeme. Wird als Referenzen des/der docx-Vorlage bei Callbacks übergeben und beherrscht Vorlagen-Syntax inkl. Zugriff auf Payload-Daten.
Visuelle Kennzeichnung für schnelle Identifikation des/der docx-Vorlage. Vor allem nützlich für Dashboard-Statistiken und Charts.
Kontext-Aktionen
Aktions-Dropdown
Aktions-Dropdown
Klicken Sie auf das Drei-Punkte-Menü am Ende jeder Zeile für Aktionen mit dem jeweiligen docx-Vorlage.
Testen
Öffnet eine docx-Vorlage-Testumgebung zum lokalen Rendern mit bearbeitbaren Validatoren und JSON-Testdaten.
docx-Vorlage herunterladen
Lädt die Quell-Datei des docx-Vorlage auf Ihren Computer herunter.
Anzeigen
Öffnet eine reine Detailansicht der kompletten Meta-Informationen und Einstellungen des docx-Vorlage.
Ändern
Öffnet das Bearbeitungsformular für alle Einstellungen und den Upload einer neuen docx-Vorlage-Version.
Spalten konfigurieren
Passen Sie die Anzeige der docx-Vorlage-Liste für bessere Übersichtlichkeit an. Spalten können per Drag-and-Drop neu angeordnet und über Checkboxen ein-/ausgeblendet werden.
Für mich anwenden : Spalten-Konfiguration wird nur für Ihren Account gespeichert und beeinflusst andere Benutzer nicht.
Als Standard anwenden : Konfiguration wird für alle Benutzer der Instanz übernommen und als neue Standard-Ansicht gesetzt.
docx-Vorlage erstellen
'Details'-Tab
Eindeutige Kennung für dieses/r docx-Vorlage zur programmatischen Verwendung, Einbindung in Vorlagen, Lookups und API-Zugriff.
Identifiers sollten 'snake_case' sein, also klein geschrieben und Unterstriche verwenden, z.B. 'kunde_name' oder 'rechnung_nummer'.
Ein Identifier ist immer erforderlich und muss eindeutig sein. Er ist die Referenz für die programmatische Verwendung und API-Zugriff, und sollte daher auch aus der Perspektive ihres Systems aussagekräftig sein.
Interne Beschreibung eines/r docx-Vorlage für Identifikation und bessere Übersicht bzw. Dokumentation. Diese Beschreibung wird im Output.Rocks-Backend verwendet und nicht im Output angezeigt.
Beschreibungen sollten kurz und prägnant sein, um Übersichtlichkeit zu gewährleisten. Längere Erklärungen sollten im Feld 'Kommentar' platziert werden.
Die Beschreibung wird im Output.Rocks-Backend zentral angezeigt, zum Beispiel in der tabellarischen .docx-Vorlagen‑Übersicht.
Zusätzliche Notizen und Hinweise zum/r docx-Vorlage für interne Verwendung.
Eindeutige Kennung für die Gruppierung und Organisation von docx-Vorlagen.
Elemente einer Gruppe werden gemeinsam verarbeitet und optionale Validatoren können dabei einzelne Elemente aktivieren oder ignorieren.
Gruppen-Identifier sind optional und können bei Bedarf leer gelassen werden.
Gruppen-Identifier sollten 'snake_case' sein, also klein geschrieben und Unterstriche verwenden, z.B. 'kunde_name' oder 'rechnung_nummer'.
Bedingte Logik für die Auswahl des Elements basierend auf Payload-JSON-Daten. Das Element wird angesprochen, wenn der Gruppen-Identifier mit dem Request übereinstimmt. Es wird aber nur gerendert, wenn die Bedingung erfüllt (true) ist.
Aktiviert einen optionalen, manuellen Prüfprozess: Liefert der Ausdruck true, wird das Rendern abgeschlossen, aber Versand und Webhooks bleiben pausiert bis zur Freigabe im Dashboard.
false, also keine Freigabe erforderlich. Beispiel (Symfony Expression Language): data['contract']['id'] > 1000 - ist diese erfüllt, muss das Dokument erst freigeben werden.done ohne Versand.Startdatum des Elements. Elemente werden erst ab diesem Datum beim Rendern beachtet.
Die Aktiv-Checkbox ermöglicht eine sofortige De-/Aktivierung unabhängig vom Datum.
Vor-Terminierung: Mit diesem Feld können Elemente vor-terminiert werden. Setzen Sie ein zukünftiges Datum, um das Element automatisch ab diesem Zeitpunkt zu aktivieren.
Mehrere Elemente mit gleichem Identifier: unterschiedliches 'Aktiv ab' staffelt die Version; bei einer Anfrage gilt das aktive Element mit dem spätesten Aktiv ab (nicht Erstell- oder Änderungsdatum).
Temporäre Deaktivierung des docx-Vorlages ohne Löschung.
Name für die generierte Datei beim docx-Vorlage-Rendering.
Der Ziel-Dateiname unterstützt Platzhalter für dynamische Dateinamen. Verwenden Sie
<<feldname>> für JSON-Daten und <<or.expression.timestamp({"format":"Y-m-d"})>> für Zeitstempel.Beispiel:
vertragsbestaetigung_<<contract.id>>_<<or.expression.timestamp({"format":"Y-m-d"})>> erzeugt: vertragsbestaetigung_12345_2024-03-15.pdfOptionale eigene Kennung, die bei Callbacks nach dem Rendering der docx-Vorlage zurückgegeben wird.
Die benutzerdefinierte ID unterstützt Platzhalter für dynamische Werte. Verwenden Sie <<feldname>> für JSON-Daten.
Beispiel: rechnung_<<contract.id>>_<<kunde.nummer>>
Farbkennzeichnung für bessere Übersicht und Kategorisierung der docx-Vorlage.
Farben können genutzt werden, um z.B. Dokument-Arten, Marken, Kampagnen oder Produkttypen im Backend schnell optisch zuzuordnen.
Maximale Anzahl Seiten für docx-Vorlage-Renderings. Dient der Fehlersicherheit und Kostenkontrolle. Bricht bei Überschreitung des Limits den Renderprozess ab.
Bei Überschreitung der maximalen Seitenanzahl werden Warnungen im Dashboard erzeugt und der Renderprozess wird abgebrochen.
Maximale Anzahl blockierter Rendering-Prozesse für das docx-Vorlage. Ab dieser Anzahl werden weitere blockierte Prozesse (z.B. wegen Seitenzahl-Überschreitung, Syntaxfehlern oder Problemen mit Vorlagen-Dateien) nicht mehr versucht zu rendern, sondern direkt abgewiesen.
Ab der festgelegten Anzahl blockierter Prozesse werden weitere Renderings direkt abgewiesen. Es werden Fehlermeldungen im Dashboard erzeugt.
Auswahl der Datei für die docx-Vorlage hochladen und verwalten. Nach dem Upload wird hier der Name der Datei im Dateisystem der Cloud angezeigt.
Beim Bearbeiten einer bestehenden Vorlage bleibt die vorhandene Datei erhalten, solange Sie keine neue .docx-Datei auswählen. Die Dateiauswahl akzeptiert ausschließlich .docx.
Zuordnung zu einem spezifischen Umgebungs-Mandanten oder Standard-Verwendung für alle Mandanten.
Markiert Element als Standard-Element, das automatisch an alle Umgebungs-Mandanten vererbt wird.
Fehlermeldung: Die Kombination "Standard für Umgebungs-Mandanten" + ausgewählter "Umgebungs-Mandant" erzeugt die Fehlermeldung: Tenant defaults can not be set on tenant assigned entities. Ein Element kann entweder für einen spezifischen Mandant ODER als Standard für alle Umgebungs-Mandanten konfiguriert werden.
'Validierung'-Tab
Wählen Sie die Validatoren aus, die für diese docx-Vorlage angewendet werden sollen. Validatoren prüfen die Eingabedaten vor der PDF-Generierung und können docx-Vorlagen bei Fehlern pausieren.
| ID | Identifier | Beschreibung | Fehlermeldung | Aktiv | Aktiv ab | |
|---|---|---|---|---|---|---|
| 42 | rechnung_gueltigkeitspruefung | Prüft ob Rechnungsdaten gültig sind | callback-ready-errorcode-example | YES | 01.01.2025 |
Markierte Validatoren werden bei jeder docx-Vorlage-Ausführung angewendet.
Docx-Vorlagen werden nur generiert, wenn ein Validator auf sie zutrifft.
'Diagramme'-Tab
Wählen Sie die Diagramme aus, die in dieser docx-Vorlage verfügbar sein sollen. Diagramme werden über den Identifier in Vorlagen eingebunden.
| ID | Identifier | Höhe | Breite | Aktiv | Aktiv ab | |
|---|---|---|---|---|---|---|
| 263 | verbrauch_chart_gas | 300 | 500 | YES | 01.01.2025 |
'QR-Codes'-Tab
Wählen Sie die QR-Codes aus, die in dieser docx-Vorlage verfügbar sein sollen. QR-Codes werden über den Identifier in Vorlagen eingebunden.
| ID | Identifier | Text | Size | Dunkel | Hell | Aktiv | Aktiv ab | |
|---|---|---|---|---|---|---|---|---|
| 265 | rechnung_zahlungslink | https://zahlung.stadtwerke.de/rechnung/<<rechnung.nummer>> | 150 | YES | 01.01.2025 |
docx-Vorlage-Aktionen
Nach dem Ausfüllen der Formularfelder können Sie die docx-Vorlage speichern:
- Erstellen: Speichert die docx-Vorlage und kehrt zur Vorlagen-Übersicht zurück
- Erstellen und weiteres Element hinzufügen: Speichert die docx-Vorlage und öffnet direkt ein neues, leeres Formular für die Erstellung einer weiteren docx-Vorlage
Aktions-Buttons zum Speichern und Verwalten der docx-Vorlage-Konfiguration.
Verwenden Sie "Erstellen und weiteres Element hinzufügen" für effizientes Batch-Erstellen mehrerer Elemente.
CI-Prüfung bei Uploads
Wenn für die gewählte Marke die CI-Prüfung aktiv ist, prüft Output.Rocks die .docx-Datei beim Speichern serverseitig gegen die Markenregeln. Das gilt beim Erstellen einer Vorlage, beim Hochladen einer neuen Datei zu einer bestehenden Vorlage und beim Wechsel einer bestehenden Vorlage auf eine Marke mit aktivierter Prüfung.
Direkt unter der Markenauswahl zeigt das Formular an, ob für die ausgewählte Marke eine CI-Prüfung aktiv ist. Ist die Prüfung aktiv, wird die Vorlage vor dem Speichern analysiert. Erfüllt sie die Regeln nicht, wird sie nicht gespeichert und die bisherige Datei bleibt unverändert.
Geprüfte Bereiche
Die CI-Prüfung kann folgende Merkmale aus der .docx-Datei auswerten:
- Schriften: verwendete Schriftfamilien
- Farben: erkannte Hex-Farben
- Formatvorlagen: Word-Styles wie
Normal,Heading 1oder kundenspezifische Formatvorlagen - Bilder und Logos: SHA-256-Hashes der eingebetteten Bilder
- Seitenlayout: Seitenorientierungen und, sofern konfiguriert, Seitenränder mit Toleranz in Twips
Nicht jede Kategorie muss konfiguriert sein. Leere Regelbereiche werden nicht geprüft. Sind jedoch gar keine Regeln hinterlegt, schlägt die Prüfung mit einem Einstellungsfehler fehl.
Fehlgeschlagene Prüfung
Bei einer Abweichung öffnet Output.Rocks den Dialog CI-Prüfung fehlgeschlagen. Der Dialog gruppiert die Verstöße nach Bereichen wie Farben, Schriften, Formatvorlagen, Bilder, Seitenlayout, CI-Einstellungen oder Dokumentprüfung. Jede Zeile nennt den betroffenen Wert und die Regelverletzung, z.B. eine nicht erlaubte Farbe oder Schrift.
Um die Vorlage zu speichern, gibt es zwei Wege:
- Passen Sie die .docx-Datei in Word oder LibreOffice an und laden Sie sie erneut hoch.
- Passen Sie die CI-Regeln der Marke an, wenn die Abweichung künftig erlaubt sein soll.
Stimmen Sie neue CI-Regeln zuerst mit repräsentativen Bestandsvorlagen ab. Der Vorschlag im Markenformular kann dafür aktive Vorlagen derselben Marke analysieren und eine erste Regelbasis erzeugen.
docx-Vorlage-Integration und Workflow
.docx-Vorlagen müssen im .docx-Format vorliegen. .doc-Dateien (älteres Format) werden nicht unterstützt. Stellen Sie sicher, dass Ihre docx-Vorlage gültige Output.Rocks-Syntax für Feldplatzierung verwendet.
Testen Sie neue .docx-Vorlagen immer mit den Testdaten, bevor Sie sie produktiv einsetzen. Für Layoutprüfungen gegen Briefpapier oder Formularhintergründe können Sie zusätzlich PDF-Overlays verwenden.
.docx-Vorlagen werden in Output.Rocks in verschiedenen Bereichen verwendet und mit anderen Funktionen kombiniert. Die korrekte Integration ist entscheidend für einen effizienten Dokumentenerstellungs‑Workflow.
Verwandte Backend-Bereiche
- Vorlagen‑Editor: WYSIWYG‑Editor für .docx-Vorlagen‑Bearbeitung
- Testdaten: JSON-Testdaten für docx-Vorlage-Validierung
- PDF-Overlays: Referenz-PDFs für visuelle Dokumentprüfungen im Template-Test
- Standardwerte: docx-Vorlage-weite Standardwerte konfigurieren
- Validierung: Datenvalidierung für .docx-Vorlagen einrichten
docx-Vorlage-Funktionen
- docx-Vorlage-Syntax: Vollständige Output.Rocks-Syntax-Dokumentation
- Bedingte Abschnitte: If-Then-Else Logik in .docx-Vorlagen
- Wiederholende Abschnitte: Schleifen für Listen und Tabellen
Use Cases
- Vorlage-Management: Strategien für docx-Vorlage-Organisation
- Bildverwaltung: Bilder in .docx-Vorlagen integrieren