W ramach pakietu Generator dokumentów do rejestru VAT, pobranego z zakładki „Przykłady”, z sekcji „ERP Optima” na Indywidualnych Stronach Partnerów (zob. Indywidualne Strony Partnerów | ERP Optima (comarch.pl)) znajdują się następujące katalogi:

Informacje początkowe i konfiguracja

1.Do katalogu, w którym jest zainstalowana stacjonarna wersja Comarch BPM (dawniej DMS) należy skopiować pliki z katalogu bin.

2.Kopiowanie pliku NLog.config jest opcjonalne, jest wymagany, jeżeli zachodzi potrzeba logowania informacji podczas generowania dokumentu.

3.Z katalogu „Typ obiegu” do programu Comarch BPM (dawniej DMS) należy zaimportować typ obiegu: OptimaVatRegisterGenerationAndAnalyticalDescription

4.Podczas generowania dokumentu do rejestru VAT Comarch ERP Optima za pomocą niniejszego mechanizmu, Comarch BPM (dawniej DMS) loguje operatora Comarch ERP Optima wskazanego w oknie Ustawienia > Autoryzacja API lub domyślnego operatora wskazanego w oknie Ustawienia > Połączenia z ERP (w przypadku, gdy Comarch BPM (dawniej DMS) pracuje w trybie wielofirmowym).

5. W katalogu ze stacjonarną wersją Comarch BPM (dawniej DMS) należy odszukać skopiowany wcześniej plik OptimaVatRegisterDimension.exe.config.

6. W pliku OptimaVatRegisterDimension.exe.config należy w kluczu <add key=”ServerUri” value=”http://<host>/<nazwa katalogu>”/> wpisać adres URL aplikacji serwerowej (dawna web) Comarch BPM (dawniej DMS).

7.Analogiczną operację należy przeprowadzić z plikiem OptimaVatRegisterGenerator.exe.config. W pliku należy odszukać kluczu <add key=”ServerUri” value=”http://<host>/<nazwa katalogu>”/> i wpisać adres URL aplikacji serwerowej (dawna web) Comarch BPM (dawniej DMS).

Klucze licencji

Podczas generowania dokumentu do rejestru VAT Comarch ERP Optima za pomocą niniejszego mechanizmu, pobierana jest licencja Comarch ERP Optima.

Dokumenty są generowane w oparciu o licencje operatora wskazanego w oknie Ustawienia > Autoryzacja API lub domyślnego operatora wskazanego w oknie Ustawienia > Połączenia z ERP (w przypadku, gdy Comarch BPM (dawniej DMS) pracuje w trybie wielofirmowym).

Istnieje również możliwość wskazania licencji, która będzie pobierana podczas generowania dokumentów do rejestru VAT w Comarch ERP Optima.

Aby wskazać licencję należy ustawić value =”1” dla wybranej licencji w pliku konfiguracyjnym OptimaVatRegisterGenerator.exe.config:

<add key=”KP” value=”0″/>

<add key=”KH” value=”0″/>

<add key=”KHP” value=”0″/>

<add key=”ST” value=”0″/>

<add key=”FA” value=”0″/>

<add key=”MAG” value=”0″/>

<add key=”PK” value=”0″/>

<add key=”PKXL” value=”0″/>

<add key=”CRM” value=”0″/>

<add key=”ANL” value=”0″/>

<add key=”DET” value=”0″/>

<add key=”BIU” value=”0″/>

<add key=”SRW” value=”0″/>

<add key=”ODB” value=”0″/>

<add key=”KB” value=”0″/>

<add key=”KBP” value=”0″/>

<add key=”HAP” value=”0″/>

<add key=”CRMP” value=”0″/>

Jeżeli w pliku OptimaVatRegisterGenerator.exe.config wszystkie wartości kluczy w sekcji Moduły Optima będą miały ustawioną wartość 0, wówczas generowanie dokumentów będzie odbywać się na dotychczasowych zasadach.

Konfiguracja kontrolek w obszarze (sekcji) „Rejestr zakupu”

Należy ustawić nazwę konfiguracyjnej bazy danych ERP Optima w zapytaniach inicjujących wartości kontrolek.

W tym celu należy kolejno:

Aby możliwe było generowanie dokumentów do Rejestru VAT Optima z załącznikami, wymagane jest zapisywanie załączników w bazie Comarch BPM (dawniej DMS).

Za ustawienie bazy, w której zapisywane są załączniki, odpowiada klucz <add key=”DestinationAttachmentsWorkflow” value=”DO” /> w pliku web.config (wartość DO oznacza zapisywanie załączników w bazie Comarch BPM (dawniej DMS)).

Kontrolka Własna akcja

Z poziomu kontrolki „Własna akcja” (Generuj dokument), należy ustawić definicję uruchomienia dodatku.

Definicja uruchomienia pliku OptimaVatRegisterGenerator.exe:

OptimaVatRegisterGenerator.exe @^UserLoginToken@ @^DocumentId@ @^Culture@ @^DocumentCompanyId@ @Int1@

Kontrolka Walidator

W załączonym typie obiegu znajduje się kontrolka Walidator (identyfikator Int1), w jej definicji wprowadzono warunek, odpowiadający za możliwość jednokrotnego generowania dokumentu.

Warunek blokuje możliwość wygenerowania kolejnego dokumentu również w przypadku, gdy wcześniej wygenerowany dokument w Comarch ERP Optima został odpięty od dokumentu w Comarch BPM (dawniej DMS).

W przypadku, gdy zajdzie potrzeba wygenerowania wielu dokumentów, należy zmienić warunek w kontrolce.

W przypadku gdy:

Domyślnie w kontrolce wyświetlana jest wartość 0.

Kontrolki Termin płatności i Zastosuj termin płatności

Włączenie obsługi terminu płatności, gdy przykład był wykorzystywany w poprzednich wersjach

W przypadku, gdy w Comarch BPM (dawniej DMS) wykorzystywany jest przykład do generowania dokumentów w rejestrze VAT ERP Optima, do obsługi przekazania terminu płatności wymagane jest wprowadzenie zmian jak poniżej:

1. Na definicji typu obiegu należy dodać kontrolki:

2.Po dodaniu kontrolek, należy w pliku konfiguracyjnym przykładu do generowania dokumentów odkomentować klucze odpowiedzialne za przekazanie wartości powyższych kontrolek:

