Startseite
jump to top

Startseite / Vorlagenentwicklung / Formulare / Eingabekomponenten / DATASET

FS_DATASETVerfügbar ab FirstSpirit-Version 4.2

Inhaltsverzeichnis
zum Beispiel
zu den Methoden: DatasetContainer
FS_DATASET

FS_DATASET

Über die Eingabekomponente FS_DATASET wird ein Datensatz aus der Datenquellen-Verwaltung referenziert. Die Auswahl ist nicht auf Datensätze einer definierten Zieltabelle eingeschränkt. Stattdessen kann die gewünschte Tabelle über einen Auswahldialog gewählt werden. Dabei werden gleichzeitig die Zieltabelle und der gewünschte Datensatz ausgewählt.

FS_DATASET bietet darüber hinaus viele Bearbeitungsmöglichkeiten: Verändern einzelner Datensätze, Anlegen neuer Datensätze in der Datenquelle, Entfernen von Datensätzen aus der Datenquelle (nur in der Datenquellen-Verwaltung).

Access-API Anwendungsbeispiel
Die Beispiel-Implementierung DatasetEditorValueExample veranschaulicht einige einfache Anwendungsfälle für den Lesenden-, Schreibenden-, Erstellenden-Zugriff auf das Daten-Objekt (DatasetEditorValue) und dessen innerer Daten-Container (DatasetContainer) der Eingabekomponente anhand der FirstSpirit Access-API.

Wichtig Die Eingabekomponente FS_DATASET wird im FirstSpirit ContentCreator unterstützt. Zu Einschränkungen siehe Kapitel Einschränkungen in ContentCreator.

Zu Informationen über für Drag-and-drop unterstützte Transfer-Typen siehe Seite Drag-and-drop.

name
Designator
Pflichtparameter
allowChoose
YesNo
Optionaler Parameter
allowDelete
YesNo
Optionaler Parameter
allowEdit
YesNo
Optionaler Parameter
allowEmpty
YesNo
Optionaler Parameter
allowNew
YesNo
Optionaler Parameter
convertEntities
ConvertEntity
Optionaler Parameter
hFill
YesNo
Optionaler Parameter
height
PositiveInteger
Optionaler Parameter
hidden
YesNo
Optionaler Parameter
indexTreatment
Treatment
Optionaler Parameter
mode
DatasetMode
Optionaler Parameter
noBreak
YesNo
Optionaler Parameter
preset
Preset
Optionaler Parameter
searchRelevancy
Relevancy
Optionaler Parameter
selectorMode
DatasetSelectorMode
Optionaler Parameter
useLanguages
YesNo
Optionaler Parameter
lang
LanguageAbbreviation
Pflichtparameter
description
String
Optionaler Parameter
expression
String
Optionaler Parameter
label
String
Optionaler Parameter
name
ReferenceName
Pflichtparameter

Parameter

Der nachfolgenden Tabelle können die Parameter der Eingabekomponente DATASET entnommen werden.

ParameterPflichtparameterSeitTypStandardwert
name*Ja3.1DesignatorKeiner
allowChooseNein3.0YesNoYES
allowDeleteNein4.2YesNoYES
allowEditNein4.2YesNoYES
allowEmptyNein3.0YesNoYES
allowNewNein4.2YesNoYES
convertEntitiesNein2.0ConvertEntityNONE
hFillNein2.0YesNoNO
heightNein4.2PositiveInteger500
hiddenNein4.0.44YesNoNO
indexTreatmentNein5.2.12TreatmentDEFAULT
modeNein4.2DatasetModeDIALOG
noBreakNein2.0YesNoNO
presetNein4.0PresetDEFAULT
searchRelevancyNein5.2.305RelevancyDEFAULT
selectorModeNein5.1.504DatasetSelectorModeDIALOG
useLanguagesNein2.0YesNoYES

name

Das Attribut "name" ist der Variablenname einer Eingabekomponente, mit dem in den Vorlagen - mit Hilfe von $CMS_VALUE()$ - das Ergebnisobjekt der Eingabekomponente verwendet oder der Inhalt ausgegeben werden kann.

ParameterPflichtparameterSeitTypStandardwert
name*Ja3.1DesignatorKeiner

allowChoose

Mit dem Parameter allowChoose kann festgelegt werden, ob in der Eingabekomponente bestehende Datensätze ausgewählt werden dürfen oder nicht.

Standardmäßig ist die Auswahl von Datensätzen möglich.

Wird allowChoose mit NO (allowChoose="NO") angegeben, so ist eine Auswahl nicht mehr möglich. Datensätze in der Eingabekomponente können dann nur über das Anlegen von neuen Datensätzen hinzugefügt werden.

ParameterPflichtparameterSeitTypStandardwert
allowChooseNein3.0YesNoYES

allowDelete

