Uwaga

Przed zainstalowaniem Comarch ERP XL Web 2024.0 należy odinstalować poprzednią wersję aplikacji.

Uwaga

Podczas instalacji Comarch ERP XL Web 2024.0 na systemie Microsoft Windows 11 należy być zalogowanym na lokalne konto systemowe.

Comarch ERP XL Web Instrukcja instalacji

Proces instalacji

Uruchomienie pliku instalacyjnego Comarch XL Web.exe rozpoczyna proces instalacji systemu.

W kolejnym kroku Użytkownik może wybrać typ instalacji:

Następnie należy wskazać katalog instalacyjny.

Kolejny etap to podanie parametrów konfiguracyjnych takich jak:

Po naciśnięciu przycisku Dalej wyświetlony zostaje ekran, na którym można uruchomić instalację zgodnie z ustawionymi we wcześniejszych krokach parametrami.

Po rozpoczęciu instalacji wyświetlany jest stan procesu instalacyjnego.

Na zakończenie wyświetlany jest ekran z informacją o zakończeniu procesu instalacji.

Uruchomienie

Ekran logowania

Po wpisaniu w przeglądarce nazwy hosta, na którym zainstalowany został Comarch ERP XL oraz portu wskazanego podczas instalacji, np. https://localhost:8000, zostanie wyświetlony ekran logowania się do programu.

Po wpisaniu identyfikatora operatora oraz hasła program Comarch ERP XL zostanie uruchomiony w przeglądarce.

Comarch ERP XL Web Podręcznik Użytkownika

Logowanie

Ekran logowania

Po uruchomieniu w przeglądarce programu Comarch ERP XL wyświetlony zostaje ekran logowania jak poniżej.

Dane Użytkownika

W polu Użytkownik należy wpisać identyfikator operatora zdefiniowanego w programie Comarch ERP XL, w polu Hasło należy wprowadzić hasło wpisanego operatora.

Uwaga

W celu zabezpieczenia się przed zalogowaniem nieuprawnionego Użytkownika na ekranie logowania nie ma możliwości wyświetlenia listy operatorów. Identyfikator operatora należy każdorazowo wpisać w pole Użytkownik.

Informacje o bazie danych i wersji programu

U dołu ekranu logowania wyświetlana jest informacja z nazwą bazy danych, do której loguje się Użytkownik oraz numer wersji programu.

Uwaga

Podczas logowania nie ma możliwości zmiany bazy – Użytkownik może się zalogować wyłącznie do bazy wskazanej podczas instalacji programu.

Wskazówka

Zmiany parametrów logowania takich jak nazwa serwera SQL oraz nazwa bazy danych można dokonać poprzez edycję stosownych ustawień w plikach appsettings znajdujących się w katalogach podrzędnych katalogu XLRestApi w folderze, w którym zainstalowany jest program Comarch ERP XL Web.

Ekran startowy (dashboard) aplikacji

W wersji 2024.0 systemu Comarch ERP XL Web udostępniony został ekran startowy, tzw. dashboard aplikacji.

Wyświetlenie dashboardu

Budowa dashboardu

Ekran startowy podzielony jest na trzy panele: Skróty, Statystyki i Zamówienia sprzedaży.

W wersji 2024.0 systemu Comarch ERP XL Web obsługiwane są wyłącznie zamówienia sprzedaży, stąd dane prezentowane na ekranie startowym dotyczą tylko tego obszaru.

Wraz z pojawieniem się funkcjonalności z kolejnych obszarów dashboard będzie stosownie rozbudowywany.

Panel Skróty

W panelu Skróty znajdują się przyciski szybkiej obsługi pozwalające wykonać określoną akcję.

W wersji 2024.0 aktywny jest wyłącznie przycisk do dodawania nowego zamówienia sprzedaży. W kolejnych wersjach wraz z rozwojem funkcjonalności aktywowane będą kolejne przyciski.

Panel Statystyki

Panel Statystyki zawiera dwa wykresy:

Dla każdego z wykresów można wskazać okres, za jaki mają zostać zaprezentowane dane:

Po najechaniu kursorem na słupek wykresu Wartość zamówień Twojego centrum prezentowana jest szczegółowa informacja dotycząca zamówień w danym okresie.

