Best Practice - File Plan Converter

Transkript

1 Best Practice - File Plan Converter

2 Copyright 206 Lexmark. All rights reserved. Lexmark is a trademark of Lexmark International, Inc., registered in the U.S. and/or other countries. All other trademarks are the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in any form without the prior written permission of Lexmark.

3 Inhaltsverzeichnis Best Practice File Plan Converter.... Einführung..... Aktenplan-Import Aktenplan-Export Filesystem to File Plan Voraussetzungen Konfigurationsdateien Import-export.properties... 2 Sektion "Server Anmeldedaten"... 3 Sektion "Filesystem to File Plan"... 3 Sektion "Import"... 3 Sektion "Export" Log4j.properties Saperion.properties XML-Datei Starten einer Anwendung File Plan Beispiel... 8

4 . Einführung Best Practice - File Plan Converter Best Practice File Plan Converter In diesem Best Practice erhalten Sie einen Leitfaden für die Einrichtung eines Aktenplans. Dies geschieht mit Hilfe eines Tools - dem File Plan Converter - das mit der SAPERION-DVD mit ausgeliefert wird. Im Wesentlichen müssen Sie folgenden Schritte ausführen, um den File Plan Converter anwenden zu können: Anpassung der mit ausgelieferten Konfigurationsdatei (XML) Starten der Anwendung. Einführung Der File Plan Converter enthält Anwendungen, welche es ermöglichen entweder eine Dateistruktur auf dem lokalen Dateisystem in das SAPERION-System zu importieren oder eine Akten-Struktur innerhalb von SAPERION in das lokale Dateisystem zu exportieren. Diese Vorgänge werden mit Hilfe einer XML-Datei ausgeführt... Aktenplan-Import Mit dem File Plan Importer kann eine Dateistruktur vom lokalen Dateisystem in das SAPERION-System importiert werden. Diese dient hier als Vorlage für Aktenstrukturen innerhalb von SAPERION - so können Sie für Ihre betriebsinterne Aktenanwendung stets den gleichen Aktenplan für alle Mitarbeiter anlegen. Diese Struktur kann auch Dateien enthalten und beliebig verschachtelt sein. Der Root-Ordner wird in SAPERION stets als efile festgelegt, so dass alle Unterordner als Register fungieren. Der Aktenplan-Import basiert auf einer XML-Datei, welche zur Verfügung gestellt wird. Diese XML-Datei enthält alle Informationen, die der Importer benötigt. Nähere Informationen zu Import-Properties ist in Kapitel Konfigurationsdatei zu finden..2 Aktenplan-Export Mit dem Aktenplan-Exporter kann eine Aktenstruktur aus SAPERION in das lokale Dateisystem exportiert werden. Bei einem Export wird eine XML-Datei erzeugt, die vom Anwender angepasst und später wieder vom Importer verwendet werden kann. Alle Informationen, die der Exporter benötigt, werden in der Konfigurationsdatei "import-export.properties" in der Sektion [EXPORT] angegeben.