W wartościach kluczy należy wpisać identyfikatory kontrolek dodanych na typie obiegu.

Włączenie obsługi terminu płatności w przypadku nowej konfiguracji przykładu

Aby włączyć obsługę terminu płatności, należy w pliku konfiguracyjnym OptimaVatRegisterGenerator.exe.config odkomentować klucze odpowiedzialne za przekazanie wartości powyższych kontrolek:

Kontrolka Numer rachunku bankowego

W przypadku, gdy w Comarch BPM (dawniej DMS) wykorzystywany jest przykład do generowania dokumentów w rejestrze VAT Comarch ERP Optima, do obsługi przekazania numeru rachunku bankowego wymagane jest:

1. dodanie kontrolki na definicji typu obiegu

Na definicji typu obiegu należy dodać kontrolkę typu tekst, nadać jej nazwę np. Numer rachunku bankowego i identyfikator np. Numer_rachunku_bankowego.

2. dodanie w pliku konfiguracyjnym klucza obsługującego przekazanie numeru rachunku bankowego na generowany dokument w Comarch ERP Optima.

Następnie należy w pliku konfiguracyjnym przykładu do generowania dokumentów dodać klucz odpowiedzialny za przekazanie numeru rachunku bankowego:

<add key="AccountNumberControl" value="Numer_rachunku_bankowego"/>

W wartości klucza należy wpisać identyfikator kontrolki typu tekst dodanej na typie obiegu.

Klucz ten domyślnie jest zakomentowany – aby korzystać z danej funkcjonalności należy go odkomentować.

Kontrolka Tryb generowania

W przypadku, gdy w Comarch BPM (dawniej DMS) wykorzystywany jest przykład do generowania dokumentów w rejestrze VAT Comarch ERP Optima do obsługi przekazania trybu generowania Netto/Brutto wymagane jest wprowadzenie zmian jak poniżej:

Na definicji typu obiegu należy dodać kontrolkę:

Tryb generowania – kontrolka typu Lista, inicjowanie wartości poprzez Słownik, wartości słownika: ‘Netto’, ‘Brutto’.

Kontrolka przekazuje informacje o tym, czy dokument ma zostać wygenerowany w rejestrze VAT Comarch ERP Optima od Netto, czy od Brutto.

W kontrolce należy wskazać odpowiednią wartość:

Po dodaniu kontrolki, należy w pliku konfiguracyjnym przykładu do generowania dokumentów dodać klucz odpowiedzialny za przekazanie wartości powyższej kontrolki:

<add key="GenerationModeControl" value="Tryb_Generowania" />

W wartości klucza należy wpisać identyfikator kontrolki dodanej na typie obiegu (w przykładzie jest to kontrolka o identyfikatorze Tryb_Generowania)

W przypadku konfiguracji generowania dokumentu do rejestru VAT Comarch ERP Optima po raz pierwszy, nie ma potrzeby modyfikacji pliku OptimaVatRegisterGenerator.exe.config oraz definicji typu obiegu, ponieważ te zmiany są już uwzględnione. Należy dokonać pozostałej konfiguracji zgodnie z opisem w tym artykule.

Konfiguracja kontrolek w obszarze (sekcji) „Opis analityczny”

Na właściwościach kontrolki „Opis analityczny” (kontrolka tabelaryczna), należy dodać kolumny typu lista odpowiadające zdefiniowanym wymiarom opisu analitycznego dla dokumentu typ „rejestr zakupu”.

Podczas konfiguracji kolumn z wymiarami analitycznymi w polach „Nazwa kolumny” należy wprowadzić dokładnie takie same nazwy wymiarów, jakie zostały zdefiniowane w Optimie.

Przykład posiada 7 inicjatorów list o nazwach od „Wymiar 1” do „Wymiar 7”. W każdej kolejnej kolumnie wymiaru należy ustawić kolejne inicjatory list.

Przyklad

Przykładowo, jeżeli na formatce „Opis analityczny” powiązanym z dokumentem typu „rejestr zakupu” zostały zdefiniowane poniższe wymiary:

 

 

konfiguracja kontrolki tabelarycznej „Opis analityczny” powinna wyglądać następująco:

 

Przenoszenie danych KSeF podczas generowania dokumentów FZV do Comarch ERP Optima

Od wersji Comarch BPM 2025.2.0 podczas generowania dokumentów FZV do Comarch ERP Optima można przenosić na dokumenty dane dotyczące KSeF (numery i daty).

W ramach definicji obiegu OptimaVatRegisterGenerationAndAnalyticalDescription.workflow dostępnego wraz z generatorem dokumentów i opisu analitycznego do rejestru VAT Comarch ERP Optima dodano następujące kontrolki, z których dane przekazywane są przez generator dokumentów Rejestr VAT do Comarch ERP Optima:

Dla tych kontrolek wprowadzono także odpowiednie klucze w pliku OptimaVatRegisterGenerator.exe.config (<add key="KSeFNumberControl" value="NumerKSeF" /> oraz <add key="KSeFReceiptDateControl" value="DataKSeF" />).

Kontrolki: „Data przyjęcia KSeF” „Numer KSeF” nie są wymagane do wygenerowania dokumentu w Comarch ERP Optima.

Dodatkowo na definicji obiegu: OptimaVatRegisterGenerationAndAnalyticalDescription.workflow wprowadzono następujące zmiany:

Uruchomienie przykładu

Aby wygenerować dokument do rejestru VAT z opisem analitycznym należy:

1. otworzyć dokument BPM (dawniej DMS) ze skonfigurowanym przykładem

2. uzupełnić kontrolki w obszarze (sekcji) „Rejestr zakupu”;

3. zapisać dokument;

4. wygenerować dokument poprzez kliknięcie w przycisk „Generuj dokument”;

5. uzupełnić kontrolki w obszarze (sekcji) „Opis analityczny”;

6. zapisać dokument;

7. wygenerować opis analityczny poprzez kliknięcie w przycisk „Dodaj opis analityczny”.

Po otwarciu nowego dokumentu BPM (dawniej DMS) należy wprowadzić lub zmienić wartości na karcie obiegu. Wartości w kontrolkach, których opis jest pogrubiony są obowiązkowe. Następnie należy zapisać dokument lub przekazać do kolejnego etapu.

