Durchsuchbare Dokumentation aufrufen

Zurück zur Dokumentationsübersicht

Übungen zu XML-Templates

Mit XML-Templates (oder XML-Skripten) können Sie wiederholende Vorgänge oder umfangreiche Strukturen schnell und sicher erstellen. Sie stellen damit sicher, dass das System alle notwendigen Schritte (Struktur, Rechte und so weiter) durchführt – auch von Benutzern, die Objekte nur gelegentlich erstellen. Sie rufen lediglich ein vorgegebenes XML-Template auf.

Mehr Informationen zu XML-Templates finden Sie in den Schulungsunterlagen der Schulung zu agoscript. Dort wird auch das Ausführen des XML-Skripts beschrieben.

Kundenakte mit Projektzeiten, Firma und Kundennummer erstellen

Das XML-Template installieren

  1. Laden Sie das XML-Template KundenakteMitProjektzeiten_Name=Firma_Beschreibung=Kundennummer.xml per Einzelupload in desk4web hoch.

    Hinweis: Führen Sie kein Parsing beim Hochladen durch.

  2. Wählen Sie als Ablageverzeichnis: 
    Administration / Root Ordner / agorum / roi / ExeManTemplates

    Sie können den Zugriff per ACL so einstellen, dass nur bestimmte Benutzer die Vorlage sehen können.

Templates verwenden

  1. Benutzer mit den entsprechenden Rechten können diese Vorlage über das Kontextmenü mit Datei > Neu > Nach Vorlage einsetzen.
  2. Wählen Sie die Vorlage und tragen Sie folgende Parameter ein:

    Name
    Firma

    Beschreibung
    Kundennummer

Die Vorlage testen

  1. Wechseln Sie in den Ordner, in dem Sie den Test durchführen möchten.
  2. Wählen Sie im Kontextmenü Datei > Neu > Nach Vorlage.
  3. Wählen Sie das XML-Template KundenakteMitProjektzeiten_Name=Firma_Beschreibung=Kundennummer.xml.
  4. Geben Sie in das Feld Name die Firma ein, etwa agorum Software GmbH.
  5. Geben Sie in das Feld Beschreibung die Kundennummer ein, etwa 2233.
  6. Speichern Sie.

    Ergebnis: Das System erstellt eine elektronische Akte samt Metadaten.

Basisstrukturen, Benutzern, Benutzergruppen und Berechtigungen erstellen

  1. Laden Sie das XML-Template per Einzelupload in desk4web hoch und parsen Sie dabei die Datei.

    Ergebnis: Das System erstellt ein weiteres XML-Template im Ordner /Administration/Root Ordner/agorum/roi/ExeManTemplates.

    Benutzer können es anschließend per Funktion Datei/Neu/Nach Vorlage aufrufen.

    Hinweis: Das XML-Template enthält 2 als base64 kodierte Word-Dokumente, die das System an eine vorgegebene Stelle in der neu erzeugten Ordnerstruktur ablegt und verlinkt. Dies könnten etwa AGB oder ähnliche Standarddokumente sein. Anstelle der Einbettung mit base64 können Sie die Dokumente separat lagern und bei Aufruf des XML-Templates einbinden.

So erstellen Sie Basisstrukturen, Benutzern, Benutzergruppen und Berechtigungen:

  1. Melden Sie sich mit dem Super-Administrator roi in agorum core an.
  2. Wechseln Sie in das gewünschte Zielverzeichnis, etwa: 
    Teambereich / Dateien / ... / <Zielverzeichnis>
  3. Laden Sie in desk4web das XML-Template DemoFirmaGruppenUserACLStruktur.ac.xml per Einzelupload hoch und aktivieren Sie dabei die Option XML-Dateien nach dem Hochladen parsen.
  4. Speichern Sie.

    Ergebnis: Das System erstellt alle Bereiche.

    • Im Bereich Dateien existiert jetzt die DemoFirma mit Unterstrukturen.
    • Im Bereich User existiert jetzt DemoFirma mit den Benutzern der DemoFirma.
    • Im Bereich Gruppen existiert jetzt DemoFirma mit den Benutzergruppen der DemoFirma.
    • Im Bereich ACL existiert jetzt DemoFirma mit den ACLs der DemoFirma.
    • Im Bereich Vorlagen > /Administration/Root Ordner/agorum/roi/ExeManTemplates existiert jetzt DemoFirma mit dem Ordner ProjektTemplates und der Vorlage Projekt XY.xml.

Diese Vorlage können Sie jetzt im Projektbereich der DemoFirma aufrufen.

  1. Rufen Sie die Vorlage auf.
  2. Geben Sie im Feld Name die Firma ein, etwa agorum Software GmbH.
  3. Speichern Sie.

    Ergebnis: Das System erstellt eine Akte.

