System operacyjny dla serwera IIS

Silnik aplikacji Comarch DMS czyli aplikacje webową można zainstalować na następujących systemach operacyjnych:

Komponenty systemu IIS

Comarch DMS korzysta z następujących komponentów systemowych:

Serwer SQL

Comarch DMS może działać w oparciu o następujące wersje i edycje Microsoft SQL Server:

Uwaga

Podczas ręcznej instalacji silnika bazy danych  Microsoft SQL  Server należy zwrócić uwagę, aby po zaznaczeniu parametru „Windows collation designator and sort order” w polu „Collation designator” została wybrana wartość „Polish” oraz aby został  zaznaczony checkbox „Accent-sensitive”.

 

Prawidłowa konfiguracja parametru sortowania/porównywania znaków, widoczna w zakładce „Collation” to: POLISH_CI_AS

Jeżeli użytkownik będzie chciał dokonać zmiany ustawień w późniejszym terminie, może się okazać konieczna reinstalacja silnika bazy.

Opisane ustawienia to ustawienia na rynek polski. W przypadku stosowania Comarch DMS w innych krajach konieczne jest zastosowanie ustawień, które są rekomendowane przez firmę Microsoft dla danego kraju albo krajów.

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.

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.

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:

1. Aplikacji web,
2. Aplikacji desktop,
3. Pliku web.config,
4. Pliku DMS.exe.config (lub pliku ObiegDokumentow.exe.config dla wersji wcześniejszych niż 2020.2.1),
5. Skryptów SQL,
6. Skryptów SQL XL,
7. Skryptów SQL Optima,
8. Skryptów SQL Altum.

W sytuacji, gdy weryfikacja wersji wykaże niezgodność, zamiast okna logowania do aplikacji zostanie wyświetlony komunikat.

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 kanałów wirtualnych należy zmienić wartość na „true”.

Dla wersji Comarch DMS wcześniejszych niż 2020.2.1 klucze znajdują się w pliku ObiegDokumentow.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:

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.

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 serwerowa (dawna web). 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 serwerowa (dawna web)

Weryfikacja poprawności konfiguracji aplikacji stacjonarnej (desktop)

W utworzonym katalogu (np. C:\DMS) 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

Konfiguracja Menedżera Internetowych Usług Informatycznych (IIS)

Do instalacji aplikacji Comarch DMS wymagane jest posiadanie dodatku Microsoft.Net Framework w wersji 4.7.2 lub wyższej (zalecana 4.8) oraz zainstalowanie serwera IIS. Po zainstalowaniu serwera IIS, należy włączyć następujące komponenty:

W pobranym pliku instalacyjnym należy wejść do katalogu Comarch DMS {wersja} i  przekopiować zawartość katalogów DMS Workflow API i DMS Web do dwóch oddzielnych nowoutworzonych folderów na dysku C:\inetpub\wwwroot.

Nazwy folderów będą zarazem nazwami aplikacji webowych uruchamianych poprzez przeglądarkę, tzn:

Uwaga

Lokalnemu użytkownikowi IUSR należy nadać uprawnienie do katalogów DMSApi i DMSWeb!

 

 

Po uruchomieniu Menedżera Internetowych Usług Informatycznych należy kliknąć w nazwę 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”.

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”.

Pojawi się okno dodawania puli aplikacji. Należy wpisać w nim nazwę „DMS” i wybrać wersję .NetFramework v4.0 lub wyższą, a następnie ustawić „Zarządzany tryb potokowy” na Zintegrowany i zaznaczyć opcję „Uruchom pulę aplikacji natychmiast”.

Dla wybranej puli należy skonfigurować ustawienia zaawansowane.

Pojawi się okno, w którym należy ustawić opcję „Włącz aplikacje 32-bitowe” jako False, natomiast jako „Tożsamość” należy ustawić opcję „ApplicationPoolIdentity”, a następnie sprawdzić czy pozostałe parametry zostały ustawione jak poniżej:

