Zalecane przeglądarki

Do pracy z modułem zalecane są przeglądarki:

Porty, które powinny zostać otwarte dla Comarch DMS

Zalecana konfiguracja sprzętowa serwera IIS

Wymagany sprzęt – zalecenia minimalne:

Zapewnienie możliwości rozbudowy:

Wymagane oprogramowanie serwera IIS

System operacyjny (jedna z poniższych możliwości):

Dodatkowe wymagania:

Wymagane licencje na oprogramowanie dla serwera IIS

Licencja na system operacyjny

Jeden z dostępnych rodzajów licencji:

Licencje klienckie (dostępowe) do serwera SQL

Liczba wymaganych licencji dostępowych powinna odpowiadać ilości użytkowników lub urządzeń posiadających dostęp do serwera IIS (logujących się do Comarch DMS). W związku z tym, w niektórych przypadkach bardziej korzystnym rozwiązaniem może okazać się zakup licencji „per Core”.

Wymagane licencje:

Ograniczenia i uwagi

Zalecana konfiguracja sprzętowa serwera SQL

Zalecaną konfiguracją współpracy Comarch DMS z serwerem MS SQL jest użycie serwera MS SQL przygotowanego dla ERP XL. W przypadku konfiguracji „Standalone” lub konfiguracji z wykorzystaniem dwóch serwerów MS SQL, zalecane wymagania sprzętowe zostały przedstawione poniżej.

Wymagany sprzęt – zalecenia minimalne:

Wymagane oprogramowanie SQL

System operacyjny:

Baza danych:

Licencje:

Zalecana konfiguracja sprzętowa serwera MongoDB

(jeśli Comarch DMS ma aktywną współpracę z modułem Comarch DMS Repozytorium – zob. Comarch DMS – Repozytorium)

Wymagane oprogramowanie

(jeśli Comarch DMS ma aktywną współpracę z modułem Comarch DMS Repozytorium – zob. Comarch DMS – Repozytorium)

System operacyjny:

Baza danych:

MongoDB Community version

Licencje:

Konieczny jest zakup licencji na: system operacyjny, licencji CAL systemu operacyjnego w przypadku
systemu Windows.

Rozwiązanie dedykowane pod jeden serwer MongoDB, zalecana ilość dokumentów to 6 mln.

Obciążenie serwera uruchomioną aplikacją DMS w sesji terminalowej.

Obciążenie na jedną sesje terminalową z uruchomioną aplikacją Comarch DMS:

Konfiguracja sprzętowa dla stacji roboczej

Wymagany sprzęt – zalecenia minimalne:

Wymagane oprogramowanie dla stacji roboczej

System operacyjny:

.Net Framework:

Wydajność systemu Comarch DMS

Wydajność Comarch DMS zależy w znacznym stopniu od złożoności realizowanych procesów, tj. od liczby kontrolek zdefiniowanych na karcie obiegu, wykorzystania mechanizmów inicjowania wartości kontrolek skryptami SQL i C# oraz od liczby kolumn zdefiniowanych na liście dokumentów.

Celem modułu Repozytorium jest przechowywanie dokumentów w formie plików w ramach kreowanej przez administratorów i (częściowo) edytorów struktury folderów.

Dostęp danego pracownika do danego folderu  lub pliku zależy od tego, czy zostały mu do niego przyznane uprawnienia.  W ramach modułu Repozytorium widoczne są dla użytkownika tylko te foldery i pliki, do których przyznał mu dostęp użytkownik o uprawnieniach administratora (Repozytorium lub lokalnego).

W module Repozytorium można przechowywać:

W bieżącej wersji wymagane jest, żeby użytkownik, który korzysta z modułu Repozytorium, posiadał licencję umożliwiającą pracę z tym modułem.

Weryfikacja licencji na moduł Repozytorium będzie następowała za każdym razem, kiedy wykorzystywane będą dane Repozytorium.

Jeżeli użytkownik będzie próbował korzystać z funkcjonalności modułu Repozytorium, choć nie posiada licencji na korzystanie z tego modułu, wyświetlony zostanie komunikat informujący o zaistniałym problemie.

Bez licencji na pracę z modułem Repozytorium nie jest możliwe:

Moduł Repozytorium jest dostępny zarówno dla Comarch DMS Standalone, jak i dla wszystkich form współpracy: z Comarch ERP XL, Comarch ERP Optima, Comarch ERP Altum i  Comarch ERP Enterprise (CEE).

Uwaga

Od wersji 2023.1.0 aby możliwa była poprawna współpraca z modułem Repozytorium należy kolejno:

1. zainstalować dodatek Application Request Routing, dostępny pod następującym adresem:

https://www.iis.net/downloads/microsoft/application-request-routing

2. w ramach Menedżera Internetowych usług Internetowych  kliknąć na ikonę „Application Request Routing Cache”

3. w ramach panelu „Akcje” po prawej stronie ekranu nacisnąć link „Otwórz funkcje”.

 

 

4.  zaznaczyć parametr „Enable proxy” w ramach zakładki „Application Request Routing” i potwierdzić zmianę przyciskiem „Zastosuj”.

 

System Comarch DMS składa się z modułów:

Aby umożliwić działanie modułu Workflow i modułu Repozytorium, niezbędne  jest zainstalowanie trzech odrębnych aplikacji na serwerze IIS, z których dwie służą potrzebom modułu Comarch DMS Workflow (Obieg Dokumentów) i jedna tworzy moduł Comarch DMS Repozytorium.

