ExpiryChecker

Einleitung

Dieses Handbuch richtet sich an Systemadministratoren und IT-Verantwortliche, die vor der Aufgabe stehen, ein bereits installiertes docuvita Dokumentenmanagement-System auf die speziellen Anforderungen des dvs.ExpiryChecker anzupassen.

Es erläutert die Schritte, die für eine Installation und Konfiguration des dvs.ExpiryChecker erforderlich sind.

Über dieses Handbuch

Dieses Handbuch erklärt die Funktionen und die Einrichtung des dvs.ExpiryChecker. Die Installation sowie die Konfiguration des ExpiryChecker können sich, je nach verwendetem docuvita System, im Ablauf leicht unterscheiden. Das prinzipielle Vorgehen ist aber unabhängig von der Version.

Die Verfahren und Beispiele, die in diesem Handbuch dargestellt sind, gehen davon aus, dass Sie mit einem aktuellen Windows Betriebssystem und einem aktuellen Browser arbeiten. Manche Vorgehensweisen können hier von diesem Handbuch abweichen.

Symbolerklärung

An verschiedenen Stellen dieses Handbuches finden sich Hinweis-Boxen, die Sie auf besonders wichtige oder wissenswerte Informationen aufmerksam machen sollen. Mit * markierte Kapitel oder Bedienelemente müssen nicht zwangsläufig in sämtlichen Installationen sichtbar sein. Die Sichtbarkeit kann zusätzlich von den Berechtigungen des einzelnen Benutzers abhängen.

Achtung

Diese Hinweise sollten Sie unbedingt beachten.

Info

Hinweise dieser Kategorie enthalten hilfreiche Tipps.

Produktbeschreibung

Der dvs.ExpiryChecker überprüft das Gültigkeitsdatum eines Dokumentes, indem der Feldwert Gültig bis (Standardfeld obj.ValidUntil) aus der Eigenschaftenliste bewertet wird. Liegt das eingetragene Datum in der Vergangenheit, wird das Dokument als abgelaufen betrachtet. Alternativ kann auch eine Prüfung in die Zukunft erfolgen. So kann z.B. auch eine Kündigungsfrist berücksichtigt werden. Folgende Aktionen können bei erkannten Dokumenten ausgeführt werden:

  • Aufbringen eines Wasserzeichen auf jede Dokumentenseite. Hierfür wird eine neue Dokumentenversion erstellt.
  • Schreiben von frei definierten Objekteigenschaften.
  • Setzen der Löschmarkierung mit dem Löschgrund Abgelaufen.
  • Starten eines Workflows.

Systemvorrausetzungen

Der dvs.ExpiryChecker benötigt zur Ausführung die folgenden Vorraussetzungen:

  • .NET Framework 4.6 oder höher
  • Ein vorhandenes docuvita DMS 2.0.9xx oder höher
  • Eine freie docuvita Zugriffslizenz
  • Ca. 100 MB für die Installation
  • Eine Internetverbindung zur Aktivierung und Validierung der Produktlizenz
  • Optional: Zum Starten von Workflows wird eine docuvita.Workflow Lizenz benötigt.

Installation

Dieses Kapitel enthält die notwendigen Informationen, die zur erfolgreicher Installation und zum Update des dvs.ExpiryChecker durchzuführen sind.

Administrator Rechte

Für die Installation sowie das Update benötigen Sie lokale Administrationsrechte.

Windows Dienst

Während der Installation wird ein eigenständiger Windows Dienst (dvs.ExpiryChecker) installiert. Dieser wird standardmäßig mit dem Benutzer Lokales System ausgeführt. Als Starttyp ist automatisch eingestellt.

1 . Starten Sie die dvs.ExpiryChecker 18.x.xx.msi Datei.

2 . Klicken Sie auf Weiter um mit der Installation zu beginnen.

installtionStart

3 . Lesen Sie sich die Lizenzvereinbarung durch und bestätigen Sie diese.

installtionLicenseAgreement

Lizenzvertrag

Den aktuell gültigen Lizenzvertrag finden Sie nach der Installation zusätzlich im Installsordner. (Standardpfad: C:\Program Files (x86)\docuvita\dvs.ExpiryChecker\dvs.ExpiryChecker - Eula.pdf)

4 . Im nächsten Schritt werden Sie nach dem Lizenzschlüssel gefragt.

installtaionLicenseKey

5 . Im folgenden Schritt haben Sie die Möglichkeit den Ablageort für die Log-Dateien anzupassen.

installLogPath

6 . Als nächstes haben Sie die Möglichkeit den Installationsordner anzupassen.

installFolder

7 . Danach erscheint ein Fenster, mit dem die Installation gestartet werden kann.

installStart

8 . Nach einer erfolgreichen Installation erscheint abschließend folgendes Fenster:

installFinished

Lizenzdatei kopieren

Nach erfolgreicher Installation muss die Lizenzdatei noch direkt ins Installationsverzeichnis abgelegt werden. Standardpfad: C:\Program Files (x86)\docuvita\dvs.ExpiryChecker)

Konfiguration

Der ExpiryChecker kann ganz einfach mit der graphischen Oberfläche dvs.ExpiryChecker.Configurator konfiguriert werden.

Konfigurator Starten

Den graphischen Konfigurator dvs.ExpiryChecker.Configurator.exe finden Sie direkt im Installationsordner (Standardordner: C:\Program Files (x86)\docuvita\dvs.ExpiryChecker).

StartConfigurator

Als Admin ausführen

Der Konfigurator kann nur mit erhöhten Rechten aus,geführt werden.

Oberfläche Konfigurator