Wird diese Eingabekomponente in der Datenquellen-Verwaltung verwendet (Tabellen-Vorlage), kann über dieses Attribut eingestellt werden, dass ein ausgewählter Datensatz direkt über die Eingabekomponente gelöscht werden kann, ohne zum jeweiligen Datensatz in einer anderen Datenquelle wechseln zu müssen. Mit allowDelete="YES" kann der Datensatz aus der Eingabekomponente und der Datenquelle gleichzeitig entfernt werden. Standardmäßig ist der Parameter auf YES gesetzt. Um das Löschen von Datensätzen zu unterbinden, muss der Parameter auf NO gesetzt werden.

In der Inhalte-Verwaltung (Seiten- oder Absatzvorlage) wird das Löschen von Datensätzen aus einer Eingabekomponente diesen Typs heraus nicht unterstützt. Unabhängig von der Verwendung des Parameters wird das Icon zum Löschen des Datensatzes Icon delete content store nicht angezeigt.

ParameterPflichtparameterSeitTypStandardwert
allowDeleteNein4.2YesNoYES

allowEdit

Mit dem Parameter allowEdit kann in der Eingabekomponente das Bearbeiten von Einträgen erlaubt oder aber unterbunden werden.

Wird der Parameter nicht angegeben, so können die Einträge bearbeitet werden.

Das Bearbeiten von Einträgen ist mit der Angabe NO (...allowEdit="NO"...) nur initial beim Anlegen des Datensatzes möglich. Nach einem Speichern ist eine weitere Bearbeitung des Datensatzes in der Datenquellen-Verwaltung möglich.

ParameterPflichtparameterSeitTypStandardwert
allowEditNein4.2YesNoYES

allowEmpty

Mit dem Parameter "allowEmpty" wird festgelegt, ob für eine Eingabekomponente ein Wert angegeben werden muss oder nicht.

Bei der Angabe von allowEmpty="YES" ist eine Eingabe nicht zwingend, bei allowEmpty="NO" jedoch schon.

Eingabekomponenten mit allowEmpty="NO" werden auch als Pflichteingabekomponenten bezeichnet.

Der Standardwert für allowEmpty ist YES.

ParameterPflichtparameterSeitTypStandardwert
allowEmptyNein3.0YesNoYES

allowNew

Mit dem Parameter allowNew kann das Anlegen von neuen Einträgen erlaubt oder aber unterbunden werden.

Wird der Parameter nicht angegeben, so können neue Einträge angelegt werden.

Bei der Angabe von NO (...allowNew="NO"...) können keine neue Einträge angelegt werden.

ParameterPflichtparameterSeitTypStandardwert
allowNewNein4.2YesNoYES

convertEntities

Mit dem Attribut "convertEntities" werden Sonderzeichen, die in die Eingabekomponente eingegeben wurden, bei der Ausgabe in HTML-Zeichen umgewandelt.

Es gibt hier drei Ausprägungen:

  • convertEntities="NONE" (Standard)
  • convertEntities="STANDARD"
  • convertEntities="QUOTE"

Bei NONE werden keinerlei Konvertierungsregeln angewendet.

Wird STANDARD angegeben, so werden die Konvertierungsregeln angewendet, die im Bereich "convert" der ausgewählten Konvertierungsregel des Vorlagensatzes stehen.

Die Angabe QUOTE schließt STANDARD explizit mit ein. Es wird jedoch zusätzlich der Bereich "quote" der Konvertierungsregel angewendet.

ParameterPflichtparameterSeitTypStandardwert
convertEntitiesNein2.0ConvertEntityNONE

hFill

Die Anzeige einer Eingabekomponente erfolgt immer mit einer vordefinierten Breite.

Ist es aber gewünscht, dass die Eingabekomponente die volle zur Verfügung stehende Anzeigebreite nutzt, ist der Parameter hFill mit dem Wert YES anzugeben.

ParameterPflichtparameterSeitTypStandardwert
hFillNein2.0YesNoNO

height

Mit dem Parameter height wird die Anzeigehöhe der Eingabekomponente in Pixeln festgelegt.

Als Wert erwartet der Parameter eine Ganzzahl. Wird der Parameter nicht angegeben, wird die Höhe der Eingabekomponente standardmäßig auf 500 Pixel gesetzt.

Befindet sich die Eingabekomponente in einer Gruppierung (CMS_GROUP), richtet sich die Höhe nach der Höhe der höchsten Eingabekomponente innerhalb der Gruppierung.

ParameterPflichtparameterSeitTypStandardwert
heightNein4.2PositiveInteger500

hidden

Mit dem Parameter "hidden" kann eine Eingabekomponente für den Redakteur ausgeblendet werden.

Bei der Angabe von hidden="YES" wird die Eingabekomponente ausgeblendet, bei hidden="NO" nicht.

