Plik Web.config

image_pdfimage_print
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 serwerowej} (katalogu, do którego przekopiowano zawartość katalogu DMS Workflow Api z pakietu instalacyjnego) dostępne są następujące klucze:

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.

 

Uwaga

Od wersji 2024.0.2 możliwe jest wskazanie identyfikatora connection stringa, aby określić  connection string, na podstawie którego będzie następowało połączenie do bazy danych. Jeżeli:

  • <add key=”MultiCompany” value=”false” /> – wówczas connection stringi strConnectERPComp i strConnectERPConf1 są przechowywane w pliku Web.config
  • <add key=”MultiCompany” value=”true” /> – wówczas connection stringi są przechowywane  w pliku Web.config i w tabeli do.DF_ConfCMDictionary – w tym przypadku connection stringi do baz: konfiguracyjnej i firmowej są zapisywane pod jednym ID połączenia, zastosowano zatem nastepujące identyfikatory:
    • nazwa_spółki_Comp – pobiera connection string zapisany w kolumnie CMD_ConnectionStringERP / CMD_ConnectionStringERPEncrypted
    • nazwa_spółki_Conf – pobiera connection string zapisany w kolumnie CMD_ConnectionStringERPConf / CMD_ConnectionStringERPConfEncrypted

 

gdzie nazwa_spółki – wartość wprowadzona w polu „Nazwa spólki” / „Nazwa spółki (baza)” na zakładce  „Połączenia z ERP” na zakładce [Ustawienia]

 

Wartość wprowadzona w polu „Nazwa spółki (baza)”, która wchodzi w skład identyfikatorów connection stringów

 

Przykład wykorzystania identyfikatorów connection stringów dla bazy Comarch ERP Optima w ramach kontrolki typu Własna akcja

 

Identyfikatory connection stringów są wykorzystywane w kodzie C#:

    • dla MS SQL:
      • connection = new DmsSqlConnection(Globals.Common.ConnectionStrings.strConnectDMS)
      • DmsSqlCommand command = new DmsSqlCommand(connection, sqlQuery)
    • dla PostgreSQL:
      • connection = new DmsNpgsqlConnection(„pgStrConnectDMS”)
      • DmsNpgsqlCommand command = new DmsNpgsqlCommand(connection, sqlQuery)

 

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.

 

Rejestracja użytkownika w DMS z poziomu aplikacji web, gdy parametr „TaxPayerIdRequired” value=”false” />, „PersonalDataProcessingConsentRequired” value=”true” /> i parametr „WorkingConditionsAcceptanceRequired” value=”true”
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=„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ć.

Czy ten artykuł był pomocny?