Instalacja serwera MongoDB w systemie Windows

W celu pobrania instalatora serwera MongoDB należy wejść na stronę https://www.mongodb.com/, następnie wybrać zakładkę „Products”, później „Community Edition”, następnie „MongoDB Community Server”, nacisnąć zielony przycisk „Select package”, wybrać wersję MongoDB w polu „Version”, a następnie nacisnąć zielony przycisk „Download” (bezpośredni link do „MongoDB Community Server”: MongoDB Community Download | MongoDB).

Proces instalacji przedstawiony poniżej to skrócona wersja instalacji – przy założeniu, że na tej samej maszynie, gdzie Mongo DB jest uruchamiany, zainstalowana jest też baza.

Z pełnym procesem instalacji środowiska MongoDB można zapoznać się w instrukcji producenta pod adresem Install MongoDB Community Edition on Windows — MongoDB Manual.

1. Po pobraniu pliku instalacyjnego należy go otworzyć. Wówczas na ekranie pojawia się okno instalatora Mongo DB, gdzie powinno się kliknąć „Next”.

2. Następnie należy wyrazić zgodę na umowę licencyjną, zaznaczając checkbox i kliknąć „Next”.

3. Kolejnym krokiem jest wybór typu instalacji – należy wybrać opcję „Complete”.

4. Następnie należy w oknie konfiguracji usługi wybrać checkbox „Run service as Network Service user”.

5. W kolejnym oknie instalacyjnym zaznacza się parametr „Install Mongo DB Compass”.

Mongo DB Compass to aplikacja, która służy do przeglądania bazy danych, analogicznie do SSMS dla SQL Server. Po wyborze przycisku „Next” następuje przejście do kolejnego okna.

6. Następnie należy kliknąć „Install”.

7. Na zakończenie instalacji należy kliknąć przycisk „Finish”.

Po ukończeniu instalacji konieczne jest upewnienie się, czy usługa MongoDB jest uruchomiona. Można to sprawdzić wchodząc do Menedżera zadań systemu Windows, wybierając zakładkę Usługi  i znajdując pozycję Mongo DB, dla której w polu „Stan” powinno wyświetlać się „Uruchomiony”.

Dodawanie administratora MongoDB i bazy danych dla Comarch DMS Repozytorium za pomocą MongoDB Compass

Po instalacji na MongoDB należy uruchomić MongoDB Compass. Jeśli Mongo DB zostało zainstalowane lokalnie, wówczas nie ma konieczności uzupełniania connection stringa – wystarczy nacisnąć „Connect”, aby zalogować się do serwera.

Kiedy zalogowano się do serwera Mongo DB, wówczas:

1. należy utworzyć użytkownika o uprawnieniach administratora na serwerze – w poniższym przykładzie taki użytkownik to admin, zaś jego hasło to Passwd1234. Posiada najwyższy poziom uprawnień na serwerze.

Aby utworzyć użytkownika należy:

db.createUser(
{
user:"admin",
pwd:"Passwd1234",
roles:[{role:"root",db:"admin"}] }
)

2. Następnie należy utworzyć bazę danych dla Comarch DMS Repozytorium i dodać użytkownika, dla którego będzie następowało łączenie się aplikacji Comarch DMS Repozytorium z bazą danych. W tym celu konieczne jest, aby:

db.createUser(
{
user:"MongoUser",
pwd:"Passwd1234",
roles:[{role:"readWrite",db:"Repository"}] }
)

Po wykonaniu powyższych czynności Mongo DB Compass może zostać zamknięty.

Wprowadzanie zmian w pliku mongod.cfg

Następnie należy  dokonać edycji  pliku konfiguracyjnego mongod.cfg.

Plik znajduje się w lokalizacji:

<install directory>\bin\mongod.cfg

domyślnie lokalizacja to: C:\Program Files\MongoDB\Server\<wersja>\bin\mongod.cfg

Zmiany, których należy dokonać w pliku mongod.cfg:

Dzięki tej zmianie możliwe będzie logowanie do bazy MongoDB przy użyciu loginu i hasła.

Następnie należy zapisać plik i uruchomić ponownie serwer MongoDB w Menedżerze zadań Windows, klikając na niego prawym przyciskiem myszy i naciskając „Uruchom ponownie”.

Instalacja serwera MongoDB w systemie Linux, dystrybucja Ubuntu

Instalacja serwera MongoDB na Ubuntu powinna zostać przeprowadzona według instrukcji producenta, do której można przejść za pomocą następującego linku: Install MongoDB Community Edition on Ubuntu — MongoDB Manual.

Wprowadzanie zmian w pliku mongod.conf

Kiedy zainstalowano serwer, kolejnym krokiem jest wprowadzenie zmian w pliku konfiguracyjnym mongod.conf, dostępnym w lokalizacji: /etc/mongod.conf. Polecenie, które uruchamia plik mongod.conf do edycji, to:

sudo gedit/etc/mongod.conf

Zmiany, których należy dokonać w pliku mongod.conf:

1. w sekcji #network interfaces:

Dzięki tej zmianie możliwe będzie logowanie do bazy MongoDB przy użyciu loginu i hasła.