Kolejnym krokiem jest kliknięcie w przycisk „Generuj dokument”, wygenerowany dokument automatycznie zostanie podpięty do pola „Rejestr VAT zakupu”.

W przypadku gdy dokument generowany jest z załącznikami, dołączone pliki dostępne są na dokumencie OBD powiązanym z wygenerowanym dokumentem w rejestrze VAT.

W oknie dokumentu Comarch ERP Optima wyświetlonym w Comarch BPM (dawniej DMS) nie ma możliwości podglądu dokumentu OBD, tym samym nie ma możliwości usunięcia załączników dodanych na dokument OBD.

Aby zweryfikować listę załączonych plików, należy otworzyć dokument w systemie Comarch ERP Optima.

Oprócz dołączania załączników, na dokument OBD w Comarch ERP Optima:

1. w polu Numer obcy umieszczana jest informacja o numerze dokumentu Comarch BPM (dawniej DMS), z którego wygenerowano dokumenty w Comarch ERP Optima;

2. w tytule dokumentu umieszczana jest informacja ‘Dokument Comarch BPM’.

Po wygenerowaniu opisu analitycznego poprzez kliknięcie w przycisk „Dodaj opis analityczny”, w kontrolce ‘Weryfikator opisu analitycznego’ zostanie wyświetlona informacja, że opis analityczny został dodany do dokumentu o numerze określonym w kontrolce Dokument.

Informacje początkowe

Do katalogu bin\exe w katalogu, w którym zainstalowano aplikację serwerową (dawny web) należy skopiować całą zawartość katalogu exe.

W ustawieniach zaawansowanych puli aplikacji należy powiązać pulę z kontem Windows, na którym zainstalowano Comarch ERP Optima.

W definicji kontrolek:

należy we wzorze na wartość SQL OD zamienić identyfikator kontrolki @CustomAction1_EXE@  na @CustomAction1_IISEXE@

Następnie należy wskazać konfiguracyjną bazę danych ERP Optima w zapytaniach inicjujących wartości kontrolek. W tym celu należy:

1. uruchomić stacjonarną wersję Comarch BPM (dawniej DMS);

2. przejść do konfiguracji zaimportowanego typu obiegu.

3. w kontrolkach:

w zapytaniach SQL odszukać nazwę bazy „CDN_KNF_Konfiguracja” i zamienić ją na właściwą nazwę konfiguracyjnej bazy danych.

4. w wielospółkowym trybie pracy Comarch BPM (dawniej DMS) dodatkowo zweryfikować spółkę, która jest wskazana w kontrolkach:

Aby możliwe było generowanie dokumentów do Rejestru VAT Optima z załącznikami, wymagane jest zapisywanie załączników w bazie Comarch BPM (dawniej DMS).

Za ustawienie bazy, w której zapisywane są załączniki odpowiada klucz <add key=”DestinationAttachmentsWorkflow”value=”DO” /> w pliku web.config (wartość DO oznacza zapisywanie załączników w bazie Comarch BPM (dawniej DMS)).

Konfiguracja generowania dokumentów – OptimaVatRegisterGenerator.exe

Z poziomu kontrolki „Własna akcja” (Dodaj opis analityczny), należy ustawić definicję uruchomienia dodatku, definicja uruchomienia powinna się znaleźć w edytorze SQL wywołanym dla opcji IIS.

Definicja uruchomienia pliku OptimaVatRegisterGenerator.exe:

OptimaVatRegisterGenerator.exe @^UserLoginToken@ @^DocumentId@ @^Culture@ @^DocumentCompanyId@ @Int2@

Kontrolka Walidator

W załączonym typie obiegu znajduje się kontrolka Walidator, w jej definicji wprowadzono warunek, odpowiadający za możliwość jednokrotnego generowania dokumentu.

Warunek blokuje możliwość wygenerowania kolejnego dokumentu również w przypadku, gdy wcześniej wygenerowany dokument w Comarch ERP Optima został odpięty od dokumentu w Comarch BPM (dawniej DMS).

W przypadku, gdy zajdzie potrzeba wygenerowania wielu dokumentów, należy zmienić warunek w kontrolce.

W przypadku, gdy:

Domyślnie w kontrolce wyświetlana jest wartość 0.

Konfiguracja generowania dokumentów – OptimaVatRegisterDimension.exe

Z poziomu kontrolki „Własna akcja” (Dodaj opis analityczny), należy ustawić definicję uruchomienia dodatku, definicja uruchomienia powinna się znaleźć w edytorze SQL wywołanym dla opcji IIS.

Definicja uruchomienia pliku OptimaVatRegisterDimension.exe:

OptimaVatRegisterDimension.exe @^UserLoginToken@ @^DocumentId@ @^Culture@ @^DocumentCompanyId@ @Int2@

Konfiguracja kontrolek w obszarze (sekcji) „Opis analityczny”

Na właściwościach kontrolki „Opis analityczny” (kontrolka tabelaryczna), należy dodać kolumny typu lista odpowiadające zdefiniowanym wymiarom opisu analitycznego dla dokumentu typ „rejestr zakupu”.

Podczas konfiguracji kolumn z wymiarami analitycznymi w polach „Nazwa kolumny” należy wprowadzić dokładnie takie same nazwy wymiarów, jakie zostały zdefiniowane w Optimie.

Przykład posiada 7 inicjatorów list o nazwach od „Wymiar 1” do „Wymiar 7”. W każdej kolejnej kolumnie wymiaru należy ustawić kolejne inicjatory list.

Przyklad

Przykładowo, jeżeli na formatce „Opis analityczny” powiązanej z dokumentem typu „rejestr zakupu” zostały zdefiniowane poniższe wymiary

 

 

konfiguracja kontrolki tabelarycznej „Opis analityczny” powinna wyglądać następująco:

 

Ponadto w definicji kontrolek:

należy we wzorze na wartość SQL OD zamienić identyfikator kontrolki @CustomAction2_EXE@ na @CustomAction2_IISEXE@

Uruchomienie przykładu

Aby wygenerować dokument do rejestru VAT z opisem analitycznym należy:

1. otworzyć dokument BPM (dawniej DMS) ze skonfigurowanym przykładem

2. uzupełnić kontrolki w obszarze (sekcji) „Rejestr zakupu”;

3. zapisać dokument;

4. wygenerować dokument poprzez kliknięcie w przycisk „Generuj dokument”;

