Daten (Data)

---

Zweck und Einsatz

Über diese Dokumentfunktion können Eigenschaften über die Connect Schnittstelle (Struktur) übergeben werden, indem man über diese Funktion ein Schema definiert.

---

Unterstützte Vorlagentypen

Data lässt sich auf Word-Inhaltsvorlagen, PowerPoint-Inhaltsvorlagen, Excel-Vorlagen und E-Mail-Vorlagen aktivieren. Für E-Mail-Vorlagen gelten die Einschränkungen unter Data in E-Mail-Vorlagen.

---

Grundstruktur

<DataConfiguration>
  <Schema>
    <Text Id="MyTestValue" />
    <FormattedText Id="MyFormattedtext" />
    <WordContent Id="MyWordContent" />
    
    <Object Id="TestObject">
      <Schema>
        <Text Id="TestValueInTestObject" />
      </Schema>
    </Object>
    
    <ObjectCollection Id="TestObjectCollection">
      <Schema>
        <Text Id="TestValueInTestObjectCollection" />
      </Schema>
    </ObjectCollection>
  </Schema>
  <!-- Optional:
  <GlobalSchema Key="GlobalKey" />
  -->
</DataConfiguration>

---

Schema / GlobalSchema

Diese Funktion definiert über das Schema-Element, welche Daten über die Schnittstelle übermittelt werden können.
Die hier definierten Elemente können dann in der jeweiligen Vorlage hinterlegt werden. Das Schema kann auch unter den Globale Konfigurationen hinterlegt werden über <GlobalSchema Key="..." />.

Das Schema bzw. GlobalSchema kann dann diese Typen definieren:

Text

Über das Text-Element können Texte entgegen genommen werden.

Attributname	Beschreibung
Id (erforderlich)	Wird zur Identifikation benötigt. Darf keine Leerzeichen enthalten und muss eindeutig sein.

FormattedText

Über das FormattedText-Element können Texte mit einfachen Formatierungsoptionen entgegen genommen werden.

Attributname	Beschreibung
Id (erforderlich)	Wird zur Identifikation benötigt. Darf keine Leerzeichen enthalten und muss eindeutig sein.

hinweis

Die Daten können in verschiedenen Formaten (Html bzw. HtmlBase64) übermittelt werden.

WordContent

Über das WordContent-Element können Texte mit Word-spezifischen Formatierungsoptionen entgegen genommen werden.

Attributname	Beschreibung
Id (erforderlich)	Wird zur Identifikation benötigt. Darf keine Leerzeichen enthalten und muss eindeutig sein.

hinweis

Die Daten können in verschiedenen Formaten (DocxBase64, FlatOpc bzw. FlatOpcBase64) übermittelt werden.

Object

Möchte man mehrere Elemente gruppieren, dann eignet sich ein Element vom Typ Object. Unterhalb des Object können Text-, FormattedText- oder WordContent-Elemente sowie weitere Object- und ObjectCollection-Elemente stehen — Objekte lassen sich also beliebig verschachteln.

Attributname	Beschreibung
Id (erforderlich)	Wird zur Identifikation benötigt. Darf keine Leerzeichen enthalten und muss eindeutig sein.
Required (Optional)	Wenn true: Das Objekt muss übermittelt werden. Hinweis: Objekte, welche mit Required="true" konfiguriert sind, können in der Vorlage direkt als Feld genutzt werden.

warnung

Wird ein Object mit Required="true" nicht übermittelt, wird dies als Fehler gewertet und die Dokumentengenerierung bricht ab.

ObjectCollection

Während ein Object einen einzelnen Datensatz abbildet, nimmt eine ObjectCollection mehrere gleichartige Datensätze entgegen — also eine Liste, z. B. Rechnungspositionen oder Teilnehmer. Sie kann Text-, FormattedText- oder WordContent-Elemente sowie weitere verschachtelte Object- und ObjectCollection-Elemente beinhalten; diese definieren die Felder, die jeder Eintrag der Liste besitzt.

Attributname	Beschreibung
Id (erforderlich)	Wird zur Identifikation benötigt. Darf keine Leerzeichen enthalten und muss eindeutig sein.

---

Data in E-Mail-Vorlagen

In E-Mail-Vorlagen stehen die Data-Werte als Platzhalter {{Data.<Id>}} in Betreff, in An, CC und BCC sowie im HTML- und im Nur-Text-Inhalt zur Verfügung. Verschachtelte Werte werden über den Pfad angesprochen, beispielsweise {{Data.Customer.Name}}. Die Konfiguration des Schemas erfolgt gleich wie bei den übrigen Vorlagentypen.

Gegenüber Word-Vorlagen gelten drei Einschränkungen:

• WordContent wird nicht unterstützt. Wird ein solcher Wert an eine E-Mail-Vorlage übergeben, bricht die Generierung mit der Meldung «Word Content is only supported on Word templates» ab.
• FormattedText nur im HTML-Inhalt. Wird ein FormattedText-Feld im Betreff, in An, CC, BCC oder im Nur-Text-Inhalt referenziert, bricht die Generierung ab. Nicht referenzierte FormattedText-Felder bleiben folgenlos.
• Keine Vorschau mit Connect-Daten. Die Vorschau im Vorlageneditor erhält keine Connect-Nutzdaten. Data-basierte Inhalte lassen sich nur über einen echten Connect-Aufruf prüfen.

Ein vollständiges Beispiel mit Vorlage und Connect-Aufruf steht unter E-Mail-Vorlage — Daten über Connect.