Po zapisaniu wprowadzonych zmian należy ponownie uruchomić serwer MongoDB, przykładowo używając poniższej komendy:

sudo systemctl restart mongod

Dodawanie administratora MongoDB i bazy danych dla Comarch DMS Repozytorium z poziomu terminala w Ubuntu

Następnie należy zalogować się do MongoDB z poziomu terminala w Ubuntu,  a później utworzyć bazę danych i dodać operatora, dla którego nastąpi łączenie się Comarch DMS Repozytorium z bazą danych.

Aby utworzyć bazę, powinna zostać wpisana komenda: use Repository.

W dalszej kolejności należy utworzyć użytkownika, zaczynając od wpisania komendy use admin.

Później konieczne jest wprowadzenie polecenia, które utworzy użytkownika o uprawnieniach administratora na serwerze – w poniższym przykładzie taki użytkownik to admin, zaś jego hasło to Passwd1234. Posiada najwyższy poziom uprawnień na serwerze:

db.createUser(
{
user:"admin",
pwd:"Passwd1234",
roles:[{role:"root",db:"admin"}]
}
)

Następnie należy dodać użytkownika, dla którego będzie następowało łączenie się aplikacji Comarch DMS Repozytorium z bazą danych. W tym celu konieczne jest wprowadzenie następującego polecenia:

db.createUser(
{
user:"MongoUser",
pwd:"Passwd1234",
roles:[{role:"readWrite",db:"Repository"}]
}
)

Tworzenie i odtwarzanie backupów bazy danych MongoDB

Backupy baz danych Mongo DB mogą być tworzone i odtwarzane za pomocą narzędzi mongodump oraz mongorestore, które należą do MongoDB Database Tools. Można je pobrać ze strony producenta:

Download MongoDB Command Line Database Tools | MongoDB

Z dokumentacją dotyczącą narzędzi do tworzenia i odtwarzania baz MongoDB można się zapoznać na stronie producenta: The MongoDB Database Tools Documentation — MongoDB Database Tools.

Konfiguracja aplikacji na serwerze IIS

Instalacja komponentów

Zanim rozpocznie się konfigurację aplikacji Comarch DMS na serwerze IIS, konieczne jest zainstalowanie dwóch komponentów, niezbędnych do poprawnego działania aplikacji:

Przenoszenie katalogu DMS Repository Api 

Jeżeli na serwerze nie jest zainstalowany Comarch DMS, konieczna jest instalacja aplikacji Comarch DMS serwerowej, WEB  i desktop według instrukcji znajdującej się na stronie https://pomoc.comarch.pl/dms/ po wejściu do kategorii wybranej współpracy, w rozdziale Instalacja i konfiguracja.

Następnie należy z pakietu instalacyjnego z lokalizacji Comarch DMS {wersja} \ Comarch DMS {wersja} skopiować zawartość katalogu DMS Repository Api do folderu w lokalizacji C:\inetpub\wwwroot, np. do katalogu DocumentManager.WebApi.

Dodawanie nowej puli aplikacji dla Comarch DMS Repozytorium

Comarch DMS Repozytorium jest modułem Comarch DMS, jednak musi zostać zainstalowany jako osobna aplikacja na serwerze IIS i wymaga osobnej puli aplikacji.

Dla puli aplikacji dedykowanej modułowi Comarch DMS Repozytorium konieczne jest określenie wersji środowiska .NET CLR jako ’Bez kodu zarządzanego’.

Dla puli aplikacji dedykowanej modułowi Comarch DMS Workflow (Obieg Dokumentów) konieczne jest określenie wersji środowiska .NET CLR jako .NET CLR v4.0.

Następnie należy nacisnąć opcję „Ustawienia zaawansowane„, dostępną do wyboru po kliknięciu na „Pule aplikacji„, a następnie naciśnięciu nazwy odpowiedniej puli prawym przyciskiem myszy. Można też, alternatywnie,  kliknąć nazwę puli i wybrać opcję z paska „Akcje” po prawej stronie ekranu.

W ramach „Ustawień zaawansowanych” konieczne jest ustawienie parametru ’Włącz aplikacje 32-bitowe’ na False.

Konwertowanie katalogu DocumentManager.WebApi na aplikację

1. W kolejnym kroku należy  w ramach Menedżera IIS nacisnąć prawym przyciskiem myszy folder DocumentManager.WebApi i wybrać opcję „Konwertuj na aplikację„.

2. Następnie otworzy się okno „Dodawanie aplikacji„, w którym należy nacisnąć opcję „Wybierz„, wybrać pulę aplikacji dedykowaną Comarch DMS Repozytorium – w poniższym przykładzie jest to pula „DMS_repository” –  i nacisnąć „Ok„.

Konfiguracja pliku web.config aplikacji Comarch DMS

W ramach Comarch DMS można korzystać z Managera dokumentów lub z modułu Repozytorium, nie jest jednak możliwe jednoczesne korzystanie z obydwóch opcji.

Domyślnie włączony jest Manager dokumentów, dlatego aby włączyć obsługę modułu Comarch DMS Repozytorium, w kluczu Web.config, dostępnym w folderze z aplikacją serwerową (dawną web) Comarch DMS  należy uzupełnić 3 następujące klucze:

Wprowadzone zmiany należy zapisać.

Wskazówka

