dvs.ExpiryChecker

Administratorhandbuch - Version 18.6

Inhaltsverzeichnis

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 mit einem aktuellen Browser arbeiten. Manche Vorgehensweisen können hier von diesem Handbuch abweichen.

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
  • Setzten der Löschmarkierung mit dem Löschgrund Abgelaufen

FAQs

Bitte beachten Sie auch die aktuellen FAQs in unserem wiki Portal. Hier werden ggf. noch nicht in dieser Anleitung behandelte Themen und neue Funktionen stets aktuell beschrieben. Außerdem können Sie dort weitere Beispiele aus der Praxis finden.

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.

Symbol Beschreibung
Hinweise in dieser Kategorie beinhalten Hilfreiche Tipps
Diese Punkte sollten Sie unbedingt beachten

Systemvorrausetzungen

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

  • .NET Framework 4.6 oder höher
  • vorhandenes docuvita DMS 2.0.9xx oder höher
  • eine freie docuvita Zugriffslizenz
  • ca. 100 MB für die Installation
  • Eine Internetverbindung für die Aktivierung und Validierung der Produktlizenz

Installation

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

Achtung Für die Installation sowie das Update benötigen Sie lokale Administrationsrechte.
Frage Die aktuell Freigegeben Version finden Sie hier
  1. Starten Sie die dvs.ExpiryChecker 18.x.xx.msi Datei.

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

installtionStart

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

installtionLicenseAgreement

Frage 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)
  1. Im nächsten Schritt werden Sie nach dem Lizenzschlüssel gefragt.

installtaionLicenseKey

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

installLogPath

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

installFolder

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

installStart

  1. Bei einer erfolgreichen Installation erscheint abschließend folgendes Fenster

installFinished

Achtung Nach erfolgreicher Installation muss die Lizenzdatei noch direkt ins Installverzeichnis abgelegt werden. Standardpfad: C:\Program Files (x86)\docuvita\dvs.ExpiryChecker)
Frage 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.

Konfiguration

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

Konfigurator Starten

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

StartConfigurator

Achtung Der Konfigurator kann nur mit erhöhten Rechten durchgeführt werden.

Oberfläche Konfigurator

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

ConfiguratorMain

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

ConfiguratorMain
Hier können Sie eine bestehende Konfigurationsdateie ö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.
Achtung Vor dem Speichern der Konfiguration müssen alle offenen Bearbeitungsfelder geschlossen werden. Ansonsten werden die geöffneten Einstellungen nicht gespeichert.

Allgemeine Einstellungen

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

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 zum angegeben 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.
Achtung Beachten Sie, dass der docuvita Benutzer u.U. einen Vollzugriff auf alle Dokumente benötigt.
Frage 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.

Gespeicherte Suche In diesem Feld kann eine gespeicherte Suche eintragen werden. Die weiteren Aktionen werden dann auf der Trefferliste dieser Suche ausgeführt.
Objekt TypID 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 von dem angegebenen Workflow Startparameter. Eintrage erfolgt 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 als absoluter oder relativ Pfad zum Installationsverzeichnis. Unterstützte Dateiformate sind png und jpg.
Achtung Das Hinzufügen eines Wasserzeichen geht nur, wenn die Vorschaudatei im PDF Format vorliegt.
Frage Gespeicherte Suche: Die Suche muss für den in der Konfiguration angegebene Benutzer (vgl. Benutzername aus docuvita Systeme) gespeichert werden.
Frage Im Installationsverzeichnis finden Sie im Ordner example Beispiele für das Wasserzeichen.
Frage 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