docs: Ergänze empfohlene Strukturen für Poll- und Antwortlisten im README

This commit is contained in:
Torsten Brendgen
2026-08-27 00:34:00 +02:00
parent 6bcf7c5020
commit 8c8613afb8
+64
View File
@@ -66,12 +66,76 @@ Schluesselspalte fuer die Poll-Liste und eine nicht eindeutige Verweisspalte fue
Verweisspalte darf nicht eindeutig sein, weil mehrere Benutzer dieselbe Umfrage beantworten. Interne Namen Verweisspalte darf nicht eindeutig sein, weil mehrere Benutzer dieselbe Umfrage beantworten. Interne Namen
wie `PollDefinitionKey` und `PollReferenceKey` sind daher ebenso moeglich und werden im Property Pane zugeordnet. wie `PollDefinitionKey` und `PollReferenceKey` sind daher ebenso moeglich und werden im Property Pane zugeordnet.
### Empfohlene Struktur der Poll-Liste
| Interner Name | Typ | Einstellung / Verwendung |
|---|---|---|
| `PollDefinitionKey` | Eine Textzeile | Pflichtfeld, indiziert und eindeutig; dauerhafter Schluessel der Umfrage |
| `Title` | Eine Textzeile | Optionaler Titel der Umfrage |
| `Question` | Eine Textzeile oder mehrere Textzeilen | Pflichtfeld; angezeigte Frage |
| `OptionsText` | Mehrere Textzeilen, Nur-Text | Pflichtfeld; eine Antwortmoeglichkeit pro Zeile |
| `StartDate` | Datum und Uhrzeit | Optionaler Beginn der Anzeige |
| `EndDate` | Datum und Uhrzeit | Optionales Ende der Anzeige |
| `IsActive` | Ja/Nein | Aktiviert die Umfrage; empfohlener Standardwert `Nein` |
Beispiel fuer einen stabilen `PollDefinitionKey`:
```text
Poll-2026-Sommerfest
```
Der Schluessel darf nach Beginn der Abstimmung nicht mehr geaendert werden, weil die Antworten diesen Wert
als Verbindung zur Umfrage speichern.
### Empfohlene Struktur der Antwortliste
| Interner Name | Typ | Einstellung / Verwendung |
|---|---|---|
| `PollReferenceKey` | Eine Textzeile | Pflichtfeld und indiziert, aber **nicht eindeutig**; enthaelt den Poll-Schluessel |
| `UserKey` | Eine Textzeile | Pflichtfeld und indiziert; Login, E-Mail oder anderer stabiler Benutzerschluessel |
| `Answer` | Eine Textzeile | Pflichtfeld; ausgewaehlte Antwortmoeglichkeit |
| `Title` | SharePoint-Standardspalte | Wird vom WebPart nicht benoetigt und kann optional oder ausgeblendet sein |
`PollReferenceKey` darf nicht eindeutig sein, da mehrere Benutzer dieselbe Umfrage beantworten. Fuer
`PollDefinitionKey` und `PollReferenceKey` muessen im Inhaltstyp-Katalog zwei verschiedene Websitespalten mit
unterschiedlichen Feld-IDs angelegt werden. Dadurch kann nur der Schluessel der Poll-Liste eindeutig sein,
waehrend die Antwortliste denselben Wert mehrfach speichern darf.
### Zuordnung im Property Pane
Poll-Liste:
| Property-Pane-Feld | Empfohlene Spalte |
|---|---|
| Stabiler Schluessel | `PollDefinitionKey` |
| Titel | `Title` |
| Frage | `Question` |
| Antwortoptionen | `OptionsText` |
| Startdatum | `StartDate` |
| Enddatum | `EndDate` |
| Aktiv | `IsActive` |
Antwortliste:
| Property-Pane-Feld | Empfohlene Spalte |
|---|---|
| Umfrageschluessel | `PollReferenceKey` |
| Benutzerschluessel | `UserKey` |
| Ausgewaehlte Antwort | `Answer` |
Das mitgelieferte Provisionierungsskript verwendet fuer lokal erzeugte Listen aus Kompatibilitaetsgruenden
in beiden Listen den internen Namen `PollKey`. Bei zentral verteilten Inhaltstypen ist die oben beschriebene
Trennung in `PollDefinitionKey` und `PollReferenceKey` vorzuziehen.
Die internen Spaltennamen duerfen abweichen. Im Property Pane lassen sich Umfrageschluessel, Titel, Frage, Die internen Spaltennamen duerfen abweichen. Im Property Pane lassen sich Umfrageschluessel, Titel, Frage,
Antwortoptionen, Zeitfenster, Aktiv-Flag sowie Umfrageschluessel, Benutzer und Antwort der Antwortliste frei Antwortoptionen, Zeitfenster, Aktiv-Flag sowie Umfrageschluessel, Benutzer und Antwort der Antwortliste frei
zuordnen. Fuer vorhandene Installationen bleibt ein bestehendes `Poll`-Lookup lesbar: In diesem Fall muss als zuordnen. Fuer vorhandene Installationen bleibt ein bestehendes `Poll`-Lookup lesbar: In diesem Fall muss als
Umfrageschluessel `ID` und als Antwortschluessel das Lookup `Poll` ausgewaehlt werden. Empfohlen ist die Umfrageschluessel `ID` und als Antwortschluessel das Lookup `Poll` ausgewaehlt werden. Empfohlen ist die
Migration auf die beiden Textspalten `PollKey`. Migration auf die beiden Textspalten `PollKey`.
Neue Inhaltstypen benoetigen keine Lookup-Spalte. Ein bestehendes Lookup dient ausschliesslich der
Rueckwaertskompatibilitaet und sollte nach der Migration nicht mehr fuer neue Antworten verwendet werden.
## Paket bauen ## Paket bauen
```powershell ```powershell