5 Best Practice File Plan Converter Nähere Informationen zu Export-Properties ist in Kapitel Konfigurationsdatei zu finden...3 Filesystem to File Plan Diese Anwendung ist als Hilfsanwendung zu verstehen, welche dem Anwender das Erstellen der XML-Datei für den Import erleichtern soll. Hierbei wird die gewünschte Ordnerstruktur auf dem lokalen Dateisystem ausgelesen und in XML-Format abgespeichert. Diese XML-Datei entspricht dem vorgegebenen XML-Schema, muss aber vor dem Import angepasst werden, damit alle benötigten Informationen wie ACL s und Klassen-Namen für den Import vorhanden sind. i Bitte gehen Sie bei der Anpassung der XML-Datei sehr sorgfältig vor, da der Import fehschlägt, sobald die Konfigurationsdatei unvollständig oder fehlerhaft ist..2 Voraussetzungen Für eine fehlerfreie Funktion des File Plan Converters müssen folgende Voraussetzungen erfüllt sein: Die Konfigurationsdatei muss fehlerfrei sein Der SAPERION Server muss gestartet sein. Schreib- und Leserechte auf dem lokalen Dateisystem muss ausreichend vorhanden sein. Rechte des angemeldeten Benutzers auf dem SAPERION Server muss ausreichend sein..3 Konfigurationsdateien.3. Import-export.properties Unter Ihrem SAPERION-Installationsverzeichnis "scr-fileplanconverter/conf/import-export.properties" befindet sich die Konfigurationsdatei "import-export.properties ", die Sie Ihren Bedürfnissen entsprechend zunächst anpassen müssen. Aus dieser Datei beziehen die einzelnen Anwendungen alle notwendigen Informationen bezüglich des SAPERION-Systems und des lokalen Dateisystems. Diese Datei muss vor jedem Ausführen der Anwendung vom Benutzer angepasst werden. Die "import-export.properties" ist in vier Sektionen unterteilt: In der ersten Sektion werden die Server-Anmeldedaten angegeben. Die weiteren drei Sektionen gehören zu den Funktionen des File Plan Converters: Import, Export und Filesystem to Fileplan. 2

6 Konfigurationsdateien Sektion "Server Anmeldedaten" Server-Verbindungsdaten Property user Benutzername, mit dem sich die Anwendung auf dem Server einloggen soll. pw Passwort, mit dem sich die Anwendung auf dem Server einloggen soll. mandant Mandant, mit dem sich die Anwendung auf dem Server einloggen soll. schemalocation Pfad zu dem XML-Schema, welches für die Validierung der XML-Datei verwendet wird. Dieses gilt für die XML-Datei, welche für den Import zur Verfügung gestellt wird, und für die XML-Datei, welche vom Exporter generiert wird (Default:./required/fileplan.xsd).! Bitte beachten Sie, dass das Validierungsschema nicht geändert werden darf Sektion "Filesystem to File Plan" Filesystem to File Plan-Properties Property fsrootfolder Pfad zu dem Root-Ordner auf dem lokalen Dateisystem, welcher als efile in das SAPERION-System importiert werden soll. xmldest Pfad zu dem Ordner, wo die XML-Datei für den Import abgelegt werden soll. Der Pfad muss den Dateinamen enthalten, den die XML-Datei haben soll (Default: /export-destination/ filesystemtofileplan.xml ). Wenn diese Property leer gelassen wird, wird der XML-Inhalt in der System-Konsole ausgegeben Sektion "Import" Der Dateipfad und der Name der Datei muss in der Konfigurationsdatei (/FilplanConverter/conf/import-export.properties) in der Sektion "Import angegeben werden. Das entsprechende Property in der Datei heißt xmlsource. Diese XML-Datei wird zur Laufzeit gegen ein Schema geprüft. Sollte also die Datei einen Strukturfehler enthalten, wird der Importer nicht funktionieren. Die Schema-Datei liegt im Verzeichnis "/FilplanConverter/required/fileplan.xsd".! Bitte beachten Sie dass, Tippfehler oder nicht übereinstimmende Angaben mit der Datenbank und dem SAPERION-System (z.b. Attribute, ACLs etc) dazu führen, dass der Import gänzlich nicht funktioniert. Import-Properties Property xmlsource Pfad zu der XML-Datei, die alle notwendigen Informationen enthält, die der Importer benötigt, um die lokale Ordner-Struktur in das SAPERION-System zu importieren. Beispiel: 3