Adres URL aplikacji DocumentManager.WebApi  można sprawdzić, klikając w daną aplikację w Menedżerze internetowych usług informacyjnych (IIS) i naciskając opcję „Przeglądaj *:80 (http)” w panelu ” Zarządzaj aplikacją” po prawej stronie ekranu.

Adres strony widoczny w otwartym oknie przeglądarki to adres danej aplikacji.

 

Wprowadzanie zmian w appsettings.json, pliku konfiguracyjnym serwera

Następnie konieczne jest wejście do katalogu z aplikacją Repozytorium (np. DocumentManager.WebApi), dostępnym domyślnie w lokalizacji C:\inetpub\wwwroot\ , a następnie edycja znajdującego się tam pliku konfiguracyjnego appsettings.json , w którym należy uzupełnić poniższe informacje:

1. „IdentityMongoDatabaseSettings” – connection string do bazy Comarch DMS Repozytorium, która zawiera konta użytkowników.

2. „ApplicationMongoDatabaseSettings” – connection string do bazy Comarch DMS Repozytorium, która zawiera dane aplikacji.

Przykładowo:

„mongodb://MongoUser:Passwd1234@localhost:27017/Repository?authSource=Repository”

3. „DocumentWorkflowSettings” – adres serwera DMS.

Przykładowo:

„http://localhost/Standalone”

4.  ”StorageSettings” – ustawienia bazy, która przechowuje pliki

„Type” – właściwość, która określa domyślne miejsce przechowywania plików  dodawanych do Comarch DMS  Repozytorium. Może przyjmować wartości:

”IBARDStorageSettings” – parametr uzupełniany, jeśli wybrano bazę IBARD, baza danych, która przechowuje dane wymagane dla IBARD

„ConnectionString” – connection string do bazy z konfiguracją współpracy z IBARD – znajduje się tu ta sama informacja, która w wersji poprzedniej była w IBARDMongoDatabase Settings

Uwaga

W przypadku przechowywania plików z Repozytorium w usłudze IBARD po uzupełnieniu „Connection String” w „IBARDStorageSettings” konieczne jest zalogowanie  do usługi IBARD w sekcji „Przechowywanie plików” w zakładce „Ustawienia” w aplikacji desktop Comarch DMS, klikając przycisk „Autoryzacja„.

 

”MongoStorageSettings” – parametr uzupełniany, jeśli wybrano bazę MongoDB, baza danych, która przechowuje pliki binarne.

W tym parametrze należy uzupełnić „ConnectionString” do  bazy, która będzie służyć do przechowywania plików dodawanych do Comarch DMS Repozytorium.

Drugi klucz, ”ChunkSizeBytes”, dotyczy tylko plików przechowywanych w bazie MongoDB, definiuje maksymalny rozmiar pojedynczej części pliku (w bajtach), który jest dodawany do bazy.

Możliwa jest również sytuacja, w której podczas pracy z Comarch DMS Repozytorium zostało zmienione miejsce przechowywania plików z usługi IBARD na bazę MongoDB – wtedy możliwe jest korzystanie z plików przechowywanych zarówno w IBARD, jak i w MongoDB. Warunkiem jest uzupełnienie „Connection String”  w kluczu „IBARDStorageSettings” (tak, żeby następowało połączenie z bazą, która przechowuje konfigurację współpracy z IBARD) oraz „Connection String”  w kluczu „MongoStorageSettings” (tak, żeby następowało połączenie z bazą, która przechowuje pliki). Przy takim uzupełnieniu connection stringów domyślnie pliki, które zostaną dodane do Comarch DMS Repozytorium, będą zapisane zgodnie z lokalizacją, którą określono w parametrze Type w sekcji Storage Settings. 

5.  „AllowedOrigins” – adres witryny Comarch DMS Repozytorium, przykładowo http://<IP serwera>[/su_list]

Powyższe ustawienia są niezbędne do właściwej konfiguracji pliku. Poniższe ustawienia natomiast można zmienić opcjonalnie:

Włączenie protokołu WebSocket

Od wersji 2022.0.1 konieczne jest włączenie protokołu WebSocket. W tym celu należy wykonać następujące kroki:

1.  w ramach pola wyszukiwania przy przycisku „Start” wpisać frazę „Włącz lub wyłącz funkcje systemu Windows” i kliknąć „Otwórz”

2. Następnie w oknie, które zostało otwarte, należy rozwinąć zawartość folderu „Internetowe usługi informacyjne”, później „Usługi WWW”, potem „Funkcje tworzenia aplikacji”, zaznaczyć checkbox przy folderze „Protokół WebSocket” i kliknąć przycisk .

Zostanie wówczas otwarte okno Funkcje systemu Windows, w ramach którego system dokona zapisu wprowadzonych zmian.

Gdy zmiany zostaną zapisane, informacja o tym zostanie wyświetlona w ramach okna. Należy wówczas zamknąć okno, klikając na przycisk .

3. Następnie należy otworzyć Menadżer Internetowych Usług Internetowych (IIS) i w środkowej części okna, w sekcji Zarządzanie kliknąć na ikonę Edytor konfiguracji, a następnie wybrać opcję Otwórz funkcję, znajdującą się po prawej stronie, w górnej części panelu Akcje.

4. Po wyborze opcji Otwórz funkcję w środkowej części Menedżera zostanie wyświetlony Edytor konfiguracji.

