Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core Module und Plugins > Dokument | PDF-Annotationen

Dokument | PDF-Annotationen konfigurieren

Hinweis: Diese Dokumentation bezieht sich auf die aktuellste Version des Plugins. Aktualisieren Sie das hier beschriebene Plugin, um die Dokumentation verwenden zu können.

Sie können das Verhalten des Plugins Dokument | PDF-Annotationen über diverse Konfigurationen steuern. Sie können etwa einstellen, für welche Dokumente der Reiter Ansicht die PDF-Ansicht des Plugins zeigt und für welche Dokumente das System die PDF-Ansicht vorab im Hintergrund erzeugt.

So finden Sie die Einstellungen zum Plugin:

  1. Öffnen Sie links in der Seitenleiste Administration und dann MetaDB.
  2. Öffnen Sie den Pfad: 
    MAIN_MODULE_MANAGEMENT/customers/agorum.pdf.annotate/settings

Im Ordner settings befindet sich eine Konfiguration namens [ sample ]. In dieser finden Sie weitere Konfigurationen als Beispiel:

Diese Beispiele sind noch deaktiviert, erkennbar an dem # vor der jeweiligen Konfiguration.

Hinweis: Die Konfiguration #description dient als Information, wie Sie mit den hier beschriebenen Beispielen arbeiten sollen, und muss nicht kopiert werden.

Eine eigene Konfiguration anlegen

Damit die Beispiele des Plugins Dokument | PDF-Annotationen in [ sample ] unberührt bleiben, erstellen Sie eine eigene Konfiguration:

  1. Klicken Sie im Ordner settings oben auf  .
  2. Vergeben Sie einen Namen, etwa [ Projektname ].
  3. Speichern Sie die Einstellung.

Beispiele kopieren

Kopieren Sie die Beispiele aus der Konfiguration [ sample ] in Ihre eigene Konfiguration:

  1. Öffnen Sie die Konfiguration [ sample ].
  2. Kopieren Sie die Einträge #details.selectors und #convert.query.
  3. Öffnen Sie Ihre soeben erstellte Property-Group.
  4. Fügen Sie die Einträge ein.
  5. Benennen Sie die Einträge in Ihrer Property-Group um, indem Sie das # entfernen.

Achtung: Ändern Sie die Werte in [ sample ] nicht. Das System überschreibt sie bei jedem Update des Plugins.

Nachfolgend erfahren Sie, was die einzelnen Konfigurationen bewirken und wie Sie diese anpassen.

details.selectors

Mit details.selectors legen Sie fest, für welche Dokumente der Reiter Ansicht im Detailfenster die PDF-Ansicht des Plugins Dokument | PDF-Annotationen zeigt. So schließen Sie bestimmte Dateiendungen von der PDF-Ansicht im Reiter Ansicht aus.

Ohne eigene Konfiguration gilt dieser Wert:

[convertible(pdf)][nameExtension!=/html|htm|txt/i]

Damit zeigt der Reiter Ansicht die PDF-Ansicht für alle Dokumente, die agorum core in eine PDF-Datei umwandeln kann, außer für Dateien mit den Endungen .html, .htm und .txt.

Das Beispiel in [ sample ] enthält diese Werte:

Wert Beschreibung
[convertible(pdf)] Definiert, für welche Dokumente der Reiter Ansicht die PDF-Ansicht des Plugins zeigt.

Wenn keine nameExtension angegeben ist, gilt das für alle Dokumente, die in agorum core in eine PDF-Datei wandelbar sind.
[!isFolder] Definiert, dass der Reiter Ansicht für Ordner keine PDF-Ansicht zeigt.

Hinweis: Setzen Sie details.selectors, ersetzt Ihr Wert den Standard vollständig. Sollen Dateien mit den Endungen .html, .htm und .txt weiterhin ausgenommen bleiben, nehmen Sie [nameExtension!=/html|htm|txt/i] in Ihren Wert auf.

details.selectors gilt nur für den Reiter Ansicht. Der Eintrag PDF-Ansicht mit Kommentarfunktion im Kontextmenü hat einen eigenen, festen Selektor ([convertible(pdf)]) und bleibt auch für ausgeschlossene Dateiendungen sichtbar.

Soll der Reiter Ansicht die PDF-Ansicht etwa nur für rtf-Dokumente oder PDF-Dateien zeigen, setzen Sie zusätzlich folgenden Wert:

[nameExtension=/rtf|pdf/i]

Kompletter Wert:

[nameExtension=/rtf|pdf/i][convertible(pdf)][!isFolder]

Wenn Sie durch diese Konfiguration bestimmte Dateiendungen ausschließen, zeigt der Reiter Ansicht für diese Dokumente nicht die PDF-Ansicht des Plugins. Die Leiste mit den Schaltflächen zum Kommentieren / Bearbeiten und zum Anzeigen des Originals fehlt dann:

Reiter Ansicht ohne Leiste des Plugins bei ausgeschlossener Dateiendung
Fehlende Schaltflächen bei ausgeschlossenen Dateiendungen (hier: docx)

Fügen Sie hingegen die Dateiendung (hier: docx) in die Konfiguration ein, zeigt der Reiter Ansicht wieder die PDF-Ansicht mit den Schaltflächen:

[nameExtension=/docx|pdf|rtf/i][convertible(pdf)][!isFolder]
Reiter Ansicht mit Leiste des Plugins bei erlaubter Dateiendung
Eingeblendete Schaltflächen bei erlaubten Dateiendungen (hier: docx)

Für weitere Informationen zu den Selektoren siehe Selektoren.

convert.query

