DOKinform NOTIFYagent. Dokumentation Installation, Konfiguration und Betrieb

Transkript

1 DOKinform NOTIFYagent Dokumentation Installation, Konfiguration und Betrieb

2 Impressum Version: 3.0 Copyright ARIVATO GmbH Alle Rechte, auch die des Nachdrucks, der Vervielfältigung oder der Verwertung bzw. Mitteilung des Inhalts dieses Dokuments oder von Teilen daraus behalten wir uns vor. Kein Teil darf ohne schriftliche Genehmigung von ARIVATO GmbH in irgend einer Form reproduziert, an Dritte weitergegeben oder insbesondere unter Verwendung elektronischer Systeme verarbeitet, vervielfältigt oder zu öffentlichen Wiedergabe benutzt werden. Wir behalten uns das Recht vor, Inhalte zu aktualisieren oder zu modifizieren. Warenzeichen ELOenterprise, ELOprofessional und ELOoffice sind eingetragene Warenzeichen der ELO Digital Office GmbH. SAP, R/2, R/3, ABAP/4, SAP ArchiveLink, SAP Business Workflow, das SAP-Logo und das R/3-Logo sind eingetragene Marken der SAP AG. Microsoft Windows, Microsoft Office, Microsoft Word, Microsoft Excel, Microsoft PowerPoint, Microsoft Outlook und Microsoft SQL Server sind eingetragene Warenzeichen der Microsoft Corporation Andere Produktnamen werden nur zur Identifikation der Produkte verwendet und können eingetragene Warenzeichen / Marken der jeweiligen Hersteller sein. DOKinform NOTIFYagent Installation Seite 1/23

3 Inhaltsverzeichnis 1 Einleitung Installation Service im Tomcat installieren Konfiguration des DOKinform NOTIFYagent Spezifikation der Profile für Workflows und Aufgaben Aufbau einer Profildatei Allgemeiner Aufbau Benachrichtigung Workflows Benachrichtigung Aufgaben Aufbau der Vorlagendatei Spezifikation der Profile für Abonnements Erstellen eines neuen Abo Ändern und löschen von Abos ELO Integration Konfiguration der Vertretungsfunktion Konfiguration durch den Anwender Konfiguration durch den ELO-Administrator Betrieb des DOKinform NOTIFYagent Fehlersuche DOKinform NOTIFYagent Installation Seite 2/23

4 1 Einleitung Vielen Dank, dass Sie sich für den Kauf des DOKinform NOTIFYagent entschieden haben! Diese Dokumentation soll Ihnen eine Einführung geben und Ihnen später als Nachschlagwerk dienen. Wir empfehlen Ihnen dringend die Dokumentation zu lesen und Schritt für Schritt nachzuvollziehen. Der DOKinform NOTIFYagent ist Teil der DOKinform Best practice Produktreihe welche professionelle Erweiterungen rund um die ECM Lösungen aus dem Hause ELO Digital Office GmbH beinhaltet. Der DOKinform NOTIFYagent arbeitet als Dienst und erlaubt die serverseitige Benachrichtigung von ELO Benutzern über Aufgaben, Workflows und neue Objekte in ELO. Der DOKinform NOTIFYagent erstellt Benachrichtigungs Jobs welche für den eigentlichen Versand an den DOKinform MAILsender übergeben werden. Über individuell konfigurierbare Profile, bietet der DOKinform NOTIFYagent die Möglichkeit unterschiedlichste Anforderungen abzubilden. DOKinform NOTIFYagent Installation Seite 3/23