W polu Sekcja należy wyszukać na rozwijalnej liście sekcję system.webServer/webSocket, a następnie wybrać dla pola enabled wartość True. Następnie aby zapisać zmiany, wybierz opcję Zastosuj dostępną w ramach panelu Akcje po prawej stronie Menedżera.

5. Później należy ponownie uruchomić IIS, wybierając opcję Uruchom ponownie na panelu Akcje w ramach Menedżera IIS.

Dalsza konfiguracja Comarch DMS Repozytorium zostala opisana w artykulłach:  Konfiguracja aplikacji WEB (nowej aplikacji web) do współpracy z modułem Repozytorium oraz Repozytorium – konfiguracja początkowa dla administratora

Aby skonfigurować aplikację WEB (nową aplikację web dostępną od wersji 2024.0.0) do współpracy z modułem Repozytorium, administrator powinien:

1. W ramach katalogu zawierającego aplikację serwerową Comarch DMS (starą aplikację webową) otworzyć do edycji plik Web.config, a następnie:

<add key=”WebClientUrl” value=”http://localhost/DMSWeb” />

a następnie zapisać wprowadzone zmiany;

2. W ramach katalogu zawierającego aplikację web (nową aplikację webową) otworzyć do edycji plik web.config i uzupełnić:

Dla aplikacji Comarch DMS od wersji 2023.1.0 możliwe jest skonfigurowanie drugiej aplikacji Comarch DMS Repozytorium dla drugiej aplikacji Comarch DMS.

Przykład:

Użytkownik zainstalował dwie aplikacje Comarch DMS w następujący sposób:

Użytkownik zainstalował również dwie aplikacje Comarch DMS Repozytorium w następujący sposób:

Użytkownik utworzył również w MongoDB 2 bazy dla Comarch DMS Repozytorium:

Użytkownik chciałby, aby:

W tym celu należy wykonać następujące kroki:

Konfiguracja aplikacji DocumentWorkflow.Web.1, NewWorkflow.1 i aplikacji Repozytorium 1

1. W pliku web.config w folderze DocumentWorkflow.Web.1 należy uzupełnić klucze dotyczące konfiguracji pracy z Repozytorium 1 w następujący sposób:

<add key=”UseRepository” value=”true” />

<add key=”RepositoryUrl” value=”http://localhost/Repository.1″ />

<add key=”WebClientUrl” value=”http://localhost/ NewWorkflow.1” />

i zapisać zmiany.

2. Następnie należy dodać pulę aplikacji dms_repository dla aplikacji Repozytorium 1.

Dla puli aplikacji dedykowanej modułowi Comarch DMS Repozytorium konieczne jest określenie wersji środowiska .NET CLR jako ’Bez kodu zarządzanego’.

3. Następnie należy w ramach Menedżera IIS nacisnąć prawym przyciskiem myszy folder Repository.1 i wybrać opcję „Konwertuj na aplikację„.

Następnie otwiera się okno „Dodawanie aplikacji”, w którym należy nacisnąć opcję „Wybierz”, wybrać pulę aplikacji dedykowaną Comarch DMS Repozytorium – w tym przypadku jest to pula „dms_repository” – i nacisnąć „Ok”.

4. Następnie należy wejść do katalogu Repository.1 i otworzyć do edycji plik konfiguracyjny appsettings.json, gdzie konieczne jest uzupełnienie wszystkich connection string w następujący sposób:

„mongodb://MongoUser1:Passwd1234@localhost/Repository1?authSource=Repository1”,

Należy uzupełnić także informację w „StorageSettings” zgodnie z opisem w punkcie Plik konfiguracyjny serwera w artykule Repozytorium – instalacja dla administratora.

W polu „DocumentWorkflowSettings” i „AllowedOrigins” natomiast należy uzupełnić adres serwera jako „http://localhost/DocumentWorkflow.Web.1”.

Następnie należy zapisać wprowadzone zmiany.

5. Następnie należy otworzyc do edycji plik web.config, który znajduje się w folderze NewWorkflow.1,  i uzupełnić w następujący sposób:

<action type=”Rewrite” url=http://nazwa serwera/Repository.1/api/{R:1}
<action type=”Rewrite” url=http://nazwa serwera/Repository.1/hubs/{R:1}

a następnie zapisać zmiany.

6. Pierwsza aplikacja Comarch DMS Repozytorium, Repozytorium 1, jest gotowa do działania po włączeniu protokołu Websocket (zob. Repozytorium – instalacja dla administratora) i po wykonaniu początkowej konfiguracji (zob. Repozytorium – konfiguracja początkowa dla administratora).

Konfiguracja aplikacji DocumentWorkflow.Web.2, NewWorkflow.2 i aplikacji Repozytorium 2

1. W pliku web.config w folderze DocumentWorkflow.Web.2 należy uzupełnić klucze dotyczące konfiguracji pracy z Repozytorium 2 w następujący sposób:

<add key=”UseRepository” value=”true” />

<add key=”RepositoryUrl” value=”http://localhost/Repository.2” />

<add key=”WebClientUrl” value=„http://localhost/NewWorkflow.2” />

2. Następnie należy dodać pulę aplikacji dms_repository2 dla aplikacji Repozytorium 2.

Dla puli aplikacji dedykowanej modułowi Comarch DMS Repozytorium konieczne jest określenie wersji środowiska .NET CLR jako ’Bez kodu zarządzanego’.