Najeżdżając kursorem na wybrany fragment wykresu Zamówione towary wg wartości można zobaczyć szczegóły dotyczące danego towaru.

Uwaga

Wartości na wykresach dotyczą zamówień, których właścicielem jest centrum, w którym zalogowany jest Użytkownik.

Uwaga

Zarówno na wykresie słupkowym, jak i na wykresie kołowym wartości prezentowane są w przeliczeniu na walutę systemową.

Panel Zamówienia sprzedaży

W panelu Zamówienia sprzedaży prezentowana jest lista 10 ostatnich zamówień sprzedaży wystawionych w centrum, w którym zalogowany jest Użytkownik.

Po naciśnięciu przycisku Pokaż więcej wyświetlona zostaje pełna lista zamówień sprzedaży.

Po prawej stronie listy zamówień znajdują się przyciski prezentujące informacje związane z realizacją zamówień:

Po naciśnięciu któregokolwiek przycisku Użytkownik przenoszony jest na listę zamówień sprzedaży.

Uwaga

Filtry na listach implementowane będą w kolejnych wersjach systemu. Docelowo po naciśnięciu danego przycisku wyświetlona zostanie lista zamówień odfiltrowana do dokumentów w stanie realizacji zgodnym z opisem na przycisku.

Poruszanie się po programie

Po zalogowaniu się Użytkownika aplikacja wyświetlana jest w układzie jak poniżej.

Na ekranie programu można wyróżnić trzy podstawowe elementy:

Panel boczny nawigacji

W panelu bocznym nawigacji wyświetlane są przyciski pozwalające na przejście do wybranego obszaru programu.

W pierwszej wersji dostępne są następujące obszary:

Uwaga

W pierwszej wersji programu obsługiwany jest wyłącznie obszar zamówień sprzedaży. Po naciśnięciu przycisków Kontrahenci oraz Towary wyświetlany jest jedynie ekran informacyjny.

Za pomocą przycisku można zwijać/rozwijać panel boczny.

Panel górny nawigacji

W panelu górnym nawigacji dostępne są następujące przyciski:

Pomoc

Naciśnięcie przycisku Pomoc powoduje otwarcie okna, w którym wyświetlana jest informacja o programie oraz dostępne są przekierowania do stron pomocy dla programu Comarch ERP XL oraz stron społeczności Comarch ERP.

Informacje o operatorze

Na przycisku z informacją o operatorze wyświetlana jest nazwa centrum, do którego zalogowany jest operator oraz identyfikator i nazwisko operatora.

Po rozwinięciu przycisku Operator ma dostępną opcję wylogowania się z programu.

Uwaga

Po rozwinięciu przycisku wyświetlana jest lista centrów, do których dołączony jest zalogowany operator, w wersji 2024.0 nie ma natomiast możliwości zmiany centrum (zmiany kontekstu operatora).

Lista zamówień sprzedaży

Układ listy zamówień

Po naciśnięciu w panelu bocznym przycisku Zamówienia sprzedaży na ekranie głównym aplikacji wyświetlana jest lista zamówień sprzedaży.

Na liście wyświetlane są wszystkie dokumenty widoczne w centrum, w którym zalogowany jest Użytkownik.

Lista zawiera następujące kolumny:

Uwaga

W aplikacji webowej znany z wersji standardowej Stan dokumentu wyświetlany jest w rozbiciu na Status i Stan realizacji.

Powiązania pomiędzy Stanem dokumentu a Statusem i Stanem realizacji prezentuje poniższa tabela:

Stan w standardowym interfejsie	Status w interfejsie webowym	Stan realizacji w interfejsie webowym
Niepotwierdzone	Niezatwierdzony	–
Potwierdzone	Zatwierdzony	Do realizacji
W realizacji	Zatwierdzony	W realizacji
Zrealizowane	Zamknięty	Zrealizowany
Odrzucone	Anulowany	Niezrealizowany
Anulowane potwierdzone	Anulowany	Niezrealizowany
Zamknięte potwierdzone	Zamknięty	Niezrealizowany
Zamknięte w realizacji	Zamknięty	Częściowo zrealizowany
Korygowane potwierdzone	Korygowany	Do realizacji
Korygowane w realizacji	Korygowany	W realizacji