5 2 Installation Der DOKinform NOTIFYagent wird zentral auf einem Server, i.d.r. dem ELO-Server, installiert. Für die Installation ist eine lauffähige ELOprofessional oder ELOenterprise Umgebung mit funktionsfähigem ELO-IX erforderlich. 2.1 Service im Tomcat installieren Um den DOKinform NOTIFYagent zu installieren öffnen Sie das \webapps Verzeichnis Ihrer Apache Tomcat Installation. Kopieren Sie jetzt die Datei NOTIFYagent.war von der Produkt CD und fügen diese in das \webapps Verzeichnis ein. Den Rest der Installation führt Apache Tomcat selbständig durch und legt unter \webapps ein Verzeichnis mit dem Namen NOTIFYagent an. Starten Sie Ihren Webbrowser und öffnen die Adresse: bzw. ergänzen Sie hinter localhost die von Ihnen gewählte Port Nummer. Im Browser sollte jetzt die Statusseite des Apache Tomcat Servers zu sehen sein. Im linken Bereich der Seite befindet sich die Navigation. Kicken Sie unter Administration auf den Link Tomcat Manager. Sie werden nach dem von Ihnen bei der Installation angegebenen Benutzernamen und Passwort gefragt. Nach Eingabe und Bestätigung der Daten öffnet sich der Tomcat Webanwendungs-Manager. Auf dieser Seite sehen Sie alle im Apache Tomcat Installierten Anwendungen. Hier erscheint nun auch der DOKinform NOTIFYagent. 2.2 Konfiguration des DOKinform NOTIFYagent Die Basiskonfiguration stellt sicher, dass der Dienst startet, die Lizenzierung geprüft wird und das Logging funktioniert. Die Daten der Basiskonfiguration des DOKinform NOTIFYagent liegen in einer Konfigurationsdatei. Die Datei liegt im Verzeichnis webapps\notifyagent\conf\config.properties. Die Datei läßt sich mit einem Texteditor bequem anpassen. Im Folgenden werden die einzelnen Felder un die zulässigen Werte beschrieben. Basic.LogPattern= %d{dd.mm.yyyy HH\:mm\:ss} %-5p [%t]\: %m%n Basic.MaxRecoveryLogSize= Agent.ThreadCount=1 System relevant, bitte nicht ändern System relevant, bitte nicht ändern Basic.NewInstall=FALSE TRUE: Dienst startet nicht (wird genutzt um den Dienst zu Deaktivieren bzw. während der Initialkonfiguration bei Installation) FALSE: Dienst startet DOKinform NOTIFYagent Installation Seite 4/23

6 Bitte nach Konfiguration auf TRUE setzen. Basic.LogLevel=ALL Directories.Logging= C:\\DOKinform\\NotifyAgent\\log Directories.MailQueue= C:\\DOKinform\\MAILsender\\input MailQueue.SignalFileExtension=.sig IndexServer.URL= http\://localhost\:8080/ix-demo/ix IndexServer.User=WFagent IndexServer.Password=elo Application.PollTime=5000 Application.InsertDocURL=TRUE Application.InsertDocURL=TRUE Application.InsertWebclientURL=TRUE Application.WebclientURL= ORT/ig2- ARCHIVNAME/ix/loadDocument.jsp?guid= Templates.NewDocuments.TemplateFolder= C:\\DOKinform\\NotifyAgent\\mailbody\\doc Templates.NewDocuments.TemplateFile= body_subscription_documents_de.html Templates.NewFolders.TemplateFolder= C:\\DOKinform\\NotifyAgent\\mailbody\\folder Templates.NewFolders.TemplateFile= body_subscription_folders_de.html Loglevel und Pfad zu Logdatei (Schreibweise mit doppelten \\ beachten!!) Pfad zu Eingangsverzeichnis des MAILsenders Standardwert für Signaldatei MAILsender URL des zu nutzenden ELO-IndexServer. (Schreibweise beachten!!) Anmeldedaten des ELO Benutzers in dessen Kontext der Dienst die Workflows bearbeiten soll. Zeitintervall in Millisekunden. TRUE: ELO-EDC Link auf das Dokument wird in die eingefügt. Zusätzlichen (!!) Link für ELO WEBclient einfügen URL des zu verwendenden ELO WEBaccess Servers Pfad zu Vorlagendatei für die Formatierung der für neue Dokumente Name der Vorlage Pfad zu Vorlagendatei für die Formatierung der für neue Ordner Name der Vorlage Die Lizenzdatei (license.txt) muss in das Verzeichnis webapps\notifyagent\conf kopiert werden. Ohne diese Datei ist der Dienst nicht lauffähig, auch nicht in einem Demo-Modus. Ihre Lizenz gilt nur in Verbindung mit Ihrem individuellen ELO Lizenzkey und kann zeitlich eingeschränkt sein. Ggf. kann die Lizenz bezüglich der maximalen Anzahl von Profilen eingeschränkt sein. DOKinform NOTIFYagent Installation Seite 5/23

7 Das Ergebnis eines erfolgreich erstellten Banachrichtigungs Jobs besteht aus einem Ordner im MailQueue Verzeichnis (s.o.). In diesem Ordner befindet sich eine XML Datei mit dem Namen mailsender.meta sowie ggf. eine oder mehrere Grafik Dateien (s.u.). Für weitere Details wird an dieser Stelle auf die Dokumentation des DOKinform MAILsender verwiesen. DOKinform NOTIFYagent Installation Seite 6/23

