Archiv – manuelle Installation
Das Archiv-Modul ist sowohl für Comarch DMS Standalone als auch für alle Formen der Zusammenarbeit verfügbar: mit Comarch ERP XL, Comarch ERP Optima, Comarch ERP Altum und Comarch ERP CEE.
Das Comarch DMS-System besteht aus den Modulen:
-
-
- Comarch DMS Workflow (Dokumentumlauf)
- Comarch DMS Archiv
-
Es erfordert die Installation von drei separaten Apps auf dem IIS-Server, eine für das Comarch
DMS Workflow (Dokumentumlauf) Modul und zwei für das Comarch DMS Archiv Modul.
Installation des MongoDB-Servers in Windows
Das Installationsprogramm für den MongoDB-Server sollte von https://www.mongodb.com/ [Products →Community Server → MongoDB Community Server] MongoDB Community Download | MongoDB heruntergeladen werden.
Der dargestellte Installationsvorgang ist eine Kurzfassung der Installation. Es wird davon ausgegangen, dass MongoDB Compass auf demselben Computer gestartet wird, auf dem auch die Datenbank installiert ist. Der vollständige Installationsvorgang der MongoDB-Umgebung wird in der Anleitung des Herstellers näher beschrieben: Install MongoDB Community Edition on Windows.
Nachdem das Installationsprogramm heruntergeladen und geöffnet wurde, die folgenden Optionen wählen:
- Schaltfläche Next im ersten Fenster des Installationsprogramms
- Der Parameter I accept the terms in the License Agreement und die Schaltfläche Next
- Installation des Typs Complete und Schaltfläche Next
- Installation als Dienst (as a Service) und die Schaltfläche Next
- Parameter Install MongoDB Compass – eine App zum Durchsuchen der Datenbank (vergleichbar mit SSMS für SQL Server) und die Schaltfläche Next
- Schaltfläche Install
- Schaltfläche Finish, um die Installation abzuschließen
- Nach der Installation von MongoDB überprüfen Sie, ob der Dienst MongoDB im Task-Manager Windows-Dienste ausgeführt wird.
Hinzufügen des MongoDB-Administrators und der Datenbank für das Comarch DMS-Archiv mit hilfe von MongoDB Compass
Anschließend starten Sie MongoDB Compass. Wurde MongoDB lokal installiert, muss der Connection String nicht eingegeben werden. Die Anmeldung auf den Server erfolgt über das Klicken auf Connect.
Im nächsten Schritt erstellen Sie einen Benutzer mit Administratorrechten für den Server (mit dem nachfolgenden Befehl wird der Benutzer admin erstellt, mit dem Kennwort Passwd1234 und der höchsten Stufe der Serverberechtigungen).
Bevor Sie den Benutzer erstellen, führen Sie den Befehl use admin aus, und anschließend:
db.createUser(
{
user:”admin”,
pwd:”Passwd1234″,
roles:[{role:”root”,db:”admin”}]
}
)
Im nächsten Schritt sollte eine Datenbank für Comarch DMS Archiv mit dem Befehl: use Repository erstellt werden.
Im nächsten Schritt erstellen Sie die Datenbank für Archiv über den Befehl use Repository.
Anschließend fügen Sie zu der erstellten Datenbank einen Benutzer hinzu, für den eine Verbindung der Anwendung Repository zur Datenbank hergestellt wird.
Das Hinzufügen des Benutzers erfolgt über den Befehl:
db.createUser(
{
user:”MongoUser”,
pwd:”Passwd1234″,
roles:[{role:”readWrite”,db:”Repository”}]
}
)
MongoDB Compass kann jetzt geschlossen werden.
Änderungen in der Konfigurationsdatei mongod.cfg
Im nächsten Schritt sind einige Änderungen in der Konfigurationsdatei mongod.cfg vorzunehmen.
Die Konfigurationsdatei finden Sie unter <install directory>\bin\mongod.cfg, der voreingestellte Speicherort ist: C:\Program Files\MongoDB\Server\<Version>\bin\mongod.cfg
Folgende Änderungen sind in der Konfigurationsdatei mongod.cfg vorzunehmen:
- Im Abschnitt #network interfaces:
port: 27017 – Standardport
bindIp: 127.0.0.1 – standardmäßig wird localhost eingestellt. Geben Sie an dieser Stelle die IP-Adresse des Clients ein, der mit dem Datenbankserver kommuniziert (für Comarch DMS Archiv ist es der IIS-Server). Statt bindIp können Sie auch bindIpAll: true verwenden. Hierbei ist die Verbindung zum Datenbankserver für jeden Computer möglich.
- Im Abschnitt #security:
Durch diese Änderung wird das Anmelden für MongoDB mit Benutzernamen und Passwort möglich.
Nach dem Speichern der Konfigurationsdatei starten Sie den MongoDB-Server im Windows Task-Manager erneut, indem mit der rechten Maustaste auf die entsprechende Position geklickt wird und Neustart gewählt wird.
Zum Beispiel für einen Administrator:
mongodb://admin:Passwd1234@localhost/?authSource=admin
Zum Beispiel für den Benutzer MongoUser:
mongodb://MongoUser:Passwd1234@localhost/Repository?authSource=Repository [/su_spoiler]
Installation des MongoDB-Servers in Linux, Ubuntu-Distribution
Die Installation des MongoDB-Servers auf Ubuntu ist nach den Anweisungen des Herstellers durchzuführen: Install MongoDB Community Edition on Ubuntu — MongoDB Manual.
-
Änderungen in der Datei mongod.conf
Nach der erfolgreichen Installation des Servers sollen einige Änderungen in der Konfigurationsdatei vorgenommen werden:
- Die Konfigurationsdatei finden Sie unter /etc/mongod.conf
- Befehl zur Ausführung der Datei plik mongod.conf zum Bearbeiten: sudo gedit/etc/mongod.confÄndern Sie die Konfigurationsdatei wie folgt:
- Im Abschnitt #network interfaces:
port: 27017 – Standardport
bindIp: 127.0.0.1 – standardmäßig wird localhost eingestellt. Geben Sie an dieser Stelle die IP-Adresse des Clients ein, der mit dem Datenbankserver kommuniziert (für Comarch DMS Archiv ist es der IIS-Server). Statt bindIp können Sie auch bindIpAll: true verwenden. Hierbei ist die Verbindung zum Datebbankserver für jeden Computer möglich.
- Im Abschnitt #security:
-
Hinzufügen des MongoDB-Administrators und der Datenbank für das Comarch DMS Archiv vom Ubuntu-Terminal
In den folgenden Schritten erfolgt die Anmeldung für MongoDB vom Ubuntu-Terminal aus, Erstellung der Datenbank und Hinzufügen eines Operators, für den eine Verbindung der Repository-Anwendung zur Datenbank hergestellt wird.
Die Datenbank wird über die Eingabe des Befehls use Repository erstellt.
Bevor Sie den Benutzer erstellen, führen Sie den Befehl use admin aus. Im nächsten Schritt erstellen Sie einen Benutzer mit Administratorrechten für den Server (mit dem nachfolgenden Befehl wird der Benutzer admin erstellt, mit dem Kennwort Passwd1234 und der höchsten Stufe der Serverberechtigungen):
db.createUser(
{
user:”admin”,
pwd:”Passwd1234″,
roles:[{role:”root”,db:”admin”}]
}
)
- Anschließend fügen Sie einen Benutzer hinzu, für den eine Verbindung der Repository-Anwendung zur Datenbank hergestellt wird. Das Hinzufügen des Benutzers erfolgt über den Befehl:db.createUser(
{
user:”MongoUser”,
pwd:”Passwd1234″,
roles:[{role:”readWrite”,db:”Repository”}]
}
)
Erstellung und Wiederherstellung der Sicherungskopien von MongoDB
Die Backups der Datenbanken werden mit den Tools mongodump und mongorestore (Elementen von MongoDB Database Tools) erstellt und wiederhergestellt.
MongoDB Database Tools können Sie von der Seite des Herstellers herunterladen:
Download MongoDB Command Line Database Tools | MongoDB
Die zugehörige Dokumentation ist der Herstellerseite zu entnehmen: The MongoDB Database Tools Documentation — MongoDB Database Tools.
Konfiguration der Anwendung auf IIS-Server
Installation von Komponenten
Bevor Sie mit der Konfiguration der Archiv-App auf dem IIS-Server beginnen, installieren Sie die Komponenten URL Rewrite und ASP.NET Core 3.1 Runtime – Windows Hosting Bundle Installer. Die Komponenten sind für die ordnungsgemäße Funktion der Anwendung erforderlich. Sie können von den folgenden Seiten heruntergeladen werden:
Verschieben der Verzeichnisse DocumentManager.WebApi und DocumentManager.WebClient
Im nächsten Schritt der Konfiguration von Comarch DMS Archiv werden die Verzeichnisse DocumentManager.WebApi und DocumentManager.WebClient aus dem Installationspaket (heruntergeladen von den validierten Partnerseiten) in den Ordner C:\inetpub\wwwroot\.
Kataloge, je nach Version der Comarch DMS-Zusammenarbeit, befinden sich unter:
- Comarch DMS {Version } Standalone\ Comarch DMS {Version }\ DMS Repository\
- Comarch DMS {Version } CEE\ Comarch DMS {Version }\ DMS Repository\
- Comarch DMS {Version} XL\ Comarch DMS {Version}\ DMS Repository\
- Comarch DMS {Version} Optima\ Comarch DMS {Version}\ DMS Repository\
- Comarch DMS {Version} Altum\ Comarch DMS {Version}\ DMS Repository\
Kopieren Sie die Verzeichnisse in den Ordner: C:\inetpub\wwwroot\. Wurde Comarch DMS auf dem Server nicht installiert, sollen die Comarch DMS-Anwendungen Web und Desktop gemäß den unter https://hilfe.comarch.de/dms/ verfügbaren Anweisungen installiert werden.
Hinzufügen eines neuen Anwendungspools für Comarch DMS Archiv
Obwohl das Archiv als ein Modul von Comarch DMS fungiert, wird es als eine eigenständige Anwendung installiert. Das Modul Archiv erfordert die Erstellung eines separaten Anwendungspools. Aufgrund unterschiedlicher Eigenschaften kann derselbe Anwendungspool gleichzeitig für die Web-Anwendungen DMS und für Archiv nicht verwendet werden. Für das Modul soll ein separater Anwendungspool erstellt werden. Um einen neuen App-Pool hinzuzufügen, mit der rechten Maustaste auf die Kategorie App-Pools klicken und die Option App-Pool hinzufügen wählen.
- Anwendungspool für Archiv – es ist erforderlich, den Namen des Pools einzugeben (z. B. DMS_repository) und den Umgebungsversion .NET CLR als ‘Kein verwalteter Code‘ festlegen. Der verwaltete Flussmodus sollte auf Integriert eingestellt und die Option App-Pool sofort ausführen markiert sein.
- Anwendungspool für Dokumenten-Workflow – es ist erforderlich, den Namen des Pools einzugeben (z. B. DMS_workflow) und die .NET CLR-Umgebungsversion als .NET CLR v4.0 anzugeben. Der verwaltete Flussmodus sollte auf Integriert eingestellt und die Option App-Pool sofort ausführen markiert sein. Anschließend auf die Kategorie App-Pool, dann mit der rechten Maustaste auf den entsprechenden Pool klicken und Erweiterte Einstellungen wählen, wobei der Parameter „32-Bit-Apps aktivieren“ auf False gesetzt werden sollte.
Konvertieren von DocumentManager.WebApi- und DocumentManager.WebClient-Verzeichnissen in Anwendungen
Anwendungen für Archiv-Modul
Für das Archiv-Modul sind zwei Anwendung vorgesehen:
- DocumentManager.WebApi
- DocumentManager.WebClient
Die Ordner DocumentManager.WebApi und DocumentManager.WebClient sind im Manager der Internet Informationsdienste (IIS) sichtbar, nachdem die Webseite erweitert wird. Im Falle von beiden Ordnern, wenn diese mit der rechten Maustaste geklickt werden und die Option in eine App umwandeln gewählt wurde, sollte im Fenster Apps hinzufügen auf Auswählen geklickt werden und danach den App-Pool angeben, der dem Comarch DMS Archiv-Modul – DMS_repository – zugeordnet ist.
Konfiguration der Datei web.config für DMS
Bedienung des Archiv-Moduls und Funktionalität Dokumentmanager
Comarch DMS bietet wahlweise das Archiv-Modul oder die Funktionalität Dokumentmanager. Es ist nicht möglich, gleichzeitig das Archiv-Modul und den Dokumentmanager zu verwenden. Die Funktion Dokumentenmanager ist standardmäßig aktiviert.
Um das Archiv-Modul zu aktivieren, sind entsprechende Einträge der Schlüssel in der Datei web.config erforderlich:
- <add key=”UseRepository” value=”true” /> – Schlüssel zur Aktivierung des Archiv-Moduls, der Wert „false“ sollte durch „true“ ersetzt werden, der Wert false bedeutet, dass der Dokumentmanager aktiviert wird.
- <add key=”RepositoryUrl” value=”http://<Server-IP>/DocumentManager.WebApi” /> – Schlüssel, in dem die URL von DocumentManager.WebApi eingegeben werden soll, z. B.
http://localhost/DocumentManager.WebApi
- <add key=”RepositoryClientUrl” value=”http://<Server-IP>/DocumentManager.WebClient” /> – Schlüssel, in dem die URL von DocumentManager.WebClient eingegeben werden soll, z. B.
http://localhost/DocumentManager.WebClient
Änderungen an appsettings.json, der Serverkonfigurationsdatei
Im nächsten Schritt sind einige Änderungen in der Konfigurationsdatei appsettings.json im Verzeichnis DocumentManager.WebApi vorzunehmen:
appsettings.json ist eine Konfigurationsdatei, die folgende Informationen enthält:
- „IdentityMongoDatabaseSettings” – connection string für Archiv-Datenbank, die Benutzerkonten enthält
- „ApplicationMongoDatabaseSettings” – connection string für Archiv-Datenbank, die Anwendungsdaten enthält. Zum Beispiel:
„mongodb://MongoUser:Passwd1234@localhost:27017/Repository?authSource=Repository”
- ”StorageSettings” – Einstellungen der Datenbank, in der Dateien abgelegt sind:
„Type” – bestimmt den Standard-Speicherort für die zum Archiv hinzugefügten Dateien. Mögliche Werte:
„IBard” – die zum Archiv hinzugefügten Dateien werden im Dienst Comarch IBARD gespeichert
„Mongo” – die zum Archiv hinzugefügten Dateien werden in der Datenbank MongoDB gespeichert
- ”IBARDStorageSettings” – Konfiguration bei der Auswahl der IBARD-Datenbank – Datenbank mit den für IBRAD erforderlichen Daten
„ConnectionString” – connection string für Datenbank mit Konfiguration der Zusammenarbeit mit IBARD (enthält dieselbe Information, die in der vorigen Version unter IBARDMongoDatabaseSettings gespeichert wurde).
- ”MongoStorageSettings” – Konfiguration bei der Auswahl der MongoDB-Datenbank – Datenbank mit binären Dateien
”ConnectionString” – connection string für Datenbank, in der die zum Archiv hinzugefügten Dateien gespeichert werden
- ”ChunkSizeBytes” – der Schlüssel gilt nur für die in MongoDB gespeicherten Dateien und bestimmt die Maximalgröße des einzelnen Teils der zur Datenbank hinzuzufügenden Datei. Die Größe wird in Bytes angegeben. Wenn die Größe der hinzuzufügenden Datei die in ChunkSizeBytes angegebene Größe überschreitet, wird die Datei in entsprechend viele Teile gesplittet – die Anzahl der Splittdateien entspricht der Anzahl der hochzuladenden Dateien, deren maximale Größe von ChunkSizeBytes bestimmt wird, und ggf. noch eine Datei im Falle der Division mit Rest.
Wenn das Archiv einen einzelnen Dateispeicher verwendet, d.h. alle zum Archiv hinzugefügten Dateien werden ausschließlich in IBARD abgelegt, müssen die Positionen StorageSettings”, „ConnectionString”, „ChunkSizeBytes” im Abschnitt „StorageSettings” in der Konfigurationsdatei gelöscht werden. Nachfolgend wird eine exemplarische Konfigurationsdatei abgebildet, für die alle Dateien im Dienst Comarch IBARD gespeichert werden.
Wenn das Archiv einen einzelnen Dateispeicher verwendet, d.h. alle zum Archiv hinzugefügten Dateien werden ausschließlich in MongoDB abgelegt, müssen die Positionen „IbardStorageSettings” und „ConnectionString” im Abschnitt „StorageSettings” in der Konfigurationsdatei gelöscht werden. Nachfolgend wird eine exemplarische Konfigurationsdatei abgebildet, für die alle Dateien in MongoDB gespeichert werden.
Wird der Speicherort der Dateien während der Arbeit mit Archiv von IBARD auf MongoDB geändert, können sowohl die in IBARD als auch die in MongoDB gespeicherten Dateien in der Anwendung verwendet werden. Die Voraussetzung für die Verwendung der IBARD- und MongoDB-Dateien ist eine entsprechende Konfiguration der Datei appsettings.json, d.h. Einstellung des Connection Strings für die Datenbank, in der die Konfiguration der Zusammenarbeit mit IBARD gespeichert ist, im Schlüssel IBARDStorageSettings und für die MongoDB – im Schlüssel MongoStorageSettings.
Nach der Eingabe der Connection Strings in der Datei appsettings.json für die Schlüsseln IBARDStorageSettings und MongoStorageSettings werden die zum Archiv hinzugefügten Dateien standardmäßig an dem mit dem Parameter Type im Abschnitt StorageSettings festgelegten Speicherort abgelegt.
Wenn die zum Archiv hinzugefügten Dateien im IBRD-Dienst gespeichert werden sollen, ist die Anmeldung bei IBARD in der Desktop-Anwendung Comarch DMS – Tab Dateiaufbewahrung im Abschnitt Repository des Fensters Einstellungen in der Comarch DMS-Desktop-App, wo man auf die Schaltfläche Autorisierung klicken, den Benutzernamen und das Kennwort für das IBARD-Konto eingeben und auf Einloggen klicken muss.
In der Datei appsettings.json sollte Folgendes ergänzt werden:
- „DocumentWorkflowSettings“ – DMS-Einstellungen
„ServerUrl”: – Adresse der App-Webseite, z. B. http://<serverIP>/<App_Name>
- „AllowedOrigins“: – Adresse der Comarch DMS Archiv Webseite, z.B. http://<IP server>
Die nachfolgenden Einstellungen können entsprechend angepasst werden.
- „JWTSettings” – Einstellungen für JSON Web Tokens, Benutzerautorisierung innerhalb Repository
„Key” – Verschlüsselungsschlüssel
„Issuer”: „CoreIdentity”,
„Audience”: „CoreIdentityUser”,
„DurationInMinutes”: 60 – Ablaufzeit des Autorisierungstokens, ausgedrückt in Minuten
- „Serilog” – Framework für Protokollierung der Anwendungsaktivitäten
„MinimumLevel” – Präzisionsebene des Protokolls
„Default”: „Information”, – Standardebene
„Override” – detaillierte Protokoll-Einstellungen für Microsoft- und Systempakete, Speicherung von Informationen auf der Warnstufe und höher, d.h. error, fatal error.
- „Enrich”: [ „FromLogContext”, „WithMachineName”, „WithProcessId”, „WithThreadId” ] – Schema der Protokolleinträge
„WriteTo” – Protokolldefinition
„Name”: „Console” – Protokolle für Konsole
„Name”: „File” – Protokolle für txt-Datei
„path”: „C:\\temp\\repository.txt” – Speicherort der Protokolle
„outputTemplate”: „{Timestamp:G} {Message}{NewLine:1}{Exception:1}” – Format der Protokolle
„Name”: „File” – Protokolle für json-Datei
„path”: „C:\\temp\\repository.json” – Speicherort der Protokolle
„formatter”: „Serilog.Formatting.Json.JsonFormatter, Serilog”
Nach der Eingabe der Daten speichern Sie die Datei appsettings.json und anschließend starten Sie die zuvor angehaltene Website oder den IIS-Server erneut.
Aktivieren des WebSocket-Protokolls
Ab Version 2022.0.1 ist es notwendig, das WeSocket-Protokoll zu aktivieren, um dies zu tun, gehen Sie folgendermaßen vor:
- im Suchfeld neben der Schaltfläche „Start“ den Ausdruck „Windows-Features aktivieren oder deaktivieren“ eingeben und auf „Öffnen“ klicken
Dann im geöffneten Fenster zum Ordner „Internetinformationsdienste“ gehen, dann zu „WWW-Dienste“, danach zu „Anwendungsentwicklungsfeatures“, das Kontrollkästchen neben dem Ordner „WebSocket-Protokoll“ aktivieren und auf die Schaltfläche klicken.
Daraufhin wird das Fenster Windows-Features geöffnet und das System speichert die vorgenommenen Änderungen.
Wenn die Änderungen gespeichert sind, werden Informationen darüber im Fenster angezeigt. Sie sollten das Fenster dann schließen, indem Sie auf die Schaltfläche klicken.
Dann den Internetinformationsdienste-Manager (IIS) öffnen und im mittleren Teil des Fensters, im Abschnitt Verwaltungskonsole auf das Symbol Konfigurations-Editor klicken und dann die Option Feature öffnen im oberen rechten Teil des Panels Aktionen wählen.
Nach Auswahl der Option Feature öffnen in der Mitte des Managers erscheint der Konfigurations-Editor. Im Feld Abschnitt in der Dropdown-Liste nach der Sektionsystem.webServer/webSocket suchen und dann für das Feld enabled den Wert True auswählen. Um die Änderungen zu speichern, dann die Option Übernehmen im Panel Aktionen auf der rechten Seite des Managers wählen.
IIS muss später neu gestartet werden, indem im Panel Aktionen im Rahmen des IIS-Managers die Option Neu starten ausgewählt wird.
Nach der oben beschriebenen Installation Weitere Informationen zur Konfiguration von Comarch DMS Archiv finden Sie in diesem Artikel: Konfiguration des Archiv-Moduls für den Administrator – Comarch DMS-Wissensdatenbank .