Uwaga

W aplikacji webowej kontrahent główny wyświetlany jest jako Nabywca, a kontrahent docelowy jako Odbiorca.

Obsługa listy zamówień

Na liście Użytkownik może wykonywać następujące operacje:

Dodawanie zamówienia sprzedaży

Układ formularza zamówienia

Po naciśnięciu na liście zamówień przycisku Dodaj wyświetlony zostaje formularz nowego zamówienia sprzedaży.

Pola obowiązkowe do wypełnienia oznaczone są gwiazdką.

Pomiędzy sekcjami formularza można poruszać się za pomocą nawigacji dostępnej z prawej strony.

Nagłówek zamówienia

W nagłówku zamówienia wyświetlane są następujące elementy:

Uwaga

Numer zamówienia generowany jest po dodaniu kontrahenta na dokument.

Przed dodaniem kontrahenta w miejscu numeru wyświetlany jest opis Numer zamówienia. 

Uwaga

Jeżeli do zamówienia dodany został kontrahent i wygenerowany został numer dokumentu, to po naciśnięciu przycisku Wróć do listy zamówień sprzedaży zamówienie zostanie zapisane ze statusem Niezatwierdzony.

Dodawanie kontrahenta na zamówienie

Po ustawieniu kursora w polu Wybierz kontrahenta Użytkownik ma możliwość dodania kontrahenta na zamówienie.

Istnieją dwa sposoby na dodanie kontrahenta:

Nabywca i odbiorca na zamówieniu

Po wybraniu kontrahenta w zależności od ustawień na kartotece kontrahenta na dokument pobierane są dane nabywcy i odbiorcy.

Dane nagłówkowe

Na formularzu nowo dodawanego zamówienia przed dodaniem kontrahenta na dokument w sekcji Dane nagłówkowe wyświetlane są następujące pola:

Po dodaniu kontrahenta na zamówienie w sekcja Dane nagłówkowe zostaje uzupełniona o następujące pola:

Uwaga

W standardowej wersji systemu odpowiednikiem pola Centrum jest pole Właściciel.

Pozycje zamówienia

Pozycje zamówienia przed dodaniem kontrahenta

Na formularzu nowo dodawanego zamówienia sprzedaży przed dodaniem kontrahenta na dokument w sekcji Pozycje wyświetlane są wyłącznie nagłówki kolumn i nie ma możliwości dodania pozycji.

Wyświetlany jest także stosowny komunikat informujący, że dodanie pozycji będzie możliwe po wybraniu kontrahenta.

Pozycje zamówienia po dodaniu kontrahenta

Po wybraniu kontrahenta w sekcji Pozycje zostaje wyświetlony wiersz, w którym można dodawać pozycje do zamówienia.

Układ listy pozycji zamówienia

Lista pozycji zamówienia sprzedaży zawiera następujące kolumny:

Dodawanie pozycji na zamówienie

Dodawanie pozycji przez edycję pola Towar

Po ustawieniu kursora w polu Towar Użytkownik ma możliwość dodania pozycji na zamówienie.

Istnieją dwa sposoby na dodanie pozycji:

Wiersz do dodawania nowej pozycji wyświetlany jest zawsze jako pierwszy.

Pobieranie danych o towarze na pozycje zamówienia

Dodawanie pozycji z uproszczonej listy towarów

W wersji 2024.0 systemu Comarch ERP XL Web na formularzu zamówienia sprzedaży udostępniona została możliwość dodawania pozycji zamówienia z uproszczonej listy towarów.

Wywołanie uproszczonej listy towarów

Na zamówieniu sprzedaży Użytkownik może wywołać uproszczoną listę towarów na dwa sposoby:

Obsługa uproszczonej listy towarów

Po wyborze opcji do dodawania towarów z listy wyświetlona zostaje uproszczona lista towarów w następującym układzie.

W celu wyboru towaru, który ma zostać dodany na zamówienie, Użytkownik może:

Jeżeli na karcie towaru zdefiniowane są jednostki pomocnicze, to na uproszczonej liście na tym towarze Użytkownik może wskazać, w jakiej jednostce towar ma zostać dodany do zamówienia.

