Zum Hauptinhalt springen

Platzhalter in Dokumenten

Preview Feature

Bitte beachten Sie, dass sich die Abläufe und Funktionen in während der weiteren Entwicklung ändern können.

Einzelne Dokumente können als Vorlagen erstellt werden. Diese Vorlagen können genutzt werden, um automatische Reports zu erstellen. Um das Ausfüllen mit Daten aus Ihrer Software zu ermöglichen, muss das Schlagwort _dynamicContent verknüpft werden. Platzhalter werden gefunden, in dem die Variable in {{variable}} in doppelt geschweiften Klammern verwendet wird. Für Beispiele zur Anwendung werfen Sie einen Blick in unsere Vorlagen und hier insbesondere in das Dokument Managementbewertung.

Bitte exakte Schreibweise (Groß-/Kleinschreibung) beachten

Das Ersetzen von Platzhaltern nutzt die Handlebars Templating Sprache. Somit können auch komplexe Aufgaben, wie das rendern von Listen umgesetzt werden. Wenn Sie ein Dokument, das mit dem entsprechenden Schlagwort versehen ist, bearbeiten, werden Ihnen Vorschläge zur Autovervollständigung angezeigt, sobald Sie "{" tippen.

Die Werte der Platzhalter werden immer in drei Namensräumen geladen.

  • "Current": Aktueller Zeitraum
  • "Comapre": Vergleichszeitraum
  • Statische Daten (Namen der Organisationen etc.), die nicht keinen Bezug zu einem Zeitraum haben.

Der Aufbau innerhalb dieser beiden Bereiche ist identisch. Der Zeitraum bezieht sich dabei, sofern möglich, auf die Erstellungsdaten der jeweiligen Objekte.

Beispiele für Platzhalter​

Folgende Platzhalter können verwendet und ersetzt werden:

PlatzhalterUrsprung
organisationFirma aus Admin Startseite
{{organisation.title}}Name der Firma
{{organisation.addresses.[0].line1}}Erste Zeile der Anschrift der Firma
managingDirectorGeschäftsführer aus Admin Startseite Typ: Person
{{managingDirector.fullName}}Vor- und Nachname GF
{{managingDirector.email}}E-Mail GF
{{today}}Aktuelles Datum
dataProtectionOfficerDatenschutzbeauftragter aus Admin Startseite Typ:Person
{{dataProtectionOfficer.fullName}}Vor- und Nachname DSB
{{dataProtectionOfficer.email}}E-Mail DSB

Organisationen und Personen verfügen zusätzlich noch über Listen von verknüpften Adressen. Im einfachsten Fall ist es einfach die primäre Adresse. Um die erste Adresse einer Liste (Array) von verknüpften Adressen zu erhalten wird diese Notation benötigt organisation.addresses.[0].[addressproperty]

Eigenschaften​

In der folgenden Übersicht finden Sie weitere Eigenschaften der zur Verfügung stehenden Objekte.

interface Person {
  firstName: string;
  lastName: string;
  fullName: string;
  telephones: Telephone[];
  addresses: Address[];
}
interface Telephone {
  number: string;
}

Hilfen zur Formatierung​

Werte, die nicht nur einfache Textinformationen (z.B. Titel einer Maßnahme) sind, können formatiert werden. Die Datentypen und möglichen Formatierungen sehen finden Sie in der folgenden Tabelle.

DatentypeBefehl zur FormatierungWeitere Optionen
Datum/Zeit{{formatDate order.createdAt "datetime"}}Option: "datetime" oder "date".
Dezimal → Prozent{{formatDecimalToPercentage product.discountRate}}Erwartet Float (z. B. 0.25).
Dauer (Stunden → Einheit){{formatHoursToDays task.durationHours}} {{formatHoursToDays task.durationHours "hours"}}Einheiten: years, quarters, months, weeks, days, hours, minutes, seconds, milliseconds. Default: days.
String (Trenner einfügen){{ addSeparator user.name ", " }}2 Argument ist der Separator (String).
Array-Objekt (find by id){{#findById products "1234"}} <div> Product found: {{name}} (ID: {{id}}) </div> {{/findById}}Sucht Objekt mit id in products und rendert den Block im gefundenen Kontext. id-Vergleich als String.
Bild/URL{{{image product.imageUrl }}}Achtung: drei geschweifte Klammern, damit HTML nicht escaped wird.

Erstellung automatischer Berichte für einzelne Objekte​

Es ist hilfreich für einzelne Objekte wie Reklamationen oder Audits automatisch Berichte über das Objekt selbst und die damit verknüpften Informationen erstellen zu können. Diese Vorlagen können im Dokumentenmanagement vordefiniert und dann in den einzelnen Apps verwendet werden (bisher nur Auditmanagement und Reklamationsmanagement). In der Ansicht zum Ausfüllen des Berichts gibt es unter dem Tab Data eine Übersicht aller zur Verfügung stehenden Daten, die abgefragt werden können. Im folgenden bieten wir einige Beispiele für gängige Informationen:

Abfrage von Informationen aus dem Objekt selbst:​

PlatzhalterBeschreibung der Abfrage
{{id}}ID
{{title}}Titel
{{description}}Beschreibung
{{responsible.fullName}}Verantwortlicher
{{formatDate deadline "date"}}Frist
{{#findById customFields "myCfId"}} {{value}} {{/findById}}Abfrage eines Custom Fields anhand der ID
{{#each customFields}} {{value}} {{/each}}Abfrage aller ausgefüllten Custom Fields

Abfrage von mit dem Objekte verknüpften Informationen​

Die Anzahl der verknüpften Informationen (z.B. Anzahl der Maßnahmen) kann variieren, daher ist es notwendig eine Schleife zu definieren, die alle Informationen eines Typs (z.B. Maßnahmen) abfragt. Es bietet sich an, diese Schleife in einer Tabelle aufzubauen:

IDTitelFristVerantwortlich
{{#each todos}}
{{id}}{{title}}{{formatDate deadline "date"}}{{responsible.fullName}}
{{/each}}

{{ #each todos }} bezeichnet dem Beginn der Schleife. Der Bestandteil todos gibt dabei an, dass die Schleife die verknüpften Maßnahmen abfragt. {{/each}} bezeichnet das Ende der Schleife.

Die Parameter innerhalb der Schleife fragen zu jeder Maßnahme die Informationen gemäß der Tabellenüberschrift ab.