Beispiel zu agorum core active folder mit agorum core fileworkflow oder JavaScript

Szenario

---

Ein Unternehmen will Dokumente automatisch in ein Archiv ablegen. Geplant ist folgende Struktur:

• Archiv
  • <Jahr>
    • <Monat>

Der Hauptordner Archiv dient als Eingangsordner, in dem Benutzer Dokumente ablegen. Diese soll das System dann automatisch in eine dynamische Unterordnerstruktur in Jahr und Monat verschieben.

Umsetzung

---

Da Benutzer die Dokumente in den Ordner Archiv ablegen, definieren Sie diesen Ordner als agorum core active folder. Sobald ein Objekt in einem definierten Archiv-Ordner landet, aktiviert sich eine der folgenden Aktionen:

agorum core fileworkflow
Durch die grafische Bedienoberfläche und Schaltflächen können Sie Konfigurationen schnell und einfach erstellen.

JavaScript
Durch die in agorum core mitgelieferten Funktionen und die Möglichkeit, eigene zu erstellen, sind Sie bei einem JavaScript flexibler. Sie können hierbei alles Mögliche konfigurieren und Objekte automatisch verarbeiten.

agorum core active folder und agorum core fileworkflow

---

Den Ordner „Archiv“ erstellen

1. Öffnen Sie links in der Seitenleiste Explorer.
2. Klicken Sie mit der rechten Maustaste auf den Ordner Dateien.
3. Wählen Sie im Kontextmenü Neu > Ordner.
4. Vergeben Sie den Namen Archiv für den neuen Ordner.

Einen Aktiven Ordner erstellen

1. Öffnen Sie links in der Seitenleiste Weitere Apps und dann Aktive Ordner.
2. Klicken Sie rechts im Abschnitt Konfigurationen auf Neue Konfiguration > FileWorkflow.
   
   Ergebnis: Ein Eingabebereich auf der linken Seite öffnet sich.
3. Klicken Sie auf die Lupe und wählen Sie den erstellten Ordner Archiv.
4. Benennen Sie die Konfiguration so um, dass Sie diese auch auf lange Sicht anhand des Namens zuordnen können.
   
   Beispiel
   Aktiver Ordner - Fileworkflow - Archiv
5. Speichern Sie die Einstellungen.
   
   Ergebnis:
   
   • Sie haben den Ordner Archiv als Aktiven Ordner angelegt und mit der Option zum agorum core fileworkflow verknüpft.
   • Das System weiß jetzt, dass es den agorum core fileworkflow aktiviert, sobald ein Benutzer Dokument in diesen Ordner ablegt.

Einen FileWorkflow erstellen

1. Öffnen Sie links in der Seitenleiste Weitere Apps und dann fileworkflow Dokumentenregeln.
2. Klicken Sie rechts im Abschnitt Regeln auf Neu > Neue Bedingung.
3. Vergeben Sie einen sinnvollen Namen, indem Sie rechts auf Neue Bedingung doppelklicken.
   
   Beispiel
   Aktiver Ordner - FileWorkflow - Archiv - Ablage
4. Tragen Sie unter Pfad den Pfad zu Ihrem erstellten Ordner Archiv ein.
    
   

   Bedingung anlegen
5. Klicken Sie auf In Ordner ablegen.
   
   Ergebnis: Ein Eingabebereich öffnet sich.
6. Geben Sie als Wurzelordner den erstellten Ordner Archiv an.
7. Geben Sie diesen Pfad an:

   ${date:yyyy}/${date:MM}

    
   

   In Ordner ablegen
8. Speichern Sie die Einstellungen.
   
   Ergebnis: Ihre Konfigurationen sind abgeschlossen.

agorum core active folder und JavaScript

---

Den Ordner „Archiv“ erstellen

1. Öffnen Sie links in der Seitenleiste Explorer.
2. Klicken Sie mit der rechten Maustaste auf den Ordner Dateien.
3. Wählen Sie im Kontextmenü Neu > Ordner.
4. Vergeben Sie den Namen Archiv für den neuen Ordner.

Das JavaScript erstellen

1. Öffnen Sie links in der Seitenleiste Explorer.
2. Öffnen Sie den Ordner js in Ihrem Konfigurationsprojekt:

   Eigene Dateien‎/Administration‎/customers‎/<Konfigurationsprojekt>‎/js‎/

3. Erstellen Sie im Ordner js ein neues JavaScript über die rechte Maustaste > Neu > JS-Dokument.
4. Befüllen Sie das JavaScript mit diesem Inhalt:

   /* global folder, parameters */
   
   let objects = require('common/objects');
   let transaction = require('common/transaction');
   let templates = require('common/templates');
   
   /**
   // Test
   let folder = objects.find('/agorum/roi/Files/Archiv');
   /**/
   
   // folder enthält den agorum core active folder
   // parameters enthält die Parameter, die übergeben werden
   folder.items().forEach(function(item) {
     if (item.isFolder === false){
       transaction(() => {
         let path = folder.createPath(templates.fill('archive/${datum:yyyy}/${datum:de|MMM}', {datum: item.createDate}));
         objects.unlink(item);
         objects.link(item, path);      
       });
     }
   });

5. Speichern Sie das Skript.

   Hinweis: Das Skript ruft interne Funktionen auf:
   
   • JavaScript-Bibliothek common-objects (find, unlink, link)
   • JavaScript-Bibliothek common-objects (find, unlink, link)
   • JavaScript-Bibliothek common-transaction
   • JavaScript-Bibliothek common-templates (fill)
   
   Der folder stellt den gewählten Ordner Archiv dar. Das System prüft, ob die übergebenen Dokumente (item) KEINE Ordner sind:

   folder.items().forEach(function(item) {...
   if (item.isFolder === false){...

   Ist diese Bedingung wahr, erstellt das System einen Pfad basierend auf den Metadaten des Dokuments:

   folder.createPath(templates.fill('archive/${datum:yyyy}/${datum:de|MMM}', {datum: item.createDate}));
   

   Das System entfernt das Dokument aus dem aktuellen Ordner:

   objects.unlink(item);

   Das System fügt den vorhin erstellten dynamischen Pfad in den Ordner ein:

   objects.link(item, path);

Einen Aktiven Ordner erstellen

1. Öffnen Sie links in der Seitenleiste Weitere Apps und dann Aktive Ordner.
2. Klicken Sie rechts im Bereich Konfigurationen auf Skript ausführen.
   
    
   

   Skript ausführen
3. Wählen Sie im Feld Ordner den Ordner Archiv.
4. Wählen Sie im Feld Skript das erstellte JavaScript.
5. Entfernen Sie den Haken bei Skript in Transaktion ausführen, da sich das Skript auf jedes Dokument nacheinander ausführen soll.

   Hinweis: In diesem Beispiel benötigen Sie keine Parameter, die das System an das JavaScript als Input übergibt. Der Parameter-Bereich bleibt leer.

6. Benennen Sie die Konfiguration um und speichern Sie.
   
   Ergebnis: Ihre Konfigurationen sind abgeschlossen.