Po naciśnięciu przycisku Dodaj zaznaczone towary zostaną dodane na zamówienie w ilościach i jednostkach ustalonych na uproszczonej liście towarów.

Wskazówka

Jeżeli na kartotece towaru jednostka pomocnicza oznaczona została, jako proponowana przy sprzedaży, to na uproszczonej liście towarów jednostka ta będzie się domyślnie proponować dla danego towaru.

Wskazówka

Jeżeli Użytkownik chce dodać do zamówienia ilość towaru inną niż 1, to powinien to zrobić korzystając z uproszczonej listy towarów – w wersji 2024.0 nie ma możliwości edycji ilości towaru bezpośrednio na liście pozycji zamówienia.

Zapisywanie zamówienia

W stopce zamówienia znajduje się przycisk pozwalający na zapisanie dokumentu.

Po naciśnięciu przycisku weryfikowane jest, czy obowiązkowe pola zostały uzupełnione oraz czy dane na dokumencie są poprawne – jeżeli na zamówieniu występuje błąd, wyświetlany jest stosowny komunikat, pole, w którym występuje błąd jest odpowiednio podświetlane a przycisk Zapisz jest dezaktywowany aż do usunięcia błędu.

Jeżeli próba zapisu zakończy się sukcesem, system wraca do listy zamówień sprzedaży.

Architektura rozwiązania

Opis

Architektura Comarch ERP XL wydziela część dostępu do danych (backend) od części prezentacyjnej (frontend). W ramach części prezentacyjnej dostarczany jest interfejs WWW, który jest serwowany przy wykorzystaniu serwera nginx. Dodatkowo nginx służy jako API gateway i load balancer, rozdzielając zapytania do warstwy danych, do odpowiednich mikroserwisów. Sama warstwa danych składa się z wielu mikroserwisów odpowiadających za wybrane funkcjonalności systemu. Dzięki takiej architekturze możliwe jest skalowanie horyzontalne aplikacji oraz łatwe aktualizowanie pojedynczych serwisów przy zachowaniu ciągłości pracy. Aby mikroserwisy były osiągalne z poziomu frontendu, aby mogły się ze sobą komunikować oraz aby można było rozdzielać do nich ruch – konieczny jest mechanizm rejestracji serwisów, czyli Service Discovery. Służy do tego Consul – czyli repozytorium serwisów.

W konsekwencji do działania XL’a w wersji Web konieczne są aktywne procesy: nginx, consul, consul-template oraz procesy samych mikroserwisów (obecnie XL.Authorization, XL.Customers, XL.Orders, XL.Users oraz XL.Articles).

Proces uruchamiania Comarch ERP XL składa się zatem z uruchomienia usługi Consul, następnie uruchomienia mikroserwisów (które zarejestrują swój adres i port w Consul’u) – na tym etapie mamy już dostępne nowe Rest API dla XL’a. Następnie do uruchomienia frontend potrzebne jest jeszcze uruchomienie serwera nginx oraz usługi consul-template, której zadaniem jest odczytanie adresów i portów mikroserwisów z repozytorium Consul’a, oraz zapisanie ich w konfiguracji nginx. Jeżeli uruchomimy wiele instancji tego samego mikroserwisu, to nginx będzie przekierowywał żądania równomiernie do każdej instancji (tzw. metoda Round-Robin). Również w ramach wewnętrznej komunikacji między mikroserwisami funkcjonuje load balancing oparty o repozytorium Consul.

Przy domyślnej instalacji stan serwisów można monitorować z poziomu strony http://localhost:8500/. Dodatkowo wszystkie błędy i ostrzeżenia samych mikroserwisów są logowane w zdarzeniach systemowych Windows w sekcji “Aplikacja”. Natomiast logi z warstwy prezentacji znajdują się w katalogu serwera nginx w podkatalogu logs. Ponieważ cała komunikacja wymaga zabezpieczenia przed nieautoryzowanym dostępem wdrożono wykorzystanie protokołu https. Aby to było możliwe konieczne jest posiadanie certyfikatu ssl – podczas instalacji jest kreowany certyfikat podpisany samodzielnie o nazwie localhost_xlweb. W przypadku potrzeby udostępnienia programu w sieci publicznej zalecane jest zakupienie certyfikatu w jednym z zaufanych centrów certyfikacji.