In diesem Kapitel wird die Oberfläche des dvs.ExpiryChecker-Konfigurators beschrieben.

ConfiguratorMain

Verschlüsselung

Das Passwort bzw. die API-Benutzer-GUID werden automatisch verschlüsselt in der Konfigurationsdatei hinterlegt. Nach Eingabe des Passwortes wird es automatisch im Konfigurator verschlüsselt angezeigt.

Schaltfläche Beschreibung
ConfiguratorMain Hier können Sie eine bestehende Konfigurationsdatei öffnen.
ConfiguratorMain Hier können Sie die Konfigurationsdatei auf den zuletzt gespeicherten Stand zurücksetzen.
ConfiguratorMain Mit dieser Schaltfläche wird die aktuelle Einstellung übernommen und abgespeichert.
ConfiguratorMain
  • Bei Mandanten: Mit dieser Schaltfläche wird ein zusätzlicher Mandant zur Konfiguration hinzugefügt.
  • Bei Objekten: Mit dieser Schaltfläche wird ein zusätzliches Objekt zur Konfiguration hinzugefügt.
ConfiguratorMain
  • Bei Mandanten: Mit dieser Schaltfläche wird die aktuell ausgewählte Zeile (docuvita System) gelöscht.
  • Bei Objekten: Mit dieser Schaltfläche wird die aktuell ausgewählte Zeile (Objektliste) gelöscht.

Bearbeitungsfelder schließen

Vor dem Speichern der Konfiguration müssen alle offenen Bearbeitungsfelder geschlossen werden. Ansonsten werden die geöffneten Einstellungen nicht gespeichert.

Allgemeine Einstellungen

Feld Beschreibung
Objekte/Batchrun Anzahl der Objekte die pro Stapelverarbeitung kontrolliert werden.
Start Zeit Zu dieser Uhrzeit wird die Überprüfung der Dokumente gestartet.
Arbeitsverzeichnis Temporäres Arbeitsverzeichnis für die Erstellung neuer Dokumentenversionen.

docuvita Systeme

Feld Beschreibung
docuvita Server Adresse Hier tragen Sie die docuvita-Server URL ein.
System ID Hier tragen Sie docuvita-System-ID (Mandant) ein.
Benutzername Benutzername des docuvita-Benutzers, der für die Überprüfung verwendet werden soll.
Passwort docuvita Passwort des angegebenen docuvita-Benutzers.
API-Benutzer GUID GUID (Passwort) des API-Benutzers im docuvita.
Komplettes Update Wenn diese Option gesetzt ist, werden alle Objekte aktualisiert. Ansonsten erfolgt immer nur eine Überprüfung der letzten 24 Stunden nach dem zu prüfenden Datum.

Vollzugriff

Beachten Sie, dass der docuvita Benutzer u.U. einen Vollzugriff auf alle Dokumente benötigt.

komplettes Update

Nach der Installation bzw. nach einer längeren Betriebspause sollte die Option Komplettes Update aktiviert sein.

Objektliste

Hier haben Sie die Möglichkeit die Konfiguration an einzelnen Objekten anzupassen.

Objekt Beschreibung
Gespeicherte Suche In diesem Feld kann eine gespeicherte Suche eintragen werden. Die weiteren Aktionen werden dann auf der Trefferliste dieser Suche ausgeführt.
Objecttyp-ID Objekttyp-ID des docuvita Objektes, das aktualisiert werden soll. Wenn 0 dann wird diese Einstellung bei alle Objekttypen angewandt.
Vorlauf Mit diesem Wert können auch Objekte mit einem Gültigkeitsdatum in der Zukunft erfasst werden. Der Eintrag erfolgt in Tagen.
Update Feld Feldname der Objekteigenschaft, die aktualisiert werden soll.
Neuer Feldwert Wert, der in das zu aktualisierende Feld geschrieben wird.
Workflow Name Hier kann der (technische) Name des Workflows eingetragen werden. Dieser Workflow wird dann auf den gefundenen Objekten gestartet.
Workflow Parameter Die Startparameter von dem angegebenen Workflow. Einträge erfolgen als kommagetrennte Liste (z.B.StartParamerter1=value1,StartParameter2=value2)
Einmaliger Workflowstart Wenn false (Häckchen nicht gesetzt) wird der Workflow gestartet, auch wenn bereits der selbe Workflow auf diesem Dokument läuft.
Hintergrundbild Bilddatei, die als Wasserzeichen aufgebracht werden soll. Die Angabe erfolgt als absoluter oder relativer Pfad zum Installationsverzeichnis. Unterstützte Dateiformate sind png und jpg.

Wasserzeichen

Das Hinzufügen eines Wasserzeichen geht nur, wenn die Vorschaudatei im pdf-Format vorliegt.

Gespeicherte Suche

Die Suche muss für den in der Konfiguration angegebenen Benutzer (vgl. Benutzername aus docuvita Systeme) gespeichert werden.

Beispiel

Im Installationsverzeichnis finden Sie im Ordner example Beispiele für das Wasserzeichen.

Löschmarkierung

Wenn die drei Eigenschaften Update Feld, Neuer Feldwert und Hintergrundbild leer bleiben wird die Löschmarkierung gesetzt.

Starten der Überprüfung

Zum Starten der Überprüfung des Gültigkeitsdatums muss nur der installierte Windows Dienst dvs.ExpiryChecker gestartet werden. Beim Starten des Dienstes stehen zwei Parameter zur verfügung:

Parameter Funktion
-t Direkt beim Starten des Dienstes erfolgt die erste Überprüfung der eingestellten Objekte.
-u Führt ein Update der Konfigurationsdatei aus.

ConfiguratorMain