Następnie należy skonwertować katalogi DMSApi (katalog, do którego skopiowano pliki z folderu DMS Workflow Api z pakietu instalacyjnego)  i DMSWeb (katalog, do którego skopiowano pliki z folderu DMS Web z pakietu instalacyjnego) na aplikacje i przypisać do nich utworzoną pulę.

Przygotowanie baz danych

W kolejnym kroku instalacji należy przygotować bazę danych dla aplikacji Comarch DMS.

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.

Konfiguracja pliku web.config

W pliku konfiguracyjnym Web.config znajdującym się w katalogu C:\inetpub\wwwroot\{nazwa aplikacji serwerowej} 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.

Uwaga

Od wersji 2024.0.0 instalator szyfruje connection strings w pliku Web.config w katalogu aplikacji serwerowej (dawnej web).

Ustawienia kluczy używane w obu trybach:

• <add key=”Version” value=”5048495746514648″ /> – parametr określający numer wersji Comarch DMS.
• <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 i aktywuje funkcje wpisywane do tabeli do.DF_ConfOSEmployeesQueue – tabeli z danymi rejestracji użytkowników. Okno rejestracji można wyświetlić po 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.

 

Uwaga

Do właściwego działania rejestracji użytkownika z poziomu aplikacji web konieczne jest poprawne wypełnienie przez administratora pól sekcji Ustawienia konta pocztowego w ramach zakładki Ustawienia w aplikacji desktopowej

• <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=”ACDFolderPathsDestination” value=”Registry” /> – parametr dostępny od wersji 2023.1.0; umożliwia wybór miejsca zapisu ścieżek punktów ACD. Klucz może przyjmować wartości:
  • • • • Registry – wartość domyślna, oznaczająca, że ścieżki punktów ACD będą zapisywane w rejestrze (jak dotychczas)  .
        • Database– wartość oznaczająca, że ścieżki punktów ACD będą zapisywane w bazie danych w tabeli do.DF_ConfAPFolderPaths

Uwaga

Jeśli użytkownik pierwszy raz zmienia wartość klucza na „Database”, wówczas przy pierwszym ładowaniu widoku punktów ACD wszystkie dane z rejestru zapisują się do bazy.  Natomiast przy zmianie wartości z „Database” na „Registry” dane z bazy nie są automatycznie przepisywane do rejestru.

• <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=”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 = „MailSendingInterval” value=”1” /> – parametr, w którym operator określa, jak często baza danych będzie sprawdzać, czy są nowe maile (w minutach)
• <add key = „DeleteMailsAfterSending” value=”False” /> – od wersji 2022.0.3 parametr, w którym operator określa, czy wiadomości email po wysłaniu powinny być usuwane czy zachowywane w tabelach. Klucz może przyjmować wartości:
  • • • • „False” – wartość oznaczająca, że zarówno maile, jak I załączniki zostaną zarchiwizowane w tabelach po wysłaniu
        • „True” – wartość oznaczająca, że zarówno maile, jak i załączniki zostaną usunięte po wysłaniu
• <add key=„NotAllowedFileExtensionsDM” value=”” /> – parametr, w ramach którego można wpisać rozszerzenia plików, które mają być zabronione przy dodawaniu nowych dokumentów do Managera Dokumentów. Domyślnie wartość klucza jest pusta – jeśli nie zostanie uzupełniona przez administratora, możliwe będzie dodawanie plików z każdym rodzajem rozszerzenia.
• <!– <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.

 

• <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=”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=”Comarch2FAUri” value=”https://ws.erp.comarch.pl/services/” /> – adres usługi 2FA z Comarch ERP Optima.

• add key=”KSeFWorkMode” value=”Demo” /> – klucz wprowadzony w wersji 2024.0.1; umozliwia określenie, czy Firma testuje funkcjonalność wysyłania faktur do KSeF, czy korzysta z niej produkcyjnie. Klucz może przybierać jedną z następujących wartości:

1.Demo – wartość domyślna; w przypadku wprowadzenia takiej wartości praca z systemem KSeF odbywa się w trybie Demo;

2.Production – w przypadku wprowadzenia takiej wartości praca z systemem KSeF odbywa się w trybie Produkcyjnym, czyli wersji produkcyjnej systemu;

3.Test – w przypadku wprowadzenia takiej wartości praca z systemem KSeF odbywa się w trybie testowym.

W kwestii różnic pomiędzy powyższymi trybami zob. Przełączanie trybu pracy z KSeF

• <add key=„EDorAuthApiUrl” value=”https://ow.edoreczenia.gov.pl/auth/realms/EDOR” /> – klucz dodany w wersji 2024.1.0 związany z integracją z usługą e-Doręczenia; w kluczu znajduje się adres potrzebny do uzyskania tokenu dostępowego do API Search Engine i User Agent;
• <add key=„EDorUserAgentApiUrl” value=”https://uaapi-ow.poczta-polska.pl/api/v2″ /> – klucz dodany w wersji 2024.1.0 związany z integracją z usługą e-Doręczenia; w ramach klucza określony jest endpoint dla API Search Engine;
• <add key=„EDorSearchApiUrl” value=”https://ow.edoreczenia.gov.pl/api/se/v2″ /> – klucz dodany w wersji 2024.1.0 związany z integracją z usługą e-Doręczenia; w ramach klucza określony jest endpoint dla API User Agent;
• <add key=„EDorMaxMessageSize” value=”15″ /> – klucz dodany w wersji 2024.1.0 związany z integracją z usługą e-Doręczenia; w ramach klucza określony jest maksymalny dopuszczalny rozmiar załączników, które są przesyłane w ramach usługi E-Doręczenia. Aktualnie wartość ta wynosi 15 MB. Klucz nieaktywny w pierwszej wersji funkcjonalności;
• <add key=„ChatERPUrl” value=”https://chat.aiml.comarch.com/api/v2″ /> – klucz dodany w wersji 2024.3.0; w ramach klucza znajduje się adres URL usługi Chat ERP;
• <add key=„ChatERPApiKeyEncrypted” value=”zaszyfrowany klucz API”/> – klucz dodany w wersji 2024.3.0; w ramach klucza znajduje się zaszyfrowany klucz API – jest to stała wartość, której nie należy edytować;

• <!– <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=”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=”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=”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=„WebClientUrl” value=”http://<ip serwera>/DocumentWorkflow.Web” /> – wprowadzony w wersji 2024.0.0; klucz, w którym (w przypadku korzystania z funkcjonalności Comarch DMS Repozytorium) należy wprowadzić adres aplikacji nowego klienta web,
  np. http://localhost/ DocumentWorkflow.Web (w wersjach starszych niż 2024.0.0 w tym miejscu znajduje się klucz <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).
• <add key=”PerformanceAnalysisTimeRange” value=”1000,5000″ /> – klucz dostępny od wersji 2024.0.0; umożliwia zmianę zakresów czasowych  informacji prezentowanych na zakładce „Analiza wydajności” w sekcji „Statystyki”
• <add key=”MaxLoginAttempts” value=”5″/> – klucz dostępny od wersji 2024.1.1; w ramach tego klucza należy podać, jaka ma być maksymalna liczba prób logowania dla operatora zanim nastąpi zablokowanie logowania – domyślna wartość to 5 (zob. Blokowanie logowania po kilku nieudanych próbach)
• <add key=”LoginBlockTime” value=”60″/> – klucz dostępny od wersji 2024.1.1; w ramach tego klucza należy podać, po jakim czasie (liczonym w sekundach) operator będzie mógł podjąć kolejną próbę logowania, po tym, jak logowanie zostało zablokowane – domyślna wartość to 60 (zob. Blokowanie logowania po kilku nieudanych próbach)

 

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=”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=”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ć.