7 Best Practice File Plan Converter #Location of the import-xml-file xmlsource=./required/fileplan.xml.3..4 Sektion "Export" Export-Properties Property exportefile Pfad zu dem exportierenden efile innerhalb von SAPERION (zu finden in der entsprechenden DDC, die weiter unten angegeben werden muss). exportdestfolderd Pfad zu dem Export-Zielordner auf dem lokalen Dateisystem. Hierher wird die Aktenstruktur aus SAPERION exportiert (Default:./export-destination). fileplanlocation Pfad zu dem Ordner auf dem lokalen Dateisystem, in dem die vom Exporter erzeugte XML-Datei abgelegt werden soll (Default:./ export-destination). folderddc Name der Datenbank-Definition (DDC), in der die efile und Register-Informationen abgelegt sind. In dieser DDC muss auch der Pfad zu dem zu exportierenden efile (weiter oben: exportefile) zu finden sein (Default: hr_records). docddc Name der Datenbank-Definition (DDC), in der die Dokumenten-Informationen abgelegt sind. (Default: hr_documents). docnamefield Für jedes SAPERION-Dokument wird von dem Exporter auf dem lokalen Dateisystem ein eigener Ordner angelegt, welcher die Elemente des Dokuments enthält. Das docnamefield ist das Feld in der Dokumenten-DDC, das für die Namen der Dokumenten-Ordner auf dem lokalen Dateisystem verwendet werden soll. 4

8 .3 Konfigurationsdateien Property folderfield, docfield Mit diesen beiden Properties können alle DDC-Felder aufgelistet werden, die beim Exportieren als Attribut in die XML-Datei geschrieben werden sollen. Für Dokumenten-Attribute wird das Feld aus der Dokumenten-DDC ausgelesen. Dafür muss der Property-Name immer mit docfield beginnen und mit _<Zähler> enden. Durch den Zähler am Ende des Property-Namens kommen keine Namen mehrfach vor. Beispiele: docfield_=gbdate docfield_2=vname docfield_3=nname Die Ordner-Attribute fungieren nach dem gleichen ist das Prinzip. Hier muss der Property-Name mit folderfield beginnen und genauso wie bei den Dokumenten-Feldern mit _<Zähler> enden. Bitte achten Sie darauf, dass die angegebenen Felder auch tatsächlich in der entsprechenden DDC vorhanden sind..3.2 Log4j.properties Hier können Sie das Logging für die Anwendung konfigurieren. Achten Sie hierbei auf den Ausgabe-Pfad und den Root-Logger..3.3 Saperion.properties In dieser Konfigurations-Datei sind zusätzlich Informationen für die Server-Verbindung angegeben. Die Anmeldedaten werden in Import-export.properties konfiguriert.3.4 XML-Datei Der Fileplan-Import basiert auf der XML-Datei, die zur Verfügung gestellt wird. Diese XML-Datei entspricht dem vorgegebenen XML-Schema, diese können Sie jedoch Ihren Anforderungen entsprechend vor dem Import anpassen. So werden alle benötigten Informationen, wie beispielsweise ACL s und Klassennamen für den Import, definiert.! Bitte beachten Sie, dass diese XML-Datei vollständig und fehlerfrei abgespeichert wird, dies ist die Grundbedingung für einen funktionierenden Import. Im folgenden wird anhand eines Beispiels (FileplanConverter/example/fileplan.xml) die Anpassungen erläutert. Einzelne Abschnitte sind aus der vollständigen XML-Datei extrahiert und im Einzelnen näher beschrieben. <fileplan name="mustermann, Tanja" repository="hr_records" folderclass=" HRApplication.HRFile"> Attribut Name Name der elektronischen Akte; der Import funktioniert nicht, wenn der Name bereits in der Datenbank vorhanden ist. 5

