1 Zweck und Einsatz
2 Grundstruktur
3 Schema / GlobalSchema
- 3.1 Text
- 3.2 FormattedText
- 3.3 WordContent
- 3.4 Object
- 3.5 ObjectCollection

Zweck und Einsatz

Über diese Dokumentfunktion können Eigenschaften über die Connect Schnittstelle (https://primesoft-group.atlassian.net/wiki/spaces/PDT/pages/310902805/Struktur#Data) übergeben werden, indem man über diese Funktion ein Schema definiert.

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 https://primesoft-group.atlassian.net/wiki/spaces/PDT/pages/31457334 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

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

FormattedText

Diese Funktion ist verfügbar ab Version 4.0.30107.0.

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

Attributname	Beschreibung

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

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

WordContent

Diese Funktion ist verfügbar ab Version 4.0.30107.0.

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

Attributname	Beschreibung

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

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 sind dann wieder Text, FormattedText oder WordContent-Elemente zu finden.

Attributname	Beschreibung

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. Objekte, welche mit `Required="true"` konfiguriert sind, können in der Vorlage direkt als Feld genutzt werden.

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

ObjectCollection

Möchte man eine Auflistung von Daten entgegen nehmen nutzt man das ObjectCollection-Element, was wiederum Text, FormattedText oder WordContent-Elemente beinhaltet.

Attributname	Beschreibung

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