Open Source Dokumentenmanagement
Dokumentation

Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core agoscript


Lektionen 1-9

In diesen Lektionen lernen Sie den Einsatz von XML in agorum core. Zu jeder Lektion gehört ein XML-Skript-Beispiel, das am Anfang der Lektion verlinkt ist. Laden Sie dieses Skript herunter, damit Sie es für die jeweilige Lektion verwenden können. Die Funktionsweise des Skripts ist im Skript beschrieben.

Für das Ausführen des XML-Skripts siehe Einführung in agorum core agoscript.

Lektion 1: Einen Ordner erstellen


XML-Datei zur Lektion: undefined>Lektion 1.ac.xml

In dieser Lektion erstellen Sie über agoscript einen Ordner, der in allen weiteren Beispielen die Grundlage für die XML-Skripte darstellt. Löschen Sie diesen Ordner deshalb nicht.

Attribute eines FolderObjects

Ein Ordner ist ein FolderObject, das einen Ordner mit all seinen Attributen beschreibt:

Attribut Beschreibung
Name Definiert den Namen des Objekts, so wie es im Dateisystem erscheint.
  • Die maximale Länge eines Namens ist 254 Zeichen.
  • Geben Sie den Namen zwingend an.
Description Definiert eine Beschreibung.
  • Die Länge ist nicht begrenzt.
  • Das Attribut bleibt leer, wenn Sie keine Beschreibung angeben.
Acl Definiert, welcher Rechtestempel für dieses Objekt gilt.

Das System vererbt die ACL des übergeordneten Folders, an den Sie das Objekt verknüpfen, wenn Sie keinen Rechtestempel angeben.

Befehle zur ersten Übung

Befehl Beschreibung
<NoErrorIfExist/> Unterdrückt Fehlermeldungen und den Abbruch des XML-Skripts, wenn das Objekt schon vorhanden ist.
<Update> Holt das Objekt, damit sich dessen Attribute aktualisieren können.
<AddToFolder> Verknüpft ein Objekt mit einem vorhandenen Ordner. 
  • Sie können verknüpfte Objekte nicht löschen.
  • Das System vererbt die ACL bei der Verknüpfung, wenn keine ACL vorgegeben ist.

Das FolderObject per Skript erstellen

Führen Sie das Skript aus, um das FolderObjekt für die nachfolgenden XML-Skript-Beispiele zu erstellen.

  1. Öffnen Sie links in der Seitenleiste Weitere Apps und dann desk4web.
  2. Öffnen Sie ein beliebiges Verzeichnis in desk4web.
  3. Führen Sie das Skript aus.

    Ergebnis: Das System:

    • erstellt den Ordner unter dem gewählten Verzeichnis mit dem Namen XML-Script-Schulung
    • verknüpft den Ordner in den Ordner Dateien

Hinweis: Im Normalfall legt ein Administrator, etwa roi, die Objekte an. Die hier beschriebenen Beispiele wurden so angelegt, dass nur der erstellende Benutzer die angelegte Struktur sieht, da das System gleich zu Beginn die ACL Private setzt.

Erläuterung der XML-Datei

Code Beschreibung
<?xml version = "1.0" encoding="ISO-8859-1"?> Definiert die Textdatei als XML-Datei.
<ObjectList> Öffnet die Liste der Objekte.
<FolderObject> Legt ein neues Objekt vom Typ Folder an.
<Name></Name> Legt den Namen des Objekts (Ordners) fest.
<Description></Description> Definiert eine Beschreibung.
<AddToFolder>/agorum/roi/files</AddToFolder> Definiert, unter welchem Pfad das System das neue Objekt erzeugt.

Eine fehlende Angabe führt zu verwaisten Einträgen in der Datenbank, die Sie nur schwer wieder entfernen können.
<Acl DataType="GLOBALOBJECT" RefType="Name" ClassName="AccessControlListObject">Published</Acl> Setzt die ACL des Objekts.
<NoErrorIfExist/> Unterdrückt eine Fehlermeldung und den Abbruch des XML-Skripts, wenn das Objekt schon vorhanden ist.
  • Das System verwendet bereits existierende Objekte.
  • Sie können alternativ existierende Objekte zuerst löschen und dann wieder neu anlegen, etwa bei Updates.
</FolderObject> Schließt das FolderObjekt.
</ObjectList> Schließt die Liste der Objekte und die XML-Datei.

Lektion 2: Einen Ordner verknüpfen


XML-Datei zur Lektion: undefined>Lektion 2.ac.xml

In dieser Lektion verknüpfen Sie Ordner absolut und relativ. Bei der relativen Verknüpfung hängt das Ergebnis davon ab, in welchem Ordner Sie das XML-Skript ausführen. Dieser Ordner ist dann der Startordner für die relativen Verweise im XML-Skript.

  1. Führen Sie das XML-Skript im angelegten Ordner XML-Script-Schulung aus.

    Ergebnis: Das Skript legt drei Ordner an, die es relativ verknüpft. Sind Sie in einem anderen Ordner, erstellt das Skript die Ordnerstruktur dort.

Hinweis: Führen Sie die nachfolgenden Skripte immer im Ordner XML-Script-Schulung aus, soweit nicht anderweitig angegeben.

Lektion 3: Relative Verweise zwischen Ordnern


XML-Datei zur Lektion: undefined>Lektion 3.ac.xml

