Elemente im agorum core smart assistant konfigurator anlegen

Der Bearbeitungsbereich

---

Im Bearbeitungsbereich bearbeiten Sie das aktuell im Elemente-Baum gewählte Element. Die Möglichkeiten der Bearbeitung hängen vom Element ab.

Ein Element anlegen

---

1. Markieren Sie im Elemente-Baum den jeweiligen Ordner.
   
   Ergebnis: Neben dem Menü Datei sowie im grauen Bereich in der Mitte erscheint je nach Kontext eine Schaltfläche, um das neue Element anzulegen. Da das Vorgehen bei jedem Element gleich ist, beschreibt diese Dokumentation nur Abweichungen detailliert.
    
   

   Neues Element anlegen
   
   
   Elemente:
   
   • Einsprungspunkt
   • Anlage
   • Ablage
   • Liste
   • Suche
   • Aktionen
2. Klicken Sie auf die jeweilige Schaltfläche.
3. Füllen Sie das Feld Name mit einem Namen.
   
   • Das Feld Name (intern) füllt sich ebenfalls.
   • Lassen Sie die restlichen Felder leer.
   
    
   

   Feld Name befüllen
4. Klicken Sie auf OK.
   
   Ergebnis: Der Dialog zum Bearbeiten des jeweiligen Elements öffnet sich.

Einsprungspunkt

---

Im Element Einsprungspunkt legen Sie die Ordner fest, die im agorum core explorer erscheinen. Sie können maximal 2 Fenster für die Einsprungspunkte anlegen.

1. Name
   Namen des Elements. Dieser Name erscheint auch beim Benutzer.
   
   Sie können ebenfalls einen Übersetzungskey eintragen, der in den entsprechenden Übersetzungsdateien eingetragen ist. Tragen Sie etwa agorum.demotranslate.InvoiceNumber ein, muss in der Übersetzungsdatei ein Eintrag mit der Übersetzung vorhanden sein. Für Deutsch lautet der Eintrag agorum.demotranslate.InvoiceNumber=Rechnungsnummer, für Englisch agorum.demotranslate.InvoiceNumber=Invoicenumber.
   
   Name (intern)
   Name, auf den sich Referenzen beziehen.
   
   ACL
   (optional) Steuert die Sichtbarkeit des Elements.
   
   • Hat ein Benutzer mindestens ein Leserecht für die eingetragene ACL, erscheint bei ihm das Element.
   • Hat er kein Recht auf die ACL, erscheint das Element nicht.
   • Ist das Feld leer, findet keine Prüfung auf eine ACL statt, und das Element ist immer wirksam und sichtbar.

   Tipp: Auch für Administratoren können Sie Elemente komplett ausblenden. Dazu tragen Sie einen ACL-Namen ein, der nicht existiert. Dies schließt den Super-Administrator roi und jeden daran gebundenen Automatismus mit ein.

   • Rufen Sie etwa eine Anlage per JavaScript auf, funktioniert der Service nicht mehr, da durch das gesetzte Dummy-ACL der Super-Administrator roi die Aktion / Anlage im agorum core smart assistant konfigurator nicht mehr einsehen und somit verwenden darf.
   • Fügen Sie statt einer Dummy-ACL eine leere, existierende ACL ein.

2. Ordner
   Ordner, die im agorum core explorer erscheinen. 
   
   • Die Eingabe eines Ordners können Sie direkt per Eingabe in das Eingabefeld machen (wird sichtbar bei Klick in die Liste), oder Sie wählen rechts von der Liste die Lupe aus und navigieren im Explorer zum gewünschten Ordner.
   • Sobald Sie den Ordner markiert haben, klicken Sie auf Öffnen. Das System übernimmt den Ordner.
3. Hauptansicht und Ansichtstyp
   Definiert, ob es sich bei dem Einsprungspunkt um die Hauptansicht handelt.
   
   • Das System weist automatisch der Ansichtstyp Vollansicht zu.
   • Handelt es sich um keine Hauptansicht, können Sie zwischen den zwei anderen Ansichtstypen wählen
   
   Vollansicht (bereits abgelegt)
   • Fenster mit einem Baum und einem Listenelement
   
   Sammelbereich (nicht abgelegt)
   • Ähnelt der Hauptansicht. Daten, die Benutzer per Drag-and-drop ablegen, rufen keine Ablage-Skripte auf.
   
   Sammelbereich – zeige nur Dateien (flach)
   • Das ist ein typischer Posteingang. Sie sehen nur die Dateien der ausgewählten Ordner.
   • Empfohlen als zweites Fenster

