Einführung in agorum core agoscript

Sie können mit einer XML-Datei das System managen. Eine Aufgabe der XML-Sprache ist es, Objekte zu manipulieren, etwa durch: 

• anlegen
• ändern
• löschen

Sie können XML-Skript-Dateien so vorbereiten und hochladen, dass sie eine Reihe an vordefinierten Schritten abarbeiten, etwa die Anlage einer Kunden- oder Personalakte. 

Mithilfe von agoscript können Sie Vorlagen für alle möglichen Anwendungsfälle / Automatisierungen erzeugen:

• Komplexe Ordnerstrukturen anlegen
• Komplettes Berechtigungssystem anlegen
• Elektronische Akten (etwa Kundenakten, Mitgliederakten, Projektakten) anlegen
• Projektzeitenvorlagen (etwa Vorlagen für die Erfassung von Projektzeiten)
• Rechtevergabe (etwa Berechtigen der elektronischen Akten)
• Adressobjekte anlegen (etwa Adressbüchern, Organisationen, Abteilungen und Personen)
• Benutzer anlegen / ändern (etwa für einen neuen Kunden oder Partner einen Zugang schaffen)
• Benutzergruppen anlegen / ändern (etwa für einen neuen Kunden oder Partner Benutzergruppen anlegen)
• ACL anlegen / ändern (etwa Rechtestempel anlegen für neue Kunden oder Partner und deren elektronischen Bereiche / Akten)
• Setzen von erweiterten Attributen und so weiter
• Menüerweiterungen (etwa erweiterte Funktionen im Kontextmenü im DMS-Laufwerk)
• Erweiterungen in der Schnellsuche

Ein XML-Skript ausführen

---

Sie legen XML-Skripte als Vorlage ab, erstellen sie dynamisch durch Fremdprogramme und führen sie auf verschiedene Weisen automatisiert in agorum core aus.

• Ausführen per desk4web
• Ausführen per Vorlage über desk4web (veraltet)
• Ausführen über FTP
• Ausführen per Dateiexplorer
• Bereitstellung durch ein anderes XML-Template
• Ausführung eines XML-Skripts per agorum core template manager

Ein XML-Skript per desk4web ausführen

1. Öffnen Sie links in der Seitenleiste Weitere Apps und dann desk4web.
2. Wählen Sie links im Menü Team Bereich.
3. Klicken Sie im mittleren Bereich auf Dateien.
4. Klicken Sie rechts auf Datei > Neu > Einzel Upload.
5. Geben Sie im Feld Name den Wert <Name>.xml ein.

   Hinweis: Die Endung .xml ist zwingend erforderlich.

6. Wählen Sie eine XML-Datei.
7. Setzen Sie den Haken bei XML-Dateien nach dem Hochladen parsen.

   Hinweis: Wenn Sie diesen Haken nicht setzen, lädt das System die Datei nur hoch, ohne dass es das XML-Skript ausführt.

8. Speichern Sie.
   
   Ergebnis: Das System führt das Skript aus und legt die gewünschten Objekte an.
   
   • Fehlermeldungen finden Sie in desk4web.
   • Sie müssen vor einem erneuten Ausführen des Skripts diese Fehler beheben.

Ein XML-Skript per Vorlage über desk4web ausführen (veraltet)

Sind XML-Templates vorhanden, können Benutzer diese mit den entsprechenden Zugriffsrechten über Datei > Neu > Nach Vorlage verwenden. Damit Benutzer diese Vorlagen verwenden können, müssen Sie diese über den Einzelupload und mit deaktivierter Einstellung XML-Dateien nach dem Hochladen parsen hochladen.

Legen Sie Vorlagen in diesem Ordner ab:

/Administration/Root Ordner/agorum/roi/ExeManTemplates

Sie können hier Parameter übergeben (max. 2 Werte in den Feldern Name und Description). Das XML-Template weist den beiden Parametern direkt nach der Eingabe die gewünschten Feldnamen zu, etwa Firma statt Name und Kundennummer statt Description.

Ein XML-Skript per FTP ausführen

1. Melden Sie sich mit dem Benutzer roi per FTP an.
2. Navigieren Sie zu dem Pfad:

   /agorum/roi/files