Der Standardwert für hidden ist NO, so dass Eingabekomponenten standardmäßig für den Redakteur sichtbar sind.

ParameterPflichtparameterSeitTypStandardwert
hiddenNein4.0.44YesNoNO

indexTreatment

Die Indizierung von Datensätzen, die mittels dieser Eingabekomponente referenziert werden, kann so konfiguriert werden, dass die Pfadlänge berücksichtigt wird. So kann beispielsweise bestimmt werden, ob zu einem Ausgangs-Datensatz nur die Inhalte dieses Datensatzes oder auch Inhalte referenzierter Datensätze indiziert werden sollen. Sollen auch Inhalte referenzierter Datensätze mit indiziert werden, kann angegeben werden, bis zu welcher Pfadlänge sie berücksichtigt werden sollen. So bedeutet eine Pfadlänge "2" beispielsweise, dass zusätzlich zu den Inhalten des Ausgangs-Datensatzes auch Inhalte von Datensätzen indiziert werden, die vom Ausgangs-Datensatz referenziert werden sowie Inhalte von Datensätzen, die von den referenzierten Datensätzen referenziert werden.

Diese Pfadlänge kann mithilfe des Parameters indexing.relationshipPathLengthToFollow in der Konfigurationsdatei fs-server.conf definiert werden. Standardmäßig werden im Falle dieser Eingabekomponente zu Datensätzen auch die Inhalte von direkt referenzierten Datensätzen indiziert (Pfadlänge "1").
Diese Konfiguration gilt serverweit für alle Projekte. Auf Projekt-/Komponentenebene kann der Parameter indexTreatment verwendet werden, um die durch indexing.relationshipPathLengthToFollow definierte Pfadlänge über spezielle Tabellen hinweg manuell zu verlängern und damit quasi den Wert des Parameters indexing.relationshipPathLengthToFollow für bestimmte Eingabekomponenten zu erhöhen. Wird

indexTreatment="follow"

gesetzt, werden Datensätze, die über die betreffende Eingabekomponenten referenziert werden, bei einer Indizierung des Ausgang-Datensatzes mit berücksichtigt. Wird der Parameter nicht gesetzt (entspricht indexTreatment="default"), werden referenzierte Datensätze gemäß der Konfiguration von indexing.relationshipPathLengthToFollow mit indiziert. Die Indizierung kann über das Setzen von indexTreatment also immer nur ausgeweitet werden, aber nicht eingeschränkt.

Soll der Pfad über mehrere Tabellen hinweg mittels indexTreatment="follow" verlängert werden, muss indexTreatment="follow" in einer entsprechenden Eingabekomponente in jeder Tabelle entlang des gewünschten Pfades vorhanden sein. Wird in einer Tabellenvorlage kein indexTreatment="follow" gesetzt (entspricht indexTreatment="default"), bricht die Indizierung ab.

Für weitere Informationen siehe auch Seite Suche und Indizierung.

ParameterPflichtparameterSeitTypStandardwert
indexTreatmentNein5.2.12TreatmentDEFAULT

mode

Über diesen Parameter kann die Anzeige von Datensätzen in FS_DATASET im SiteArchitect gesteuert werden.

mode="dialog"
Standardmäßig werden die Daten aller Spalten des gewählten Datensatzes dargestellt (entspricht mode="dialog").

FS_DATASET Dialog-Darstellung

mode="sheet"
Mithilfe von mode="sheet" kann statt der Daten aller Spalten des gewählten Datensatzes eine verkürzte, übersichtlichere Anzeige verwendet werden. Dazu wird auf die Definition auf dem Register Schnipsel auf der zugrundeliegenden Tabellenvorlage zurückgegriffen.
FS_DATASET Sheet-Darstellung

mode="combobox"
Wurde über die Tags SOURCES / CONTENT eine Datenquelle definiert, aus der Datensätze ausgewählt werden können, kann die Anzeige und Auswahl der Datensätze dieser Datenquelle auch über eine Combobox erfolgen. Dazu muss mode="combobox" gesetzt werden.

Ist auf der Datenquelle ein Filter auf der Basis einer Abfrage gesetzt, wird dieser bei der Anzeige der auswählbaren Datensätze berücksichtigt.

Standardmäßig werden dabei die IDs der Datensätze angezeigt, die Anzeige kann aber über den Parameter expression dynamisch gestaltet werden (z. B. expression="#item.Headline_DE", wobei Headline_DE der Spaltenname ist, wie er im Datenbank-Schema-Editor angegeben wurde und beispielsweise auf dem Register "Mapping" der jeweiligen Tabellenvorlage in den sprachabhängigen Spalten (DE, EN etc.) angezeigt wird.)

FS_DATASET Combobox-Darstellung