8 3 Spezifikation der Profile für Workflows und Aufgaben Die Profile werden aus dem Ordner webapps\notifyagent/profiles der Webapplikation geladen. Der Name der Dateien muss mit profile_ (bitte den _ beachten!) beginnen und mit.properties enden. Alle anderen Dateien in dem Ordner werden ignoriert. 3.1 Aufbau einer Profildatei Alle Daten eines Profils werden im Format der Java-Properties Dateien gespeichert, d.h. es sind normale Textdateien die in jedem Texteditor bearbeitet werden können Allgemeiner Aufbau ProfileName=FIBU-WF SendDays=2;3;4;5;6 SendHour=7 SendImmediately=FALSE Name des Profiles Tage an welchen das Profil aktiv sein soll (so=1;mo=2;di=3;mi=4;do=5;fr=6;sa=7) Uhrzeit FALSE: o.g. Zeitsteuerung ist aktiv TRUE: Zeitsteuerung inaktiv, Ausführung nur einmalig bei Start des Dienstes (Testmodus) Der Name des Profils muss eindeutig sein. Der Dienst startet nicht, wenn zwei Profile mit dem gleichen Namen gefunden werden, selbst wenn die Dateien unterschiedliche Namen haben Benachrichtigung Workflows Zusätzlich zu den allgemeinen Daten sind folgende Parameter zu konfigurieren: Action=NotifyUser NotifyUser.template=FIBU NotifyUser.maxWorkflows=100 NotifyUser.from= ELO-Workflow (DOKinform MAILsender) <noreply@kunde.de> Statischer Wert Name der ELO-Workflow Vorlage Max. Anzahl von zu bearb. WFs, der Rest wird ignoriert. Absender der NotifyUser.subject=ELO - Bitte Rechnung bearbeiten Betreff der DOKinform NOTIFYagent Installation Seite 7/23

9 NotifyUser.messageTemplate=D\:\\DOKInform\\ NotifyAgent\\mailbody\\body_FIBU-WF.htm Vorlagendatei für die Gestaltung der E- Mail Benachrichtigung Aufgaben Zusätzlich zu den allgemeinen Daten sind folgende Parameter zu konfigurieren: Action=TaskList TaskList.priorities = TaskList.maxWorkflows=100 TaskList.showSubstitute=true Statischer Wert Priorität der ELO-Aufgaben, hier sind folgende Werte möglich: A, B, C, AB, AC, BC, ABC Max. Anzahl von zu bearbeitenden ELO Aufgaben, der Rest wird ignoriert. True = Aufgaben aller Anwender für welche der in der config.properties Datei hinterlege Anwender Vertreter ist werden ausgewertet False = Ausschließlich Aufgaben des in der config.properties Datei hinterlegen Anwenders werden ausgewertet TaskList.from= ELO-Aufgaben (DOKinform MAILsender) <noreply@kunde.de> TaskList.subject=ELO - Bitte Aufgaben prüfen TaskList.messageTemplate= C\:\\DOKInform\\NotifyAgent\\mailbody\\body _TASKS.htm Absender der Betreff der Vorlagendatei für die Gestaltung der E- Mail DOKinform NOTIFYagent Installation Seite 8/23