Metadaten erstellen

Beispieldatei eadFormate.xml

  1. Melden Sie sich als Super-Administrator roi in agorum core an.
  2. Wechseln Sie in den gewünschten Zielordner, etwa: 
    Teambereich / Dateien / ... / <Zielordner>
  3. Laden Sie in desk4web das XML-Template DemoFirmaGruppenUserACLStruktur.ac.xml per Einzelupload hoch und aktivieren Sie dabei die Option XML-Dateien nach dem Hochladen parsen.
  4. Speichern Sie.
  5. Öffnen Sie in agorum core den Metadaten Designer.

    Ergebnis: In der Liste des Metadaten Designers erscheint jetzt ein Eintrag namens eadFormate.

Metadaten hinzufügen (ExtendedAttributes)

Wenn Sie ein Metadatum vergessen haben oder nachträglich auf eine Datei setzen möchten, das bereits Metadaten (ExtendedAttributes) besitzt, verwenden Sie die Funktion UpdateExtendedAttributes. Die vorhandenen Metadaten bleiben unberührt.

Das folgende Beispiel fügt dem Dokument (fileobject) Testdokument.pdf das ExtendedAttribute NochEinMetadatenfeld mit dem Wert Test hinzu:

<?xml version = "1.0" encoding="ISO-8859-1"?>
<ObjectList>
 <FileObject>
   <Update>Testdokument.pdf</Update>
   <UpdateExtendedAttributes><![CDATA[
     <NochEinMetadatenfeld DataType="STRING">Test</NochEinMetadatenfeld>
 ]]></UpdateExtendedAttributes>
 </FileObject>
</ObjectList>

Beispiel für die Formatierung von Metadaten per DMS-Laufwerk

Beispieldateien:

  1. Verbinden Sie das DMS-Laufwerk.

    Hinweis: Der Benutzer muss berechtigt sein, ac.xml auszuführen (Administrator, etwa roi).

  2. Kopieren Sie die Datei FormatbeispieleExtendedAttribute.txt in ein beliebiges Verzeichnis.
  3. Kopieren Sie die Datei FormatbeispieleExtendedAttribute.txt.ac.xml in dasselbe Verzeichnis.

    Ergebnis: An der Datei FormatbeispieleExtendedAttribute.txt sind jetzt Metadaten angehängt, zu sehen etwa über desk4web oder über die Objekt-Info.

Beispiel für eine Rechnung

Die folgenden Daten (Dokument + Metadaten) könnten aus einem ERP-System stammen, das Dokumente samt Metadaten an agorum core übergibt (eventuell inklusive Revisionssicherheit durch Workflow).

Das kann auf gleiche Art und Weise ausgeführt werden. Zuerst die Musterrechnung_2008.pdf, dann die Musterrechnung_2008.pdf.ac.xml-Datei.

Suche nach Metadaten

XML-Template: QuickSearchController.xml

Dieses XML-Template erweitert die Auswahlliste (links neben dem Suchfeld) der Schnellsuche um einen weiteren Eintrag. Mit diesem Eintrag können Sie die Suche auf bestimmte Objekte einschränken. In diesem Fall erstellt das System alle Erweiterungen auf einmal (in einer Datei).

Das Objekt definieren Sie pro Modul in der Datei QuickSearchController.xml.

Pfad
< Installations-Pfad von agorum core > /jboss/server/default/deploy/roi.ear/roiwebui.war/WEB-INF/config/< Modul_name >/

Datei
QuickSearchController.xml

So erstellen Sie einen Eintrag:

  1. Erstellen Sie einen neuen Modul-Ordner im Verzeichnis: 
    < Installations-Pfad von agorum core > /jboss/server/default/deploy/roi.ear/roiwebui.war/WEB-INF/config

    Aufbau
    < MeineFirma >_modul

    Beispiel für agorum core
    agorum_modul
  2. Legen Sie in diesem Verzeichnis eine Datei mit dem Namen QuickSearchController.xml, in dem die erweiterten Definitionen für den QuickSearch definiert sind.

    Sie stellen damit sicher, dass ein Update Ihre QuickSearch-Definition nicht überschreibt, weil der entsprechende Modul-Ordner im Standard nicht existiert.
  3. Starten Sie agorum core neu, damit sich Ihre Ergänzung für den QuickSearch aktiviert.

    Ein Beispiel für Linux finden Sie unter vi /opt/agorum/agorumcore/jboss/server/default/deploy/roi.ear/roiwebui.war/WEB-INF/config/agorum_module/QuickSearchController.xml.