Im ContentCreator hat dieser Parameter keine Auswirkung auf die Darstellung und den Auswahlmodus.
Der Auswahlmodus im SiteArchitect kann bei Bedarf über den Parameter selectorMode konfiguriert werden.

ParameterPflichtparameterSeitTypStandardwert
modeNein4.2DatasetModeDIALOG

noBreak

Mit dem Parameter noBreak kann der automatische Zeilenumbruch nach einer Eingabekomponente unterdrückt werden.

Um den automatischen Zeilenumbruch zu unterdrücken, ist der Parameter noBreak mit dem Wert "YES" anzugeben (noBreak="YES").

ParameterPflichtparameterSeitTypStandardwert
noBreakNein2.0YesNoNO

preset

Mit dem Attribut preset kann festgelegt werden, wie Vorgabewerte in einer Eingabekomponente behandelt werden (vgl. dazu auch Kapitel Vorgabewerte). Wird preset="default" gesetzt, wird der im Formular definierte Rückgriffwert verwendet. Nachträgliche Änderungen im Formular an diesem Wert wirken sich auf alle Verwendungen in den vom Redakteur gepflegten Eingabekomponenten aus, solange bis ein manueller Wert in die Eingabekomponente gesetzt wird. Dies ist die Standardeinstellung. Wird preset="copy" gesetzt, wird der durch den Redakteur gewählte Wert "hart" in der Eingabekomponente gespeichert. Nachträgliche Änderungen am Vorgabewert im Formular wirken sich nicht aus.

ParameterPflichtparameterSeitTypStandardwert
presetNein4.0PresetDEFAULT

searchRelevancy

Mithilfe dieses Parameters kann definiert werden, mit welcher Gewichtung Inhalte dieser Eingabekomponente in Suchergebnissen angezeigt werden (SiteArchitect: Globale Suche (Globale Suche (→Handbuch FirstSpirit SiteArchitect)), Suche in Datenquellen (Suche (→Handbuch FirstSpirit SiteArchitect)) | ContentCreator: Suche im Report-Bereich). So kann beispielsweise festgelegt werden, dass Suchtreffer in Überschriften prominenter in den Suchergebnissen angezeigt werden als Suchtreffer in Fließtexten. Andererseits können auch Eingabekomponenten ganz von der Suchindizierung ausgenommen werden, was in einer erhöhten Performanz der Indizierung resultieren kann.
Für diese Konfiguration der Suche stehen folgende Werte für eine Gewichtung zur Verfügung:

  • none: Der Inhalt einer mit diesem Attribut versehenen Eingabekomponente wird nicht indiziert. Seiten, Absätze und Datensätze, die Inhalte enthalten, die in auf diese Weise konfigurierten Eingabekomponenten gespeichert sind, werden nicht als Suchtreffer angezeigt. Eine Suche nach in solchen Komponenten gespeicherten Inhalten per Drag-and-drop ist nicht möglich ("Das Feld kann nicht für die Suche verwendet werden, da es als nicht relevant markiert ist."). Solche Felder sind auch in der "Einfachen Suche" in Datenquellen entsprechend markiert ("Kann nicht durchsucht werden.").
  • default: Der Inhalt der Eingabekomponente wird mit normaler Gewichtung indiziert. Hierbei handelt es sich um die Standardeinstellung.
  • high: Der Inhalt einer mit diesem Attribut versehenen Eingabekomponente wird mit erhöhter Gewichtung in Suchergebnissen angezeigt (Ausnahme: Suche nach Datensätzen). Das heißt, ist der Suchbegriff sowohl in einer Eingabekomponente enthalten, die mit searchRelevancy="high" versehen ist, als auch in einer Eingabekomponente, die mit searchRelevancy="default" versehen ist, wird ein Suchtreffer, der in der Eingabekomponente mit searchRelevancy="high" gespeichert ist, an höherer Position in den Suchergebnissen angezeigt.

Wird der Parameter nicht angegeben, wird die Eingabekomponente für den Suchindex normal gewichtet (searchRelevancy="default").

Auswertungshierarchie:

  • Ist für diese Eingabekomponente ("außen") searchRelevancy="none" konfiguriert,
    • werden Eingabekomponenten von inneren Einträgen nicht indexiert, unabhängig von den searchRelevancy-Einstellungen der Eingabekomponenten der für innere Einträge verwendeten Vorlagen.
  • Ist für diese Eingabekomponente ("außen") searchRelevancy="default" konfiguriert,
    • werden Eingabekomponenten in inneren Einträgen, für die searchRelevancy="none" gesetzt ist, nicht indexiert,
    • werden Eingabekomponenten in inneren Einträgen, für die searchRelevancy="default" gesetzt ist, bei der Indexierung normal gewichtet,
    • werden Eingabekomponenten in inneren Einträgen, für die searchRelevancy="high" gesetzt ist, bei der Indexierung höher gewichtet.
  • Ist für diese Eingabekomponente ("außen") searchRelevancy="high" konfiguriert,
    • werden Eingabekomponenten in inneren Einträgen, für die searchRelevancy="none" gesetzt ist, nicht indexiert,
    • werden Eingabekomponenten in inneren Einträgen, für die searchRelevancy="default" oder searchRelevancy="high" gesetzt ist, bei der Indexierung höher gewichtet.