3. Kopieren Sie das XML-Skript in agorum core.

   Hinweis: Die Endung .xml ist zwingend erforderlich.

   Ergebnis: Das System führt das XML-Skript aus.

Bei FTP parst der XML-Parser von agorum core automatisch alles, was mit .xml endet. Sie können dann per FTP keine XML-Dateien in agorum core einspielen, ohne dass das System diese ebenfalls parst.

Tritt ein Fehler auf, legt das System eine Datei an, die den Namen der kopierten XML-Datei mit der Endung .parseError.txt enthält.

Ein XML-Skript per Dateiexplorer ausführen

1. Stellen Sie mit dem Benutzer roi eine Verbindung mit dem DMS-Laufwerk her:

   \\<agorum core IP>\dms
   

2. Kopieren Sie die XML-Datei ins Laufwerk.

   Hinweis: Die Datei muss mit .ac.xml enden.

   Ergebnis: Das System führt das XML-Skript aus.

Tritt ein Fehler auf, legt das System eine Datei an, die den Namen der kopierten XML-Datei mit der Endung .parseError.txt enthält.

Viele Systeme können Dateien samt XML-Template erstellen und in einem Netzwerklaufwerk ablegen. Damit ist eine reibungslose, automatische Übernahme etwa aus ERP- oder CRM-Systemen möglich.

Bereitstellung durch ein anderes XML-Template

Ein XML-Template kann ein eingebettetes XML-Template enthalten, das als Vorlage in den XML-Vorlagenordner gelegt wird und dort von den Benutzern als Vorlage aufgerufen werden kann.

Besonderheiten beim Ausführen eines XML-Skripts

Abhängig vom XML-Skript sind die Resultate nicht sofort wirksam. Wenn etwa das XML-Skript Menüfunktionen oder erweiterte Suchoptionen erzeugt, dann sind diese erst nach einem Neustart von agorum core verfügbar. Der Neustart kann allerdings (häufig) durch die Ausführung des KillCache-Skripts vermieden werden:

1. Öffnen Sie im Browser die Adresse:

   http://<IP-Adresse der agorum core Installation>/roiwebui/roiwebui_module/KillCache.jsp
   

   
   Beispiel
   http://10.0.0.12/roiwebui/roiwebui_module/KillCache.jsp
   
   Ergebnis: Das Skript endet mit der Meldung Cache killed. Anschließend sind die Menüfunktionen und Sucherweiterungen verwendbar.

Ein XML-Skript per agorum core template manager ausführen

1. Öffnen Sie links in der Seitenleiste Explorer.
2. Markieren Sie ein Skript mit der rechten Maustaste.
3. Wählen Sie im Kontextmenü agorum core template manager > XML-Parser ausführen (agoscript).

Aufbau eines XML-Skripts

---

Sie können das XML-Skript manuell (etwa im Texteditor) oder durch ein Programm erstellen. In der Regel können Sie ein XML-Skript in Teile zerlegen und der Aufgabe anpassen, etwa Anlegen einer Kundenakte, Anlegen einer Projektakte. Ein XML-Skript (Abarbeitung eines XML-Templates) wird als ein Prozess angesehen, der entsprechend lange dauern kann, etwa bei umfangreichen Aktenplänen. Wenn das Skript nicht per FTP ausgeführt (hochgeladen) wird, achten Sie auf eventuelle Time-outs.

Ein XML-Skript fängt immer folgendermaßen an:

<?xml version = "1.0" encoding="ISO-8859-1" ?>
<ObjectList>

Ein XML-Skript hört immer folgendermaßen auf:

</ObjectList>

Eingebettete und verlinkte Dokumente

XML-Templates werden oft auf Dokumente angewandt. Diese können in das XML-Template eingebettet sein oder auf die jeweiligen Dokumente verlinken:

Einbetten mit base64

<Content Encoding="base64">
 <![CDATA[DQoNCg0K...in der inneren Klammer steht base64...KRGllcBF]]>
</Content>

Verlinken zum Dokument

<Content RefType="TmpPath">
 <![CDATA[<Pfad zu den Dokumenten>/<MyDocument.pdf>]]>
</Content>

Beispiel: Objekt anlegen

Um ein bestimmtes Objekt anzulegen, fängt ein Objekt im XML-Skript immer mit dem Objektnamen an und hört damit auf:

<FolderObject>
..
..
</FolderObject>