3. Następnie należy w ramach Menedżera IIS nacisnąć prawym przyciskiem myszy folder Repository.2 i wybrać opcję „Konwertuj na aplikację„.

Następnie otworzy się okno „Dodawanie aplikacji”, w którym należy nacisnąć opcję „Wybierz”, wybrać pulę aplikacji dedykowaną Comarch DMS Repozytorium – w tym przypadku jest to pula „dms_repository2” – i nacisnąć „Ok”.

4. Następnie należy wejść do katalogu Repository.2 i otworzyć do edycji plik konfiguracyjny appsettings.json, gdzie konieczne jest uzupełnienie wszystkich connection string w następujący sposób:

„mongodb://MongoUser2:Passwd5678@localhost/Repository2?authSource=Repository2”

Należy również uzupełnić informację w „StorageSettings”, zgodnie z opisem w punkcie Plik konfiguracyjny serwera.

W polu „DocumentWorkflowSettings” i „AllowedOrigins” natomiast należy uzupełnić adres serwera jako „http://localhost/DocumentWorkflow.Web.2”.

Następnie należy zapisać wprowadzone zmiany.

5. Następnie należy otworzyć do edycji plik web.config, który znajduje się w folderze NewWorkflow.2, i uzupełnić w następujący sposób:

<action type=”Rewrite” url=http://nazwa serwera/Repository.2/api/{R:1}
<action type=”Rewrite” url=http://nazwa serwera/Repository.2/hubs/{R:1}

a następnie zapisać zmiany.

6. Druga aplikacja Comarch DMS Repozytorium, Repozytorium 2, jest gotowa do działania po wykonaniu początkowej konfiguracji (zob. Repozytorium – konfiguracja początkowa dla administratora).

Korzystanie z dwóch aplikacji Comarch DMS Repozytorium

Po odpowiednim skonfigurowaniu dwóch aplikacji Comarch DMS Repozytorium (zob. punkty Konfiguracja aplikacji DocumentWorkflow.Web.1 i aplikacji Repozytorium 1 i Konfiguracja aplikacji DocumentWorkflow.Web.2 i aplikacji Repozytorium 2) oraz po włączeniu protokołu WebSocket (zob. Repozytorium – instalacja dla administratora), a także po wykonaniu początkowej konfiguracji (zob. Repozytorium – konfiguracja początkowa dla administratora)  można korzystać z odrębnego modułu Repozytorium w każdej z dwóch aplikacji Comarch DMS.

Backupy baz danych Mongo DB mogą być tworzone i odtwarzane za pomocą narzędzi mongodump oraz mongorestore, które należą do MongoDB Database Tools.

Backup bazy danych MongoDB w systemie Windows

1. Aby pobrać narzędzia, należy wejść na stronę producenta: https://www.mongodb.com/try/download/database-tools, wybrać właściwą platformę w polu „Platform” i format „msi” w polu „Package”, a następnie nacisnąć przycisk „Download”.

2. Następnie należy otworzyć pobrany plik. Zostanie wówczas otwarte okno początkowe instalatora MongoDB Database Tools, gdzie należy kliknąć na „Next”.

3. W następnym kroku należy wyrazić zgodę na umowę licencyjną, zaznaczając checkbox, a następnie wybrać „Next”.

4. Następnie otwarte zostaje okno, w którym można wybrać lokalizację, gdzie zostaną zainstalowane narzędzia MongoDB.

Domyślna lokalizacja to C:\Program Files\MongoDB\Tools\100\bin.

Po wyborze lokalizacji użytkownik powinien kliknąć „Next”.

5. W kolejnym oknie należy wybrać przycisk „Install”. Wówczas następuje instalacja MongoDB Database Tools.

6. Następnie należy uruchomić wiersz polecenia, wpisując cmd w wyszukiwarce w menu „Start” i wybierając opcję „Uruchom jako administrator”.

7. Następnie należy wpisać cd, nacisnąć spację i podać ścieżkę do lokalizacji narzędzi MongoDB – w poniższym przykładzie znajdują się one w lokalizacji C:\Program Files\MongoDB\Tools\100\bin.

8. Następnie należy nacisnąć Enter i wprowadzić następującą frazę:

mongodump --uri="mongodb://MongoUser@localhost/Repository?authSource=Repository"

gdzie:

MongoUser – to nazwa użytkownika, dla którego będzie następuje łączenie się aplikacji Comarch DMS Repozytorium z bazą danych (zob. Repozytorium – instalacja dla administratora)

localhost – nazwa hosta i port

Repository – nazwa bazy Repozytorium

9. Następnie należy nacisnąć Enter.

10. W kolejnym kroku konieczne jest wprowadzenie hasła do Repozytorium dla użytkownika MongoUser – w poniższym przykladzie jest to hasło Passwd1234, analogicznie do przykładu przedstawionego w instrukcji instalacji Repozytorium.

11. Po naciśnięciu przycisku Enter następuje tworzenie kopii zapasowej bazy Repozytorium.

12. Backup bazy Repozytorium jest zapisywany w folderze „dump” w lokalizacji, w której znajdują się narzędzia MongoDB – w poniższym przykładzie jest to lokalizacja C:\Program Files\MongoDB\Tools\100\bin\dump.

Backup bazy danych MongoDB w systemie Linux, dystrybucja Ubuntu