FS_CATALOG, searchRelevancy, hierarchy

Hinweis: Auch Kennsätze (Register Schnipsel von Vorlagen, Feld "Kennsatz") werden indiziert. Wird für eine Eingabekomponente die Suchrelevanz auf none gesetzt (searchRelevancy="none") und der Inhalt gleichzeitig als Kennsatz in der Schnipsel-Definition der Vorlage verwendet, so wird das entsprechende Objekt dennoch gefunden.

Siehe auch

  • Seite Suche und Indizierung
  • Interface GomSearchRelevancy (Package de.espirit.firstspirit.access.store.templatestore.gom, FirstSpirit Developer-API)
  • Interface SearchService (Package de.espirit.firstspirit.access.search, FirstSpirit Access-API)
  • Interface QueryAgent (Package de.espirit.firstspirit.agency, FirstSpirit Developer-API)

ParameterPflichtparameterSeitTypStandardwert
searchRelevancyNein5.2.305RelevancyDEFAULT

selectorMode

Über diesen Parameter kann die Auswahl von Datensätzen in FS_DATASET im SiteArchitect gesteuert werden.

selectorMode="dialog"
Standardmäßig wird für die Auswahl eines Datensatzes über diese Eingabekomponente ein Auswahldialog (siehe Dokumentation zum SiteArchitect, Kapitel "Auswahldialoge (→Handbuch FirstSpirit SiteArchitect)") geöffnet (entspricht selectorMode="dialog").

selectorMode="list"
Wurde über die Tags SOURCES / CONTENT nur eine Datenquelle definiert, aus der Datensätze ausgewählt werden können, kann die Auswahl der Datensätze dieser Datenquelle auch über eine einfache Liste erfolgen. Dazu muss selectorMode="list" gesetzt werden.
Ist SOURCES / CONTENT nicht angegeben, oder sind mehrere Datenquellen definiert, wird automatisch der Auswahldialog (selectorMode="dialog") verwendet.

Ist für den Parameter mode der Wert "combobox" gesetzt (mode="combobox"), hat der Parameter selectorMode keine Auswirkung.

Im ContentCreator hat dieser Parameter keine Auswirkung auf die Darstellung und den Auswahlmodus.
Der Darstellungsmodus im SiteArchitect kann bei Bedarf über den Parameter mode konfiguriert werden.

ParameterPflichtparameterSeitTypStandardwert
selectorModeNein5.1.504DatasetSelectorModeDIALOG

useLanguages

Mit dem Parameter useLanguages kann festgelegt werden, ob eine Eingabekomponente für verschiedene Sprachen unterschiedliche bzw. abweichende Werte speichern soll oder nicht (mehrsprachige Pflege).

Wird der Parameter nicht angegeben so werden standardmäßig abweichende Werte für die verschiedenen Sprachen gespeichert.

Bei der Angabe von NO (...useLanguages="NO") wird ein Wert für alle Sprachen gespeichert.

Verfügbar ab FirstSpirit-Version 5.2R5 Ab FirstSpirit-Version 5.2R5 wird useLanguages="YES" potenziell nicht mehr berücksichtigt. Siehe dazu Parameter forbidPolyglotDataHierarchy (FS_CATALOG).

ParameterPflichtparameterSeitTypStandardwert
useLanguagesNein2.0YesNoYES

LANGINFOSVerfügbar ab FirstSpirit-Version 4.0

Über das Tag LANGINFOS können für jede Eingabekomponente sprachabhängige Angaben definiert werden, z. B. wie die Eingabekomponente in den unterschiedlichen Projektsprachen betitelt sein soll (Parameter label), welcher Tooltip angezeigt werden soll (Parameter description) usw. Aus Gründen der Übersichtlichkeit werden dabei Definitionen, die in mehreren Sprachen identisch sind, zusammengefasst. So wird z. B. aus

 <LANGINFOS> 
<LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
<LANGINFO lang="DE" label="Date" format="dd.MM.yy"/>
<LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

beim Speichern

 <LANGINFOS> 
<LANGINFO lang="*" label="Date" format="dd.MM.yy"/>
<LANGINFO lang="EN" label="Date" format="MM/dd/yy"/>
</LANGINFOS>

Die Definition für den Rückfallwert (*) bleibt dabei immer erhalten, von Definitionen für Sprachen mit gleichen Werten bleibt immer die oberste erhalten.