5. uzupełnić kontrolki w obszarze (sekcji) „Opis analityczny”;

6. zapisać dokument;

7. wygenerować opis analityczny poprzez kliknięcie w przycisk „Dodaj opis analityczny”.

Po otwarciu nowego dokumentu BPM (dawniej DMS) należy wprowadzić lub zmienić wartości na karcie obiegu. Wartości w kontrolkach, których opis jest pogrubiony są obowiązkowe. Następnie należy zapisać dokument lub przekazać do kolejnego etapu.

Kolejnym krokiem jest kliknięcie w przycisk „Generuj dokument”, wygenerowany dokument automatycznie zostanie podpięty do pola „Rejestr VAT zakupu”.

W przypadku gdy dokument generowany jest z załącznikami, dołączone pliki dostępne są na dokumencie OBD powiązanym z wygenerowanym dokumentem w rejestrze VAT.

W oknie dokumentu Comarch ERP Optima uruchomionym w Comarch BPM (dawniej DMS) nie ma możliwości podglądu dokumentu OBD, tym samym nie ma możliwości usunięcia załączników dodanych na dokument OBD.

Aby zweryfikować listę załączonych plików, należy otworzyć dokument w systemie Comarch ERP Optima.

Oprócz dołączania załączników, na dokument OBD w Comarch ERP Optima:

1. w polu Numer obcy umieszczana jest informacja o numerze dokumentu Comarch BPM (dawniej DMS), z którego wygenerowano dokumenty w Comarch ERP Optima;

2. w tytule dokumentu umieszczana jest informacja ‘Dokument Comarch BPM’.

Po wygenerowaniu opisu analitycznego poprzez kliknięcie w przycisk „Dodaj opis analityczny”, w kontrolce ‘Weryfikator opisu analitycznego’ zostanie wyświetlona informacja, że opis analityczny został dodany do dokumentu o numerze określonym w kontrolce Dokument.

<a href=”https://pomoc.comarch.pl/bpm/wp-content/uploads/2025/09/Przyklad-zastosowania-kodu-C-ze-wskazaniem-identyfikatora-connection-string.pdf”>Przykład zastosowania kodu C# ze wskazaniem identyfikatora connection string</a>

Poprawność instalacji można zweryfikować poprzez uruchomienie skonfigurowanej aplikacji web (nowej aplikacji web) i zalogowanie się na użytkownika „administrator” (bez hasła). Od wersji 2025.1.0 w przypadku, gdy aplikację Comarch BPM instalowano za pomocą instalatora, w polu „Hasło” należy wprowadzić hasło, które wprowadzono dla administratora podczas instalacji, w ramach okna „Klucze licencji i hasło Administratora”.

Zmiana puli aplikacji dla aplikacji WEB

W tym celu operator powinien kolejno:

• Otworzyć Menedżer Internetowych Usług Informacyjnych (IIS)
• Jeżeli chce użyć nowej puli: dodać nową pulę, analogicznie jak przy instalacji Comarch DMS, o takich samych właściwościach (zob. przykładowo Konfiguracja Menedżera Internetowych Usług Informatycznych (IIS));
• Na liście aplikacji dostępnej po lewej stronie okna kliknąć na aplikację WEB, która ma zostać zaktualizowana i w oknie „Akcje” (z prawej strony okna) nacisnąć „Ustawienia zaawansowane…”

 

 

• W ramach okna „Ustawienia zaawansowane” kliknąć w pole „Pula aplikacji” , a następnie w przycisk z wielokropkiem

 

 

• W oknie „Wybieranie puli aplikacji” wybrać inną pulę aplikacji o odpowiednich właściwościach dla aplikacji Comarch BPM (dawniej DMS)

 

 

• nacisnąć przycisk „OK” w ramach okna „Wybieranie puli aplikacji”
• nacisnąć przycisk „OK” w ramach okna „Ustawienia zaawansowane” – od tej pory dana aplikacja WEB znajduje się na wybranej puli aplikacji

Kopiowanie zawartości katalogu DMS Web

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

Wprowadzanie zmian w pliku Index.html

Następnie w ramach katalogu zawierającego aplikację web należy otworzyć do edycji plik index.html i uzupełnić nazwę aplikacji web w ramach klucza „base href”, przykładowo:

<base href=”/BPMWeb/”>

a następnie zapisać wprowadzone zmiany.

Wprowadzanie zmian w pliku web.config

Następnie w ramach katalogu zawierającego aplikację web należy otworzyć do edycji plik web.config i uzupełnić:

a następnie zapisać wprowadzone zmiany.

Przyklad

Przykład:

<rule name=”WorkflowApi” stopProcessing=”true”>
<match url=”^api/(.*)” />
<action type=”Rewrite” url=”http://localhost/BPMApi/api/v3/{R:1}”
logRewrittenUrl=”true” />
</rule>
<rule name=”WorkflowDashboards” stopProcessing=”true”>
<match url=”^dashboards/(.*)” />
<action type=”Rewrite”
url=”http://localhost/BPMApi/reports/{R:1}”
logRewrittenUrl=”true” />
</rule>
<rule name=”WorkflowWebsockets” stopProcessing=”true”>
<match url=”^hubs/(.*)” />
<action type=”Rewrite” url=”http://localhost/BPMApi/signalr/{R:1}”
logRewrittenUrl=”true” />
</rule>

 

Weryfikacja poprawności konfiguracji aplikacji web

Poprawność aktualizacji można zweryfikować poprzez uruchomienie skonfigurowanej aplikacji web i zalogowanie się na użytkownika „administrator” (bez hasła). Od wersji 2025.1.0 w przypadku, gdy aplikację Comarch BPM instalowano za pomocą instalatora, w polu „Hasło” należy wprowadzić hasło, które wprowadzono dla administratora podczas instalacji, w ramach okna „Klucze licencji i hasło Administratora”.

W wersji 2025.2.0 umożliwiono dodanie nowego administratora w Comarch BPM Repozytorium:

Od wersji 2025.2.0 po przejściu do okna „Zarządzanie uprawnieniami” dla danego folderu (obszaru) istnieje możliwość wyboru roli „Administrator” dla pracownika. W tym celu w ramach listy wyboru poziomu uprawnień dla pracownika wyświetlanej po kliknięciu ikony strzałki skierowanej w dół dodano opcję „Administrator” wraz z opisem dostępnych uprawnień. Operator może wybrać tę opcję, aby zmienić poziom uprawnień pracownika lub nadać takie uprawnienie nowemu pracownikowi.