Instalacja MongoDB Database Tools na Ubuntu powinna zostać przeprowadzona według instrukcji producenta, dostępnej pod następującym adresem: Installing the Database Tools on Linux — MongoDB Database Tools.

Backup bazy danych MongoDB na Ubuntu należy przeprowadzić zgodnie z instrukcją producenta dostępną pod adresem mongodump — MongoDB Database Tools.

Przywracanie bazy danych Mongo DB w systemie Windows

Po wcześniejszym pobraniu MongoDB Database Tools oraz wykonaniu kopii zapasowej bazy Repozytorium za pomocą narzędzia mongodump (zob. Backup bazy danych MongoDB) możliwe jest przywrócenie bazy danych za pomocą narzędzia mongorestore. W tym celu:

1. należy uruchomić wiersz polecenia, wpisując cmd w wyszukiwarce w menu „Start” i wybierając opcję „Uruchom jako administrator”.

2. Następnie należy wpisać cd, nacisnąć spację i podać ścieżkę do lokalizacji narzędzi MongoDB – w poniższym przykładzie znajdują się one w lokalizacji C:\Program Files\MongoDB\Tools\100\bin.

3. Następnie należy nacisnąć Enter i wprowadzić następującą frazę:

mongorestore --uri="mongodb://MongoUser@localhost/Repository?authSource=Repository" dump/Repository

gdzie:

MongoUser – to nazwa użytkownika, dla którego następuje łączenie się aplikacji Comarch DMS Repozytorium z bazą danych (zob. Repozytorium – instalacja dla administratora)

localhost – nazwa hosta i port

Repository – nazwa bazy Repozytorium

dump/Repository – lokalizacja folderu, w którym zapisano kopię zapasową bazy Repozytorium

4. Następnie należy nacisnąć Enter.

5.  W kolejnym kroku konieczne jest wprowadzenie hasła do Repozytorium dla użytkownika MongoUser – w poniższym przykladzie jest to hasło Passwd1234, analogicznie do przykładu przedstawionego w instrukcji instalacji Repozytorium i w instrukcji tworzenia kopii zapasowej bazy Repozytorium.

6. Po naciśnięciu przycisku Enter następuje przywrócenie kopii zapasowej bazy Repozytorium.

Przywracanie bazy danych Mongo DB w systemie Linux, dystrybucja Ubuntu

Przywrócenie bazy danych MongoDB na Ubuntu należy przeprowadzić zgodnie z instrukcją producenta dostępną pod adresem: mongorestore — MongoDB Database Tools.

Jeśli użytkownik korzystał przedtem z Comarch DMS i z Comarch DMS Repozytorium, powinien dokonać aktualizacji.

Najpierw konieczna jest aktualizacja aplikacji serwerowej, WEB i desktop Comarch DMS, którą można przeprowadzić ręcznie albo za pomocą instalatora. Kiedy aplikacje zostały zaktualizowane, wówczas można przystąpić do aktualizacji modułu Repozytorium.

Przebieg aktualizacji:

1. W pobranym pakiecie instalacyjnym  należy otworzyć folder Comarch DMS {wersja},  a następnie Comarch DMS {wersja}, w którym znajduje się  folder DMS Repository Api

2. następnie konieczne jest usunięcie i podmienienie dotychczasowej zawartości  folderu DocumentManager.WebApi (lub folderu o innej nazwie, do którego w wersji 2024.0.0 lub późniejszej skopiowano zawartość folderu DMS Repository Api), znajdującego się domyślnie w lokalizacji C:\inetpub\wwwroot, na odpowiadającą mu zawartość folderu DMS Repository Api z pakietu instalacyjnego, poprzez jej skopiowanie i wklejenie

3. następnie należy sprawdzić i uzupełnić plik Web.config w folderze z aplikacją serwerową Comarch DMS oraz plik web.config w folderze z aplikacją WEB Comarch DMS, zgodnie z instrukcjami w artykule Konfiguracja aplikacji WEB (nowej aplikacji web) do współpracy z modułem Repozytorium, czyli:

W ramach katalogu zawierającego aplikację web (nową aplikację webową) otworzyć do edycji plik web.config i uzupełnić:

4. następnie należy zrestartować serwer IIS  w Menedżerze internetowych usług informacyjnych (IIS) , klikając przycisk „Uruchom ponownie” po prawej stronie ekranu

5. w dalszej kolejności konieczne jest wyczyszczenie danych przeglądarki, na której użytkownik korzysta z modułu Repozytorium, w tym plików cookie oraz innych danych witryn

Tak przygotowane Repozytorium jest zaktualizowane i gotowe do pracy.

Informacje ogólne

W wersji 2022.0.3 wprowadzono automatyczną aktualizację baz danych modułu Comarch DMS Repozytorium. Aktualizacja bazy danych umożliwia dokonanie konwersji struktury bazy MongoDB do nowej wersji.

Aktualizacja bazy następuje automatycznie po pierwszym uruchomieniu Repozytorium, po tym, jak podniesiono system do nowej wersji.

Aktualizacja umożliwia konwersję struktury bazy MongoDB do nowej wersji. Podczas aktualizacji rozpoznawana jest wersja bazy, która jest aktualizowana – jeśli występują różnice w strukturze bazy poprzedniej wersji, wówczas aktualizacja bazy uruchamiana jest automatycznie, jeżeli natomiast struktura bazy pomiędzy danymi wersjami nie uległa zmianie – nie zachodzi aktualizacja.