Sie realisieren in diesem Beispiel die Verknüpfung der Ordner durch Referenzen und Verweise, wobei das System die erste Referenz relativ zum Ausführungsort des XML-Skripts holt.

Lektion 4: An mehrere Stellen verlinken


XML-Datei zur Lektion: undefined>Lektion 4.ac.xml

In dieser Lektion erstellen Sie drei Ordner und verlinken einen dieser Ordner an drei Stellen. Sie können damit andere Sichten auf Daten abbilden. Weiter können Sie, mit den richtigen Rechten versehen, abteilungsübergreifende Ordner erstellen und administrieren. Dazu verlinken Sie denselben Ordner in mehrere Abteilungen und berechtigen den Ordner so, dass alle betroffenen Abteilungen dafür berechtigt sind.


Struktur nach dem Ausführen des Skripts

XML-Script-Schulung/
 Ordner A/
    Ordner A.A/
         Ordner A.A.A
    Ordner C.C/
         Ordner C.C.C
 Ordner B/
    Ordner B.B/
         Ordner B.B.B
    Ordner C.C/
         Ordner C.C.C
 Ordner C/
    Ordner C.C/
         Ordner C.C.C

Hinweis: Bei den Ordnern C.C und C.C.C handelt es sich um dieselben Ordner. Wenn Sie dort eine Datei ablegen, ist diese Datei über alle Pfade zu erreichen.

Lektion 5: Ein Objekt ändern


XML-Datei zur Lektion: undefined>Lektion 5.ac.xml

Sie erstellen mit dem Befehl <Update> nicht nur ein Objekt in einem SavePoint, sondern ändern es auch.


Struktur nach dem Ausführen des Skripts

XML-Script-Schulung/
 A Ordner/
    Ordner A.A/
         Ordner A.A.A
    Ordner C.C/
         Ordner C.C.C
 B Ordner
    Ordner B.B/
         Ordner B.B.B
    Ordner C.C/
         Ordner C.C.C
 C Ordner
    Ordner C.C/
         Ordner C.C.C

Lektion 6: Die Struktur erstellen


XML-Datei zur Lektion: undefined>Lektion 6.ac.xml

Mit diesem Skript erstellen Sie eine Demo-Struktur bei der Installation von agorum core.


Struktur nach dem Ausführen des Skripts

XML-Script-Schulung/
 A Ordner/
 …
 B Ordner
 …
 C Ordner
 …
 Demo/
  Entwicklung
    …
 …
usw.

Lektion 7: Das Dokument (FileObject) erstellen


XML-Datei zur Lektion: undefined>Lektion 7.ac.xml

Mit diesem Skript erstellen Sie etwa ein FileObject. txt-Dokumente können Sie mit Inhalt füllen.

Nachdem Sie das Skript ausgeführt haben, liegt das neue Dokument im Ordner A.

Lektion 8: Das Dokument (FileObject) mit Base64 erstellen


XML-Datei zur Lektion:: undefined>Lektion 8.ac.xml

Mit diesem Skript erstellen Sie eine .doc-Datei mit dem Namen Willkommen.doc. Da es sich um eine binäre Datei handelt, müssen Sie die Vorlage in Base64 umwandeln.

Nachdem Sie das Skript ausgeführt haben, liegt das neue Dokument im Ordner Demo.

Lektion 9: Benutzergruppen (DirectoryGroupObject) erstellen


XML-Datei zur Lektion: undefined>Lektion 9.ac.xml

In dieser Lektion erstellen Sie neue Benutzergruppen mit unterschiedlichen Berechtigungen. Eine Benutzergruppe ist ein DirectoryGroupObject. Mit diesem fassen Sie Benutzer und Benutzergruppen zusammen. Der Benutzergruppe selbst vergeben Sie dann in den ACLs die Rechte.

Eine Benutzergruppe benötigen Sie, wenn bestimmte Benutzer dieselben Rechte bekommen sollen. Über die Benutzergruppe erledigen Sie administrative Aufgaben schneller, da Sie Benutzer nur einmal über die Benutzergruppe berechtigen. Für Vorlagen von elektronischen Akten kann es zudem sinnvoll sein, eine entsprechende Benutzergruppe und zugehörige ACL mit in der Vorlage anzulegen.

In diesem Skript geht es um das Beispiel eines neuen Partners (Partner A), der einen bestimmten Zugang zu agorum core erhalten soll. In welchem Ordner Sie das Skript ausführen, ist egal.

Das Skript legt Folgendes an:

Angelegtes Objekt Beschreibung
Ordner „XML-Script-Schulung“ in der Gruppen-Verwaltung
Gruppe „GRP_XML-Script-Schulung_Partner_A_ALL“ Benutzergruppe mit Vollzugriff
Gruppe „GRP_XML-Script-Schulung_Partner_A_READ“ Benutzergruppe mit Lese-Zugriff
Gruppe „GRP_XML-Script-Schulung_Partner_A_NOT“ Benutzergruppe ohne Zugriff

Sie schließen so Benutzer aus, die über eine der anderen Benutzergruppen Zugang erhalten würden.
Gruppe „GRP_XML-Script-Schulung_Partner_A_AlleBenutzer“ Zusammenfassung der ersten beiden Benutzergruppen
Gruppe „GRP_XML-Script-Schulung_Partner_AlleBenutzer Zusammenfassung aller obigen Benutzergruppen

Sie regeln mit einer solchen Benutzergruppe den Zugang zu Bereichen, etwa den Zugang einzelner Partner in einen Partnerbereich.