PersonalizationInformation (Objekt): Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
 
(7 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
  
 
==Beschreibung==
 
==Beschreibung==
Publizierte [[Article|Artikel]] und [[Media|Medien]], bzw. die erzeugten Dateien können personalisiert werden. Dies bedeutet, dass nur authorisierte [[User|Nutzer]] auf diese Dateien über einen Apache-Webserver zugreifen können. Dazu muß ein [[ProfilePlus|zusätzliches Apache-Module]] der Firma Sitepark in den Apache integriert werden. Dieses Apache-Modul und der IES prüfen zusammen, ob der Nutzer die generierte Seite abrufen darf. In dem PersonalizationInformation-Objekt ist definiert, welchen Nutzern der Zugriff erlaubt ist.
+
Publizierte [[Article|Artikel]] und [[Media|Medien]], bzw. die erzeugten Dateien können personalisiert werden. Dies bedeutet, dass nur authorisierte [[User|Nutzer]] auf diese Dateien über einen Apache-Webserver zugreifen können. Dazu muss ein [[ProfilePlus|zusätzliches Apache-Module]] der Firma Sitepark in den Apache integriert werden. Dieses Apache-Modul und der IES prüfen zusammen, ob der Nutzer die generierte Seite abrufen darf. In dem PersonalizationInformation-Objekt ist definiert, welchen Nutzern der Zugriff erlaubt ist.
  
 
==Attribute==
 
==Attribute==
{| class="prettytable"
+
{| class="prettytable sortable"
 
|- class="hintergrundfarbe1"
 
|- class="hintergrundfarbe1"
 
! Attribut || Type || Beschreibung || ab IES Version
 
! Attribut || Type || Beschreibung || ab IES Version
Zeile 16: Zeile 16:
 
|-
 
|-
 
| field
 
| field
| [[Variable]]
+
| [[String]]
 
| Variablenname des Objektes
 
| Variablenname des Objektes
 
| 1
 
| 1
 +
|-
 +
| lastField
 +
| [[String]]
 +
| Variablenname des Objektes ohne Struktur-Date
 +
| 2.13
 
|-
 
|-
 
| root
 
| root
 
| [[Element]]
 
| [[Element]]
 
| Root-Element dieser Information
 
| Root-Element dieser Information
 +
| 1
 +
|-
 +
| parent
 +
| [[ID]]
 +
| ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein [[Element]], eine [[SubInformation]] oder eine [[ListItemInformation]] sein
 
| 1
 
| 1
 
|-
 
|-
Zeile 33: Zeile 43:
 
| [[Boolean]]
 
| [[Boolean]]
 
| <code>true</code>, wenn keine Personalisierungsdaten vorhanden sind
 
| <code>true</code>, wenn keine Personalisierungsdaten vorhanden sind
 +
| 1
 +
|-
 +
| hasRestrictions
 +
| [[Boolean]]
 +
| <code>true</code>, wenn Restriktionen vorhanden sind
 
| 1
 
| 1
 
|-
 
|-
 
| personalizationGroups
 
| personalizationGroups
| [[Collection]] <[[UserPool]]>
+
| [[Collection]]&nbsp;<[[UserPool]]>
 
| Liste aller [[UserPool|UserPools]], dessen Nutzer der Zugriff gewährt werden soll (bzw. nicht gewährt werden soll, siehe personalizationExclusion)
 
| Liste aller [[UserPool|UserPools]], dessen Nutzer der Zugriff gewährt werden soll (bzw. nicht gewährt werden soll, siehe personalizationExclusion)
 
| 1
 
| 1
Zeile 42: Zeile 57:
 
| personalizationGroupList
 
| personalizationGroupList
 
| [[String]]
 
| [[String]]
| kommaseparierte Liste von UserPool-IDs, dessen Nutzer der Zugriff gewährt werden soll (bzw nicht gewährt werden soll, siehe personalizationExclusion). Die IDs werden ohne [[ID|Element-Typ]] ausgegeben
+
| kommaseparierte Liste von UserPool-IDs, dessen Nutzer der Zugriff gewährt werden soll (bzw. nicht gewährt werden soll, siehe personalizationExclusion). Die IDs werden ohne [[ID|Element-Typ]] ausgegeben
 
| 1
 
| 1
 
|-
 
|-
Zeile 51: Zeile 66:
 
|}
 
|}
  
 +
==Methoden==
 +
{| class="prettytable sortable"
 +
|- class="hintergrundfarbe1"
 +
! Methode || Rückgabewert || Beschreibung || ab IES Version
 +
|-
 +
| <code>toXip([[Boolean]] emptyFields)</code>
 +
| String
 +
| Erzeugt XML-Daten im XIP-Format für dieses Objekt
 +
| 2.14
 +
|}
 +
 +
;<code>[[String]] toXip([[Boolean]] emptyFields)</code>
 +
:Erzeugt XML-Daten im XIP-Format für dieses Objekt.
 +
:;Parameter
 +
::;<code>Boolean emptyFields</code>
 +
:::Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).
 +