Anlage

---

Im Element Anlage definieren Sie Anlage-Skripte, die als Templates aufrufbar sind. Die Anlagen können Strukturen anlegen, etwa eine Lieferantenakte mit allen benötigten Unterordnern. Durch Skripte können Sie den vollen Umfang der JavaScript-API verwenden und durch filingassistant/service.js eine Anlage von beliebiger Stelle aus aufrufen.

Sie können beliebig viele Anlagen definieren.

1. Name, Name intern und ACL
   siehe Element Einsprungspunkt
2. Platzhalter
   Metadaten, die das System in der Bedienoberfläche für die Eingabe anzeigt, aber nicht auf die angelegte Akte setzt.
   
   Folgendes können Sie eingeben:
   
    
   

   Eingabe eines Platzhalters
   
   
   • Platzhalter (Metadatum)
   Definiert ein Metadatum. Sie müssen dieses zuvor über den Metadatendesigner oder über eine metadata.yml (empfohlen) angelegt haben.
   
   • Vererbt / Nutzereingabe
   Bei Vererbt verwendet das System den Inhalt des Metadatums aus dem übergeordneten Ordner. Dementsprechend muss das Metadatum auf dem Ordner gesetzt sein, in dem ein Benutzer die Anlage ausführt.
   
   Bei Nutzereingabe fragt das System das Metadatum in der Bedienoberfläche ab. Der Benutzer muss eine Eingabe tätigen.
   
   • Angezeigter Name
   Name, den der Benutzer für das Metadatum in der Bedienoberfläche sieht. Sie können einen Namen oder einen Übersetzungsschlüssel eingeben.
3. Metadaten
   Zeigt alle Metadaten der darunter liegenden Ordnerstruktur an.
   
   • Für diese können Sie die Standardwerte für Eingabe und Anzeige ändern. 
   • Ein Metadatum können Sie auf optional setzen (siehe Abbildung Metadatum optional setzen).
   • Mit einem Klick auf den Stift können Sie die Default-Einstellungen ändern und ein Metadatum eintragen (siehe Abbildung Einstellungen überschreiben).
   
    
   

   Metadatum optional setzen
   
   
    
   

   Einstellungen überschreiben