Ab FirstSpirit-Version 4.2R4 kann der Rückfallwert weggelassen werden. Dann wird beim Speichern automatisch die zuerst definierte Sprache als Rückfallwert verwendet, z. B. wird aus

<LANGINFOS>
<LANGINFO lang="EN" label="Date"/>
<LANGINFO lang="DE" label="Datum"/>
</LANGINFOS>

beim Speichern

 <LANGINFOS> 
<LANGINFO lang="*" label="Date"/>
<LANGINFO lang="DE" label="Datum"/>
</LANGINFOS>

LANGINFO

Mit dem Tag LANGINFO werden Werte oder Attribute für eine Sprache oder aber für die Verwendung als Rückfallwerte angegeben.

Um Werte bzw. Attribute für eine Sprache anzugeben ist im Parameter lang die Abkürzung der Projektsprache anzugeben:

...
<LANGINFO lang="DE".../>
...

Rückfallwerte werden mit dem speziellen Sprachkürzel * ("für alle Sprachen") angegeben:

...
<LANGINFO lang="*".../>
...

Bei dem Parameter lang handelt es sich um einen Pflichtparameter.

ParameterPflichtparameterSeitTypStandardwert
lang*Ja3.1LanguageAbbreviationKeiner
descriptionNein3.1StringKeiner
expressionNein4.0StringKeiner
labelNein3.1StringKeiner

lang

Mit dem Parameter lang wird das Sprachkürzel, das in den Servereigenschaften im Feld Abkürzung eingetragen ist (siehe Sprach-Vorlagen (→Dokumentation für Administratoren)), angegeben, um festzulegen, für welche Projektsprachen die Definitionen gelten sollen, z. B. DE für Deutsch, EN für Englisch, FR für Französisch usw. Folgende Zeichen können dabei beliebig oft angegeben werden: -, _, 0-9 und A-Z. Kleinbuchstaben werden nach dem Speichern der Vorlage automatisch in Großbuchstaben umgewandelt. Alternativ kann * für Rückfallwerte verwendet werden.

ParameterPflichtparameterSeitTypStandardwert
lang*Ja3.1LanguageAbbreviationKeiner

description

Mit dem Parameter description kann eine Beschreibung angegeben werden, die zur Anzeige eines Tooltipps (Mouse-Over) genutzt wird.

ParameterPflichtparameterSeitTypStandardwert
descriptionNein3.1StringKeiner

expression

Wird die Eingabekomponente FS_DATASET in der Datenquellen-Verwaltung verwendet, können mit dem Parameter expression in der Spaltenübersicht Werte einer Spalte aus einer Tabelle ausgegeben werden, die über einen Fremdschlüssel mit der Datenquelle verbunden ist.

Dazu muss FS_DATASET in einer Tabelle A definiert sein, die mit der Tabelle B, in einer 1:N-Fremdschlüsselbeziehung steht. Tabelle A ist somit die Ziel-Tabelle (N Elemente), Tabelle B ist die Quell-Tabelle (1 Element). FS_DATASET muss mit dem Fremdschlüssel verknüpft sein.

In FS_DATASET kann dann über expression auf die in die Spalten der Tabelle B eingepflegten Werte zugegriffen werden.

Hierfür steht innerhalb von expression das Systemobjekt #item zur Verfügung. Das Systemobjekt #item repräsentiert den jeweiligen in der Eingabekomponente ausgewählten Datensatz. Auf die Werte der einzelnen Spalten des Datensatzes kann über die Punktnotation zurückgegriffen werden. Im Beispiel wird für die Beschriftung in der Spaltenüberschrift der Wert der Spalte Headline_DE (#item.Headline) verwendet.

Weiterhin werden über den Ausdrucksmechanismus sprachspezifische Endungen automatisch gesetzt, sollten sie vorhanden sein, d. h. folgende Definition ist möglich:

<FS_DATASET name="cs_dataset">
<LANGINFOS>
<LANGINFO lang="*" label="News" expression="#item.Headline_DE"/>
</LANGINFOS>
<SOURCES>
<CONTENT name="news"/>
</SOURCES>
</FS_DATASET>
Wichtig Es ist darauf zu achten, dass der Spaltenname korrekt angegeben wird und die Spalten auch tatsächlich in der angegebenen Tabelle vorhanden ist, da sonst kein Wert in der Datenquellen-Übersicht angezeigt wird.

ParameterPflichtparameterSeitTypStandardwert
expressionNein4.0StringKeiner

label

Mit dem Parameter label wird die Oberflächenbeschriftung für Eingabe- und Visualisierungkomponenten angegeben.

ParameterPflichtparameterSeitTypStandardwert
labelNein3.1StringKeiner