W sytuacji, kiedy przedtem do danego obszaru przypisany był tylko jeden administrator lokalny, nadanie uprawnień administratora lokalnego drugiemu operatorowi umożliwia edycję lub usunięcie jednego z administratorów lokalnych.

Wprowadzone zmiany należy zapisać za pomocą przycisku [Zapisz].

Obok nagłówka „Osoby z dostępem do folderu” dodano również ikonę [Info] – po przesunięciu na nią kursora wyświetlana jest następująca informacja:

Wybrane osoby mogą mieć określony poziom uprawnień:

Przeglądający – tylko podgląd
Edytor – porządkowanie, dodawanie i edytowanie
Administrator – pełen dostęp, archiwizacji i zarządzanie uprawnieniami

Role operatorów – administrator i użytkownik

W ramach Comarch BPM (dawniej DMS) Repozytorium można wyróżnić dwie główne role, jakie mogą pełnić operatorzy:

• Administrator – jest to użytkownik, który jednocześnie:

 

1. posiada uprawnienie administratora w Comarch BPM (dawniej DMS), tzn. w aplikacji desktopowej Comarch BPM (dawniej DMS) w ramach zakładki [Struktura organizacyjna] na karcie pracownika, w zakładce Uprawnienia, w sekcji Uprawnienia ogólne opcja Administrator  jest zaznaczona na Tak,

2. ma  w  tej samej zakładce [Struktura organizacyjna] na karcie pracownika w sekcji Funkcjonalności  parametr Praca z modułem  wybrany na Obieg Dokumentów i Repozytorium.

Nowododany administrator posiada uprawnienia administratora także do obszarów , folderów podrzędnych i dokumentów, które znajdowały się w Repozytorium zanim przyznano mu uprawnienia.

 

 

Administrator posiada w ramach Repozytorium wiele uprawnień niedostępnych dla standardowego użytkownika, takich jak:

• definiowanie typów dokumentu - w tym możliwość włączenia, edycji lub wyłączenia retencji
• definiowanie globalnej listy atrybutów
• dodawanie powodów unieważnienia dokumentów
• zarządzanie poziomem uprawnień innych użytkowników we wszystkich katalogach i w stosunku do wszystkich dokumentów w Repozytorium
• tworzenie obszarów (katalogów z przypisanym administratorem) w ramach katalogu głównego Repozytorium
• tworzenie, edycja i usuwanie obszarów i katalogów w każdym katalogu w ramach Repozytorium
• dodawanie, edycja i usuwanie dokumentów w ramach całego Repozytorium (poza katalogiem głównym Repozytorium)

Uwaga

Administrator główny jest dodawany do każdego obszaru , katalogu i dokumentu, ponieważ jest dodawany do root'a (katalogu głównego Repozytorium).

Uwaga

Jeżeli którekolwiek z wymienionych uprawnień  (administratora lub pracy z modułem Repozytorium) zostanie odebrane, wówczas operator zostanie usunięty z katalogu głównego Comarch BPM (dawniej DMS) Repozytorium - czyli usunięty z wszelkich podrzędnych obszarów , katalogów i dokumentów.

• Standardowy użytkownik – operator, którego dodano w Comarch BPM (dawniej DMS), a który nie jest administratorem i który w aplikacji desktopowej Comarch BPM (dawniej DMS) w ramach zakładki [Struktura organizacyjna] na karcie pracownika, w zakładce Uprawnienia,  w sekcji Funkcjonalności  ma parametr Praca z modułem  wybrany na Obieg Dokumentów i Repozytorium. Użytkownik może mieć następujące poziomy uprawnień: administrator obszaru, edytor albo przeglądający.

 

Uwaga

Aby standardowy użytkownik mógł pracować w Repozytorium, powinien  mieć przyznane przez administratora uprawnienia do przynajmniej jednego katalogu – w innym wypadku nie będzie w stanie przesłać żadnych dokumentów bezpośrednio do Repozytorium ani przeglądać żadnych dokumentów w ramach Repozytorium.

Rodzaje uprawnień operatorów

W odniesieniu do danego folderu lub dokumentu administrator Repozytorium może nadać użytkownikowi jeden z trzech rodzajów uprawnień:

• • • Przeglądający – użytkownik nie może modyfikować danego obszaru /katalogu /dokumentu, ma jednak dostęp do podglądu  i przeglądania dokumentów, które należą do katalogu, do którego nadano uprawnienie „Przeglądający”,  a także do katalogów podrzędnych (chyba, że dany katalog to  obszar , którego administratorem jest inny użytkownik). Dostęp obejmuje także opcję pobrania na dysk dokumentów, zarówno aktywnych, jak i zarchiwizowanych.

 

 

Uwaga

Jeżeli w ramach katalogu, do którego przyznano uprawnienie „Przeglądający”  administrator doda obszar podrzędny , którego administratorem jest inny użytkownik, wtedy taki obszar podrzędny nie jest widoczny dla „Przeglądającego”.

• • • Edytor – użytkownik może modyfikować dany obszar /katalog /dokument. Oprócz uprawnień dostępnych na poziomie „Przeglądający” użytkownik będący „Edytorem”  ma możliwość dodawania, archiwizacji, unieważniania i usuwania dokumentów, a także zmiany ich nazwy, typu dokumentu i wartości atrybutów oraz edycji zakończenia okresu przechowywania. Może także w ramach podglądu dodać nowe atrybuty do danego typu dokumentu, wybierając spośród wszystkich określonych w Repozytorium przez administratora Repozytorium.  W zakresie uprawnień „Edytora” leży także dodawanie, usuwanie i edycja katalogów (zmiana nazwy), w przypadku katalogu, do którego przyznano uprawnienie oraz katalogów do niego podrzędnych.

 

 

 

Uwaga

Jeżeli w ramach katalogu, do którego przyznano uprawnienie „Edytor”  administrator doda obszar podrzędny , którego administratorem jest inny użytkownik, wtedy taki obszar podrzędny nie jest widoczny dla „Edytora”.

 

Przyklad

Administrator nadał operatorowi „Jan Kowalski” uprawnienia edytora do obszaru Folder na faktury. Następnie postanowił utworzyć w ramach tego folderu obszar Folder C, którego administratorem jest operator „Joanna Bławatek”.

 