Uruchamianie skryptów

Następnie należy uruchomić skrypty na bazie Comarch DMS.

W katalogu DMS Workflow Api\Sql znajduje się plik Install.bat, który służy do instalacji skryptów na bazie Comarch DMS.

Lokalizacja pliku:

katalog z plikami instalacyjnymi \ Comarch DMS {wersja} \ DMS Workflow Api \ Sql \ Install.bat

Aby uruchomić skrypty, należy postępować w jeden z następujących sposobów:

Przyklad

Sposób 1

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

 

Następnie należy wpisać cd, nacisnąć spację i podać ścieżkę do lokalizacji pliku Install.bat – np. C:\inetpub\wwwroot\DMS Workflow Api\Sql – a następnie nacisnąć Enter.

Później należy uruchomić plik z linii poleceń wpisując:

Install.bat <nazwa_serwera> <nazwa_bazy_Comarch_DMS>

a następnie klikając Enter – wówczas zostaną uruchomione skrypty.

 

 

Po wykonaniu skryptów należy zamknąć okno Wiersza polecenia.

Przyklad

Sposób 2

W katalogu DMS Workflow Api\Sql należy odnaleźć plik Install.bat i otworzyć go do edycji.

 

 

Następnie w ramach okna edytora należy uzupełnić dane w następujący sposób:

set SERVER=nazwa_serwera

SHIFT

set DATABASE=nazwa_bazy_Comarch_DMS

a następnie zapisać zmiany i zamknąć okno.

 

 

Uwaga

W wersji 2024.0.2 w pliku Install.bat został dodany dodatkowy argument ODUSERPASSWORD, w którym należy uzupełnić hasło dla ODUsera w przypadku instalacji ręcznej aplikacji Comarch DMS, jeśli aplikacja Comarch DMS jest instalowana po raz pierwszy i użytkownik ODUser nie istnieje w MSSQL.

Hasło dla użytkownika ODUser musi być zgodne z polityką haseł.
Należy używać silnego hasła, które spełnia wszystkie poniższe warunki:

• składa się z minimum 12 znaków;
• zawiera znaki alfabetyczne;
• zawiera znaki specjalne ze zbioru !@#$%^*()

 

 

Później należy kliknąć prawym przyciskiem myszki na plik Install.bat i wybrać opcję „Uruchom jako administrator”. Wówczas, po wyrażeniu zgody na dokonanie zmian przez Windows Command Processor, zostaną uruchomione skrypty. Po wykonaniu skryptów okno zostanie automatycznie zamknięte.

 

Reindeksacja bazy

W katalogu DMS Workflow Api\SQL znajduje się plik „reindex.bat”, który umożliwia:

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

Następnie należy wpisać cd, nacisnąć spację i podać ścieżkę do lokalizacji pliku reindex.bat – np. C:\inetpub\wwwroot\dms202311\Sql – a następnie nacisnąć Enter.

Póżniej należy uruchomić plik z linii poleceń wpisując:

reindex.bat <nazwa_serwera> <nazwa_bazy_Comarch_DMS>

a następnie klikając Enter – wówczas zostanie uruchomiona reindeksacja bazy Comarch DMS.

Po wykonaniu reindeksacji należy kliknąć dowolny przycisk, a później zamknąć okno Wiersza polecenia.

Weryfikacja poprawności konfiguracji aplikacji serwerowej

Poprawność instalacji można zweryfikować poprzez uruchomienie skonfigurowanej aplikacji serwerowej (dawny web) i zalogowanie się na użytkownika „administrator” (bez hasła).

Okno logowania do aplikacji serwerowej 

W celu konfiguracji aplikacji WEB należy przejść do artykułu Ręczna konfiguracja aplikacji WEB (nowej aplikacji web)

