XIP User: Unterschied zwischen den Versionen

Aus SiteparkWiki
Zur Navigation springen Zur Suche springen
K (hat „XIP Nutzer“ nach „XIP User“ verschoben)
 
Zeile 1: Zeile 1:
==Nutzer==
+
=<code><user></code>=
Neben Artikeln können auch alle anderen IES-Elemente bzw. Pools über diese Schnittstelle importiert werden. Die Eigenschaften der Nutzer werden über Attribute bestimmt. Zusäzliche Inhalte (z.B. Telefonnummer) werden über eine Resource beschrieben. Hier gelten die selben Bedingungen wie bei Resource-Artikeln.
+
===Beschreibung===
 +
Dieses XML-Element wird verwendet um IES-Nutzer zu definieren.
 +
===Erlaubte übergerodnete XML-Elemente===
 +
<code><xip></code>, <code><userpool></code>
 +
===Attribute===
 +
{| class="prettytable sortable"
 +
|- class="hintergrundfarbe1"
 +
! Name || Beschreibung
 +
|-
 +
| <code>parent</code>
 +
| Anchor des Nutzer-Pools für diesen Nutzer. Die Angabe eines Parents ist nicht nötig, wenn die XML-Datei in einem Verzeichnis liegt, das als Pool definiert wurde (siehe [[XIP Format#XIP-INF_Verzeichnis|XIP-INF]]). Elemente können auch ohne Angabe eines Parents importiert werden, wenn mit dem Parameter <code>ies.xip.import.root</code> ein Parent definiert wurde.
 +
|-
 +
| <code>anchor</code>
 +
| Der Anchor des Elementes
 +
|-
 +
| <code>name</code>
 +
| Der Name des Nutzers ergibt sich aus '<code>Nachname, Vorname (login)</code>' und wird beim exportieren gesetzt. Für den Import wird dieses Attribut ignoriert.
 +
|-
 +
| <code>login</code>
 +
| Login des Nutzers
 +
|-
 +
| <code>firstname</code>
 +
| Vorname des Nutzers
 +
|-
 +
| <code>lastname</code>
 +
| Nachname des Nutzers
 +
|-
 +
| <code>type</code>
 +
| Typ des Nutzers. Der Typ wird als Zahlenwert angegeben.
 +
*<code>3002</code> = Administrator
 +
*<code>3003</code> = Standard-Nutzer
 +
*<code>3004</code> = Gast
 +
|-
 +
| <code>password</code>
 +
| Hash-Wert des Nutzerpasswortes. Dieses Attribut wird bei einem Export des Nutzers gesetzt und kann auch für den Import verwendet werden.
 +
|-
 +
| <code>clear-password</code>
 +
| Passwort im Klartext. Dieses Attribut wird bei einem Export nicht gesetzt (im IES sind die Passwörter nicht im Klartext abgelegt). Dieses Attribut kann für den Import verwendet werden.
 +
|-
 +
| <code>sex</code>
 +
| Geschlecht des Nutzers (<code>0=female, 1=male, -1=unknown</code>)
 +
|-
 +
| <code>email</code>
 +
| System-E-Mail-Adresse des Nutzers
 +
|-
 +
| <code>locale</code>
 +
| Sprache des Nutzers (z.B. "<code>de</code>" oder "<code>de_DE</code>")
 +
|-
 +
| <code>valid-from</code>
 +
| Beginn der Freischaltzeit. Das Datum wird in Millisekunden ab dem 1.1.1970 00:00 Uhr ([http://de.wikipedia.org/wiki/Koordinierte_Weltzeit UTC]) angegeben
 +
|-
 +
| <code>valid-to</code>
 +
| Ende der Freischaltzeit. Das Datum wird in Millisekunden ab dem 1.1.1970 00:00 Uhr ([http://de.wikipedia.org/wiki/Koordinierte_Weltzeit UTC]) angegeben
 +
|-
 +
| <code>disabled</code>
 +
| Sperre des Nutzers
 +
|}
  
Attribute des XML-Elements "user"
+
===Unterelemente===
;<code>anchor</code>
+
====<code><comment></code>====
:Anker des Nutzers. Dient beim wiederholten Import als Primärschlüssel dieser Daten und als Parent für die Artikel ([[String]]).
+
=====Beschreibung=====
;<code>parent</code>
+
Kommentare zu dem Nutzer
:Anker des Parentpools. Die Angabe muss über einen Anker erfolgen ([[String]]).
+
=====Attribute=====
;<code>firstname</code>
+
keine
:Vorname des Nutzers ([[String]]).
+
====<code><resource></code>====
;<code>lastname</code>
+
=====Beschreibung=====
:Nachname des Nutzers ([[String]]).
+
Beliebiger Content, der für den Nutzer definiert werden soll. Wie die einzelnen Content-Elemente definiert werden, ist unter[[XIP Content]] beschrieben.
;<code>login</code>
+
=====Attribute=====
:Login des Nutzers ([[String]]).
+
keine
;<code>type</code>
+
===Beispiel für einen Nutzer===
:Nutzertyp ([[Integer]]).
+
<source lang="xml">
;<code>password</code>
+
<?xml version="1.0" encoding="UTF-8"?>
:binäres Passwort des Nutzers (i.d.R. wird das Attribut "<code>clear-password</code>" verwendet, um ein Passwort zu setzen) (<code>Base64-Encoded Bytes</code>).
+
 
;<code>clear-password</code>
+
<user
:Klartextpasswort des Nutzers ([[String]]).
+
  anchor="user.wacker" name="Wacker, Willi (wacker)" parent="userpool.test2"
;<code>email</code>
+
  login="wacker" password="d2Ezc1lZQXRVUmZJSQ==" firstname="Willi"
:System-E-Mail-Adresse des Nutzers ([[String]]).
+
  lastname="Wacker" email="willi.wacker@sitepark.com" locale="de" type="3003">
;<code>locale</code>
+
 
:Sprache des Nutzers (z.B. "<code>de</code>" oder "<code>de_DE</code>") ([[String]]).
+
  <resource>
;<code>sex</code>
+
    <text name="company">Sitepark GmbH</text>
:Geschlecht des Nutzers (<code>0=female, 1=male, -1=unknown</code>) ([[Integer]]).
+
  </resource>
;<code>valid-from</code>
+
 
:Ein Long-Wert mit der Angabe der Freischaltungszeit ([[Long]]).
+
</user>
;<code>valid-to</code>
+
</source>
:Ein Long-Wert mit der Angabe der Freischaltungszeit ([[Long]]).
 
;<code>disabled</code>
 
:Sperre des Nutzers ([[Boolean]]).
 
  
 
<noinclude>
 
<noinclude>

Aktuelle Version vom 8. Mai 2009, 16:53 Uhr

<user>

Beschreibung

Dieses XML-Element wird verwendet um IES-Nutzer zu definieren.

Erlaubte übergerodnete XML-Elemente

<xip>, <userpool>

Attribute

Name Beschreibung
parent Anchor des Nutzer-Pools für diesen Nutzer. Die Angabe eines Parents ist nicht nötig, wenn die XML-Datei in einem Verzeichnis liegt, das als Pool definiert wurde (siehe XIP-INF). Elemente können auch ohne Angabe eines Parents importiert werden, wenn mit dem Parameter ies.xip.import.root ein Parent definiert wurde.
anchor Der Anchor des Elementes
name Der Name des Nutzers ergibt sich aus 'Nachname, Vorname (login)' und wird beim exportieren gesetzt. Für den Import wird dieses Attribut ignoriert.
login Login des Nutzers
firstname Vorname des Nutzers
lastname Nachname des Nutzers
type Typ des Nutzers. Der Typ wird als Zahlenwert angegeben.
  • 3002 = Administrator
  • 3003 = Standard-Nutzer
  • 3004 = Gast
password Hash-Wert des Nutzerpasswortes. Dieses Attribut wird bei einem Export des Nutzers gesetzt und kann auch für den Import verwendet werden.
clear-password Passwort im Klartext. Dieses Attribut wird bei einem Export nicht gesetzt (im IES sind die Passwörter nicht im Klartext abgelegt). Dieses Attribut kann für den Import verwendet werden.
sex Geschlecht des Nutzers (0=female, 1=male, -1=unknown)
email System-E-Mail-Adresse des Nutzers
locale Sprache des Nutzers (z.B. "de" oder "de_DE")
valid-from Beginn der Freischaltzeit. Das Datum wird in Millisekunden ab dem 1.1.1970 00:00 Uhr (UTC) angegeben
valid-to Ende der Freischaltzeit. Das Datum wird in Millisekunden ab dem 1.1.1970 00:00 Uhr (UTC) angegeben
disabled Sperre des Nutzers

Unterelemente

<comment>

Beschreibung

Kommentare zu dem Nutzer

Attribute

keine

<resource>

Beschreibung

Beliebiger Content, der für den Nutzer definiert werden soll. Wie die einzelnen Content-Elemente definiert werden, ist unterXIP Content beschrieben.

Attribute

keine

Beispiel für einen Nutzer

<?xml version="1.0" encoding="UTF-8"?>

<user
   anchor="user.wacker" name="Wacker, Willi (wacker)" parent="userpool.test2"
   login="wacker" password="d2Ezc1lZQXRVUmZJSQ==" firstname="Willi"
   lastname="Wacker" email="willi.wacker@sitepark.com" locale="de" type="3003">

  <resource>
    <text name="company">Sitepark GmbH</text>
  </resource>

</user>