Spis treści artykułu
- Informacje początkowe i konfiguracja
- Klucze licencji
- Konfiguracja kontrolek w obszarze (sekcji) „Rejestr zakupu”
- Konfiguracja kontrolek w obszarze (sekcji) „Opis analityczny”
- Przenoszenie danych KSeF podczas generowania dokumentów FZV do Comarch ERP Optima
- Uruchomienie przykładu
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://
Plik OptimaVatRegisterDimension.exe.config
7.Analogiczną operację należy przeprowadzić z plikiem OptimaVatRegisterGenerator.exe.config. W pliku należy odszukać kluczu <add key=”ServerUri” value=”http://
Plik OptimaVatRegisterGenerator.exe.config
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:
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.
Plik konfiguracyjny OptimaVatRegisterGenerator.exe.config, sekcja Moduły Optima – klucze licencji
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:
- uruchomić stacjonarną wersję Comarch BPM (dawniej DMS),
- przejść do konfiguracji zaimportowanego typu obiegu.
- W kontrolkach:
-
-
- Waluta
- Elementy, zakładka Listy -> lista: Stawka
- Elementy, zakładka inicjowanie wartości -> kontrolki powiązane: 3 wystąpienia
w zapytaniach SQL odszukać nazwę bazy „CDN_KNF_Konfiguracja” i zamienić ją na właściwą nazwę konfiguracyjnej bazy danych. - dodatkowo w wielospółkowym trybie pracy Comarch BPM (dawniej DMS) zweryfikować spółkę, która jest wskazana w kontrolkach:
-
Sekcja Dane ogólne:
- Kontrahent
- Waluta
- Forma płatności
Sekcja Rejestr i kategoria:
- Kategoria
- Opis kategorii
- Rejestr
- Typ rejestru
Sekcja Pozycje:
- Definicje list w kontrolce Elementy
Sekcja Dokument w ERP Optima:
- Generuj dokument
- Rejestr Vat zakupu
Sekcja Opis analityczny:
- Definicje list w kontrolce Opis analityczny
- Dodaj opis analityczny
- Obowiązkowe kolumny
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
Kontrolka Własna akcja
Z poziomu kontrolki „Własna akcja” (Generuj dokument), należy ustawić definicję uruchomienia dodatku.
Uwaga
Definicja uruchomienia powinna się znaleźć w edytorze SQL wywołanym dla opcji Plik wykonywalny.
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:
- dokument generowany jest poprawnie, kontrolka typu „Własna akcja” (Generuj dokument) zwróci w kontrolce Walidator wartość większą od zera (ID wygenerowanego dokumentu)
- wystąpi błąd, kontrolka typu „Własna akcja” (Generuj dokument) zwróci w kontrolce Walidator wartość mniejszą od zera.
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:
- Na definicji typu obiegu należy dodać kontrolki:
- Zastosuj termin płatności – kontrolka typu Lista, inicjowanie wartości poprzez Słownik, wartości słownika: ‘Tak’, ‘Nie’.
Kontrolka przekazuje informację o tym czy termin płatności wskazany w kontrolce ‘Termin płatności’ zostanie przekazany do dokumentu w rejestrze VAT Comarch ERP Optima z karty obiegu, czy będzie ustalany zgodnie z konfiguracją Comarch ERP Optima.
W kontrolce należy wskazać odpowiedzi:
-
- Tak – wówczas termin płatności na dokumencie w Comarch ERP Optima będzie pochodził z kontrolki Termin płatności
- Nie – termin płatności będzie ustalany zgodnie z konfiguracją Comarch ERP Optima.
Konfiguracja kontrolki typu Lista
- Termin płatności – kontrolka typu data i godzina.
- Jeżeli w kontrolce ‘Zastosuj termin płatności’ ustawiono wartość ‘Tak’, termin płatności zostanie przeniesiony na dokument w rejestrze VAT Comarch ERP Optima,
- Jeżeli w kontrolce ‘Zastosuj termin płatności’ ustawiono wartość ‘Nie’, termin płatności na dokumencie w rejestrze VAT będzie wynikał z konfiguracji Comarch ERP Optima.
Konfiguracja kontrolki typu Data i godzina
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:
-
-
-
-
– dotyczy kontrolki typu Lista, - – dotyczy kontrolki Data i godzina
-
-
-
W wartościach kluczy należy wpisać identyfikatory kontrolek dodanych na typie obiegu.
OptimaVatRegisterGenerator.exe.config z odkomentowanymi kluczami dla kontrolek Lista i Data i godzina odpowiadających za przekazanie terminu płatności
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:
– dotyczy kontrolki typu Lista, – dotyczy kontrolki Data i godzina
W wartościach kluczy należy wpisać identyfikatory kontrolek dodanych na typie obiegu.
W załączonym typie obiegu udostępniono kontrolki:
- Zastosuj termin płatności – kontrolka typu lista w formie słownika z możliwością wskazania wartości domyślnej. Kontrolka przekazuje informację o tym czy termin płatności wskazany w kontrolce ‘Termin płatności’ zostanie przekazany do dokumentu w rejestrze VAT Comarch ERP Optima z karty obiegu, czy będzie ustalany zgodnie z konfiguracją Comarch ERP Optima. W kontrolce można wskazać odpowiedzi:
- Tak – wówczas termin płatności na dokumencie w Comarch ERP Optima będzie pochodził z kontrolki Termin płatności
- Nie – termin płatności będzie ustalany zgodnie z konfiguracją Comarch ERP Optima.
- Termin płatności – kontrolka typu data i godzina, jeżeli w kontrolce ‘Zastosuj termin płatności’:
- ustawiono wartość ‘Tak’, termin płatności zostanie przeniesiony na dokument w rejestrze VAT Comarch ERP Optima;
- ustawiono wartość ‘Nie’, termin płatności na dokumencie w rejestrze VAT będzie wynikał z konfiguracji Comarch ERP Optima.
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:
- 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.
- 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:
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ć.
OptimaVatRegisterGenerator.exe.config z odkomentowanym kluczem odpowiadającym za przekazanie numeru rachunku bankowego
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’.
Konfiguracja kontrolki typu Lista
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ść:
-
-
-
-
- Netto – wówczas podczas generowania dokumentu do Comarch ERP Optima zostanie przekazana kwota netto i VAT i na tej podstawie wyliczy się kwota brutto - Brutto – wówczas podczas generowania dokumentu do Comarch ERP Optima zostanie przekazana kwota brutto i VAT i na tej podstawie wyliczy się kwota netto
-
-
-
Po dodaniu kontrolki, należy w pliku konfiguracyjnym przykładu do generowania dokumentów dodać klucz odpowiedzialny za przekazanie wartości powyższej kontrolki:
W wartości klucza należy wpisać identyfikator kontrolki dodanej na typie obiegu (w przykładzie jest to kontrolka o identyfikatorze Tryb_Generowania)
OptimaVatRegisterGenerator.exe.config z kluczem dla kontrolki Lista odpowiadającej za przekazanie trybu 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”.
Uwaga
Kolejność kolumn w kontrolce „Opis analityczny” musi być następująca:
- Pozycja – kolumna istnieje na zaimportowanym przykładzie
- Kolumny wymiarów – (max. 7) w kolejności określonej na formatce „Opis analityczny” w Comarch ERP Optima
- Procent – kolumna istnieje na zaimportowanym przykładzie
- Wartość – kolumna istnieje na zaimportowanym przykładzie
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:
Przykład tabeli opisu analitycznego w Comarch ERP Optima
konfiguracja kontrolki tabelarycznej „Opis analityczny” powinna wyglądać następująco:
Przykład konfiguracja typu obiegu do generowania opisu analitycznego
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:
- kontrolkę typu Data „Data przyjęcia KSeF” (identyfikator: DataKSeF)
- kontrolkę typu Tekst „Numer KSeF” (identyfikator: NumerKSeF).
Dla tych kontrolek wprowadzono także odpowiednie klucze w pliku OptimaVatRegisterGenerator.exe.config (
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:
- dodano kontrolkę typu Własna akcja z procedurą ERP akcja „Sprawdź numer KSeF” (identyfikator: Sprawdz_numer_KSeF), która sprawdza, czy dokument z danym numerem KSeF w kontrolce „Numer KSeF” (identyfikator: NumerKSeF) jest już w Comarch ERP Optima
- dodano kontrolkę typu Komunikat (identyfikator: Msg2), która odpowiada za wyświetlenie komunikatu „Dokument o numerze KSeF [numer] znajduje się już w Comarch ERP Optima” – jeśli dokument o numerze znajdującym się w kontrolce „Numer KSeF” (identyfikator: NumerKSeF) jest już w Comarch ERP Optima
- dodano kontrolkę typu Tekst „Status KSeF w Optimie” (identyfikator: StatusKSeFOptima), która zawiera informację zależną od wyniku weryfikacji za pomocą kontrolki „Sprawdź numer KSeF” – jeśli dokument znajduje się w Comarch ERP Optima, w kontrolce „Status KSeF w Optimie” widnieje napis „Dokument o takim numerze istnieje już w ERP”, jeśli zaś nie – „Dokument o takim numerze nie istnieje w ERP”.
Nowe kontrolki na dokumencie, który ma zostać wygenerowany do rejestru VAT
Uruchomienie przykładu
Aby wygenerować dokument do rejestru VAT z opisem analitycznym należy:
- otworzyć dokument BPM (dawniej DMS) ze skonfigurowanym przykładem
- uzupełnić kontrolki w obszarze (sekcji) „Rejestr zakupu”;
- zapisać dokument;
- wygenerować dokument poprzez kliknięcie w przycisk „Generuj dokument”;
- uzupełnić kontrolki w obszarze (sekcji) „Opis analityczny”;
- zapisać dokument;
- 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”.
Obieg dokumentów, generowanie dokumentu do rejestru VAT w Comarch ERP Optima.
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.
Dokument w rejestrze VAT zakupu w Comarch ERP Optima oraz powiązany dokument OBD załącznikiem przekazanym z Comarch BPM (dawniej DMS). Dokumenty wyświetlone w systemie Comarch ERP Optima
Oprócz dołączania załączników, na dokument OBD w Comarch ERP Optima:
- w polu Numer obcy umieszczana jest informacja o numerze dokumentu Comarch BPM (dawniej DMS), z którego wygenerowano dokumenty w Comarch ERP Optima;
- 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.
Sekcja Opis analityczny po wygenerowaniu opisu analitycznego do dokumentu w rejestrze VAT Comarch ERP Optima
Rozpoczynasz pracę z Comarch BPM (dawniej DMS) i chcesz dowiedzieć się, jak korzystać z programu? A może masz już podstawową wiedzę o Comarch BPM (dawniej DMS) i chcesz dowiedzieć się więcej?