Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core für Entwickler > agorum core agoscript


Lektionen 1-9

In diesen Lektionen lernen Sie den Einsatz von agoscript-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.

Hinweis: Für das Ausführen von agoscript-Dateien siehe Einführung in agorum core agoscript. Im Folgenden werden die agoscript-XML-Dateien über eine Template Manager Aktion ausgeführt. Installieren Sie dazu das Plugin agorum core template manager.

Lektion 1: Einen Ordner (FolderObject) erstellen

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

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

Eigenschaften eines FolderObjects

Ein Ordner ist ein FolderObject, das einen Ordner mit all seinen Eigenschaften beschreibt. Die Eigenschaften werden in der XML-Struktur als Unterelemente angegeben.

Eigenschaft/Element 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 Element 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/Element 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. Klicken Sie die Datei Lektion 1.ac.xml mit der rechten Maustaste an, um das Kontextmenü zu öffnen.
  2. Wählen Sie im Kontextmenü agorum core template manager > XML-Parser ausführen (agoscript).
  3. Führen Sie das Skript durch Klicken auf OK aus.

    Ergebnis: Das System erstellt:
    • einen neuen Ordner mit dem im Skript angegebenen Namen agoscript-Schulung
    • den neuen Ordner im Ordner Dateien, wie im Skript angegeben

 

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.

Lektion 2: Einen Ordner (FolderObject) erstellen und verknüpfen

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

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

  1. Fügen Sie die Datei Lektion 2.ac.xml in den angelegten Ordner agoscript-Schulung ein.
  2. Klicken Sie die Datei Lektion 2.ac.xml mit der rechten Maustaste an, um das Kontextmenü zu öffnen.
  3. Wählen Sie im Kontextmenü agorum core template manager > XML-Parser ausführen (agoscript).
  4. Führen Sie das Skript durch Klicken auf OK 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 agoscript-Schulung aus, soweit nicht anders angegeben.

Lektion 3: Relative Verweise zwischen Ordnern (FolderObject)

XML-Datei zur Lektion: 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.

  1. Fügen Sie die Datei Lektion 3.ac.xml in den angelegten Ordner agoscript-Schulung ein.
  2. Klicken Sie die Datei Lektion 3.ac.xml mit der rechten Maustaste an, um das Kontextmenü zu öffnen.
  3. Wählen Sie im Kontextmenü agorum core template manager > XML-Parser ausführen (agoscript).
  4. Führen Sie das Skript durch Klicken auf OK 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.

Lektion 4: Ordner (FolderObject) an mehreren Stellen verlinken

XML-Datei zur Lektion: 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.

  1. Fügen Sie die Datei Lektion 4.ac.xml in den angelegten Ordner agoscript-Schulung ein.
  2. Klicken Sie die Datei Lektion 4.ac.xml mit der rechten Maustaste an, um das Kontextmenü zu öffnen.
  3. Wählen Sie im Kontextmenü agorum core template manager > XML-Parser ausführen (agoscript).
  4. Führen Sie das Skript durch Klicken auf OK aus. 

    Ergebnis: Das Skript legt drei Ordner an, die es relativ verknüpft und zusätzlich in andere, bereits vorhandene Ordner verlinkt. 


Struktur nach dem Ausführen des Skripts

agoscript-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 (FolderObject) ändern

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

Sie erstellen mit dem Befehl <Update> nicht nur ein Objekt in einem SavePoint, sondern können die Eigenschaften des Objekts auch ändern. In diesem Beispiel wird gezeigt, wie Sie den Namen und die Beschreibung ändern.

  1. Fügen Sie die Datei Lektion 5.ac.xml in den angelegten Ordner agoscript-Schulung ein.
  2. Klicken Sie die Datei Lektion 5.ac.xml mit der rechten Maustaste an, um das Kontextmenü zu öffnen.
  3. Wählen Sie im Kontextmenü agorum core template manager > XML-Parser ausführen (agoscript).
  4. Führen Sie das Skript durch Klicken auf OK aus. 

    Ergebnis: Das Skript ändert die Namen der drei Ordner A, C und C und ergänzt jeweils eine Beschreibung mit einer Information zur Namensänderung.


Struktur nach dem Ausführen des Skripts