[/su_lightbox]

Administrator Repozytorium widzi wówczas w obszarze Folder na faktury listę folderów i dokumentów, która zawiera również obszar Folder C.

 

 

Natomiast użytkownik „Jan Kowalski” widzi tę samą listę, ale bez obszaru Folder C.

 

• • • Administrator – użytkownik może modyfikować dany obszar /katalog /dokument. Oprócz uprawnień dostępnych na poziomie „Edytor” użytkownik będący „Administratorem”  ma możliwość zarządzania uprawnieniami innych użytkowników do obszaru , dla którego jest administratorem oraz do znajdujących się w nim dokumentów.

 

Uwaga

Uprawnienie administratora może być przyznane tylko do obszaru – nie jest możliwe przyznanie uprawnień administratora do katalogu lub dokumentu.

 

Uwaga

Jeśli użytkownikowi zostaną nadane uprawnienia administratora do obszaru , to takie uprawnienia są dziedziczone także na podrzędny w stosunku do niego obszar z nowym administratorem.

 

Przyklad

Administrator utworzył w ramach katalogu głównego Repozytorium obszar Folder 5 i nadał w stosunku do niego uprawnienia administratora operatorowi „Joanna Bławatek”.

 

 

Następnie w ramach obszaru Folder 5  administrator utworzył nowy obszar Folder na instrukcje, nadając  operatorowi „Aleksandra Maj” uprawnienia administratora  w stosunku do niego.

 

Wówczas po wybraniu opcji Zarządzaj uprawnieniami widoczne jest, że operator „Joanna Bławatek” ma w stosunku do obszaru Folder na instrukcje uprawnienia administratora, choć nie nadawano jej takich uprawnień na tym obszarze – dziedziczy je z obszaru nadrzędnego Folder 5.

 

 

Uwaga

W wersjach wcześniejszych niż 2025.2.0 po nadaniu uprawnień administratora danego obszaru innemu użytkownikowi nie jest możliwa edycja lub usunięcie uprawnień takiego użytkownika, chyba że uprawnienia administratora lokalnego do danego obszaru ma co najmniej dwóch użytkowników – wtedy możliwe jest usunięcie lub modyfikacja uprawnień jednego z nich. Nie jest też możliwe dodanie nowego administratora lokalnego do istniejącego obszaru .

Od wersji 2025.2.0 umożliwiono dodanie nowego administratora w Comarch BPM Repozytorium do już utworzonego obszaru (zob.  Zmiana administratora na obszarach w Comarch BPM Repozytorium)

 

Przykłady funkcjonowania uprawnień w Repozytorium

Przyklad

Uprawnienia administratora folderu podrzędnego a uprawnienia do folderu nadrzędnego

Administrator nadaje operatorowi "Anna Kowalik" uprawnienia administratora do obszaru Folder na potwierdzenia zamówień.

 

 

Następnie w ramach obszaru Folder na potwierdzenia zamówień administrator tworzy obszar Styczeń 2022 i nadaje w nim uprawnienia administratora użytkownikowi "Barbara Nowacka".

 

 

Przy takim zdefiniowaniu uprawnień do tych obszarów zarówno "Barbara Nowacka", jak i "Anna Kowalik" mają uprawnienia do obszaru Styczeń 2022.

 

 

Jednocześnie operator "Barbara Nowacka" nie posiada żadnych uprawnień do obszaru Folder na potwierdzenia zamówień - pomimo tego, że jest administratorem obszaru znajdującego się w Folderze na potwierdzenia zamówień.

 

Przyklad

Uprawnienia edytora folderu podrzędnego a uprawnienia do folderu nadrzędnego

Administrator nadaje operatorowi "Anna Kowalik" uprawnienia administratora do obszaru Folder na potwierdzenia zamówień.

 

 

Następnie w ramach obszaru Folder na potwierdzenia zamówień administrator tworzy folder Uwagi, nie dodając dodatkowego administratora.

 

 

Po wejściu do menu kontekstowego   folderu Uwagi   i po wybraniu opcji Zarządzaj uprawnieniami  administrator nadaje operatorowi "Barbara Nowacka" uprawnienie edytora w stosunku do tego folderu, wyszukując operatora za pomocą wyszukiwarki, klikając [Dodaj] przy  nazwisku "Barbara Nowacka", następnie w ramach pola Osoby z dostępem do pliku naciskając obok tego użytkownika i wybierając  opcję Edytor.

 

 

 

 

 

Wówczas, kiedy administrator wybierze menu kontekstowe obszaru Folder na potwierdzenia zamówień  i opcję Zarządzaj uprawnieniami , wtedy będzie widoczne, że operator "Barbara Nowacka" co prawda znajduje się na liście Osoby z dostępem do pliku, ale z poziomem uprawnienia Brak dostępu.

Poziom uprawnień można zmienić z Brak dostępu  na Edytor lub Przeglądający, naciskając strzałkę obok napisu Brak dostępu i wybierając odpowiednią opcję, a następnie [Zapisz]

W ten sposób  ułatwiono potencjalne nadanie uprawnień do folderu nadrzędnego dla osoby, która ma już uprawnienia do znajdującego się w nim folderu podrzędnego. Jeżeli natomiast administrator nie chce, żeby operatora "Barbara Nowacka" wyświetlano na liście, może usunąć tę pozycję z listy, klikając ikonę obok napisu Brak dostępu,  a następnie [Zapisz] -  ta operacja nie wpłynie na uprawnienia operatora "Barbara Nowacka" w folderze podrzędnym.

 

 

 

Przyklad

Uprawnienia operatora o poziomie uprawnień "przeglądający"  do folderu nadrzędnego Folder 4, kiedy zostaje mu odebrany dostęp do folderu podrzędnego Folder 4.1

Na liście obszarów znajduje się obszar Folder 4 , a w nim dwa foldery podrzędne: Folder 4.1 i  Folder 4.2.

 

 

Administrator nadaje uprawnienie „Przeglądający” operatorowi „Jan Kowalski” na poziomie obszaru Folder 4.

 

 

Następnie administrator usuwa uprawnienia operatora „Jan Kowalski” na poziomie folderu podrzędnego Folder 4.1.

 

Wówczas uprawnienia operatora "Jan Kowalski" na poszczególnych poziomach prezentują się następująco:

