Standardelemente
Vorlagenkomponenten
Verwalten Sie Komponenten für Vorlagen
Die Komponenten-Funktion erlaubt die modulare Erstellung von wiederverwendbaren und dynamischen Bausteinen wie Regeln oder Low-Code-Elementen, die flexibel in alle Vorlagen integriert werden können.
Komponenten sind wiederverwendbare und funktionale Textbausteine, die im App-Backend definiert und mit einem eindeutigen Identifier versehen werden. Sie bilden die dritte Ebene der modularen Element-Hierarchie in Output.Rocks und können in Vorlagen und Teil-Vorlagen verwendet werden. Komponenten können Standardwerte enthalten, können Output.Rocks-Syntax-Logik ausführen und sie sind in der Lage, Daten aus dem Daten-Payload zu lesen.
In Vorlagen werden Komponenten mit der Syntax <<component.IDENTIFIER>> referenziert. Sie eignen sich vor allem für die Verwaltung von zentralen aber komplexeren Informationen wie Impressum-Blöcken, Kontakt- und Ansprechpartner-Informationen oder Berechnungen von Preisen oder anderen Werten.
Diese Seite zeigt eine Liste aller Elemente, und darüber diverse Aktionen, die du ausführen kannst:
Komponenten können über das Backend-Interface oder programmatisch über die API erstellt werden.
Jede Komponente benötigt einen eindeutigen Identifier zur Verwendung in Vorlagen. Verwenden Sie aussagekräftige Namen wie header_logo oder footer_imprint.
Komponenten-Liste
Die Übersicht zeigt alle verfügbaren Komponenten mit ihren wichtigsten Eigenschaften:
ID, Identifier, Aktiv ab
| ID | Identifier | Gruppen-Identifier | Aktiv ab | Wert |
|---|---|---|---|---|
| identifier_name | Null |
ID
Eindeutige Nummer zur internen Identifikation des Komponentes.
Identifier
Eindeutiger Name des Komponentes für Rendering und API-Aufrufe.
Eindeutiger Name für eine optionale Gruppierung von verwandten Komponenten. Elemente einer Gruppe werden gemeinsam verarbeitet und optionale Validatoren können dabei einzelne Elemente aktivieren oder ignorieren.
Aktiv ab
Startdatum eines Komponentes. Komponentes werden erst ab diesem Datum beim Rendern beachtet.
Wert
Der Dateneintrag des Komponentes. Kann Text, Zahlen, Bedingungen oder andere Daten enthalten, die in Vorlagen verwendet werden.
Root-Level
Root-Level |
|---|
| Nein |
Root-Level
Steuert, ob die Komponente direkt auf Root-Level oder unter component.* im Daten-Array verfügbar ist. Standardmäßig sind Komponenten unter component.* verfügbar (z.B. <<component.identifier>>). Root-Level-Komponenten können direkt mit <<identifier>> referenziert werden.
Aktiv, Erstellt am, Aktualisiert am
| Validatoren | Pausiert | Aktiv | Erstellt am | Aktualisiert am |
|---|---|---|---|---|
| Null | NO | Ja | ||
| missing_street | YES | Nein |
Zugewiesene Validierungsregeln für das Komponente. Prüfen Ihre Bedingungen vor der Verarbeitung und aktivieren/deaktivieren das Rendering entsprechend.
Temporäre Deaktivierung des Komponentes. Pausierte Elemente werden nicht verarbeitet.
Aktivierungsstatus des Komponentes. Nur aktive Elemente werden beim Rendern berücksichtigt.
Erstellt am
Zeitstempel der Komponente-Erstellung.
Aktualisiert am
Zeitstempel der letzten Änderung. Zeigt wann Komponente-Konfiguration zuletzt bearbeitet wurde.
Mandant, Standard für Umgebungs-Mandanten
| Umgebungs-Mandant | Standard für Umgebungs-Mandanten | Benutzerdefinierte ID | Farbe |
|---|---|---|---|
| (1880) Submarke 1 | NO | Null | |
| Null | YES | <<payload.value>> |
Zugeordneter Mandant des/der Komponente. Ermöglicht Mandanten-spezifische Konfiguration.
Kennzeichnet Komponente 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 Komponente bei Callbacks übergeben und beherrscht Vorlagen-Syntax inkl. Zugriff auf Payload-Daten.
Visuelle Kennzeichnung für schnelle Identifikation des/der Komponente. 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 Komponente.
Anzeigen
Öffnet eine reine Detailansicht der kompletten Meta-Informationen und Einstellungen des Komponente.
Ändern
Öffnet das Bearbeitungsformular für alle Einstellungen und den Upload einer neuen Komponente-Version.
Löschen
Entfernt das Komponente dauerhaft aus dem System. Diese Aktion kann nicht rückgängig gemacht werden.
Spalten konfigurieren
Passen Sie die Anzeige der Komponente-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.
Komponente erstellen
Aktions-Buttons zum Speichern und Verwalten der Komponente-Konfiguration.
Verwenden Sie "Erstellen und weiteres Element hinzufügen" für effizientes Batch-Erstellen mehrerer Elemente.
Formularfelder
Das Erstellungsformular für Komponenten ist in zwei Tabs unterteilt: Details für grundlegende Konfiguration und Inhalt für den Komponenten-Wert.
Identifier
Eindeutige Kennung für dieses/r Komponente 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'.
Beschreibung
Interne Beschreibung eines/r Komponente 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.
Aktiv ab und Aktiv
Startdatum des Komponentes. Komponentee 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 Komponentee 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).
Root-Level
Steuert, ob die Komponente direkt auf Root-Level oder unter component.* im Daten-Array verfügbar ist. Standardmäßig sind Komponenten unter component.* verfügbar (z.B. <<component.identifier>>). Root-Level-Komponenten können direkt mit <<identifier>> referenziert werden.
Mandant & Standard für Umgebungs-Mandanten
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.
Komponente-Aktionen
Nach dem Ausfüllen der Formularfelder können Sie die Komponente speichern:
- Erstellen: Speichert die Komponente und kehrt zur Übersicht zurück
- Erstellen und weiteres Element hinzufügen: Speichert die Komponente und öffnet direkt ein neues, leeres Formular
Komponenten-Integration und Workflow
Komponenten sind ideal für die Verwaltung von komplexeren wiederverwendbaren Bausteinen, die Logik ausführen oder mehrere Standardwerte kombinieren. Für einfache statische Werte sollten Sie stattdessen Standardwerte verwenden.
Variablen in Komponenten sind nur innerhalb des Kontextes dieser Komponente gültig, da Komponenten vorgerendert werden. Andere Elemente und die Stamm-Vorlage können solche Variablen nicht referenzieren. Weitere Informationen finden Sie in der Variablen-Dokumentation.
Komponenten 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
- docx-Vorlagen: Einbindung von Komponenten in .docx-Vorlagen
- Teil-Vorlagen: Einbindung von Komponenten in Teil-Vorlagen
- Standardwerte: Verwendung von Standardwerten in Komponenten
Komponenten-Funktionen
- Output.Rocks-Syntax: Verwendung von Komponenten in der Vorlagen-Syntax
- Bedingte Abschnitte: Komponenten in Bedingungen nutzen
- Wiederholende Abschnitte: Komponenten in Schleifen verwenden
Use Cases
- Komponenten-Einführung: Detaillierte Erklärung der Komponenten-Funktionalität
- Modulare Element-Hierarchie: Verständnis der Hierarchie und Verwendung
- Zentrale Konfiguration: Beispiele für die Anwendung von Komponenten