LEGACYTEMPLATEVerfügbar ab FirstSpirit-Version 4.2.402

Dieses Tag muss verwendet werden, wenn von der Verwendung von CMS_INPUT_OBJECTCHOOSER in einem Projekt zu FS_DATASET gewechselt werden soll:

Damit die Daten, die durch den Redakteur bereits über CMS_INPUT_OBJECTCHOOSER eingegeben wurden, weiterhin gespeichert bleiben, muss zusätzlich zu der Datenquelle, die über SOURCES / CONTENT definiert wird, der eindeutige Bezeichner der Tabellenvorlage aus dem zu migrierenden CMS_INPUT_OBJECTCHOOSER-Formular angegeben werden, z. B.

<LEGACYTEMPLATE>Products.products</LEGACYTEMPLATE>
<SOURCES>
<CONTENT name="produkte"/>
</SOURCES>

Für "neue" FS_DATASET-Komponenten, die neu im Projekt befüllt werden sollen, wird dieses Tag nicht benötigt.

TEXTVerfügbar ab FirstSpirit-Version 4.2

An dieser Stelle wird der eindeutige Bezeichner der Tabellenvorlage aus dem zu migrierenden CMS_INPUT_OBJECTCHOOSER-Formular angegeben.

SOURCESVerfügbar ab FirstSpirit-Version 4.2

Mit dem Tag SOURCES ist es möglich, die Auswahl oder Anzeige auf Datenquellen der Datenquellen-Verwaltung einzuschränken.

Bei SOURCES handelt es sich um eine Positivlist, d.h. es werden nur die angegebenen Datenquellen zugelassen. Wird SOURCES nicht angegeben, kann aus allen Datenquellen des Projekts ausgewählt werden.

Um eine Datenquelle zuzulassen, ist jeweils ein CONTENT-Tag anzugeben.

CONTENTVerfügbar ab FirstSpirit-Version 4.2

Mit dem CONTENT-Tag wird eine Datenquelle angegeben, die berücksichtigt werden soll.

Für jede gewünschte Datenquelle wird ein CONTENT-Tag definiert.

Soll FS_DATASET auf eine Fremdschlüsselbeziehung abgebildet ("gemappt") werden, darf ausschließlich ein CONTENT-Tag angegeben werden.

ParameterPflichtparameterSeitTypStandardwert
name*Ja4.2ReferenceNameKeiner

name

Für den Parameter name ist ein gültiger Name einer Datenquelle anzugeben.

ParameterPflichtparameterSeitTypStandardwert
name*Ja4.2ReferenceNameKeiner
Legende

PositiveInteger

Positive Ganzzahl

Designator

Eindeutiger Bezeichner variabler Länge; muss mit einem Buchstaben oder Unterstrich beginnen und darf nur die Zeichen "A-Z", "a-z", "0-9" und "_" enthalten, z.B. "fr_st_varName"

Treatment

Indizierungsverhalten bei referenzierten Datensätzen

DEFAULTVerfügbar ab FirstSpirit-Version 5.2.12

Mit-Indizierung von referenzierten Datensätzen gemäß der Konfiguration von "indexing.relationshipPathLengthToFollow"

FOLLOWVerfügbar ab FirstSpirit-Version 5.2.12

Verlängerung des Pfades, entlang dessen referenzierte Datensätze mit indiziert werden

Relevancy

Definition einer Gewichtung für die Suche

NONEVerfügbar ab FirstSpirit-Version 5.2.305

Irrelevant für die Suche

DEFAULTVerfügbar ab FirstSpirit-Version 5.2.305

Normale Gewichtung

HIGHVerfügbar ab FirstSpirit-Version 5.2.305

Hohe Gewichtung

Preset

Behandlung von Vorgabewerten

CopyVerfügbar ab FirstSpirit-Version 4.0

Verwendung des vom Redakteur gewählten Wertes, nachträgliche Änderungen wirken sich nicht aus

DefaultVerfügbar ab FirstSpirit-Version 4.0

Verwendung des im Formular definierten Rückgriffwerts, solange kein manueller Wert gesetzt wird

DatasetSelectorMode

Schalter für den Auswahlmodus der Eingabekomponente (SiteArchitect)

DIALOGVerfügbar ab FirstSpirit-Version 5.1.504

Standardmodus: Auswahl per Auswahldialog

LISTVerfügbar ab FirstSpirit-Version 5.1.504

Auswahl per einfacher Liste (nur mit einer Datenquelle möglich)

String

Eine beliebige Zeichenkette

YesNo

Schalter, um ein Attribut anzuwenden oder nicht

NOVerfügbar ab FirstSpirit-Version 2.0

Attribut nicht anwenden

YESVerfügbar ab FirstSpirit-Version 2.0

Attribut anwenden

ConvertEntity

Schalter, um die Konvertierungsregel festzulegen

