Nutzungsprotokoll

primedocs führt pro Datasource ein Nutzungsprotokoll in der Datenbank. Es hält fest, welche Vorlagen verwendet und verwaltet werden, und ist die Grundlage der Vorlagenstatistik. Anders als die Server Logs und Client Logs ist es keine Datei, sondern ein Satz von Einträgen, die über die Statistik und die Admin API ausgewertet werden.

Inhalt eines Eintrags

Feld	Inhalt
Zeitpunkt	Zeitpunkt des Ereignisses in UTC
Aktion	Open (Dokument aus einer Vorlage erstellt oder über Connect aktualisiert), Create, Update oder Delete. Paket-Importe schreiben PackageImport.Create, PackageImport.Update und PackageImport.Deactivate
Objekt	Typ, ID und Name des betroffenen Objekts, zum Beispiel einer Vorlage
Sprache	Dokumentsprache, in der die Vorlage verwendet wurde
Organisationseinheit	ID und Name der Organisationseinheit, für die das Dokument erstellt wurde
Benutzer	ID und Name der handelnden Person. Nur wenn die Datenschutz-Einstellung es erlaubt, siehe unten
Nachricht, Änderungen	Bei Paket-Importen die Beschreibung der Änderung und die ChangesetId des Laufs

Aktion, Benutzername, Objektname und Organisationseinheit werden auf 200 Zeichen gekürzt, die Nachricht auf 500 Zeichen.

Dokumenterstellung

Jede Dokumenterstellung aus einer Vorlage schreibt einen Eintrag mit der Aktion Open, unabhängig vom Weg. Ausgenommen sind Vorschau-Generierungen. Auch das Aktualisieren eines bestehenden Dokuments über Connect schreibt Open, der Editor-Modus von primedocs Desktop schreibt Update.

Weg	Vorlagenname	Organisationseinheit
primedocs Desktop und Office COM-Add-Ins	Name in der Standard-Oberflächensprache, ohne Übersetzung ein Platzhalter. Bei Connect der erste vorhandene Name, nach Sprachcode (LCID) sortiert	Organisationseinheit des Standardprofils
primedocs Web, Office Web-Add-Ins, Connect API und übrige serverseitige Erstellung	Name in der Standard-Oberflächensprache, ohne Übersetzung der erste vorhandene Name, nach Sprachcode (LCID) sortiert	Organisationseinheit des Profils, mit dem das Dokument erstellt wurde

Bei der serverseitigen Erstellung geht eine übersteuerte Organisationseinheit der des Profils vor, wie bei den Profildaten im Dokument selbst. Wird nur eine Organisationseinheit ohne Profil übergeben (Legacy-Connect), gilt diese. Ohne Profil und ohne Organisationseinheit, oder wenn das Profil keiner Organisationseinheit zugeordnet ist, bleibt das Feld leer.

primedocs Desktop speichert die Einträge zuerst im lokalen Cache und überträgt sie bei der nächsten Synchronisation an den Server.

Einträge aus früheren Versionen

Vor Version 4.1 schrieb die serverseitige Erstellung weder Vorlagenname noch Organisationseinheit ins Protokoll. Diese älteren Einträge bleiben unverändert. In der Statistik fallen sie unter eine leere Organisationseinheit.

Datenschutz: PrivacyLogUserData

Die Einstellung PrivacyLogUserData legt fest, ob ein Eintrag den Benutzer enthält:

Wert	Wirkung
False (Standard)	Benutzername und Benutzer-ID werden nicht gespeichert. Der Eintrag entsteht trotzdem, mit Vorlage, Sprache und Organisationseinheit, damit die Vorlagenstatistik vollständig bleibt.
True	Benutzername und Benutzer-ID werden mitgespeichert.

Die Einstellung gilt für alle Wege der Dokumenterstellung, also auch für primedocs Web, die Office Web-Add-Ins und die Connect API. Die Schreibweise des Schlüssels spielt keine Rolle. Sie wirkt beim Schreiben eines Eintrags: Eine Änderung betrifft nur neue Einträge, bestehende bleiben, wie sie sind.

Gesetzt wird sie pro Datasource im Web-Admin unter Einstellungen › Sicherheit & Compliance, im Admin Dashboard im Bereich Settings oder über die Admin API (PUT .../Admin/Settings/Security, Eigenschaft privacyLogUserData, siehe Admin API).

Aufbewahrung

Ohne weitere Einstellung bleiben die Einträge unbegrenzt erhalten. Mit LogEntryRetentionDays lässt sich pro Datasource eine Aufbewahrungsdauer in Tagen festlegen. Der JobHost löscht bei jedem Lauf ohne Parameter (Job LogEntryCleanup) alle Einträge, die älter sind. Leer, 0 oder ein negativer Wert schaltet die Bereinigung ab.

Die Einstellung steht im Web-Admin unter Einstellungen › Sicherheit & Compliance, im Admin Dashboard im Bereich Settings und in der Admin API unter .../Admin/Settings/Security (Eigenschaft logEntryRetentionDays). Sie betrifft auch das Protokoll der Paket-Importe, das in derselben Tabelle liegt.

Admin API

Ein PUT .../Admin/Settings/Security schreibt immer beide Eigenschaften. Deshalb beide mitsenden: Fehlt privacyLogUserData, gilt false, fehlt logEntryRetentionDays, ist die Bereinigung ausgeschaltet.

Auswertung

• Im Admin Dashboard im Bereich Stats, inklusive Export der Rohdaten als CSV.
• Über die Admin API mit den Endpunkten unter .../Admin/Statistics, siehe Admin API: Statistiken.