Felder (Fields)


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 einen Titel vom Benutzer abzufragen und möchten diese Daten gemeinsam in einer Fusszeile platzieren.
Dann können Sie über diese Dokumentfunktion das Datumsfeld und das Textfeld in einem Field zusammen ausgeben. So können Sie auch handhaben, was geschieht, wenn nicht beide Forms-Felder vom Benutzer ausgefüllt werden.


Grundaufbau

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

Elemente

Attribute, die bei allen Elementen erforderlich sind:

Attributname

Beschreibung

Attributname

Beschreibung

Name
(erforderlich)

Wird zur Identifikation benötigt. Darf keine Leerzeichen enthalten und muss eindeutig sein.

Attributwerte aus globalen Übersetzungen

Einige Attribute können anstelle eines fixen Wertes mit dem Wert einer globalen Übersetzung befüllt werden. Diesen Attributen ist jeweils ein translate- vorangestellt. Die beiden Attribute schliessen sich gegenseitig aus, es darf also nur ein fixer Wert oder ein übersetzter Wert eingesetzt werden.

Text

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

Attribute für Text

Attributname

Beschreibung

Attributname

Beschreibung

Value
translate-Value
(optional)

Vordefinierter Text bzw. vordefinierter Text aus den Globalen Übersetzungen, den der Benutzer bearbeiten kann.
Hinweis: Nur eines der Attribute darf gesetzt werden.


FormattedText

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

Beim Einfügen mittels Globale Übersetzungen 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. Code | formattedText API

<FieldsConfiguration> <Fields> <!-- FormattedText als globale Übersetzung holen --> <FormattedText Name="EnclosuresTitle"> <Code>$.translations.getFormattedText("FormattedTexts.EnclosuresTitle")</Code> </FormattedText> <!-- FormattedText als Textbaustein holen --> <FormattedText Name="SimpleSnippet"> <Code>$.snippets.getFormattedText("FormattedTexts.SimpleSnippet")</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.

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. Code | wordContent API


Date

Attribute für Date

Attributname

Beschreibung

Attributname

Beschreibung

Format
translate-Format
(optional)

Datumsformat für die Anzeige im Dokument. Der Tooltip zu Format zeigt eine Liste von möglichen Platzhalter für die Zeiteinheiten.
Über translate-Format kann auf eine Formatierung aus den Globalen Übersetzungen zugegriffen werden.
Hinweis: Nur eines der Attribute darf gesetzt werden.


YesNo

Attribute für YesNo

Attributname

Beschreibung

Attributname

Beschreibung

Value
(optional)

Vordefinierter Wert des Eintrags, den der Benutzer bearbeiten kann.


Picture

Attribute für Picture

Attributname

Beschreibung

Attributname

Beschreibung

Asset
(optional)

Angabe eines Asset einer Bildergalerie, nur möglich in PowerPoint:
<Picture Name="Mountains" Asset="Bildergalerie/General/Berge.jpg" />

Das Asset-Attribut wird zwar in allen anderen Vorlagentypen auch angezeigt, es kann aber nicht verwendet werden.


GlobalFields

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

Dabei können GlobalFields in jeder Fields-Konfiguration - in einer Vorlage oder in einem Eintrag in der globalen Konfiguration - referenziert werden.

Mehr Informationen zu den Globalen Konfigurationen sind hier zu finden: 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: Globale Konfigurationen | Globale Einträge 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

Attributname

Beschreibung

Key
(erforderlich)

Die ID des globalen Eintrags, der referenziert werden soll.

Fields modifizieren

Das Element Modifications in GlobalFields erlaubt die Modifizierung von jedem Field, das durch die Referenzierung des GlobalField in der Field-Pipeline bei der Dokumentgenerierung inkludiert wird.

image-20240729-085258.png

Um ein Field zu modifizieren, wird im GlobalField das Modifications-Element eröffnet. Darin wird das zu modifizierende Field mit demselben Name erneut definiert und sein Wert bzw. sein Code anders definiert. So wird bei der Dokumentgenerierung nicht das ursprüngliche Field in die Field-Pipeline inkludiert sondern das modifizierte.

Beispiel

Das GlobalField mit Id Fields.IsPresident enthält ein YesNo-Field mit dem Wert true. Die Konfiguration sieht so aus:

In einer Vorlage soll für das YesNo-Field IsPresident ausnahmsweise false verwendet werden. Um das zu erreichen, wird in der Fields-Konfiguration dieser Vorlage IsPresident neu definiert:

Wird aus der Vorlage ein Dokument generiert, wird nun die neue Definition berücksichtigt und damit der Wert false verwendet - auch falls dieses Field in anderen Fields referenziert wird.


Beispiele

Fields in Office-Vorlagen

Wie bereits in https://primesoft-group.atlassian.net/wiki/x/EgDCAQ erläutert, werden die Fields anschliessend manuell in die Vorlage eingefügt. Dabei werden sie je nach Typ als bestimmtes Inhaltssteuerelement eingefügt, wodurch zwischen primedocs und dem Dokument ein DataBinding hergestellt wird. DataBindings werden in Dokumenten von primedocs nachverfolgt und die Fields bei der Dokumentgenerierung und bei einer Dokumentaktualisierung laufend validiert.

Übersicht eingefügtes Inhaltssteuerelement pro Field-Typ

Folgende Tabelle zeigt, welcher Field-Typ als welches Inhaltssteuerelement in die Vorlage eingefügt wird:

Field-Typ

Inhaltssteuerelement

Field-Typ

Inhaltssteuerelement

Text

PlainText (Nur-Text)

FormattedText

RichText

WordContent

RichText

Date

Date

YesNo

Kann nicht eingefügt werden.

Picture

Image

Übersicht Field-Typ pro Office-Anwendung

Als Ergänzung zeigt folgende Matrix, welcher Field-Typ in welchen Office-Anwendungen verwendet werden kann:

 

Word

Outlook (web)

PowerPoint

Excel

 

Word

Outlook (web)

PowerPoint

Excel

Text

FormattedText

*

WordContent

Date

YesNo

Picture

* Outlook-E-Mails und -Signaturen werden in der webfähigen Outlook-Version nur noch in HTML gespeichert. Daraus folgt:

Globale Übersetzungen vom Typ FormattedText können über das FormattedText-Field in Outlook-Vorlagen beliebige HTML-Elemente enthalten und sind somit flexibler als globale Übersetzungen, die in Word- oder PowerPoint-Vorlagen eingefügt werden.

Eine Liste der erlaubten HTML-Elemente in Word und PowerPoint-Vorlagen finden Sie hier: FormattedText | Mögliche HTML Elemente

PrimeSoft AG, Bahnhofstrasse 4, 8360 Eschlikon, Switzerland