Od wersji 2020.2.1 dostępna jest możliwość rejestracji nowych użytkowników Comarch DMS z poziomu aplikacji serwerowej (dawna web). Do potencjalnego użytkownika zostaje wysłany mail zawierający link do formularza rejestracyjnego, w ramach którego potencjalny użytkownik :

Konfiguracja

Rejestracja nowych użytkowników z poziomu aplikacji serwerowej (dawna web) zostaje włączona, jeśli w pliku web.config wartość klucza <add key=”ExternalRegistrationEnabled” value=”false” /> zostanie zmieniona na true:

<add key=”ExternalRegistrationEnabled” value=”true” />  (zob. Instalacja aplikacji serwerowej (dawnej web) w trybie ręcznym).  Następnie należy określić następujące parametry:

• <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.

Przebieg rejestracji

Uwaga

Do właściwego działania rejestracji użytkownika z poziomu aplikacji web konieczne jest poprawne wypełnienie przez administratora pól sekcji Ustawienia konta pocztowego w ramach zakładki Ustawienia  w aplikacji desktopowej

Potencjalny użytkownik wyświetla w przeglądarce stronę, która znajduje się pod adresem: http://localhost/DocumentWorkflow.Web/ExternalRegistration- adres składa się z adresu aplikacji serwerowej (dawna web), do którego dokładany jest człon „/ExternalRegistration”, np. http://localhost/Standalone/ExternalRegistration

Potencjalny użytkownik powinien uzupełnić wymagane pola formularza, a następnie kliknąć przycisk [Zarejestruj się].

Po wyborze przycisku [Zarejestruj się] wyświetlone zostaje okno informujące o konieczności aktywacji konta, aby dokończyć proces rejestracji, a na adres email podany w formularzu wysyłana jest wiadomość zawierająca link aktywacyjny do konta. Jeżeli wiadomość nie dotarła na skrzynkę mailową, można ponowić próbę, klikając wyślij link ponownie w ramach okna przeglądarki.

Po wyborze przycisku [Aktywuj konto] wyświetlane jest okno z informacją o zakończeniu rejestracji sukcesem i z przyciskiem [Zaloguj się do Comarch DMS], po wyborze którego następuje przejście do okna logowania do aplikacji serwerowej (dawna web) Comarch DMS.

Dodany w ten sposób pracownik jest widoczny wraz z  loginem, imieniem, nazwiskiem i adresem mailowym, które uzupełniono w formularzu rejestracji,  w ramach zakładki [Struktura organizacyjna] w aplikacji Comarch DMS desktop.

Aby program działał prawidłowo, konieczne jest ustawienie opcji regionalnych systemu na polskie.

W tym celu dla systemu Windows 8/ Windows 10 należy:

• w ramach opcji Ustawienia wybrać Region i w polu Kraj lub region  – „Polska”

 

• w ramach opcji Panel sterowania wybrać ustawienia Zegar i region, a później Region

 

 

• następnie w ramach zakladki  „Formaty” wybrać format „Polski (Polska)”

 

 

• później w ramach zakładki „Administracyjne”  upewnić się, czy w polu Bieżący język dla programów nieobsługujących kodu Unicode: wybrane zostało ustawienie „Polski (Polska)”. Ustawienie mozna zmienić   po kliknięciu na przycisk „Zmień ustawienia regionalne systemu” – w otwartym wówczas oknie „Ustawienia regionalne” nalezy również dodatkowo sprawdzić, czy checkbox Użyj formatu Unicode UTF-8 do obsługi języków z całego świata jest zaznaczony – jeśli jest, należy go odznaczyć.

Kopiowanie zawartości katalogu DMS Workflow Api

W pobranym pliku instalacyjnym należy wejść do katalogu Comarch DMS {wersja} i przekopiować zawartość katalogu DMS Workflow Api  do folderu, który utworzono podczas poprzedniej instalacji i do którego wówczas przeniesiono zawartość folderu DMS Web (np.na dysku C:\inetpub\wwwroot\DMS).