9 Best Practice File Plan Converter Attribut Repository Name der Datenbank, in der die efile-informationen abgespeichert werden sollen. Folderclass Name der Klasse, welcher der Aktenplan angehört. Für den Aktenplan sollte es immer HRApplication.HRFile sein und für ein Register HRApplication.HRFile.HRRegister. i Alle drei Attribute sind Pflichtangaben, also zwingend erforderlich. Aktenpläne können Attribute, Dokumente und Register enthalten; diese werden ebenso in der XML-Datei definiert. ACL Sie haben die Option, Registern, Dokumenten und dem Aktenplan selbst ACL s zuzuweisen. Hierfür müssen Sie jedoch sicherstellen, dass diese ACL s in der Datenbank vorhanden sind. <acls> <acl>acl</acl> <acl>acl2</acl> </acls> Attribute Sie haben die Option, Regsitern, Dokumenten und dem Aktenplan selbst Attribute zuzuweisen. Diese Attribute sind beliebige Felder in der Datenbank, welche beim Importieren in der entsprechenden Datenbank gesetzt werden (Bei Aktenplan in der Aktenplan-Datenbank, bei Dokumenten in der Dokumenten-Datenbank, etc..).! Der Import schlägt fehl, wenn diese Angaben nicht mit der Datenbank übereinstimmen. <attributes> <attribute name="vname" kind="string">tanja</attribute> <attribute name="nname" kind="string">mustermann</attribute> </attributes> Attribut Name Name des Feldes in der Datenbank Kind Typ des Datenbankfeldes Wert Der Wert enthält den Inhalt des Feldes. Register Der Aktenplan kann beliebig viele Register enthalten. Ein Register kann ebenfalls beliebig viele Register, Attribute, ACL S und Dokumente enthalten. <register name="levelb" folderclass="hrapplication.hrfile.hrregister"> 6

10 .4 Starten einer Anwendung Attribut Name Name des Registers Folderclass Name der Klasse, welcher das Register angehört. Für den Aktenplan sollte es immer HRApplication.HRFile sein und für ein Register HRApplication.HRFile.HRRegister. Dokumente Aktenpläne und Register können objects enthalten. Objects enhalten die beliebig viele Dokumente, die dem Register oder Aktenplan angehören. Dokumente enthalten den Content, der beim Importieren wieder zu einer mehrseitigen Datei zusammengefügt wird. Des Weiteren können Sie Dokumenten Attribute und ACL S zuweisen. Jedes Dokument enthält im Endeffekt also eine Datei, die (je nach Anzahl der Contents) mehrere Seiten enthalten kann. <objects> <document repository="hr_documents"> Content Hier wird der Dateipfad zu den Dateien angegeben, die zu diesem Aktenplan oder Register gehören. Alle Dateien, auf die in Contents referenziert wird, werden beim Import zu einer mehrseitigen Datei zusammengefügt. <contents> <content> name="agbs.pdf">./example/documents/agbs.pdf </content> <content> name="contract.docx">./example/documents/contract.docx </content> </contents>.4 Starten einer Anwendung Nachdem Sie die Konfigurationsdatei "import-export.properties" angepasst haben (siehe Kapitel Konfigurationsdatei ), können Sie nun die Anwendung starten. Dies erfolgt über die folgenden Start-Skripte: Start_Importer.bat Dieses Skript startet die Import-Funktion. Start_Exporter.bat Dieses Skript startet die Export-Funktion. Start_FilesystemToFileplan.bat 7

11 Best Practice File Plan Converter Dieses Skript startet die Filesystem to Fileplan-Funktion..5 File Plan Beispiel Im Verzeichnis ""...FilePlanConverter/example" befindet sich ein Anwendungs-Beispiel. An diesem Beispiel können die Funktionen des File PlanConverters getestet werden. Der Ordner enthält folgende Dateien: fileplan.xml Diese XML-Datei kann vom Importer verwendet werden. Sie müssen diese aber vorher an Ihr lokales Dateisystem und die DDC s anpassen. part.xml Eine kleine XML-Datei, welche in die Haupt-XML-Datei (fileplan.xml) eingebunden werden kann. hr.file Die "hr.file"-datei ist eine Beispiel-Ordnerstruktur mit Dokumenten, welche in das SAPERIONSystem importiert werden kann. 8