NONEVerfügbar ab FirstSpirit-Version 2.0

Keine Konvertierungsregeln anwenden

STANDARDVerfügbar ab FirstSpirit-Version 2.0

Konvertierungsregeln des "convert"-Bereichs anwenden

QUOTEVerfügbar ab FirstSpirit-Version 2.1

Konvertierungsregeln des "convert"- und "quote"-Bereichs anwenden

LanguageAbbreviation

Sprachkürzel, z.B. DE, EN, FR oder * für Rückfallwerte

DatasetMode

Schalter für den Anzeigemodus der Eingabekomponente (SiteArchitect)

DIALOGVerfügbar ab FirstSpirit-Version 4.2.413

Standardmodus: Bietet alle Funktionen, Anzeige aller Informationen des Datensatzes

SHEETVerfügbar ab FirstSpirit-Version 5.0R1

Verkürzte Anzeige der Informationen eines Datensatzes

COMBOBOXVerfügbar ab FirstSpirit-Version 4.2.413

Auswahl per Combobox und Icons zur Bearbeitung

ReferenceName

Eindeutiger Referenzname, darf nur die Zeichen "A-Z", "a-z", "0-9" und "_" enthalten, z. B. "fr_st_varName"

Beispiel

Ein Beispiel für die Eingabekomponente FS_DATASET:

<FS_DATASET name="BEZEICHNER" hFill="YES" useLanguages="YES">
<LANGINFOS>
<LANGINFO lang="*" label="TEXT_FALLBACK" description="TEXT_FALLBACK"/>
<LANGINFO lang="DE" label="TEXT_DE" description="TEXT_DE"/>
<LANGINFO lang="EN" label="TEXT_EN" description="TEXT_EN"/>
</LANGINFOS>
<SOURCES>
<CONTENT name="BEZEICHNER"/>
</SOURCES>
</FS_DATASET>

Verwendungsbeispiele in der Vorlagensyntax

Für die Ausgabe eines über FS_DATASET referenzierten Datensatzes gibt es zwei Möglichkeiten:

  1. Auswahl und Ausgabe des/der gewünschten Datensatzes/Datensätze erfolgt über dieselbe Vorlage („zentral“; ...dataset.entity...).
  2. Auswahl und Ausgabe des/der gewünschten Datensatzes/Datensätze erfolgt über getrennte Vorlagen („dezentral“). Die Ausgabe erfolgt über die Tabellenvorlage, über die die Datensätze erstellt werden. Die Ausgabe in der Vorlage, über die die Datensätze ausgewählt werden, erfolgt über ein einfaches $CMS_VALUE(...)$ (...dataset.formData...).

1) Im ersten Fall werden einzelne Spalten des Datensatzes mithilfe des Spaltennamens im Datenbank-Schema ausgegeben:

$CMS_VALUE([Bezeichner_der_FS_DATASET_Eingabekomponente].dataset.entity.[Spaltenname])$

Beispiel (aus dem Beispielprojekt „Mithras Energy“, Absatzvorlage „Kontakt“, Ausgabe von Kontakten in der rechten Marginalspalte):

$CMS_VALUE(st_contact.dataset.entity.Salutation)$
$CMS_VALUE(st_contact.dataset.entity.Firstname)$
$CMS_VALUE(st_contact.dataset.entity.Lastname)$

2) Im zweiten Fall werden die Inhalte der Datensätze über die Tabellenvorlage, über die die Datensätze erstellt werden, ausgegeben:

$CMS_VALUE([Bezeichner_der_Eingabekomponente_Tabellenvorlage])$ </br>

Beispiel:

$CMS_VALUE(cs_salutation)$ $CMS_VALUE(cs_lastname)$ </br>
Wichtig Bei einer Ausgabe über Tabellenvorlagen sollte darauf geachtet werden, dass nur dynamische Inhalte (also beispielsweise über $CMS_VALUE(...)$, kein statischer Text!) ausgegeben werden, da alle Inhalte auf dem Ausgaberegister einer Tabellenvorlage für jeden auf dieser basierenden Datensatz und somit potenziell mehrfach auf einer Seite ausgegeben werden.

In der Vorlage, mithilfe derer die Datensätze ausgewählt werden, wird der Inhalt der Eingabekomponente über $CMS_VALUE(...)$ und den Bezeichner der Eingabekomponente ausgegeben:

$CMS_VALUE([Bezeichner_der_FS_DATASET_Eingabekomponente].dataset.formData])$

Beispiel:

$CMS_VALUE(st_dataset.dataset.formData)$

Zu weiteren Informationen siehe auch Datentyp DatasetContainer.

© 2005 - 2020 e-Spirit AG | Alle Rechte vorbehalten. | FirstSpirit 2020-07 | Datenschutz | Impressum | Kontakt