• W ramach uprawnień do Folder 4.1 – brak dostępu* z możliwością edycji

 

• W ramach uprawnień do drugiego folderu podrzędnego, Folder 4.2 – przeglądający

 

• W ramach uprawnień do obszaru nadrzędnego Folder 4 – przeglądający*

 

Przy dodawaniu uprawnień pracownikowi pod możliwymi do wyboru opcjami Przeglądający i Edytor dostępne są krótkie opisy możliwości działań na danym poziomie uprawnień – w wersji 2022.0.1 informacja dostępna pod opcją Edytor została zmodyfikowana, tak aby obejmować nowoprzyznane edytorowi uprawnienie archiwizacji dokumentów.

Możliwości pracy danego użytkownika  w  Repozytorium są zależne od tego, czy administrator nadał mu uprawnienia do dostępu do danego pliku lub folderu.

Bez przyznanych uprawnień użytkownik nie może  dodawać nowych obszarów, folderów i dokumentów ani modyfikować tych, które wprowadzono już do Repozytorium, nie są też dla niego widoczne obszary, foldery oraz dokumenty dodane przez innych użytkowników.

Rodzaje uprawnień użytkowników – „Przeglądający”, „Edytor”, „Administrator”

W odniesieniu do danego folderu lub dokumentu użytkownikowi może zostać nadany przez administratora jeden z trzech rodzajów uprawnień:

1. Przeglądający – użytkownik z takim rodzajem uprawnień:

Uwaga

Jeżeli w ramach katalogu, do którego przyznano uprawnienie „Przeglądający”  administrator doda obszar podrzędny , którego administratorem jest inny użytkownik, wtedy taki obszar podrzędny nie jest widoczny dla „Przeglądającego”.

2. Edytor – użytkownik z takim poziomem uprawnień:

Uwaga

Jeżeli w ramach katalogu, do którego przyznano uprawnienie „Edytor”  administrator doda obszar podrzędny , którego administratorem jest inny użytkownik, wtedy taki obszar podrzędny nie jest widoczny dla „Edytora”.

Przyklad

Administrator nadał operatorowi „Jan Kowalski” uprawnienia edytora do obszaru Folder na faktury. Następnie postanowił utworzyć w ramach tego folderu obszar Folder C, którego administratorem jest operator „Joanna Bławatek”.

 

 

Administrator Repozytorium widzi wówczas w obszarze Folder na faktury listę folderów i dokumentów, która zawiera również obszar Folder C.

 

 

Natomiast użytkownik „Jan Kowalski” widzi tę samą listę, ale bez obszaru Folder C.

 

3. Administrator – użytkownik z takim poziomem uprawnień:

Uwaga

Uprawnienie administratora może być przyznane tylko do obszaru – nie jest możliwe przyznanie uprawnień administratora do katalogu lub dokumentu.

Uwaga

Jeśli użytkownikowi zostaną nadane uprawnienia administratora do obszaru , to takie uprawnienia są dziedziczone także na podrzędny w stosunku do niego obszar z nowym administratorem.

Przyklad

Administrator utworzył w ramach katalogu głównego Repozytorium obszar Folder 5 i nadał w stosunku do niego uprawnienia administratora operatorowi „Joanna Bławatek”.

 

 

Następnie w ramach obszaru Folder 5  administrator utworzył nowy obszar Folder na instrukcje, nadając  operatorowi „Aleksandra Maj” uprawnienia administratora  w stosunku do niego.

 

 

Wówczas po wybraniu opcji Zarządzaj uprawnieniami widoczne jest, że operator „Joanna Bławatek” ma w stosunku do obszaru Folder na instrukcje uprawnienia administratora, choć nie nadawano jej takich uprawnień na tym obszarze – dziedziczy je z obszaru nadrzędnego Folder 5.

 

Uwaga

W wersjach wcześniejszych niż 2025.2.0 po nadaniu uprawnień administratora danego obszaru innemu użytkownikowi nie jest możliwa edycja lub usunięcie uprawnień takiego użytkownika, chyba że uprawnienia administratora lokalnego do danego obszaru ma co najmniej dwóch użytkowników – wtedy możliwe jest usunięcie lub modyfikacja uprawnień jednego z nich. Nie jest też możliwe dodanie nowego administratora lokalnego do istniejącego obszaru .

Od wersji 2025.2.0 umożliwiono dodanie nowego administratora w Comarch BPM Repozytorium do już utworzonego obszaru (zob. Zmiana administratora na obszarach w Comarch BPM Repozytorium )

[/su_list]

Zarządzanie uprawnieniami do folderu lub dokumentu

Zarządzanie uprawnieniami do folderu lub dokumentu  jest możliwe dla użytkownika, któremu przyznano uprawnienie „Administrator” do danego folderu albo dokumentu.

Istnieją cztery sposoby na uzyskanie dostępu do zarządzania uprawnieniami:

1. przesunięcie kursora na dany folder/dokument, a następnie kliknięcie w menu kontekstowe  i wybór opcji [Zarządzaj uprawnieniami]

2. zaznaczenie checkboxa przy danym folderze/dokumencie, a następnie naciśnięcie [Zarządzaj uprawnieniami] z menu kontekstowego na belce nad listą dokumentów

3. zaznaczenie checkboxa przy danym folderze/dokumencie, wybór ikonki [Info] na prawym panelu, a następnie naciśnięcie [Zarządzaj uprawnieniami]

4. wybór opcji [Zarządzaj uprawnieniami] po wyborze przycisku „Więcej akcji” w podglądzie dokumentu

Okno „Zarządzaj uprawnieniami folderu”/”Zarządzaj uprawnieniami pliku” składa się z dwóch części:

1. pola „Nadaj uprawnienia pracownikom” – można w nim wyszukać danego pracownika i dodać go do osób posiadających uprawnienia do folderu/dokumentu.

Wyszukiwanie jest możliwe już po wpisaniu jednego znaku, pod wpisywanym tekstem pojawia się lista pracowników, w których imieniu albo nazwisku występuje podana fraza.

Aby nadać uprawnienia do folderu/dokumentu pracownikowi, należy kliknąć przycisk [Dodaj].

Jeżeli użytkownik ma już przyznane uprawnienia, obok jego nazwiska na liście pojawia się znak .

 

 

2. pola „Osoby z dostępem do pliku” – wyświetlona jest pod nim lista osób, którym nadano uprawnienia do danego katalogu/dokumentu.