10 3.2 Aufbau der Vorlagendatei Die Vorlage ist eine reine HTML Datei. Über spezielle Platzhalter werden dynamisch die Werte aus ELO eingefügt: {##user##} {##timestamp##} {##workflow##} {##numberofworkflows##} {##workflowlist##} {##numberoftasks##} {##tasklist##} Anwendername in ELO Zeitpunkt der Berichtserstellung Name der ELO-Workflow Vorlage Anzahl der gefundenen aktiven Workflows Liste der Workflows (Anzeigename aus ELO) Anzahl der ELO-Aufgaben Liste der ELO-Aufgaben (Anzeigename in ELO) Ab DOKinform MAILsender Version können auch Grafiken in die s mit eingebunden werden. Um Grafiken in die zu intergrieren müssen diese im Vorlagenordner abgelegt und in der Vorlage über die Variable {##cid:filename.ext##} eingebunden werden. FILENAME = Dateiname EXT = Dateiendung (aktuell werden jpg, gif und png unterstützt). Alle Dateien im Vorlagenordner ohne direkte Einbindung in die HTML-Vorlage werden als gewöhnlicher Dateianhang mit versendet. DOKinform NOTIFYagent Installation Seite 9/23

11 Beispiele für formatierte s 1. Text, Tabellen, benutzerdefinierte Farben 2. Grafiken, Text, Tabellen, benutzerdefinierte Farben DOKinform NOTIFYagent Installation Seite 10/23

12 4 Spezifikation der Profile für Abonnements Die Profile für Abonnements werden über ein grafisches Frontend ( Abo-Manager ) in einem Webbrowser erstellt und direkt im ELO-Archiv im Ordner Administration\DOKinform\NOTIFYagent gespeichert. Je Anwender wird ein Ordner mit dem Namen erstellt, darunter wird je Abo ein eigener Ordner erstellt. Die Profildaten werden in dem Memo-Feld in einem ähnlichen Format wie in einer Java- Properties Datei hinterlegt. Zur Laufzeit legt der DOKinform NOTIFYagent einen Unterordner für den Status an. Änderungen an den Profilen sollten nur über den Abo-Manager erfolgen. Zum Löschen eines Profiles kann der ELO Administrator den entsprechenden Ordner löschen. Zum entfernen aller Abos eines Benutzers bitte den Ordner mit dem Benutzernamen löschen. DOKinform NOTIFYagent Installation Seite 11/23

13 4.1 Erstellen eines neuen Abo Der zu überwachende Ordner wird im ELO-Client ausgewählt, danach wird das ELO-Script DOKinform Abomanager über das Kontextmenü oder einen Script-Button gestartet. Der Abo-Mananger wird im Browser gestartet, der Anwender meldet sich mit seinem ELO Benutzernamen und Passwort an (die Anmeldung erfolgt direkt am ELO IndexServer ix). DOKinform NOTIFYagent Installation Seite 12/23

14 Nach erfolgreicher Anmeldung sieht der Anwender eine Liste all seiner Abos. Nach dem Wechsel auf Neues Abonnement können in der Maske die Daten für das neu zu erstellende Abo erfaßt werden: Name Pfad Aktion Maske Wiederholung Betreff Name des Abos (freier Text) ELO Ordner von wo der Aufruf des Abo-Managers erfolgte Benachrichtigung für neues Dokument bzw. neuen Ordner ELO-Maske, bei leerem Feld wird unabhängig von der Maske eine Benachrichtigung durchgeführt Häufigkeit der Prüfung und Benachrichtigung Betreff der Nach dem Speichern wird erneut die Liste der Abos angezeigt, das neue Abo ist unten aufgeführt und hat den Status NEU. Sobald das Abo beim nächsten Lauf des DOKinform NOTIFYagent erfolgreich in die Warteschlagen aufgenommen wurde, wechselt der Status auf OK und in der Spalte Zuletzt aktiv ist der Zeitpunkt des letzten Laufs abzulesen. DOKinform NOTIFYagent Installation Seite 13/23

15 Falls der Anwender für denselben Pfad in ELO ein weiteres Abo erstellen möchte, kann er den Vorgang wie oben beschrieben wiederholen. Für Abos in anderen Ordnern ist der Aufruf aus ELO zu wiederholen. 4.2 Ändern und löschen von Abos Um ein Abo zu ändern oder zu löschen muss der Abo-Manager gestartet werden. Das kann entweder wie unter 4.1 beschrieben direkt aus ELO (aus einem beliebigen Ordner) geschehen oder per direktem Aufruf der URL im Webbrowser. Nach Anmeldung wird die Liste alle Abos angezeigt. Zum Ändern bzw. Löschen werden die beiden Knöpfe am Ende der Zeile verwendet. DOKinform NOTIFYagent Installation Seite 14/23

16 Löschen: Nach einer Sicherheitsabfrage wird das entsprechende Abo gelöscht. Bearbeiten: Es wird der Dialog zum Bearbeiten geöffnet. Hier können Änderungen vorgenommen werden. DOKinform NOTIFYagent Installation Seite 15/23

17 5 ELO Integration Damit ein Anwender Nachrichten erhalten kann muss in der ELO Anwenderverwaltung folgende Konfiguration erfolgen: Adresse Aktivieren des Versands durch den Eintrag SENDMAIL Konfiguration der Vertretungsfunktion für Benachrichtigung der Aufgaben und Workflows Diese Option ist im nächsten Kapitel ausführlich beschrieben. Eine korrekte Konfiguration ist für den Betrieb zwingend erforderlich. Einbinden des Abo-Managers in den ELO-Client Für den Aufruf des Abo-Managers ist das Script DOKinform_Abomananger.vbs bzw. DOKinform_Abomananger.js (für den Java Client) in ELO zu importieren und ggf. auf einen Button zu legen. DOKinform NOTIFYagent Installation Seite 16/23

18 6 Konfiguration der Vertretungsfunktion Damit der Anwender NOTIFYagent neben den eigenen Aufgaben und Workflows auch die der zu vertretenden Anwender sehen und in die Benachrichtigung mit einbeziehen kann, muß er als Vertreter eingesetzt werden. In diesem Beispiel hat der ELO-Anwender ELOservice Vertretungsrechte für die Anwender Administrator, DOKinform und ugross. Auf den folgenden Seiten ist der Prozess aus der Sicht des Anwenders bzw. der Sicht des ELO Administrators im Detail beschrieben. Falls der Anwender die Konfiguration selber vornehmen darf oder soll, so empfiehlt es sich im Vorfeld durch den ELO Administrator für alle Anwender die Konfiguration gemäß Kapitel 5 durchzuführen. Durch Hinzufügen des Anwenders NOTIFYagent als Vertreter kann der Anwender die Benachrichtigung selbst Aktivieren und auch deaktivieren. Der Administrator kann das auch tun und darüber hinaus durch Entfernen des Eintrages im Feld E4 die Benachrichtigung komplett abstellen. DOKinform NOTIFYagent Installation Seite 17/23

19 6.1 Konfiguration durch den Anwender Öffnen der Vertretungsregelung Hinzufügen... (Im Fensterkopf ist der eigene Benutzername sichtbar) Anwender NOTIFYagent auswählen Ergebnis mit OK bestätigen DOKinform NOTIFYagent Installation Seite 18/23

20 6.2 Konfiguration durch den ELO-Administrator Öffnen der Vertretungsregelung Hinzufügen... (Im Fenstertitel ist der eigene Benutzername sichtbar) Neuer Anwender klicken Den zu konfigurierenden Anwender auswählen... Name des gewählten Anwenders ist im Fenstertitel sichtbar: Hinzufügen klicken DOKinform NOTIFYagent Installation Seite 19/23

21 Anwender NOTIFYagent auswählen Ergebnis mit OK übernehmen DOKinform NOTIFYagent Installation Seite 20/23

22 7 Betrieb des DOKinform NOTIFYagent Im laufenden Betrieb kann der DOKinform NOTIFYagent über eine Status-Seite im Apache Tomcat Manager überwacht werden. Nach Klick auf den Kontext Pfad /NOTIFYagent, öffnet sich die Statusseite im Webbrowser. Hier erhalten Sie einen Gesamtüberblick über die aktuellen Status, die verwendeten Profile sowie einige Betriebsparameter. Auf dem Tab Lizenz finden Sie einen Überblick über die Lizenzinformationen des Produktes. Falls Sie technischen Support benötigen können Sie direkt auf der Support Seite sich beim DOKInform Online Supportsystem anmelden und ein Ticket erstellen. DOKinform NOTIFYagent Installation Seite 21/23

23 Darüber hinaus haben Sie dort Zugriff auf Ihre gesamten bisherigen Supportanfragen sowie deren Lösungswege. Details zur Bedienung des Supportsystems finden Sie in der zugehörigen Dokumentation. Sicherheit und Datenschutz bei Fernwartung Nach entsprechender Aufforderung durch das DOKinform Support Team können Sie hier auch den Fernwartungszugang (TeamViewer QuickSupport) aktivieren. Jede Fernwartungssitzung wird verschlüsselt, um Manipulationen und Abhören der Daten zu verhindern. Nach Beendigung des Support Moduls befindet sich der PC wieder in seinem ursprünglichen Zustand. Auf dem Gastrechner werden keinerlei Veränderungen (wie z.b. Registry-Einträge) vorgenommen. DOKinform NOTIFYagent Installation Seite 22/23

24 8 Fehlersuche Der DOKinform NOTIFYagent schreibt zur Laufzeit Status und Fortschrittinformationen in eine Logdatei. Die Lage und die Detailtiefe der Logdatei werden in der Konfiguration festgelegt. Bedingt durch die Abhängigkeit der Dienste von dem ELO IndexServer können diese nur gestartet werden, wenn der IndexServer selber lauffähig ist. Neben den eigenen Logdateien können sich im Fehlerfalle auch nützliche Hinweise in den ELO Logdateien der Serverkomponenten finden, insbesondere AM und IX. Für Details hierzu sei auf die Herstellerdokumentation verwiesen. DOKinform NOTIFYagent Installation Seite 23/23