agoscript-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: Eine Struktur (FolderObject) erstellen

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

Mit diesem Skript erstellen Sie eine Demo-Struktur bei der Installation von agorum core innerhalb des angegebenen Basisordners (agoscript-Schulung).

  1. Fügen Sie die Datei Lektion 6.ac.xml in den angelegten Ordner agoscript-Schulung ein.
  2. Klicken Sie die Datei Lektion 6.ac.xml mit der rechten Maustaste an, um das Kontextmenü zu öffnen.
  3. Wählen Sie im Kontextmenü agorum core template manager > XML-Parser ausführen (agoscript).
  4. Führen Sie das Skript durch Klicken auf OK aus. 

    Ergebnis: Das Skript erstellt einen neuen Ordner Demo innerhalb des Basisordners agoscript-Schulung mit einer vorgegebenen Unterordner-Struktur.


Struktur nach dem Ausführen des Skripts

agoscript-Schulung/
 A Ordner/
 …
 B Ordner
 …
 C Ordner
 …
 Demo/
  Entwicklung
    …
 …

Lektion 7: Ein Dokument (FileObject) mit Textinhalt erstellen

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

Mit diesem Skript erstellen Sie ein FileObject. Textdokumente (Format .txt) können Sie direkt mit Inhalt füllen.

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

  1. Fügen Sie die Datei Lektion 7.ac.xml in den angelegten Ordner agoscript-Schulung ein.
  2. Klicken Sie die Datei Lektion 7.ac.xml mit der rechten Maustaste an, um das Kontextmenü zu öffnen.
  3. Wählen Sie im Kontextmenü agorum core template manager > XML-Parser ausführen (agoscript).
  4. Führen Sie das Skript durch Klicken auf OK aus. 

    Ergebnis: Das Skript erstellt eine neue Textdatei mit dem im Content-Element angegebenen Text im Ordner A.

Lektion 8: Ein Dokument (FileObject) mit Base64-Inhalt erstellen

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

Mit diesem Skript erstellen Sie zwei Dokumente mit den Namen Einstieg zu agorum core.docx und Willkommen.pdf. Da es sich um binäre Dateien handelt, müssen Sie den Inhalt in Base64 umwandeln und können ihn dann als Dokumentinhalt angeben.

Nachdem Sie das Skript ausgeführt haben, liegen die neuen Dokumente im Ordner Demo.

  1. Fügen Sie die Datei Lektion 8.ac.xml in den angelegten Ordner agoscript-Schulung ein.
  2. Klicken Sie die Datei Lektion 8.ac.xml mit der rechten Maustaste an, um das Kontextmenü zu öffnen.
  3. Wählen Sie im Kontextmenü agorum core template manager > XML-Parser ausführen (agoscript).
  4. Führen Sie das Skript durch Klicken auf OK aus. 

    Ergebnis: Das Skript erstellt zwei neue Dokumente im Ordner agoscript-Schulung/Demo.

Lektion 9: Benutzergruppen (DirectoryGroupObject) erstellen

XML-Datei zur Lektion: 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.

  1. Fügen Sie die Datei Lektion 9.ac.xml in den angelegten Ordner agoscript-Schulung ein.
  2. Klicken Sie die Datei Lektion 9.ac.xml mit der rechten Maustaste an, um das Kontextmenü zu öffnen.
  3. Wählen Sie im Kontextmenü agorum core template manager > XML-Parser ausführen (agoscript).
  4. Führen Sie das Skript durch Klicken auf OK aus. 

    Ergebnis: Das Skript erstellt einen Ordner für die Benutzergruppen und die angegebenen Benutzergruppen.

Das Skript legt Folgendes an:

Angelegtes Objekt Beschreibung
Ordner „agoscript-Schulung“ in der Gruppen-Verwaltung
Gruppe „GRP_agoscript-Schulung_Partner_A_ALL“ Benutzergruppe mit Vollzugriff
Gruppe „GRP_agoscript-Schulung_Partner_A_READ“ Benutzergruppe mit Lese-Zugriff
Gruppe „GRP_agoscript-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_agoscript-Schulung_Partner_A_AlleBenutzer“ Zusammenfassung der ersten beiden Benutzergruppen
Gruppe „GRP_agoscript-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.