Możliwe poziomy uprawnienia to: „Administrator”, „Przeglądający”, „Edytor”.

Raz nadany poziom uprawnienia „Administrator” nie podlega edycji (chyba że administratorów jest przynajmniej dwóch i są to administratorzy lokalni), nie można także dodać takiego uprawnienia w ramach opcji „Zarządzaj uprawnieniami folderu”.

Natomiast poziom uprawnień „Przeglądający” podlega opcji edycji na „Edytor” i na odwrót.

Jeżeli zmieniono poziom uprawnień w ramach katalogu podrzędnego, niebędącego obszarem lub dokumentu znajdującego się w katalogu podrzędnym, wówczas przy poziomie uprawnień danego użytkownika w folderze nadrzędnym pojawia się znak *.

Za pomocą ikonki [Kosz], znajdującej się obok przyznanego poziomu uprawnienia użytkownika i widocznej po najechaniu kursorem na dany wiersz, możliwe jest całkowite usunięcie uprawnień do danego folderu z zawartością/dokumentu dla danego użytkownika. Ta opcja nie jest aktywna dla poziomu uprawnień „Administrator”, chyba że ustalono dwóch lub więcej administratorów lokalnych – wtedy możliwe jest usunięcie wszystkich z nich oprócz jednego.

 

 

 

Przyklad

W ramach folderu nadrzędnego „Folder 5_admin” nadano uprawnienie „Edytor” użytkownikowi „Józef Kowal”.

 

 

Następnie w folderze podrzędnym „Pliki graficzne” znajdującym się w folderze „Folder 5_admin” zmieniono poziom  uprawnień użytkownika „Józef Kowal” do folderu podrzędnego na „Przeglądający”.

 

 

Wówczas przy poziomie uprawnień użytkownika „Józef Kowal” w folderze nadrzędnym „Folder 5_admin” pojawia się gwiazdka, wskazująca na to, że w folderze podrzędnym zostało dla niego zmienione uprawnienie.

 

 

Uwaga

Zmiana uprawnień użytkownika z „Edytor” na „Przeglądający” i na odwrót nie wpływa na uprawnienia tego użytkownika w stosunku do folderów podrzędnych z przypisanym administratorem lokalnym i  zawartości takich folderów)

Przy nazwisku użytkownika w polu „Osoby z dostępem do pliku” może również pojawić się adnotacja [Brak dostępu], jeżeli:

• użytkownik nie miał przyznanych uprawnień do nowego folderu podrzędnego/dokumentu, ale przyznano mu je  wcześniej do innego folderu podrzędnego/dokumentu, a oba te foldery/dokumenty znajdują się we wspólnym folderze nadrzędnym. Oznaczenie "Brak dostępu" pojawia się wtedy przy nazwisku danego użytkownika w zarządzaniu uprawnieniami nowego folderu/dokumentu.
• użytkownik miał przyznane uprawnienia do folderu nadrzędnego, później utworzono folder podrzędny/dokument, a następnie usunięto uprawnienia użytkownika na poziomie folderu nadrzędnego. Oznaczenie "Brak dostępu" pojawia się wtedy przy nazwisku danego użytkownika  w zarządzaniu uprawnieniami  folderu podrzędnego/dokumentu.

W ramach okna zarządzania uprawnieniami dostępne są również poniższe przyciski:

[Zapisz] - po kliknięciu przycisku zmiany zostają zapisane, a okno zamknięte . Należy nacisnąć go przed opuszczeniem okna, w przeciwnym wypadku wprowadzone zmiany nie zostaną zachowane.

[Odrzuć] -  po kliknięciu przycisku wprowadzone zmiany zostaną anulowane, a okno zamknięte

[Zamknij] - po kliknięciu przycisku okno zamyka się bez zapisania zmian

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

Uwaga

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

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

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

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

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

 

 

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

 

System Comarch BPM (dawniej DMS) składa się z modułów:

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

Instalacja serwera MongoDB w systemie Windows

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

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

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

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

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

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

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

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

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

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

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

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

Dodawanie administratora MongoDB i bazy danych dla Comarch BPM (dawniej DMS) Repozytorium za pomocą MongoDB Compass

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

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

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

Aby utworzyć użytkownika należy:

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

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

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

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

Wprowadzanie zmian w pliku mongod.cfg

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

Plik znajduje się w lokalizacji:

<install directory>\bin\mongod.cfg

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

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

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

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

Instalacja serwera MongoDB w systemie Linux, dystrybucja Ubuntu

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

Wprowadzanie zmian w pliku mongod.conf

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

sudo gedit/etc/mongod.conf

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

1. w sekcji #network interfaces:

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

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

sudo systemctl restart mongod

Dodawanie administratora MongoDB i bazy danych dla Comarch BPM (dawniej DMS) Repozytorium z poziomu terminala w Ubuntu

Następnie należy zalogować się do MongoDB z poziomu terminala w Ubuntu,  a później create a database and add the operator for which the Comarch DMS Repository will be connected to the database.

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

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

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

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

Od wersji 2024.2.2 można używać powyższych znaków w ramach loginu i/lub hasła.

Nie należy natomiast używać spacji w loginie ani w haśle.

[/alert]

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

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

Tworzenie i odtwarzanie backupów bazy danych MongoDB

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

Download MongoDB Command Line Database Tools | MongoDB

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

Konfiguracja aplikacji na serwerze IIS

Instalacja komponentów

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

Przenoszenie katalogu BPM (dawniej DMS) Repository Api 

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

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

Dodawanie nowej puli aplikacji dla Comarch BPM (dawniej DMS) Repozytorium

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

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

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

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

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

Konwertowanie katalogu DocumentManager.WebApi na aplikację

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

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

Konfiguracja pliku web.config aplikacji Comarch BPM (dawniej DMS)

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

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

Wprowadzone zmiany należy zapisać.

Wskazówka

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

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

 

Wprowadzanie zmian w appsettings.json, pliku konfiguracyjnym serwera

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

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

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

Przykładowo:

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

3. „DocumentWorkflowSettings” – adres serwera BPM (dawniej DMS).

Przykładowo:

„http://localhost/Standalone”

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

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

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

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

Uwaga

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

 

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

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

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

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

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

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

Włączenie protokołu WebSocket

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

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

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

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

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

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

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

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

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

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