4. Selektor
   Definiert beliebig viele Selektoren.
   
    
   

   Selektoren eintragen
   
   
   • Wenn Sie mehrere Selektoren in verschiedenen Zeilen definieren, wertet das System diese mit ODER, in derselben Zeile mit UND. 
   • Durch die Definition eines Selektors können Sie Anlagen kontextabhängig einblenden.
   • Geben Sie im Feld Name den Namen des Selektors ein. Ist dieser Name in der Konfiguration bereits vorhanden, schlägt Ihnen das System diesen vor und Sie können ihn aus der Liste auswählen. Alle Selektoren, die Sie in einer Konfiguration eingeben, können Sie an beliebigen Elementen wiederverwenden.
   • Tragen Sie in der Spalte Selektor den Selektor ein.

   Tipp: Durch Eingabe eines [ sehen Sie die Vorlagen für Selektoren. Über Klick auf die Lupe können Sie Objekte auswählen, um deren Metadaten als Selektoren einzurichten.

5. Zielordner und Admin
   Definiert einen Zielordner.
   
    
   

   Zielordner und Admin wählen
   
   
   • Ist das Feld leer, verwendet das System den Ordner, der beim Ausführen des Befehls aktiv ist.
   • Den Zielordner können Sie entweder als Pfad händisch eingeben oder über die Lupe auswählen.
   • Bei Klick auf die Lupe öffnet sich ein Explorer, in dem Sie zu dem gewünschten Ordner navigieren können.
   
   Wenn Sie die Einstellung Mit Admin-Rechten ausführen aktivieren, führt das System die Aktion mit diesen Admin-Rechten aus. Anschließend müssen Sie die ganzen Objekte nochmals mit dem sessionControllerAdmin (sca) laden, sodass die Objekte auch für den Administrator geladen sind.
   
   Beispiel für das Laden der Objekte als Administrator in einem Skript:

   ..
   let objects = require('common/objects')(sca);
   
   let f= objects.find(folder.ID); // Nochmals mit dem Administrator laden

6. JavaScript
   Das JavaScript ist ebenfalls abhängig vom jeweiligen Element (siehe agorum core smart assistant konfigurator - JavaScript Infos).

Eine Ordnerstruktur unterhalb der Anlage erstellen

So konfigurieren Sie eine Struktur der angelegten Ordner:

1. Legen Sie ein Element an.
2. Klappen Sie die Baumstruktur unterhalb des Elements auf.
   
   Ergebnis:
   
   • Der Text Struktur und zeigt an, dass Sie noch keine Struktur definiert haben.
   • Die Schaltfläche Ordner erscheint rechts oben.
   
    
   

   Ordnerstruktur
3. Klicken Sie auf Ordner.
4. Tragen Sie im Feld Name einen Namen ein. Lassen Sie das Feld ACL leer.
5. Klicken Sie auf OK.
   
   Ergebnis:
   
   • Der Dialog zum Bearbeiten öffnet sich.
   • Das System setzt die Metadaten area (vererbt) und identifier (nicht vererbt) automatisch (siehe Abbildung Metadaten area und identifier), zunächst mit dem Wert des eingegebenen Namens der Anlage.
   • Führen Sie keine Änderungen an diesen Metadaten durch, da diese beiden Metadaten eine gezielte Kontextsteuerung durch Selektoren ermöglichen.
   
    
   

   Metadaten area und identifier
6. Setzen Sie für Name und in der Eingabespalte Fester Wert Platzhalter, die das System später anhand der eingegebenen Metadaten füllt (siehe JavaScript-Bibliothek common-templates).
   
   Für die Spalte Fester Wert gilt:
   
   • Keine Eingabe
   Metadatum wird bei Anlage abgefragt.
   
   •  Eingabe
   Automatisches Setzen auf den Ordner, entweder vererbte, nicht vererbt oder als Attribut für das Objekt.
7. Setzen den Haken Sprungziel, springt der agorum core explorer nach der Anlage genau in diesen neuen Ordner.
   
   Das Sprungziel hat keinen Einfluss auf eine Anlage per JavaScript.

Beispiel eines neuen Ordners

• Im Feld Name ist ein Platzhalter angegeben, das Metadatum acmf_projektName hat keinen festen Wert, wodurch das System es bei der Anlage abfragt.
• Das Metadatum acl ist ein Attribut. Dieses setzt das System auf den Ordner bei der Anlage. Ohne es würde die ACL des übergeordneten Ordners vererbt.
• Anhand des Namens des Objektes holt das System die ACL, zudem nimmt es den Namen des Projekts auf.

Beispiel einer fertigen Ordnerstruktur unter der Projektakte

Diese Struktur erscheint, sobald Sie auf die Schaltfläche Projektakte klicken:

Die Ordnerstruktur testen

Um sicherzugehen, dass die erstellte Ordnerstruktur sinnvoll gestaltet ist und einwandfrei funktioniert, testen Sie sie.

1. Markieren Sie die Anlage oder das Element in der Baumstruktur.
2. Klicken Sie oben rechts auf Struktur testen.
   
   Ergebnis: Ein Explorer öffnet sich, in dem Sie einen Ordner wählen. Legen Sie in diesem Ordner die Struktur testweise an.

Ablage

---

Definiert Ablage-Skripte, die Bedienoberflächen öffnen können. Diese fragen optional weitere Daten ab, etwa in einer Liste hinterlegte Metadaten. Fragt das System Metadaten ab, speichert es diese automatisch auf die in den agorum core explorer per Drag-and-drop abgelegten Dokumente.

1. Name, Name intern und ACL
   siehe Element Einsprungspunkt
2. Metadaten
   siehe Element Anlage
3. Selektor
   siehe Element Anlage
4. Zielordner und Admin
   siehe Element Anlage
5. JavaScript
   siehe Element Anlage

Liste

---

Definiert Listen mit Metadaten. Diese erscheinen je nach ausgewähltem Selektor etwa im agorum core explorer oder in der Suche:

Die folgende Abbildung zeigt die Konfiguration der Spalten im Explorer-Detail-Fenster:

1. Name, Name intern und ACL
   siehe Element Einsprungspunkt
2. Metadaten
   siehe Element Anlage
3. Selektor
   siehe Element Anlage

Suche

---

Aktionen

---

Definiert Aktions-Skripte, die Sie über das Kontextmenü der rechten Maustaste aufrufen.

• Die Aktion erscheint im Kontextmenü, wenn ein Selektor der Aktion beim momentan markierten Objekt greift.
• Sind mehrere Objekte markiert, muss der Selektor für alle markierten Objekte greifen.
• Sie können beliebig viele Aktionen definieren, die Sie in Benutzergruppen zusammenfassen können.

Aktionen können optional Eingabemasken zur Datenabfrage öffnen, die auf einer Metadatenliste basieren können.

1. Wählen Sie Aktionen.
2. Klicken Sie auf Neu > Server-Aktion oder Neu > Client-Aktion.
3. Befüllen Sie die Felder der Server-Aktion oder der Client-Aktion.

Server-Aktion bearbeiten

Client-Aktion bearbeiten

1. Name, Name intern, ACL und Befehlsgruppe
   siehe Element Einsprungspunkt für Name, Name intern und ACL
   
   Das Feld Befehlsgruppe hat zwei Optionen:
   
   • Keine
   Zeigt eine Aktion im Kontextmenü an und ist darüber von dem Benutzer ausführbar. Das System setzt es standardmäßig auf alle Aktionen als Standard.
   
   • Öffnen
   Kennzeichnet Aktionen, die entweder auf einen Doppelklick in einer Explorerliste oder auf einen Einfachklick auf einen Link des Objektnamens in einer Liste reagieren sollen.
   
   Im Standard sendet das System eine Doppelklick-Aktion an den agorum core client. Dieser öffnet das entsprechende Objekt mit dem verknüpften Client-Programm (.doc-Dateien etwa mit Microsoft Word). Sie können diesen Standard überschreiben, sodass sich etwa bei einer Datei mit der Endung .txt der interne agorum core-Editor öffnet.
   
   Beispiel zu den Dateiendungen eml oder msg siehe Outlook per Doppelklick auf E-Mail-Datei öffnen.
2. Selektor/Metadaten
   siehe Element Anlage
3. Symbol/Mehrfachauswahl
   Definiert ein Symbol aus einer Symbol-Liste.
   
   • Das Symbol erscheint im Kontextmenü dieser Aktion (nicht der Name).
   • Haken Sie Mehrfachauswahl an, können Sie die Aktion auf mehrere markierte Objekte anwenden, sofern diese dem Selektor entsprechen. Ist das nicht der Fall, erscheint die Aktion nicht im Kontextmenü.
4. Javascript
   siehe Element Anlage

   Hinweis: Wenn Sie in der Client-Aktion ein Skript mit einem require schreiben, erscheint bei der Ausführung der Fehler ReferenceError: require is not defined. Tritt dieser Fehler auf, benötigen Sie eine Server-Aktion, da require nur serverseitig vorhanden ist.

Maingruppe

---

Die Maingruppe erscheint als ein oder mehrere Symbole links neben dem Benutzerbild.

Sie definiert sich durch das Wort main in Name (intern) und kann Aktionen ohne einen Objektbezug zusammenfassen.

Beispiel

Die Maingruppe kann etwa wie hier in der agorum core basic archive-Konfiguration aussehen:

Hier sind zum einen Aktionen direkt definiert als auch eine Untergruppe mit der Bezeichnung agorum.home.asa.group.Administration, die weitere Aktionen zusammenfasst.

Eine Maingruppe anlegen

1. Legen Sie eine Gruppe mit dem Name (intern): main an.

   Tipp: Für eine bessere Übersicht setzen Sie die Information Main zusätzlich in den Namen dieses Ordners. Dieser erste Ordner erscheint nicht in der Kopfleiste, sondern dient als „Sammelpunkt“.

   

   Information Main im Namen des Ordners
2. Legen Sie unter diesem Ordner Ihre Aktionen oder weitere Untergruppen an, die Aktionen zusammenfassen.
3. Definieren Sie für Ihre Aktionen den Selektor Default, um sicherzustellen, dass diese Aktion erscheint.
   
    
   

   Beispiel-Selektor im Standard (ohne Selektor)

   Hinweise:
   
   • Wenn Sie keinen Selektor definieren, erscheint die Aktion nicht in der Kopfleiste.
   • Wenn der Ordner keine Aktionen enthält oder in den enthaltenen Aktionen der Default-Selektor nicht definiert ist, erscheint der Ordner nicht.

4. Speichern Sie und exportieren Sie die Maingruppe.
5. Laden Sie das Browserfenster neu, um Ihre Konfiguration testen und verwenden zu können.

Name	Selektor	Beschreibung
Default	–	Die Aktion erscheint bei jedem Benutzer. Sie können die Sichtbarkeit der Aktion durch eine ACL begrenzen.

 

 

Name	Selektor	Beschreibung
Admin	[sessionController.adminEnabled]	Die Aktion ist nur für einen Administrator sichtbar.