Zweck und Einsatz

Über diese Dokumentfunktion können Inhalte verknüpft werden, um diese im Dokument zu integrieren. Angenommen Sie nutzen die Formulare (Forms) Funktion, um ein Datum und ein Titel abzufragen und wollen diese Daten gemeinsam in einer Fusszeile platzieren, können Sie über diese Funktion die beiden Textfelder in ein eigenes Textfeld zusammenbringen.

Grundaufbau

<FieldsConfiguration>
  <Fields>
    <!-- Formularelemente und Gruppen hier einfügen -->
  </Fields>
</FieldsConfiguration>

Elemente

Attribute, die bei allen Elementen angeboten werden:

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

Text

<FieldsConfiguration>
  <Fields>
    <Text Name="Page" translate-Value="Content.Page" />
  </Fields>
</FieldsConfiguration>

Attribute für `Text`

Attributname	Beschreibung
`Value` (optional)	Vordefinierter Text, den der Benutzer bearbeiten kann.

FormattedText

FormattedText erlaubt das Einfügen von formatiertem Text. FormattedText ist sowohl ein Typ von Globalen Übersetzungen als auch eine Art Textbausteine.

Damit ist es möglich, abhängig von Profildaten oder selektierten Daten in Forms, unterschiedlich formatierte Textpassagen in einem Inhaltssteuerelement im Dokument auszugeben. Oft genutzt wird das beispielsweise in Kopf- und Fusszeilen, weil dort oft fette und nicht-fette Styles in einem Inhaltssteuerelement zum Zuge kommen.

Attribute für `FormattedText`

Es gibt es keine weiteren Attribute. Die Dynamisierung von Inhalt und Daten wird im Code-Element mit JavaScript und software-eigenen Funktionen ermöglicht. Die Dokumentation dazu folgt.

<FieldsConfiguration>
  <Fields>
  
    <!-- FormattedText als globale Übersetzung holen -->
    <FormattedText Name="EnclosuresTitle">
      <Code>$.translations.getFormattedText("FormattedTexts.EnclosuresTitle")</Code>
    </FormattedText>
    
    <!-- FormattedText als Textbaustein holen -->
    <FormattedText Name="EnclosuresBox">
      <Code>$.snippets.getFormattedText("FormattedTexts.EnclosuresTitle")</Code>
    </FormattedText>
    
  </Fields>
</FieldsConfiguration>

WordContent

Das Field vom Typ WordContent erlaubt das dynamische Einfügen von mehreren Textabschnitten in eine Vorlage. Zusammen mit der Dokumentfunktion Forms können so komplexere Vorlagen umgesetzt oder mehrere Vorlagen in eine konsolidiert werden.

<FieldsConfiguration>
  <Fields>
    <WordContent Name="Introduction">
      <Code>$.snippets.getWordContent("Introduction")</Code>
    </WordContent>
  </Fields>
</FieldsConfiguration>

Attribute für `WordContent`

Es gibt es keine weiteren Attribute. Das Einfügen von WordContent wird im Code-Element mit JavaScript und software-eigenen Funktionen ermöglicht. Die Dokumentation dazu folgt.

Date

<FieldsConfiguration>
  <Fields>
    <Date Name="CreateDate">
      <Code>$("Forms.Date").Value</Code>
    </Date>
  </Fields>
</FieldsConfiguration>

Attribute für `Date`

Es gibt es keine weiteren Attribute.

YesNo

<FieldsConfiguration>
  <Fields>
    <YesNo Name="InsertPartnerLogo" Value="true" />
  </Fields>
</FieldsConfiguration>

Attribute für `YesNo`

Attributname	Beschreibung
`Value` (optional)	Vordefinierter Wert des Eintrags, den der Benutzer bearbeiten kann.

Picture

<FieldsConfiguration>
  <Fields>
    <Picture Name="PartnerLogo" Asset="\\fileshare\PartnerLogo.png" />
  </Fields>
</FieldsConfiguration>

Attribute für `Picture`

Attributname	Beschreibung
`Asset` (erforderlich)	Angabe des Laufwerkpfades zum Bild. Dabei muss sichergestellt sein, dass jede Benutzer-Maschine auf das Bild zugreifen kann.

GlobalFields

Über das Element GlobalFields kann ein global abgelegtes Field geholt werden.

<FieldsConfiguration>
  <Fields>
    <GlobalFields Key="Fields.Report" />
  </Fields>
</FieldsConfiguration>

Mehr Informationen zu den Globalen Konfigurationen sind hier zu finden: https://primesoft-group.atlassian.net/wiki/spaces/PDT/pages/31457334/Globale+Konfigurationen#Umgang-mit-typisierten-Feldern.

Ein konkretes Beispiel zum Erkennen des Zusammenhangs zwischen dem globalen Eintrag und der Referenz auf einen globalen Eintrag gibt es hier: https://primesoft-group.atlassian.net/wiki/spaces/PDT/pages/31457334/Globale+Konfigurationen#Globale-Eintr%C3%A4ge-in-den-Vorlagen-referenzieren.

Attribute für `GlobalFields`

Die Referenz auf einen globalen Eintrag passiert mittels dem Key-Attribut. Wählt man dieses aus, wird einem automatisch eine Liste mit allen zur Verfügung stehenden globalen Einträgen angezeigt.

Attributname	Beschreibung
`Key` (erforderlich)	Die ID des globalen Eintrags, der referenziert werden soll.

Beispiel

<FieldsConfiguration>
  <Fields>
  
    <!-- Platzhalter befüllen vom Layout -->
    <Picture Name="PartnerLogo" Asset="\\e123\User\Muster\BeispielLogo.PNG" />
    <Text Name="Page" Value="Seite" />
    <!-- FormattedText holen -->
    <FormattedText Name="Title">
      <Code>$.translations.getFormattedText("FormattedTexts.FormattedTitle")</Code>
    </FormattedText>
    
    <!-- Daten im Inhalt der Vorlage -->
    <Text Name="Greeting" translate-Value="Greetings.KindRegards1" />
    <!-- Globaler Eintrag referenzieren -->
    <GlobalFields Key="Letters.Subject" />
    <!-- WordContent-Textbaustein holen -->
    <WordContent Name="Introduction">
      <Code>$.snippets.getWordContent("Introduction")</Code>
    </WordContent>
    
  </Fields>
</FieldsConfiguration>

Felder (Fields)