Wprowadzanie zmian w pliku Web.config

Następnie w pliku konfiguracyjnym Web.config znajdującym się w katalogu C:\inetpub\wwwroot\{nazwa aplikacji serwerowej} należy wprowadzić potrzebne informacje, analogicznie jak podczas instalacji Comarch DMS (zob. punkt Konfiguracja pliku web.config w artykule Instalacja aplikacji serwerowej (dawnej web) w trybie ręcznym) i zapisać plik.

Uruchamianie skryptów

Następnie należy uruchomić skrypty na bazie Comarch DMS.

W katalogu DMS Workflow Api \Sql znajduje się plik Install.bat, który służy do instalacji skryptów na bazie Comarch DMS.

Lokalizacja pliku:

katalog z plikami instalacyjnymi \ Comarch DMS {wersja} \ DMS Workflow Api \ Sql \ Install.bat

Aby uruchomić skrypty, należy postępować w jeden z następujących sposobów:

Przyklad

Sposób 1

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

 

Następnie należy wpisać cd, nacisnąć spację i podać ścieżkę do lokalizacji pliku Install.bat – np. C:\inetpub\wwwroot\DMSWeb\Sql – a następnie nacisnąć Enter.

Później należy uruchomić plik z linii poleceń wpisując:

Install.bat <nazwa_serwera> <nazwa_bazy_Comarch_DMS>

a następnie klikając Enter – wówczas zostaną uruchomione skrypty.

 

 

Po wykonaniu skryptów należy zamknąć okno Wiersza polecenia.

Przyklad

Sposób 2

W katalogu DMS Workflow Api \Sql należy odnaleźć plik Install.bat i otworzyć go do edycji.

 

 

Następnie w ramach okna edytora należy uzupełnić dane w następujący sposób:

set SERVER=nazwa_serwera

SHIFT

set DATABASE=nazwa_bazy_Comarch_DMS

a następnie zapisać zmiany i zamknąć okno.

 

 

Później należy kliknąć prawym przyciskiem myszki na plik Install.bat i wybrać opcję „Uruchom jako administrator”. Wówczas, po wyrażeniu zgody na dokonanie zmian przez Windows Command Processor, zostaną uruchomione skrypty. Po wykonaniu skryptów okno zostanie automatycznie zamknięte.

 

Reindeksacja bazy

W katalogu DMS Workflow Api \SQL znajduje się plik „reindex.bat”, który umożliwia:

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

Następnie należy wpisać cd, nacisnąć spację i podać ścieżkę do lokalizacji pliku reindex.bat – np. C:\inetpub\wwwroot\dms202311\Sql – a następnie nacisnąć Enter.

Póżniej należy uruchomić plik z linii poleceń wpisując:

reindex.bat <nazwa_serwera> <nazwa_bazy_Comarch_DMS>

a następnie klikając Enter – wówczas zostanie uruchomiona reindeksacja bazy Comarch DMS.

Po wykonaniu reindeksacji należy kliknąć dowolny przycisk, a później zamknąć okno Wiersza polecenia.

Weryfikacja poprawności konfiguracji aplikacji serwerowej

Poprawność instalacji można zweryfikować poprzez uruchomienie skonfigurowanej aplikacji serwerowej i zalogowanie się na użytkownika.

W pobranym pliku instalacyjnym należy wejść do katalogu Comarch DMS {wersja}, następnie zawartość katalogu DMS Desktop przekopiować do folderu, który utworzono podczas poprzedniej instalacji i do którego wówczas przeniesiono zawartość folderu DMS Desktop (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 serwerowa (dawna web). 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.

Weryfikacja poprawności konfiguracji aplikacji stacjonarnej (desktop)

W utworzonym katalogu (np. C:\DMS) należy odszukać i uruchomić plik DMS.exe. Zostanie otwarte okno logowania do aplikacji stacjonarnej, w którym należy się zalogować na operatora.