Jeśli wersja podnoszona jest o kilka wersji niższa niż aktualna, wówczas aktualizacja bazy danych następuje etapami, kolejno do każdej wersji, aż do aktualnej. Możliwe jest podniesienie z danej wersji do wersji 2022.0.2 i wyżej.

Aktualizacja bazy danych znajduje się w osobnej bibliotece DLL.

Ekran aktualizacji jest wyświetlany użytkownikom na każdym poziomie uprawnień oraz użytkownikom, którzy nie posiadają uprawnień do modułu Repozytorium – a zatem każdy operator Comarch DMS może rozpocząć aktualizację bazy modułu Repozytorium.

Dla dokumentów zarchiwizowanych, będących jednocześnie w okresie retencji, w miejsce kryterium okresu przechowywania zostaje automatycznie wprowadzona data dodania dokumentu.

Dla dokumentów aktywnych, których dotyczy reguła retencji, jako kryterium okresu przechowywania nie zostaje wprowadzona automatycznie żadna data – operator ustawia datę przy próbie zarchiwizowania dokumentu.

Dla dokumentów, które są unieważnione, w miejscu powodu unieważnienia znajduje się znak –.

Aktualizacja bazy danych MongoDB – przebieg

Po wykonaniu backupu (zob. Backup bazy danych MongoDB) można przejść do aktualizacji bazy danych Repozytorium.

Przy pierwszym uruchomieniu po aktualizacji aplikacji (zobacz Aktualizacja Comarch DMS Repozytorium) na ekranie pojawia się okno początkowe aktualizacji. Dostępny jest na nim checkbox „Potwierdzam wykonanie backupu bazy MongoDB” wraz z informacją, że potwierdzenie wykonania kopii zapasowej bazy jest konieczne do rozpoczęcia aktualizacji.

Aby rozpocząć aktualizację należy zaznaczyć checkbox i kliknąć przycisk [Aktualizuj bazę].

Po wyborze przycisku [Aktualizuj bazę] rozpoczyna się aktualizacja bazy Repozytorium, a na ekranie widoczna jest informacja o trwającej aktualizacji, wyświetlany jest także obecny etap aktualizacji i szacowany czas jej zakończenia.

Jeżeli podczas aktualizacji wystąpią błędy, które spowodują, że jej poprawne przeprowadzenie nie będzie możliwe, jak np. w przypadku przerwania połączenia do serwera repozytorium Repository.exe lub problemów związanych z serwerem bazy MongoDB, wówczas wyświetlony zostanie następujący komunikat:

Informacje techniczne dotyczące powodów niepowodzenia aktualizacji, wyników aktualizacji bazy i ewentualnych błędów (np. odnoszące się do aktualizacji bazy z wersji 2022.0.2 do wersji 2022.0.3 lub do błędów wynikających ze struktury bazy), są zapisywane w logach.

Uzupełnianie danych krytycznych dla systemu

Jeśli Repozytorium jest podnoszone z wersji, w której nie były jeszcze stosowane identyfikatory dokumentów i brak prefixów w typach dokumentów (zob. „Ustawienia” w Repozytorium – zakładka „Zarządzanie aplikacją” dla administratora), wówczas po zakończonej aktualizacji w Repozytorium zostaje wyświetlone okno, w ramach którego administrator systemu musi uzupełnić brakujące prefixy. Następnie zmiany należy zapisać, aby możliwe było rozpoczęcie pracy z Repozytorium.

Okno Uzupełnij konfigurację aplikacji zostaje automatycznie wyświetlone tuż po zakończeniu aktualizacji lub, jeśli aktualizacja miała miejsce w tle, przy zamkniętej przeglądarce – po pierwszym otwarciu interfejsu Repozytorium po aktualizacji. W oknie wyświetlone są w kolejności alfabetycznej wszystkie typy dokumentów, jakie dotychczas utworzono. Nie jest możliwe zamknięcie okna ani zapisanie zmian, jeśli wszystkie wymagane pola z prefiksami nie zostały odpowiednio uzupełnione. Po przesunięciu kursora na ikonkę wyświetlana jest informacja dotycząca zasad wprowadzania prefiksów, analogiczna do informacji dostępnej przy definiowaniu typu dokumentu w ustawieniach Repozytorium.

Kiedy wszystkie pola zostały poprawnie wypełnione, operator może zapisać zmiany za pomocą przycisku [Zapisz]. Po zapisaniu zmian okno zostaje zamknięte i można przystąpić do pracy z Repozytorium.

Jeżeli użytkownik wpisze w ramach pola Prefix taki prefix, który:

Kiedy administrator systemu uzupełni prefixy typów dokumentów i zapisze okno konfiguracji, wówczas nastąpi automatyczne nadanie dokumentom identyfikatorów.

Numeracja takich identyfikatorów po prefiksie zależy od daty dodania dokumentu do Repozytorium.

Kiedy aktualizacja bazy Repozytorium zostanie zakończona, a administrator uzupełni brakujące prefiksy (jeśli była taka potrzeba), wówczas możliwe będzie przystąpienie do pracy z Repozytorium. Zakończenie aktualizacji sukcesem zostaje potwierdzone wyświetleniem informującego o tym komunikatu.