Voraussetzungen:
- Fertig installierter SQL Server (Servername, Instanz)
- Benutzer und Passwort eines SQL Users mit Zugriff auf die Datenbanken topfact6, topfact6Archiv und topfact6Sync
Vorbereitung: Basis-Datenbanktabellen für topfact6 Archiv füllen
In Zukunft soll diesen Schritt der topfact6 Archiv-Installer automatisch machen. @Stefan ?
Damit die Archiv-Installation auf eine Grundbasis zugreifen kann, muss folgendes SQL Script ausgeführt werden. Dieses legt die Tabellen Log, tf_ArchiveFields, tf_Archives, tf_Links und tf_Settings an.
Das aktuelle SQL Script liegt hier im Wiki: https://services.topfact.de/wiki/getdocument.ashx?pageid=17031&guid=2894c973-2aa6-4c76-abd9-0a242dc2e9bc
Server als Webserver konfigurieren
Im Windows-Menü nach "server" suchen bringt den Server-Manager.
Im Server Manager findet sich oben Rechts unter "Verwalten" die Konfiguration für "Rollen und Features"
Im jetzt erscheinenden Wizard wählen wir:
- Installationstyp: Rollenbasierte oder featurebasierte Installation
- Serverauswahl: den lokalen Server
- Serverrollen: per Checkbox "Webserver (IIS)" aktivieren und als Feature hinzufügen
- Features: keine weitere Auswahl nötig
- Rollendienste: keine weitere Auswahl nötig
- Installieren
Danach sollte der Server als Webserver agieren und auch der IIS Manager zur Verfügung stehen.
Installation des topfact Archivs (Webservice) per msi-Paket
Wir installieren das topfact Archiv durch starten des aktuellsten msi Installationspakets. Falls ein Fehler mit der Information über IIS Versionen erscheint ist vermutlich der Server noch nicht korrekt als IIS Webserver konfiguriert. Siehe den Schritt oben.
Nach der abgeschlossenen Installation sollte der Webservice unter "http://localhost/tfa" bereitstehen.
Überprüfen kann man das direkt im Browser. Es dauert einen Moment zu laden, sollte dann aber die API Definition des "DocumentService" anzeigen.
IIS Webservice konfigurieren
Mit der Suche nach "IIS" im Windows Startmenü kann der IIS-Manager aufgerufen werden.
Im IIS Manager wurde nach der Archiv-Installation eine Default-Site mit dem Namen "tfa" (topfact Archiv) eingerichtet.
Den Knoten "tfa" selektieren und auf Authentifizierung gehen. Dort muss sichergestellt sein, dass die "Anonyme Authentifizierung" aktiv ist.
Datenbank-Zugriff über Verbindungszeichenfolgen aktivieren
Bei den Verbindungszeichenfolgen besteht unter "system" bereits eine vorbereitete Konfiguration.
Diese muss aber mit den lokalen DB-Servernamen und Passwörtern ergänzt / ersetzt werden.
- Server= <Servername\DB-Instanzname> des installierten SQL Servers
- Database=topfact6 (ist korrekt)
- UserID=<Benutzername> des Datenbank-Users der vorher angelegt wurde.
- Passwort= <Passwort des DB Users>
Setzen des Archiv-Dateipfades
Nachdem die Zeichenfolge angepasst wurde, muss das Ergebnis in der Web.config geprüft werden. Außerdem wird dort der Pfad zu den späteren Archiv-Dateien festgelegt.
Unter dem Installationspfad C:\Program Files (x86)\topfact AG\topfact Archiv\ findet sich die Datei Web.config (kann mit Notepad++ geöffnet werden)
- Unter <connectionString> muss der korrekte SQL Server und das Passwort drin stehen
- Unter <appSettings> / <add key="RootPath" value="c:/tfArchive"> steht der Dateipfad für das Archiv drin
Wir müssen folgendes anpassen:
- Falls der Dateipfad "RootPath" nicht stimmt, kann dieser jetzt angepasst werden!
- Im <connectionString> "content" müssen wir ebenfalls den korrekten Server und Benutzer/Passwort in Kombination ergänzen! Dieser ist dort bislang nicht enthalten.
Info: Um die Web.config Datei mit einem neuen Archiv RootPath zu speichern kann es erforderlich sein, den Editor Notepad++ im Administratormodus auszuführen. Beim Speichern wird aber hierzu ein Hinweis erscheinen.
Einrichten der Anwendung "topfact Archiv" in der tf6 Administration
Unter Anwendungen > topfact Archiv > Systemeinstellungen muss die Grundkonfiguration für alle Archive generell eingestellt werden.
- Webservice URL: http://servername/tfa/documentservice.asmx (Achtung, hier auf das documentservice.asmx achten!)
- Datenbank: wie installiert, mit Windows-Authentifizierung
- Standard-Verzeichniss: wie definiert z.B. C:/topfactArchiv
Hinweis: Evtl. kommt es zu einem Fehler beim "Verbindung testen" der Datenbank. Dann muss die Administration als Admin neu gestartet werden. Shift+Rechtsklick "als Administrator ausführen".
Installieren eines neuen Standard-Archivs über die tf6 Administration
Damit ein Archiv genutzt werden kann muss dieses in der tf6 Administration erstellt werden.
Dazu gehen wir über Anwendungen > topfact Archiv > Archive > [+] Neues Archiv anlegen und definieren den Namen des Archivs, ob es im Dateisystem abgelegt werden soll und nochmals den Dateipfad zur Ablage.
Info: Wenn der Kunde nur ein Archiv bekommt, nehmen wir üblicherweise den Kundennamen als Namen für das Archiv.
Zur Prüfung, in der Datenbank "topfactArchiv" wurden nun folgende Tabellen angelegt.
- tf_Archive001 (enthält die Beleginformationen und Indexdaten, ein Eintrag je Beleg)
- tf_Archive001Files (enthält die Dateien, da ein Beleg auch mehrere Dateien haben kann)
- tf_Archive001FT (enthält die Volltextinformationen zu den Belegen)
- tf_Archive001Log (enthält Logeinträge zu diesem Archiv)
Im Aktuellen Zustand enthält das Archiv jedoch noch keine "Business-Logik-Felder". D.h. keine Indexdaten.
Gruppen und Rechte für das neue Archiv
Damit ein Nutzer Zugriffsrechte auf ein Archiv bekommt muss dieser in einer Gruppe mit Lese- und Schreibrechten auf das Archiv zugeordnet werden. In einer Neu-Installation ist es üblicherweise der Fall dass noch keine Gruppe existiert.
Neue Gruppe anlegen
In der tf6 Administration über Organisation > Gruppen > neue Gruppe anlegen (z.B. tf6 MyWork Benutzer)
@Stefan, das in Zukunft per Default bei der tf6 Installation anlegen, Gruppen, Profile, etc.
Die neue Gruppe auf das Archiv zugreifen lassen
Dazu bei Anwendungen > topfact Archiv > Doppelklick auf das Archiv > Tab "Profile" anzeigen. Und Doppelklick auf die Funktionsprofile.
Dort kann dann unter dem Tab "Gruppen" die neue Gruppe dem Funktionsprofil des Archivs zugeordnet werden.
Wenn dies für alle Funktionsprofile entsprechend durchgeführt wurde sieht das so aus:
Die Gruppe "tf6 MyWork Nutzer" hat für alle Funktionsprofile des Archivs die Verknüpfung.
Entsprechend dürfen die Mitglieder der Gruppe "tf6 MyWork Nutzer" auf dem neuen Archiv sowohl Schreiben als auch Lesen und haben aber keinen Vollzugriff da dieser Üblicherweise löschen beinhaltet.
Initialisieren eines Archivs mit Standard-Feldern
Es können ggf. mehrere Archive für verschiedene Anwendungsfälle existieren. z.B: Kaufmännisches Archiv oder Personalarchiv. Ein Standard-Kaufmännisches Archiv hat bestimmte Felder + Kundenwünsche
Jedes Attribut (Indexfeld) wird in tf_Archive001 und in tf_ArchiveFields gespeichert, damit sowohl das Archiv selbst die Informationen hat - aber auch die tf6 Administration weiß, welche Felder und Typen das Archiv bereitstellt.
Alle Felder die mit "tf_" beginnen ("tf_xxxxx") sind allgemeine Systemfelder des Topfact Archivs. Alle anderen Tabellenfelder sind kundenspezifische Konfiguration oder gehören zum Standard-Anwendungsfall.
SQL-Script für kaufmännisches Archiv
Die Basisfelder für ein kaufmännisches Archiv lassen sich über dieses Script initialisieren: https://services.topfact.de/wiki/getdocument.ashx?pageid=17031&guid=195fc011-e81f-4dcb-9608-3dc4c622da71
Nach dem Durchlauf des Scripts sieht die Archivkonfiguration > Felder so aus:
Hinzufügen des konfigurierten Archivs zur tf Umgebung
Zum Verständnis: Ein Archiv, das unter Anwendungen > topfact Archiv konfiguriert wurde wird wie ein externes Archiv behandelt. z.B. kann tf6 ja auch Docuware Archive einbinden. Entsprechend muss das erstellte Archiv noch in die topfact6 Organisation eingebunden werden.
Dazu öffnen wir die tf6 Administration und navigieren über Organisation > Archive und wählen [+] Archiv hinzufügen
Es erscheint ein Fenster zum einbinden eines "externen" Archivs. Denn das topfact Archiv wird genau gleich wie ein externes Archiv (z.B: Docuware) eingebunden.
Wir wählen
- Benennung: <Kundenname> üblicherweise
- DMS System: topfact Archive
- WebService URL: http://servername/tfa/documentservice.asmx
- Platform URL: <leer>
- Organisationsname: <leer>
- Archivname: ein Klick auf die Lupe / Dropdown ermöglicht uns die Auswahl des vorher konfigurierten Archivs
- Aktives Archiv: true (Checkbox muss aktiviert sein)
Die Felder werden geladen sobald man das Fenster einmal mit OK beendet und neu geöffnet hat.
Es müssen aktuell noch manuell für alle Felder die Checkboxen gesetzt werden.
Die Checkboxen bedeuten je Feld:
- In Listen anzeigen (Wenn irgendwo alle Archiv-Felder zur Auswahl stehen, z.B. in der Administration von Dokumentenstrukturen)
- Im Suchformular anzeigen
- Im Indizierungsformular anzeigen (ob dieses Feld Indiziert werden darf)
Das Archiv einer Anwendung (z.B. MyWork) zuordnen
Damit das Archiv von einer tf6 Anwendung (z.B. MyWork) verwendet werden kann muss es dieser zugeordnet werden.
In der tf6 Administration navigieren wir über Anwendungen > Anwendungen > [+] Anwendung anlegen und wählen für den Standard-Fall "topfat6 MyWork" aus der Liste.
Wenn diese Anwendung hinzugefügt wurde erhält sie eine eindeutige GUID als Anwendungsschlüssel.
Nachdem die Anwendung existiert können wir sie einem Archiv zuordnen. Dazu gehen wir über Organisation > Archive > Doppelklick auf unser Archiv auf den Reiter Anwendungszuordnung und selektieren topfact6 MyWork.
Nun ist das Archiv fertig konfiguriert und kann später über MyWork zugegriffen werden.
Ein Zugriff über MyWork ist auch der Funktionstest.
Im nächsten Schritt: Installieren und Konfigurieren von MyWork
Oder: Installieren und Konfigurieren vom JobServer
Archiv-Felder erweitern
Wenn kundenspezifische Erweiterungen der Archiv-Felder nötig sind können diese direkt in der Administration vorgenommen werden.
Details wie neue Felder ergänzt werden können finden sich hier: tf6 Archiv Felder ergänzen
--
Weitere Notizen:
Auf Filesystem Ebene werden die Dateien wie folgt abgelegt:
- erste Ordner-Ebene ist das Archiv (bzw. die Archivnummer beginnend mit 001)
- Weitere Unterebenen sind nur zur Trennung der Dateien (anhand der doc-id) 000/000/001/ darunter liegt dann eine Datei mit (file-id) z.B. 1234.tfa