:;Rückgabewert
 +
::;String
 +
:::XML-Daten im XIP-Format
  
 
<noinclude>
 
<noinclude>
 
[[Category:Objekte]]
 
[[Category:Objekte]]
[[Category:Qualität_der_Sprache_prüfen]]
 
 
[[Category:Qualität_des_Codes_prüfen]]
 
[[Category:Qualität_des_Codes_prüfen]]
 
</noinclude>
 
</noinclude>

Aktuelle Version vom 4. November 2015, 13:14 Uhr

Name

PersonalizationInformation - Personalisierungsdaten für einen Artikel oder eines Mediums für einen Publisher

Beschreibung

Publizierte Artikel und Medien, bzw. die erzeugten Dateien können personalisiert werden. Dies bedeutet, dass nur authorisierte Nutzer auf diese Dateien über einen Apache-Webserver zugreifen können. Dazu muss ein zusätzliches Apache-Module der Firma Sitepark in den Apache integriert werden. Dieses Apache-Modul und der IES prüfen zusammen, ob der Nutzer die generierte Seite abrufen darf. In dem PersonalizationInformation-Objekt ist definiert, welchen Nutzern der Zugriff erlaubt ist.

Attribute

Attribut Type Beschreibung ab IES Version
id ID ID des Objektes 1
field String Variablenname des Objektes 1
lastField String Variablenname des Objektes ohne Struktur-Date 2.13
root Element Root-Element dieser Information 1
parent ID ID des Objektes, in dem diese Information eingebettet ist. Dies kann ein Element, eine SubInformation oder eine ListItemInformation sein 1
locale Locale Sprache, für die die Information gilt 1
isEmpty Boolean true, wenn keine Personalisierungsdaten vorhanden sind 1
hasRestrictions Boolean true, wenn Restriktionen vorhanden sind 1
personalizationGroups Collection <UserPool> Liste aller UserPools, dessen Nutzer der Zugriff gewährt werden soll (bzw. nicht gewährt werden soll, siehe personalizationExclusion) 1
personalizationGroupList String kommaseparierte Liste von UserPool-IDs, dessen Nutzer der Zugriff gewährt werden soll (bzw. nicht gewährt werden soll, siehe personalizationExclusion). Die IDs werden ohne Element-Typ ausgegeben 1
personalizationExclusion Boolean true, wenn nur die Nutzer Zugriff haben sollen, die nicht in personalizationGroups enthalten sind 1

Methoden

Methode Rückgabewert Beschreibung ab IES Version
toXip(Boolean emptyFields) String Erzeugt XML-Daten im XIP-Format für dieses Objekt 2.14
String toXip(Boolean emptyFields)
Erzeugt XML-Daten im XIP-Format für dieses Objekt.
Parameter
Boolean emptyFields
Gibt an, ob auch leere Felder enthalten sein sollen (Default ist true).
Rückgabewert
String
XML-Daten im XIP-Format