Przygotowanie instalacji – serwer IIS i serwer bazodanowy
System operacyjny dla serwera IIS
Silnik aplikacji Comarch DMS czyli aplikacje webową można zainstalować na następujących systemach operacyjnych:
Windows Server 2012
Windows Server 2012 R2
Windows Server 2016
Windows Server 2019
Komponenty systemu IIS
Comarch DMS korzysta z następujących komponentów systemowych:
Internetowe usługi informacyjne (IIS) w wersji 7.x lub nowszej (zalecane IIS 10.0)
Net Framework w wersji 4.6.1 lub wyższej
Serwer SQL
Comarch DMS może działać w oparciu o następujące wersje i edycje Microsoft SQL Server:
MS SQL Server 2012 Express/Standard/Enterprise Edition SP3 x86/x64
MS SQL Server 2014 Express/Standard/Enterprise Edition SP2 x86/x64
MS SQL Server 2016 Express/Workgroup/Standard/Enterprise Edition x86/x64
MS SQL Server 2017 Express/Workgroup/Standard/Enterprise Edition x86/x64
MS SQL Server 2019 Express/Workgroup/Standard/Enterprise Edition x86/x64
Wymagane komponenty SQL
W przypadku instalacji ręcznej (z pominięciem instalatora), wymagane jest posiadania narzędzia sqlcmd.exe na stanowisku, na którym będzie uruchamiany plik install.bat. SQLCMD może być zainstalowane razem z Microsoft SQL Server Management Studio lub pobrane w ramach Microsoft® Command Line Utilities.
Wymagania sprzętowe, oprogramowanie i licencje serwerowe
Zalecana konfiguracja sprzętowa serwera IIS
Wymagany sprzęt – zalecenia minimalne:
VCPU – 2 x 2.2 GHz
RAM – 8 GB
HDD/SSD – 120 GB
Kontroler z obsługą RAID
Konfiguracja RAID – RAID1
NIC – Interfejs sieciowy 100/1000 Mb/s (w zależności od całości infrastruktury)
Zapewnienie możliwości rozbudowy:
Możliwość rozbudowy do 4 CPU
Możliwość rozszerzenia pamięci RAM powyżej 8 GB
Wymagane oprogramowanie serwera IIS
System operacyjny (jedna z poniższych możliwości):
Windows Server 2012/2012 R2 Standard Edition
Windows Server 2016
Windows Server 2019
Dodatkowe wymagania:
IIS w wersji 7.x lub nowszej
.Net Framework 4.6.1 (lub wyższy)
Wymagane licencje na oprogramowanie dla serwera IIS
Licencja na system operacyjny
Jeden z dostępnych rodzajów licencji:
BOX
OEM
MOLP
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:
CAL SQL Server 2012/2014/2016/2017/2019 lub
CAL SQL Server 2012/2014/2016/2017/2019 Runtime i
CAL Windows Server 2012/2012 R2/2016/2019 lub licencja External Connector (dotyczy użytkowników zewnętrznych)
Ograniczenia i uwagi
Nie można łączyć licencji na serwer z licencjami CAL w sytuacji, kiedy są one dedykowane dla różnych wersji językowych.
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:
VCPU – 8 x 2.2 GHz
RAM – 16 GB, zalecane 31 GB
HDD/SSD – 200 GB (dla 100 tys. dokumentów DMS bez załączników należy zarezerwować 3 GB + rozmiar na załączniki przy założeniu: 200 kb dla jednej strony załącznika czarno-białego, 500 kb dla jednej strony załącznika kolorowego)
Kontroler z obsługą RAID
NIC – Interfejs sieciowy 100/1000 Mb/s (w zależności od całości infrastruktury)
Wymagane oprogramowanie SQL
System operacyjny:
Windows Server 2012/2012 R2 Standard/Datacenter Edition
Windows Server 2016 Standard/Datacenter Edition
Windows Server 2019 Standard/Datacenter Edition
Baza danych:
MS SQL 2012 Server Standard/Enterprise Edition SP1 x86/x64
MS SQL 2014 Server Standard/Enterprise Edition x86/x64
MS SQL 2016 Server Standard/Enterprise Edition x86/x64
MS SQL 2017 Server Standard/Enterprise Edition x86/x64
MS SQL 2019 Server Standard/Enterprise Edition x86/x64
Uwaga
Możliwa jest również instalacja z wykorzystaniem serwera MS SQL Express. Należy pamiętać o ograniczeniach związanych z maksymalną wielkością bazy danych (max 10 GB) oraz maksymalną ilością alokowanej pamięci (max 1 GB).
Licencje:
Konieczny jest zakup licencji na: system operacyjny, serwer baz danych oraz wymaganych licencji CAL dla serwera SQL i systemu operacyjnego.
Obciążenie serwera uruchomioną aplikacją DMS w sesji terminalowej.
Obciążenie na jedną sesje terminalową z uruchomioną aplikacją Comarch DMS:
CPU – średnio 300 MHz
RAM – max. 600 MB
HDD – 0,1 MB
Licencje – Licencja dostępu terminalowego dla każdego użytkownika (cal)
Konfiguracja sprzętowa dla stacji roboczej
Wymagany sprzęt – zalecenia minimalne:
CPU – Procesory z rodziny Intel /AMD 1 GHz lub szybszy
RAM – 4 GB
Pamięć masowa – HDD lub SSD
NIC – Interfejs sieciowy 100/1000 Mb/s (w zależności od całości infrastruktury)
Ekran – 1024×768
Wymagane oprogramowanie dla stacji roboczej
System operacyjny:
Windows 8
Windows 8.1
Windows 10
.Net Framework:
4.7.2 lub wyższy (zalecany 4.8)
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.
Optymalnymi ilościami, które nie powinny być przekraczane to ok. 100 kontrolek na karcie obiegu i 10 dodatkowych kolumn na liście dokumentów.
Optymalna liczba dokumentów wprowadzanych do systemu to ok. 400 000 dokumentów rocznie w ramach jednego typu obiegu.
Sprawdzanie numeru wersji komponentów Comarch DMS
Od wersji 2019.3 w Comarch DMS wprowadzono weryfikację zgodności wersji komponentów systemu. Podczas uruchamiania aplikacji desktop i web następuje weryfikacja zgodności numeru wersji:
Aplikacji web,
Aplikacji desktop,
Pliku web.config,
Pliku DMS.exe.config (lub pliku ObiegDokumentow.exe.config dla wersji wcześniejszych niż 2020.2.1),
Skryptów SQL,
Skryptów SQL XL,
Skryptów SQL Optima,
Skryptów SQL Altum.
W sytuacji, gdy weryfikacja wersji wykaże niezgodność, zamiast okna logowania do aplikacji zostanie wyświetlony komunikat.
Komunikat podczas uruchamiania aplikacji web dotyczący braku zgodności wersji komponentów aplikacji.
Aplikacja Comarch DMS desktop na maszynie wirtualnej
Dla aplikacji stacjonarnej uruchomionej poprzez połączenie terminalowe udostępniono kanały wirtualne umożliwiające załączanie plików oraz skanów dokumentów ze skanera podpiętego do lokalnego komputera, na którym pracuje użytkownik.
W celu korzystania z kanałów wirtualnych niezbędne jest zainstalowanie na komputerze lokalnym, z którego uruchamiane jest połączenie terminalowe, paczki sterowników – OnlineFp.exe – Comarch ERP Sterowniki i usługi terminalowe. Plik OnlineFp.exe dostępny jest w katalogu Sterowniki umieszczonym w katalogu instalacyjnym Comarch DMS.
W pliku DMS.exe.config udostępniono dwa klucze, z domyślnie ustawioną wartością „false”, oznaczającą, że kanały wirtualne są wyłączone, w celu włączenia należy zmienić wartość na „true”.
Dla wersji Comarch DMS wcześniejszych niż 2020.2.1 klucze znajdują się w pliku ObiegDokumentow.exe.config.
Klucze odpowiadające za włączenie kanałów wirtualnych w pliku DMS.exe.config
Klucz VirtualChannelToLocalMachineFiles odpowiada za możliwość załączania plików z lokalnego komputera do aplikacji Comarch DMS uruchomionej na wirtualnej maszynie.
Gdy kanał wirtualny VirtualChannelToLocalMachineFiles jest włączony, nie ma możliwości dodawania załączników z katalogów umieszczonych na maszynie wirtualnej, wywoływane są wyłącznie okna z komputera lokalnego, na którym uruchomiono połączenie terminalowe.
Możliwe jest załączanie plików zarówno z lokalnego komputera jak i maszyny wirtualnej, o ile w opcjach podłączania pulpitu zdalnego udostępniono dyski komputera lokalnego. W takiej konfiguracji należy wartość klucza VirtualChannelToLocalMachineFiles ustawić na „false”.
Klucz VirtualChannelToLocalMachineScanner odpowiada za możliwość załączenia w aplikacji Comarch DMS uruchomionej na wirtualnej maszynie skanu dokumentu bezpośrednio ze skanera podłączonego do lokalnego komputera użytkownika.
Po wybraniu w kontrolce typu Załącznik opcji „Skan”, zostaje wyświetlone okno:
Ustawienia skanowania
Funkcjonalność zrealizowana za pomocą sterowników OnlineFp pozwala na skanowanie jedno i wielostronicowe. Skanowanie jednostronicowe pozwala zapisać obrazy w formatach: jpg, tif, pdf, png. Skanowanie wielostronicowe pozwala zapisać pliki wyłącznie z rozszerzeniem tif.
Wybranie przycisku „Skan” uruchamia skanowanie na skanerze podpiętym do lokalnego komputera.
Instalacja – informacje ogólne
Do instalacji aplikacji Comarch DMS wymagane jest posiadanie dodatku Microsoft .Net Framework w wersji 4.6.1 lub wyższej.
Uwaga
Do poprawnej współpracy z systemami Comarch ERP XL i Comarch ERP Optima wymagane jest aby wpis w zmiennych środowiskowych PATH dotyczący systemu Comarch ERP XL znalazł się przed wpisem dotyczącym Comarch ERP Optima.
Uwaga
Do generowania dokumentów za pomocą kontrolki Dokument ERP XL oraz kompresji załączników zapisywanych do bazy systemu Comarch ERP XL, system Comarch ERP XL musi być zainstalowany na serwerze IIS, na którym działa aplikacja.
Z pobranego pliku instalacyjnego, do instalacji Comarch DMS we współpracy z Comarch ERP XL należy wykorzystać:
Katalog do instalacji ręcznej – Comarch DMS {wersja}
Katalog z instalatorem do współpracy z Comarch ERP XL – Comarch DMS {wersja} XL wersja instalacyjna
Podstawowym elementem systemu Comarch DMS jest aplikacja web. Dlatego w pierwszej kolejności procesu instalacji należy zainstalować aplikację web, następnie skonfigurować aplikację stacjonarną.
Uwaga
Instalator zainstaluje jedynie aplikację web, aplikację stacjonarną należy skonfigurować ręcznie.
Zalecamy przeprowadzenie instalacji aplikacji webowej, przy użyciu instalatora znajdującego się w katalogu Comarch DMS {wersja} wersja instalacyjna. Istnieje również możliwość instalacji ręcznej.
Stacjonarna aplikacja Comarch DMS może zostać skonfigurowana (uruchamiana) na dwa sposoby:
Jako samodzielna aplikacja zintegrowana z ERP XL, ale bez możliwości uruchamiania aplikacji z poziomu środowiska ERP XL.
Aplikacja zintegrowana ze środowiskiem ERP XL, z możliwością uruchomienia aplikacji z poziomu okna startowego ERP XL oraz z poziomu formatek ERP XL (historia związanych).
Konfiguracja aplikacji stacjonarnej bez możliwości uruchomienia z poziomu środowiska ERP XL
W pobranym pliku instalacyjnym należy wejść do katalogu Comarch DMS {wersja}, następnie zawartość katalogu DMS Desktop przekopiować do nowo utworzonego folderu na lokalnym dysku. Np. do c:\DMS
Następnie należy otworzyć do edycji plik DMS.exe.config i w kluczu ServerUri wprowadzić adres URL którym uruchamiana jest aplikacja webowa.
Np. <add key=”ServerUri” value=”http://localhost/DMS” />
Po zapisaniu pliku DMS.exe.config należy sprawdzić działanie aplikacji uruchamiając plik DMS.exe
Dla wersji Comarch DMS wcześniejszych niż 2020.2.1 istnieje konieczność wykonywania powyższych kroków na pliku ObiegDokumentow.exe.config, aplikacja uruchamiana jest plikiem ObiegDokumentow.exe.
Plik konfiguracyjny DMS.exe.config, adres URL którym uruchamiana jest aplikacja web
Konfiguracja aplikacji stacjonarnej z możliwością uruchamiania z poziomu Comarch ERP XL
Konfiguracja Comarch DMS z możliwością uruchomienia z poziomu Comarch ERP XL składa się z kilku kroków:
W pierwszej kolejności należy skonfigurować środowisko Windows na komputerze operatora:
W głównym katalogu Comarch ERP XL należy utworzyć nowy folder, np. DMS (c:\ERPXL_2021.0\DMS).
W zmiennych środowiskowych systemu Windows PATH należy dodać nową ścieżkę do nowoutworzonego folderu (niezależnie od ścieżki do głównego katalogu ERP XL)
Zrestartować komputer
Uwaga
Należy upewnić się że w zmiennych środowiskowych PATH istnieje tylko jedna ścieżka do folderu ERP XL i jedna do folderu ERP XL\DMS.
Kolejny krok to konfiguracja aplikacji stacjonarnej Comarch DMS:
W pobranym pliku instalacyjnym należy wejść do katalogu Comarch DMS {wersja}, zawartość katalogu DMS Desktop przekopiować do nowo utworzonego folderu w katalogu ERP XL Np. do: c:\ERPXL_2021.0\DMS
Otworzyć do edycji plik DMS.exe.config i w kluczu ServerUri wprowadzić adres URL którym uruchamiana jest aplikacja webowa. Np. <add key=”ServerUri” value=”http://localhost/DMS” />
Zapisać plik DMS.exe.config i przekopiować do głównego katalogu ERP XL (w naszym przykładzie do c:\ERPXL_2021.0). Plik DMS.exe.config musi znajdować się w dwóch katalogach:
c:\ERPXL_2021.0
c:\ERPXL_2021.0\DMS
Uruchomić RejestrOD.bat (z katalogu c:\ERPXL_2021.0\DMS). W zależności od uprawnień operatora systemu Windows można powtórzyć uruchomienie RejestrOD.bat z prawami administratora.
Jeżeli użytkownik korzysta z wersji ERP XL wcześniejszej niż 2020.0, konieczne jest również uzupełnienie i wykonanie powyższych kroków na pliku ObiegDokumentow.exe.config.
Ostatnim krokiem jest zmiana trybu pracy w środowisku ERP XL:
Włączenie w środowisku ERP XL trybu współpracy z Comarch DMS – z poziomu Microsoft SQL Management Studio na bazie ERP XL należy wykonać poniższe zapytanie:
update cdn.konfig set kon_wartosc=1 where kon_numer=7200
Uwaga
Uprawnienie „Obieg dokumentów” ustawiane na właściwościach operatora na zakładce „Parametry” w module Administrator Comarch ERP XL odnosi się do “starej” wersji Obiegu Dokumentów. W przypadku współpracy z Comarch DMS uprawnienie to należy wyłączyć wszystkim operatorom.
Należy odszukać i uruchomić plik DMS.exe. Zostanie otwarte okno logowania do aplikacji stacjonarnej, w którym należy się zalogować na operatora administrator (bez hasła).
Okno logowania do aplikacji stacjonarnej
Okno logowania do aplikacji stacjonarnej w trybie wielospółkowym
Uwaga
Po zainstalowaniu aplikacji w trybie ręcznym należy zmienić hasło dla operatora ODUser na serwerze SQL. Następnie w pliku konfiguracyjnym web.config ustawić takie samo hasło we wszystkich sekcjach „connectionstring”.
Sprawdzenie poprawności integracji z Comarch ERP XL
Poprawność integracji z Comarch ERP XL można zweryfikować uruchamiając Obieg dokumentów z poziomu menu Start systemu Comarch ERP XL. Po kliknięciu na przycisk Obieg dokumentów zostanie uruchomiony aktualnie skonfigurowany Comarch DMS.
Menu Start Comarch ERP XL
Integracja z Comarch ERP XL umożliwia wiązanie dokumentów ERP XL z dokumentami Comarch DMS wykorzystując do tego formatkę „Historia związanych”. Ponadto umożliwia też generowanie dokumentów za pomocą kontrolki Dokument ERP XL oraz działanie kontrolek elektronicznych.
Wiązanie dokumentu ERP XL z dokumentami Comarch DMS
Instalacja aplikacji web za pomocą instalatora
Instalację aplikacji webowej należy przeprowadzić na serwerze (komputerze) z zainstalowanym serwisem IIS (Internet Information Services).
Uwaga
Instalacje wersji WWW nie są zalecane na stacjach roboczych. Instalacja powinna być przeprowadzona na dedykowanym serwerze.
W pobranym pliku instalacyjnym Comarch DMS {wersja} XL należy odnaleźć katalog o nazwie Comarch DMS {wersja} XL wersja instalacyjna.
Następnie należy wybrać plik Install.exe
Zostanie uruchomiony instalator aplikacji webowej:
Instalator aplikacji webowej Comarch DMS
Akceptacja warunków instalacji
Przejście do kolejnego kroku instalacji wymaga akceptacji warunków korzystania z oprogramowania Comarch DMS.
Konfiguracja IIS
W pierwszym etapie instalacji następuje konfiguracja Internetowych Usług Informacyjnych. Instalator weryfikuje, czy wszystkie niezbędne komponenty IIS są zainstalowane.
Brakujące elementy zostaną wyszczególnione na liście, a ich instalacja zostanie zainicjowana po naciśnięciu przycisku:
Po wykonaniu tych czynności przez instalator, należy nacisnąć przycisk:
Pula Aplikacji
Kolejnym krokiem jest konfiguracja puli aplikacji. Na tym etapie administrator może wybrać istniejącą pule aplikacji lub dodać nową. Utworzenie nowej puli aplikacji odbywa się poprzez wpisanie jej nazwy i kliknięcie w przycisk
Po dodaniu nowa pula aplikacji zostanie wyświetlona na liście dostępnych pul aplikacji. Po wyświetleniu informacji należy przejść do kolejnego kroku za pomocą przycisku
Aplikacja
Następny etap instalacji to kreowanie aplikacji w witrynie IIS. Aplikacja może być utworzona w nowej lub istniejącej witrynie. Po rozwinięciu opcji dostępne są do wyboru następujące opcje:
Aplikacja w wybranej witrynie – nie jest potrzebne podawanie hosta witryny ani numeru portu (czyli adresu, pod jakim uruchamiana jest aplikacja). Aplikacja będzie działała na hoście witryny, do której zostanie podpięta. Dla aplikacji należy:
wybrać witrynę dodaną wcześniej w IIS,
podać nazwę aplikacji, która zostanie podpięta pod dodaną witrynę w polu „Nazwa aplikacji”.
Domyślna aplikacja w nowej witrynie – aplikacja będzie działała w nowej witrynie, dla której należy podać:
nazwę witryny, która zostanie dodana w IIS,
port, na którym będzie uruchamiana (np. 80),
host, który będzie wpisywany w adresie strony web (w nazwie hosta nie należy stosować znaków specjalnych).
Po wskazaniu sposobu kreowania aplikacji, należy ją utworzyć za pomocą przycisku . Po wykonaniu opisanych wyżej czynności, należy nacisnąć przycisk:
. Domyślnie aplikacja DMS zostaje utworzona w lokalizacji: C:\inetpub\wwwroot w katalogu z nazwą witryny.
Opcje instalacji
W kolejnym kroku należy wybrać opcje instalacji aplikacji Comarch DMS.
Wybór opcji instalacji Comarch DMS
Baza danych Comarch DMS – zaznaczenie oznacza stworzenie w kolejnym kroku oddzielnej bazy Comarch DMS, w ramach której będzie odbywała się praca. Na tej bazie zostaną uruchomione skrypty i założą się tabele obiegowe. Jeśli opcja pozostanie niezaznaczona, wówczas praca będzie odbywała się w ramach wspólnej bazy XL-owej. Na tej bazie zostaną założone tabele obiegowe.
Prezentuj zmianę języka na ekranie logowania – zaznaczenie umożliwi wybór języka pracy aplikacji Comarch DMS na oknie logowania.
Włącz funkcjonalność opisu analitycznego – umożliwia dekretację kosztów i generowanie dokumentów z opisem analitycznym.
Przestrzegaj polityki bezpieczeństwa haseł – zaznaczenie parametru wymusza stosowanie polityki mocnych haseł przez operatorów Comarch DMS (min 8 znaków, wielka litera, znak specjalny).
Wersja Premium – parametr domyślnie zaznaczony, pozwala na modelowanie procesów w aplikacji za pomocą kodu C#
Wskazówka
Rekomendowana jest instalacja systemów Comarch ERP XL i Comarch DMS na osobnych bazach SQL, czyli zaznaczenie opcji „Baza danych Comarch DMS”./indicator]
Po wybraniu opcji instalacji należy przejść do kolejnego etapu za pomocą przycisku
W kolejnym kroku instalacji należy połączyć się z serwerem SQL, podając login i hasło lub wybierając logowanie zintegrowane.
Następnie za pomocą przycisku instalator połączy się z serwerem SQL. Na rozwijanej liście baz danych wyświetlone zostaną wszystkie bazy dostępne na wskazanym serwerze, należy wskazać bazę danych Comarch ERP XL, dla której konfigurowana jest współpraca z Comarch DMS.
Informacja o połączeniu z serwerem SQL oraz wskazanie bazy Comarch ERP XL, która będzie współpracować z Comarch DMS.
Po wskazaniu bazy danych Comarch ERP XL konieczne jest ustawienie hasła dla operatora ODUser, który dodawany jest do serwera SQL podczas pierwszej instalacji Comarch DMS z hasłem określonym w niniejszym kroku instalacji.
Instalator blokuje możliwość uruchomienia skryptów na bazie Comarch ERP XL do momentu ustawienia i zapisu hasła dla ODUser. Po wyświetleniu informacji zostaje aktywowany przycisk .
Po wybraniu przycisku należy wpisać hasło dla użytkownika ODUser. Hasło zostanie również wpisane do wszystkich „connection string” znajdujących się pliku web.config aplikacji WWW. Jeżeli definiujemy połączenia bazodanowe w trybie wielospółkowym, należy pamiętać, aby nowe hasło podać we wszystkich połączeniach definicji spółek.
W przypadku aktualizacji Comarch DMS instalator wymaga zmiany hasła operatora ODUser. Hasło może zostać zmienione (zalecane), można również wprowadzić aktualne hasło. Przy zmienionym haśle i włączonym trybie wielospółkowym należy nowe hasło ustawić we wszystkich konfiguracjach wielospółkowych połączeń do baz danych. W przypadku instalacji kilku aplikacji Comarch DMS, korzystających z jednego MS SQL Serwera, przy zmianie hasła podczas instalacji należy pamiętać, aby zmienione hasło dla ODUser zmienić w plikach web.config oraz w konfiguracji spółek, jeżeli aplikacje pracują w trybie wielospółkowym.
Uwaga
Operator ODUser jest wspólnym operatorem dla wszystkich instalacji Comarch DMS realizowanych w ramach jednego serwera MS SQL.
Wprowadzone hasło należy zapisać i za pomocą przycisku należy zainstalować skrypty, które przygotują bazę Comarch ERP XL do współpracy z Comarch DMS. Uruchomienie skryptów może zostać wykonane tylko przez użytkownika, który jest administratorem serwera SQL, na którym znajduje się wybrana baza.
Okno z komunikatem po uruchomieniu skryptów na bazie Comarch ERP XL.
Po wykonaniu wszystkich czynności za pomocą przycisku należy przejść do kolejnego etapu instalacji.
W przypadku, gdy w opcjach instalacji wybrano następnym etapem instalacji jest utworzenie bazy danych Comarch DMS, w przypadku, gdy Comarch DMS i Comarch ERP XL będą pracowały na jednej bazie, etap ten jest pomijany.
W tym etapie należy wskazać nazwę serwera, typ logowania oraz dane użytkownika, na którego nastąpi logowanie do serwera SQL. Analogicznie do poprzedniego etapu instalacji po podaniu danych do logowania do serwera SQL należy kliknąć przycisk .
Następnie należy wskazać istniejącą bazę Comarch DMS lub za pomocą przycisku utworzyć nową bazę Comarch DMS.
Po wskazaniu/dodaniu bazy danych należy użyć przycisku aby przygotować bazę danych do pracy.
Gdy skrypty zostały wykonane pomyślnie, należy przejść do kolejnego etapu używając przycisku .
W kolejnym etapie instalacji należy wprowadzić nazwę serwera klucza licencji dla Comarch DMS. Po jego uzupełnieniu należy nacisnąć przycisk .
Wskazanie serwera klucza licencji Comarch DMS
W kolejnym kroku należy wprowadzić nazwę serwera klucza licencji dla Comarch ERP XL. Po jego uzupełnieniu należy nacisnąć przycisk .
Wskazanie serwera klucza licencji Comarch ERP XL.
Po prawidłowym wykonaniu czynności opisanych powyżej, pojawi się ekran informujący o pomyślnym zakończeniu instalacji. Należy nacisnąć przycisk: , co spowoduje zamknięcie okna instalatora.
Okno kończące proces instalacji aplikacji webowej Comarch DMS.
Do instalacji aplikacji Comarch DMS wymagane jest posiadanie dodatku Microsoft .Net Framework w wersji 4.6.1 lub wyższej oraz zainstalowanie serwera IIS.
Po zainstalowaniu serwera IIS, należy włączyć następujące komponenty:
Konsola zarzadzania usługami IIS
Narzędzia i skrypty zarządzania usługami IIS
Usługa zarządzania usługami IIS
ASP
Filtry ISAPI
Błędy HTTP
Dokument domyślny
Przeglądanie katalogów
Zawartość statyczna
Filtrowanie żądań
ASP .NET
Rozszerzalność architektury .NET
W pobranym pliku instalacyjnym należy wejść do katalogu Comarch DMS {wersja} i przekopiować zawartość katalogu DMS Web do nowo utworzonego folderu na dysku C:\inetpub\wwwroot\DMS.
Nazwa folderu będzie zarazem nazwą aplikacji webowej uruchamianą poprzez przeglądarkę, w tym przypadku jest to również DMS.
Uwaga
Lokalnemu użytkownikowi IUSR należy nadać uprawnienie do katalogu DMS.
Po uruchomieniu Menedżera Internetowych Usług Informatycznych należy podświetlić nazwę serwera i przejść do opcji „Ograniczenia ISAPI i CGI”.
Dla wpisów z Framework ASP.NetV4.0.* należy wybrać z menu kontekstowego opcję „Zezwalaj”.
Okno Ograniczenia ISAPI i CGI
W kolejnym kroku należy dodać/wybrać pulę aplikacji, na której będzie uruchamiana aplikacja Comarch DMS. Nową pulę aplikacji dodajemy klikając prawym przyciskiem myszy na kategorię „Pule aplikacji”.
Wybór puli dla aplikacji
Pojawi się okno dodawania puli aplikacji. Należy wpisać w nim nazwę „DMS” i wybrać wersję Net Framework v4.0 lub wyższą, a następnie ustawić „Zarządzany tryb potokowy” na „Zintegrowany” i zaznaczyć opcję „Uruchom pulę aplikacji natychmiast”.
Okno „Dodawanie puli aplikacji”
Dla wybranej puli należy skonfigurować ustawienia zaawansowane.
Ustawienia zaawansowane
Pojawi się okno, w którym należy ustawić opcję „Włącz aplikacje 32-bitowe” (w przypadku systemów 64 bitowych), jako „Tożsamość” należy wybrać opcję „ApplicationPoolIdentity”, a następnie sprawdzić czy pozostałe parametry zostały ustawione tak, jak poniżej.
Ustawienia zaawansowane – wzór
Następnie należy przekonwertować katalog DMS na aplikację i przypisać do niej utworzoną pulę.
Konwertowanie katalogu na aplikację
Okno dodawania aplikacji
Przygotowanie baz danych
W kolejnym kroku instalacji należy przygotować bazę danych dla aplikacji Comarch DMS oraz Comarch ERP XL.
Aplikacja może pracować na dwóch odrębnych bazach danych (baza Comarch DMS i baza ERP XL) lub na jednej wspólnej bazie (baza ERP XL). Poniżej został przedstawiony przykład instalacji z wykorzystaniem dwóch baz.
Aby utworzyć nową bazę danych Comarch DMS, należy uruchomić program Microsoft SQL Server Management Studio i za pomocą opcji New Database wykreować nową bazę.
Pojawi się okno, w którym należy podać nazwę bazy danych.
Tworzenie bazy w Microsoft SQL Serwer Management Studio
Konfiguracja pliku web.config
Uwaga
Comarch DMS może pracować w trybie jednofirmowym lub wielofirmowym. Niektóre ustawienia pliku Web.config w trybie wielofirmowym są nieużywane i nie ma potrzeby ich definiowania. Tryb pracy (jedno/wielofirmowy) ustawiany jest w kluczu <add key=”MultiCompany” value=”” />.
W pliku konfiguracyjnym Web.config znajdującym się w katalogu C:\inetpub\wwwroot\{nazwa aplikacji} należy wprowadzić następujące informacje:
Definicje connection stringów używane w obu trybach:
W kluczu „strConnectDMS” należy wprowadzić connection string do bazy danych Comarch DMS.
Definicje connection stringów używane w trybie jednofirmowym:
W kluczu „strConnectERPComp” należy wprowadzić connection string do bazy Comarch ERP XL lub bazy firmowej Comarch ERP Optima / Comarch ERP Altum. Klucz jest wymagany do poprawnego działania integracji. Wprowadzenie klucza nie jest wymagane, jeżeli Comarch DMS pracuje w trybie wielospółkowym.
W kluczu „strConnectERPConf1” należy wprowadzić connection string do bazy konfiguracyjnej Comarch ERP Optima lub Comarch ERP Altum. Klucz ten jest wymagany po poprawnego działania integracji Comarch DMS z Comarch ERP Optima lub Comarch ERP Altum. Klucz jest również wymagany w trybie chmurowym Comarch ERP Optima. Wprowadzenie klucza nie jest konieczne w przypadku pracy Comarch DMS w trybie wielofirmowym.
Definicje connection stringów używane w trybie wielofirmowym
Klucze „strConnectERPConf2”, „strConnectERPConf3” itd. mogą być używane w trybie chmurowym Comarch ERP Optima. Poprzez wprowadzenie connection stringów możliwe jest dodanie kilku baz konfiguracyjnych, które dostępne będą w Comarch DMS w oknie definiowanie połączeń spółki z bazą ERP.
Ustawienia kluczy używane w obu trybach
<add key=”WorkMode” value=”XL” /> – określenie współpracy Comarch DMS z systemami ERP,
dla Comarch ERP Optima – wartość = „Optima”,
dla Comarch ERP XL – wartość = „XL”,
dla Comarch ERP Altum – wartość = „Altum”,
bez współpracy z systemem EPR – wartość = „Standalone”.
<add key=”MultiCompany” value=”false” /> – ustawienie trybu pracy jednofirmowy (false) i wielofirmowy (true).
<add key=”MaximumNumberOfControlCardColumns” value=”10″ /> – definicja maksymalnej liczby kolumn karty obiegu, która będzie dostępna w konfiguracji typu obiegu.
<add key=”PremiumFunctionality” value=”true” /> – klucz odpowiada za dostęp do funkcjonalności modelowania procesów w Comarch DMS za pomocą kodu w języku C#. Wartość „true” – funkcjonalność dostępna, wartość „false” – funkcjonalność niedostępna.
<add key=”LicenceKeyServerDMS” value=”nazwa serwera klucza DMS” /> – należy wpisać nazwę serwera licencji dla aplikacji Comarch DMS.
<add key=”ShowChangeLanguage” value=”true” /> – wartość „true” włącza możliwość wyboru języka pracy aplikacji Comarch DMS w oknie logowania. Wartość „false” wyłącza tą możliwość.
<add key=”UseStrongPassword” value=”false” /> – wartość „true” wymusza stosowanie polityki mocnych haseł przez operatorów Comarch DMS (min 8 znaków, wielka litera, znak specjalny).
<add key=”ExternalRegistrationEnabled” value=”false” /> – wartość „true” klucza umożliwia rejestrowanie użytkowników z poziomu aplikacji web. Okno rejestracji można wyświetlić do dodaniu do adresu aplikacji członu „/ExternalRegistration”, np. http://localhost/DMS/ExternalRegistration. Wartość klucza = „false” oznacza, że rejestracja użytkowników w aplikacji web jest niemożliwa.
<add key=”TaxPayerIdRequired” value=”false” /> – klucz określa, czy użytkownik będzie musiał podać NIP podczas rejestracji. Wartość „true” oznacza konieczność podania NIP, wartość „false” oznacza brak konieczności.
<add key=”PersonalDataProcessingConsentRequired” value=”false” /> – klucz określa, czy w oknie rejestracji będzie wyświetlany parametr „Akceptuję regulamin oraz zapoznałem się z informacją o przetwarzaniu danych osobowych”. Wartość „true” spowoduje, że parametr będzie wyświetlany, a jego zaznaczenie będzie wymagane do rejestracji konta. Tekst regulaminu i informacji o przetwarzaniu danych osobowych należy wprowadzić odpowiednio do plików Rules_pl.txt i gdpr_pl.txt znajdujących się w folderze TextResources. Wartość „false” powoduje, że parametr nie jest wyświetlany i jego zaznaczenie nie jest wymagane do rejestracji.
<add key=”WorkingConditionsAcceptanceRequired” value=”false” /> – klucz określa, czy w oknie rejestracji będzie wyświetlany parametr „Akceptuję warunki pracy”. Wartość „true” powoduje, że parametr będzie wyświetlany, a jego zaznaczenie będzie wymagane do rejestracji konta. Treść informacji o warunkach pracy należy wprowadzić do pliku workingConditions_pl.txt w folderze TextResources. Wartość „false” powoduje, że parametr nie jest wyświetlany i jego zaznaczenie nie jest wymagane do rejestracji.
<add key=”DocumentListDateRange” value=”150″ /> – możliwość zdefiniowania filtra zawężającego wyszukiwanie dokumentów, dla których przekazanie do kolejnego etapu odbyło się określoną ilość dni temu. Wartość klucza odpowiada liczbie dni. Niezależnie od ustawienia, operator może usunąć lub zmienić zdefiniowany filtr. Ustawienie wartość = 0 wyłącza domyślny filtr.
<add key=”ERPXLCloud” value=”false” /> – wartość „true” umożliwia współpracę Comarch DMS z Comarch ERP XL w trybie chmurowym.
<add key=”OptimaCloudMode” value=”false” /> – wartość „true” umożliwia współpracę Comarch DMS z Comarch ERP Optima w trybie chmurowym.
<add key=”AskAboutDocumentSave” value=”True” /> – parametr odpowiedzialny za wyświetlanie komunikatów z pytaniem „Czy zapisać zmiany?” na szczegółach dokumentów Comarch DMS. W przypadku ustawienia value=”True”, komunikaty będą wyświetlane w aplikacji, w przypadku value=”False” komunikaty nie będą wyświetlane w aplikacji.
Uwaga
Gdy wartość klucza „AskAboutDocumentSave” zostanie ustawiona na „False”, w ustawieniach typu obiegu nie będzie możliwe włączenie funkcjonalności automatycznego zapisu po zainicjowaniu dokumentu.
<add key=”CombinationCompanies” value=”false”/> – klucz odpowiada za możliwość ustawienia różnych spółek dla kontrolek na definicji obiegu. Wyłączona możliwość ustawienia różnych spółek dla wszystkich kontrolek: value = „false”, włączona: value = „true”.
<add key=”CompanyNameSearchModeEnabled” value=”false” /> – klucz działa w trybie wielospółkowym, wartość „true” powoduje możliwość zawężania listy wyświetlanych spółek po wpisaniu frazy w okno wyszukiwania. Jeżeli wartość = „false”, spółkę należy znaleźć i wybrać z rozwijanej listy.
<add key=”DocumentCounterMinutesInterval” value=”1″/> – parametr odpowiedzialny za wyświetlanie liczby dokumentów utworzonych w ramach danego typu obiegu, liczba dokumentów prezentowana jest w nawiasie obok każdego typu obiegu na drzewie typów obiegów. Domyślnie funkcjonalność jest włączona z wartością 1, czyli odświeżenie danych o liczbie dokumentów w ramach danego typu/grupy typów obiegu odbywa się co 1 minutę. Klucz może przyjmować wartości:
„-1” – wartość oznaczająca, że funkcjonalność jest wyłączona, na drzewie typów obiegów nie są prezentowane wartości z liczbą dokumentów.
„0” – wartość oznaczająca, że funkcjonalność jest włączona i sumowanie liczby dokumentów odbywa się przy każdym wejściu na listę dokumentów
„<liczba całkowita>” – wartość oznaczająca, że funkcjonalność jest włączona, wpisana liczba określa wyrażony w minutach czas, po którym nastąpi automatyczne odświeżenie danych.
<!– <add key=”XLAPIOpeHaslo” value=”haslo” / />–> – musi pozostać zakomentowane. Parametr aktywny jeżeli ustawiono <add key=”WorkMode” value=”XL” />. Umożliwia pracę na wspólnym haśle podczas generowania dokumentów.
Uwaga
Odkomentowanie klucza o nazwie”XLAPIOpeHaslo” spowoduje zamianę wszystkich haseł operatorów Comarch ERP XL na hasło ustawione w kluczu.
Ustawienia kluczy używane w trybie jednofirmowym
<add key=”CompanyName” value=”<nazwa firmy>” /> – można zdefiniować nazwę firmy, która zostanie wyświetlona w aplikacji przed loginem zalogowanego operatora.
<add key=”LicenceKeyServerERP” value=”<nazwa serwera klucza ERP>” /> – należy wpisać nazwę serwera licencji dla Comarch ERP XL / Comarch ERP Optima / Comarch ERP Altum.
<add key=”EnableAnaliticDescription” value=”false” /> – parametr aktywny jeżeli ustawiono <add key=”WorkMode” value=”XL” />. Umożliwia dekretację kosztów i generowanie dokumentów.
<add key=”DestinationAttachmentsWorkflow” value=”DO” /> – parametr umożliwia wybór bazy, w której przechowywane będą załączniki dodane do dokumentów:
baza DMS – value = „DO”,
baza ERP XL – value = „XL”,
usługa IBARD – value = „IBARD”.
<add key=”DestinationAttachmentsRepository” value=”DO” /> – parametr umożliwia wybór bazy, w której przechowywane będą pliki dodane do Managera dokumentów lub usługi Comarch DMS Repozytorium:
baza DMS – value = „DO”,
usługa IBARD – value = „IBARD”.
<add key=”DMUsersIdAllowedToReorderDirectiories” value=”” /> – wartość klucza określa, którzy operatorzy są uprawnieni do zarządzania układem katalogów na drzewie w Managerze dokumentów. Domyślnie wartość klucza jest pusta, oznacza to, że wszyscy operatorzy mogą zarządzać kolejnością katalogów na drzewie. Jeżeli w kluczu zostaną wskazane identyfikatory operatorów DMS (DCD_ID), będzie to oznaczać, że jedynie wskazani operatorzy posiadają uprawnienie do reorganizacji struktury katalogów. Identyfikatory operatorów powinny być rozdzielane przecinkiem.
<add key=”AnalitycalDescriptionWorkMode” value=”1″ /> – parametr określa tryb pobierania wymiarów opisu analitycznego. Klucz przyjmuje następujące wartości:
1 – bezpośrednie pobieranie wymiarów z bazy Comarch ERP XL,
2 – tryb z buforowaniem i doczytywaniem wymiarów do nowej daty utworzenia dokumentów (tryb, w którym dotychczas były pobierane wymiary opisu analitycznego),
3 – tryb z buforowaniem, ale bez doczytywania wymiarów (warunek: w Comarch ERP XL wymiary nie posiadają zakresów czasowych).
<add key=”CdnApiVersion” value=”20201″ /> – nr wersji systemu ERP XL, z którym współpracuje Comarch DMS.
<add key=”UrlERP” value=”UrlERP” /> – klucz należy uzupełnić przy konfigurowaniu współpracy Comarch DMS z Comarch ERP Enterprise (CEE). Należy wprowadzić adres URL do systemu CEE. np. „https://nazwa_aplikacji.cisag.com”. Nie ma konieczności uzupełniania klucza w przypadku pracy w trybie wielospółkowym.
<add key=”CertificateNameERP” value=”CertificateNameERP” /> – należy uzupełnić klucz certyfikatu dla CEE. Nie ma konieczności uzupełniania klucza w przypadku pracy w trybie wielospółkowym.
<add key=”RestServiceERP” value=”RestServiceERP” /> – w kluczu należy umieścić adres serwisu rest systemu Comarch ERP Enterprise.
<add key=”DatabaseERP” value=”DatabaseERP” /> – należy wprowadzić nazwę bazy CEE. Nie ma konieczności uzupełniania klucza w przypadku pracy w trybie wielospółkowym.
<add key=”OrganizationERPId” value=”OrganizationERP” /> – należy wprowadzić unikalny identyfikator (w formie GUID) domyślnej organizacji w CEE. Nie ma konieczności uzupełniania klucza w przypadku pracy w trybie wielospółkowym.
<add key=”OrganizationERPName” value=”DefaultOrganizationIdentifier” /> – należy wprowadzić nazwę organizacji nadaną w systemie Comarch ERP Enterprise.
<add key=”OCRComarchUri” value=”https://ocr.erp.comarch.pl/v1.0/api/” /> – adres serwera usługi Comarch OCR, na który wysyłane są pliki do rozpoznania w Comarch OCR.
<add key=”OCRComarchTimeout” value=”15″ /> – wartość to wyrażony w minutach czas, po którym przetwarzanie pliku zostanie przerwane i wyświetlony zostanie błąd (!), a program przejdzie do przetwarzania następnego dokumentu w kolejce.
<add key=”Version” value=”5048495746514648″ /> – parametr określający numer wersji Comarch DMS.
<!– <add key=”ERPSQLServer1” value=”.” /> –> – klucz wymagany przy współpracy z Comarch ERP XL w trybie chmurowym (należy odkomentować). Należy zdefiniować serwer dla bazy ERP XL.
<!– <add key=”ERPSQLServer2” value=”.” /> –> – jeżeli ERP XL w trybie chmurowym pracuje na więcej niż jednym serwerze, należy odkomentować i uzupełnić.
<add key=”UseRepository” value=”false” /> – parametr określający, czy do przechowywania dokumentów będzie używany moduł Manager dokumentów (wartość „false”), czy funkcjonalność Comarch DMS Repozytorium (wartość „true”).
<add key=”RepositoryUrl” value=”” /> – w przypadku korzystania z funkcjonalności Comarch DMS Repozytorium, należy wprowadzić adres URL aplikacji DocumentManager.WebApi,
np. http://localhost/DocumentManager.WebApi
<add key=”RepositoryClientUrl” value=”” /> – w przypadku korzystania z funkcjonalności Comarch DMS Repozytorium, należy wprowadzić adres URL aplikacji DocumentManager.WebClient,
http://localhost/DocumentManager.WebClient
Uruchamianie skryptów
W katalogu DMS Web\Sql znajduje się plik Install.bat, który służy do instalacji skryptów na bazie Comarch DMS. Plik należy uruchomić z linii poleceń wpisując: Install.bat <nazwa_serwera> <nazwa_bazy_DMS>
Lokalizacja pliku:
katalog z plikami instalacyjnymi \ Comarch DMS {wersja} \ DMS Web \ Sql \ Install.bat
Analogiczny scenariusz należy wykonać dla katalogu DMS Web \ SqlXL w tej samej lokalizacji, z tą różnicą, że zamiast nazwy bazy danych Comarch DMS należy podać nazwę bazy Comarch ERP XL.
Uwaga
Skrypty na bazie Comarch DMS oraz bazie Comarch ERP XL mogą być uruchamiane wielokrotnie.
Reindeksacja bazy
W katalogu SQL znajduje się plik reindex.bat, który umożliwia:
Zreindeksowanie tabel schematu DO,
Odbudowę statystyk,
Rekompilacje procedur i funkcji schematu DO.
Przyklad
reindex.bat <nazwa_serwera> <nazwa_bazy>
Zalecana jest reindeksacja bazy przy aktualizacji aplikacji Comarch DMS.
Weryfikacja poprawności konfiguracji aplikacji web
Poprawność instalacji można zweryfikować poprzez uruchomienie skonfigurowanej aplikacji web i zalogowanie się na użytkownika „administrator” (bez hasła).
Okno do logowania w Comarch DMS
Wieloinstalacyjność
W aplikacji Comarch DMS została oprogramowana funkcjonalność obsługi wyboru adresu URL wielu instalacji obiegu w wersji stacjonarnej, mobilnej oraz przez API, z którego korzysta Comarch ERP XL.
Funkcjonalność umożliwia:
Zalogowanie się do wielu instalacji Comarch DMS poprzez jedną aplikacje desktop lub aplikacje mobilne. Wybór instalacji odbywa się poprzez wskazanie nazwy instalacji na formatce logowania.
Powiązanie nazwy zmapowanej bazy danych Comarch ERP XL z instalacją Comarch DMS. Dzięki czemu istnieje możliwość podniesienia formatek aplikacji Comarch DMS wskazanej instalacji z poziomu formatki Comarch ERP XL „Historia związanych”.
Konfiguracja wieloinstalacyjności
W tabeli do.DF_ConfCMSettings, która znajduje się w bazie Comarch DMS należy zdefiniować następujące informacje w kolumnach:
CMS_Name – nazwa instalacji (pojawia się jako lista wyboru w oknie logowania),
CMS_URL – adres URL instalacji Comarch DMS,
CMS_ERPDBMap – nazwa zmapowanej bazy Comarch ERP XL.
Uwaga
W trybie wielofirmowym nie jest możliwe korzystanie z modelu wieloinstalacyjnego
Przyklad
CMS_Name
CMS_URL
CMS_ERPDBMap
Instalacja 1
http://www.firma.com/inst1
Nazwa zmapowana 1
Instalacja 2
http://www.firma.com/inst2
Nazwa zmapowana 2
Instalacja 3
http://www.firma.com/inst3
Nazwa zmapowana 3
Uwaga
Wszystkie instalacje powinny pracować na tej samej wersji aplikacji Comarch DMS.
Konfiguracje wieloinstalacyjności należy przeprowadzić na bazie Comarch DMS, która jest domyślną instalacją. Instalacja domyślna to ta, której URL jest zdefiniowany w pliku DMS.exe.config. Dla wersji systemu wcześniejszych niż 2020.2.1 jest to plik ObiegDokumentów.exe.config.
Logowanie do wersji stacjonarnej, wybór instalacji