Mit convert.query legen Sie fest, für welche Dokumente das System die PDF-Ansicht des Plugins Dokument | PDF-Annotationen vorab im Hintergrund erzeugt.

Lädt ein Benutzer ein Dokument in einen Ordner und wird dann das Dokument angeklickt, dauert es je nach Dateigröße eine Weile, bis die PDF-Ansicht dargestellt wird. Diesen Vorgang können Sie beschleunigen, sodass das System die Dokumente bereits vorher intern konvertiert und die PDF-Ansicht schneller erzeugt.

Im Auslieferungszustand ist keine Vorab-Konvertierung eingerichtet. Ohne convert.query erzeugt das System die PDF-Ansicht erst, wenn ein Benutzer das Dokument zum ersten Mal öffnet.

Das Beispiel in [ sample ] enthält diese Werte:

Wert Beschreibung
inpath:${ID:/agorum/roi/Files} Berücksichtigt alle Dokumente unter diesem Pfad für die Konvertierung, die im Wert nameextension genannt sind. Der Platzhalter ${ID:...} steht für die ID des angegebenen Ordners.
nameextension:(docx OR doc OR xls OR xlsx OR pdf) Definiert, welche Dokumente für die Konvertierung berücksichtigt werden.
createdate_date_range:[2021-03-09 TO *] Definiert, welches Erstelldatum die Dokumente haben müssen, um für die Konvertierung berücksichtigt zu werden.

Tipp: Kopieren Sie den kompletten Wert Ihrer Konfiguration convert.query und fügen Sie ihn in die Suche ein, um zu erkennen, welche Dokumente von dem Suchmuster / von der Konvertierung berücksichtigt werden. Die Suche zeigt dabei auch Dokumente, die bereits konvertiert wurden. Um nur die noch offenen Dokumente zu sehen, ergänzen Sie den Wert um: NOT allfields:agorum_pdf_annotate_create_date NOT agorum_pdf_annotate_conversion_failed:true

Ablauf der Vorab-Konvertierung

Ist convert.query eingerichtet, führt das System die Vorab-Konvertierung des Plugins Dokument | PDF-Annotationen jede Minute aus. Es ergänzt die eingetragene Abfrage dabei selbst, sodass bereits konvertierte Dokumente und Dokumente, deren Konvertierung fehlgeschlagen ist, übersprungen werden. Das System arbeitet die Treffer in Blöcken zu 100 Dokumenten ab.

Hinweis: Liefert die Abfrage sehr viele Dokumente, erzeugt die Konvertierung entsprechend Last auf dem System. Sie können eine laufende Konvertierung in den Hintergrundaktivitäten abbrechen.

Konvertierte Dokumente mithilfe der Hintergrundaktivitäten prüfen

Sie können mit der Funktion Zeige Hintergrundaktivitäten (siehe Hintergrundaktivitäten manuell öffnen) überprüfen, welche Dokumente die Vorab-Konvertierung des Plugins Dokument | PDF-Annotationen bereits für die PDF-Ansicht konvertiert hat.

Die Hintergrundaktivität heißt pdf annotate: convert (<Datum>). Ihr Status zeigt, wie viele Dokumente noch in der Warteschlange stehen und wie viele gerade konvertiert werden (queue: ..., converting: ...).

Hintergrundaktivitäten prüfen
Hintergrundaktivitäten prüfen

Die hochgeladenen Dokumente werden dabei in einer Queue nacheinander abgearbeitet.

Konvertierte Dokumente für die PDF-Ansicht in den Hintergrundaktivitäten
Konvertierte Dokumente für die PDF-Ansicht

Generierte Metadaten nach Konvertierung

Nach dem Abschluss der Konvertierung für die PDF-Ansicht des Plugins Dokument | PDF-Annotationen setzt das System Metadaten auf das jeweilige Originaldokument. Sie können nach diesen Metadaten suchen, um sich alle Dokumente anzeigen zu lassen, die dieses Metadatum gesetzt haben.

Metadatum Beschreibung Anzeige in Oberfläche
agorum_pdf_annotate_create_date Definiert, dass das Dokument erfolgreich für die PDF-Ansicht konvertiert wurde. Das System setzt das Datum bei jeder Neuerzeugung der PDF-Ansicht neu, etwa nachdem sich der Inhalt des Originaldokuments geändert hat. PDF Ansicht Erstelldatum
agorum_pdf_annotate_conversion_failed Definiert, dass das Dokument für die PDF-Ansicht nicht konvertiert werden konnte und auf Fehler gelaufen ist. Konvertierung fehlgeschlagen

Sie finden die gesetzten Metadaten auch in der Registerkarte Objekt-Info des jeweiligen Dokuments mit einer anderen Benennung (siehe Tabelle, Spalte Anzeige in Oberfläche):

Metadatum PDF Ansicht Erstelldatum in der Objekt-Info
Gesetztes Metadatum PDF Ansicht Erstelldatum nach Konvertierung

Auf Fehler gelaufene Dokumente finden

Mit folgender Suche können Sie alle Dokumente finden, deren Konvertierung für die PDF-Ansicht auf einen Fehler gelaufen ist. Kopieren Sie die folgende Zeile und fügen Sie sie in die Suche ein:

agorum_pdf_annotate_conversion_failed:true

Die Vorab-Konvertierung versucht diese Dokumente nicht erneut. Ein neuer Versuch erfolgt, wenn ein Benutzer das Dokument im Reiter Ansicht öffnet. Gelingt die Konvertierung dann, entfernt das System das Metadatum agorum_pdf_annotate_conversion_failed wieder.