Comarch APS Instalacja

Wstęp

Dokument opisuje instalację aplikacji Comarch APS w wersji 2024.1. Wersja ta współpracuje z Comarch ERP XL w wersji 2024.1 oraz jej kolejnymi aktualizacjami HotFix.

Wymaganie systemowe

Do pracy z aplikacją Comarch APS potrzebne są:

  • Microsoft ASP.NET Core 8.0.8 Microsoft .NET Runtime 8.0.8 lub wyżej.
  • PostgreSQL ODBC Driver
  • Serwer baz danych PostgreSQL w wersji 16.3 (lub jego aktualizacje)
  • 4 GB pamięci RAM
  • Przeglądarka www – zalecane: Google Chrome, Edge

Zaleca się korzystanie z ekranów o rozdzielczości co najmniej 1980×1080 px.

Instalowanie Comarch APS

Uruchomienie instalatora

Należy uruchomić plik ComarchAPSInstaller.exe znajdujący się w paczce plików Instalatora Comarch APS.

Ekran powitalny instalatora
Ekran powitalny instalatora

W oknie powitalnym należy wybrać opcję .

Weryfikacja zainstalowania dodatków

Instalator weryfikuje czy są zainstalowane wszystkie niezbędne dodatki w wymaganej wersji tj.:

  • PostgreSQL ODBC Driver
  • Microsoft ASP.NET Core 8.0.6 – Shared Framework (x64)
  • Microsoft .NET Runtime – 8.0.6 (x64)

Uwaga
Dodatek PostgreSQL ODBC Driver jest konieczny, aby możliwe było zainstalowanie Comarch APS na bazie PostgreSQL.

Brakujące dodatki domyślnie są zaznaczone na liście, a ich instalacja zostanie zainicjowana po naciśnięciu przycisku . W osobnym oknie podniesiony zostanie instalator dodatku, przez który należy przejść akceptując wymagania licencyjne i wybierając domyślne ustawienia.

Weryfikacja zainstalowania niezbędnych dodatków
Weryfikacja zainstalowania niezbędnych dodatków

Gdy instalacja dodatków zakończy się, nastąpi przekierowanie do okna powitalnego instalatora.

Ekran powitalny instalatora
Ekran powitalny instalatora

Należy nacisnąć , aby przejść do następnego kroku.

Konfigurowanie aplikacji

W wersji 2024.0 aplikacja Comarch APS zostanie zainstalowana jako lokalna witryna dostępna pod wskazanym portem. Podczas konfiguracji ww. witryny należy zdefiniować:

  • port aplikacji, pod jakim będzie uruchamiana (np. 1025)

Uwaga
Port nie powinien być wykorzystywany w systemie przez inną aplikację, zaleca się wybranie numeru większego niż 1024, domyślnie zdefiniowany jako 80.
  • lokalizację instalacji, folder docelowy w którym zostanie zainstalowana aplikacja Comarch APS

Po wykonaniu opisanych wyżej czynności, należy nacisnąć przycisk .

Port aplikacji oraz ścieżka instalacji aplikacji Comarch APS
Port aplikacji oraz ścieżka instalacji aplikacji Comarch APS

Połączenie i autoryzacja z serwerem

W kolejnym kroku należy podać parametry służące do połączenia z bazą danych systemu Comarch APS.

Dane logowania do serwera PostgreSQL

Chcąc zainstalować Comarch APS na bazie znajdującej się na serwerze PostgreSQL należy:

  • podać nazwę adresu, na którym znajduje się baza danych
  • podać numer portu, na którym pracuje serwer PostgreSQL
  • podać nazwę użytkownika PostgreSQL z uprawnieniami administratora (domyślnie login o nazwie: postgres) oraz jego hasło

Po wskazaniu powyższych danych należy nacisnąć przycisk , aby sprawdzić połączenie z serwerem.

Wskazanie serwera PostgreSQL
Wskazanie serwera PostgreSQL

Wybór bazy danych

W kolejnym ekranie należy wybrać bazę danych Comarch APS, możemy:

  • Utworzyć nową bazę
  • Połączyć z istniejącą bazą

Utwórz nową bazę

Po wybraniu opcji Utwórz nową bazę należy wpisać nazwę bazy danych aplikacji Comarch APS.

Tworzenie nowej bazy danych na serwerze PostgreSQL
Tworzenie nowej bazy danych na serwerze PostgreSQL

Połącz z istniejącą bazą

Po wybraniu opcji Połącz z istniejącą bazą, w tabeli Znalezione bazy danych należy wybrać bazę danych, która znajduje się na serwerze PostgreSQL i za pomocą której będziemy się łączyć z aplikacją Comarch APS.

Uwaga
W związku z dużą liczbą nowych funkcjonalności wprowadzonych w wersji 2024.1, na bazach Comarch APS konwertowanych z wersji 2024.0, zaleca się pracę na harmonogramach utworzonych po konwersji.
Łączenie z istniejącą bazą danych na serwerze PostgreSQL
Łączenie z istniejącą bazą danych na serwerze PostgreSQL

Uwaga
Aby baza była widoczna na liście, musi ona mieć nadane uprawnienie Connect dla loginu ComarchAPS. W przypadku baz tworzonych przez instalator APS uprawnienie to zostaje nadane automatycznie. W przypadku baz przywracanych z backupu konieczne jest ręczne nadanie tego uprawnienia.

Bazy w wersjach starszych niż 2024.0 nie będą widoczne w instalatorze.

Przy wyborze połączenia z istniejącą bazą kroki instalacji 6 oraz 7 są pomijane – dane będą importowane z wybranej bazy danych.

Połączenie z bazą w tej samej wersji co instalator

W przypadku wyboru istniejącej bazy w wersji 2024.1 instalator rozpozna, że wprowadzenie na niej dodatkowych zmian nie jest konieczne.

 Połączenie z bazą w wersji starszej niż instalator

Uwaga
Jeśli planowana jest konwersja bazy Comarch APS z wersji 2024.0 do wersji 2024.1 należy pozostawić w systemie instalację Comarch APS 2024.0. Po przeprowadzeniu konwersji Comarch APS 2024.0 może zostać odinstalowany.

W przypadku wyboru bazy w wersji starszej instalator przeprowadzi konwersję bazy danych, aby umożliwić pracę z aktualną wersją Comarch APS. Z tego powodu i rekomendowane jest uprzednie stworzenie backupu bazy danych oraz potwierdzenie jego wykonania przed konwersją.

Potwierdzenie wykonania backupu bazy danychPotwierdzenie wykonania backupu bazy danych Potwierdzenie wykonania backupu bazy danych
Potwierdzenie wykonania backupu bazy danych

Po wprowadzeniu wszystkich danych, należy nacisnąć przycisk .

Połączenie z serwerem klucza

W tym kroku należy uzupełnić dane dla połączenia z serwerem SQL na którym zmapowany jest Comarch ERP Menadżer Kluczy z kluczem z licencją na Comarch APS:

  • Serwer: instancja SQL, na którą jest zmapowany Comarch ERP Menadżer Kluczy
  • Login: login na instancji serwerze SQL ze zmapowanym kluczem
  • Hasło: hasło dla wskazanego loginu
Uwaga
Jeśli na serwerze znajduje się wiele kluczy to należy podać serwer klucza licencji wg schematu: <nazwa_serwera>::<numer_klucza>, np. serwerX::1234567890.

Uwaga
Wskazany login powinien mieć uprawnienia sysadmina.

Uwaga
NIP na kluczu wskazanym podczas instalacji Comarch APS/Integratora Comarch ERP XL z Comarch APS musi być zgodny z NIPem ustalonym na Pieczątce firmy na bazie Comarch ERP XL wybranej do integracji (niezależnie od typu klucza).
Połączenie i autoryzacja z serwerem klucza
Połączenie i autoryzacja z serwerem klucza

Zakładanie konta dla Administratora

W następnym ekranie wprowadza się dane dla konta Administratora w aplikacji Comarch APS:

  • E-mail: powiązany z kontem administratora
  • Login: służący do logowania na konto administratora w aplikacji Comarch APS
  • Hasło: zawierające minimum 8 znaków, w tym przynajmniej po jednej małej i dużej literze, przynajmniej jedną cyfrę i przynajmniej jeden znak specjalny. Sugerowane znaki specjalne do użycia w haśle: ! @ # $ % & * ? ” ` ~ , ; : . < >
Zakładanie konta dla Administratora w aplikacji Comarch APS
Zakładanie konta dla Administratora w aplikacji Comarch APS

Po wprowadzeniu wszystkich danych, należy nacisnąć przycisk .

Ustawienia poczty wychodzącej (serwera SMTP)

W kolejnym kroku należy uzupełnić dane logowania do serwera SMTP. W oknie należy uzupełnić:

  • Adres serwera
  • Port serwera

Po wypełnieniu powyższych danych należy wprowadzić dane uwierzytelniające:

  • Login
  • Hasło

Przyklad

Dla konta gmail:

Aby wygenerować hasło do aplikacji nalezy najpierw włączyć weryfikację dwuetapową dla konta gmail: „Zarządzaj kontem → Bezpieczeństwo → Logowanie się w google → weryfikacja dwuetapowa”. Pojawi się opcja Hasła do aplikacji – dodajemy aplikację „Inna” i zapisujemy otrzymane hasło.

Adres serwera: smtp.gmail.com

Port serwera: 587

Login: uzytkownik@gmail.com

Hasło: wyżej wygenerowane hasło

Ustawienia poczty wychodzącej (serwera SMTP)
Ustawienia poczty wychodzącej (serwera SMTP)

Po wprowadzeniu danych należy nacisnąć przycisk .

Rozpoczęcie instalacji

Kolejne okno informuje o możliwości rozpoczęcia instalacji. Jeśli we wcześniejszych oknach wszystkie niezbędne dane zostały podane prawidłowo, można przystąpić do instalacji aplikacji. Jest to ostatni moment, w którym możemy powrócić do wcześniejszych okien i sprawdzić poprawność podanych ustawień.

Okno informujące o możliwości rozpoczęcia instalacji
Okno informujące o możliwości rozpoczęcia instalacji

Aby rozpocząć instalację należy nacisnąć .

Zakończenie instalacji

Następnie pojawia się ekran z postępem instalacji, po której prawidłowym zakończeniu, pojawi się ekran informujący o pomyślnym zakończeniu instalacji aplikacji.

Ekran informujący o zakończeniu instalacji
Ekran informujący o zakończeniu instalacji

Należy nacisnąć przycisk , co spowoduje zamknięcie okna instalatora.

Wraz z aplikacją automatycznie instalowane są też współpracujące z nią procesy dotnet.exe. To czy procesy zostały zainstalowane i uruchomione można zweryfikować z poziomu Menadżera zadań systemu Windows na zakładce [Szczegóły].

Uruchamianie aplikacji Comarch APS

Po pomyślnym zakończeniu instalacji można już uruchomić aplikację Comarch APS podając w przeglądarce:

  • nazwę stanowiska, na którym zainstalowana jest aplikacja oraz wskazany w kroku Konfigurowanie aplikacji port witryny w postaci: nazwa_stanowiska:port_witryny
  • frazę localhost oraz wskazany w kroku Konfigurowanie aplikacji port witryny w postaci: localhost:port_witryny
  • po wczytaniu witryny aplikacji Comarch APS zostanie wyświetlony formularz logowania
Formularz logowania do aplikacji Comarch APS
Formularz logowania do aplikacji Comarch APS

Deinstalacja Comarch APS

Odinstalowanie Comarch APS z poziomu okna Aplikacje zainstalowane (Dodaj i usuń programy)

Zainstalowana aplikacja Comarch APS widoczna jest w oknie Aplikacje zainstalowane (Dodaj i usuń programy).

Wyszukanie Comarch APS wśród zainstalowanych aplikacji i funkcja odinstalowania
Wyszukanie Comarch APS wśród zainstalowanych aplikacji i funkcja odinstalowania

Aby odinstalować aplikację Comarch APS należy wyszukać ją na liście zainstalowanych aplikacji wybrać opcję Odinstaluj.

Odinstalowanie Comarch APS przy użyciu instalatora

Odinstalowanie aplikacji Comarch APS jest możliwe również przy użyciu instalatora. W tym celu należy ponownie uruchomić instalator, tj. plik ComarchAPSInstaller.exe.

Wyświetlone zostanie okno Odinstalowanie aplikacji, w którym należy nacisnąć opcję .

Potwierdzenie chęci usunięcia programu
Potwierdzenie chęci usunięcia programu

W ostatnim oknie pojawia się informacja o zakończeniu odinstalowania aplikacji.

Zakończenie odinstalowania Comarch APS
Zakończenie odinstalowania Comarch APS

Aby zamknąć okno deinstalacji należy nacisnąć .

Wskazówki do zarządzania aplikacją

Analiza logów aplikacji

Logi pomocne w analizie błędów/problemów z działaniem Comarch APS można znaleźć w lokalizacjach:

a) C:\Program Files (x86)\Comarch APS 2024.1\nginx\logs

  • w pliku: access.log oraz error.log
Pliki acces.log oraz error.log z logami znajdujące się w folderze nginx\logs
Pliki acces.log oraz error.log z logami znajdujące się w folderze nginx\logs

b) C:\Program Files (x86)\Comarch APS 2024.1\api\consul\logs

Folder logs z logami consula
Folder logs z logami consula

c) C:\Program Files (x86)\Comarch APS 2024.1\api\logs

Folder z logami w katalogi api\logs
Folder z logami w katalogi api\logs

d) W Podgląd zdarzeń, Dzienniki systemu Windows

Aby dostać się do dziennika systemu Windows należy uruchomić aplikację Podgląd zdarzeń.

Podgląd wyników po wyszukaniu Podgląd zdarzeń
Podgląd wyników po wyszukaniu Podgląd zdarzeń

W aplikacji należy rozwinąć Dzienniki systemu Windows.

Dzienniki systemu Windows znajdujący się w aplikacji Podgląd zdarzeń
Dzienniki systemu Windows znajdujący się w aplikacji Podgląd zdarzeń

Następnie wskazać pozycję Aplikacja. Pojawi się lista na której między innymi wyświetlane są błędy związane z uruchamianymi na stanowisku aplikacjami.

Aplikacja znajdująca się po rozwinięciu Dzienniki systemu Windows w Podgląd zdarzeń
Aplikacja znajdująca się po rozwinięciu Dzienniki systemu Windows w Podgląd zdarzeń

Konfiguracja witryny Comarch APS

Aby zweryfikować na jakim porcie zainstalowaliśmy aplikację Comarch APS można to sprawdzić w pliku: C:\Program Files (x86)\Comarch APS 2024.1\nginx\conf\app.conf.

W pliku znajduje się informacja odnośnie portu, na którym uruchamiana jest witryna Comarch APS.

Sekcja, w której można sprawdzić port aplikacji Comarch APS
Sekcja, w której można sprawdzić port aplikacji Comarch APS

W aplikacji Comarch APS w Panelu Administracyjnym na zakładce [Ustawienia skrzynki SMTP] można sprawdzić dane odnośnie:

  • Adresu serwera, na którym mamy założoną pocztę np. smtp.gmail.com
    Adres serwera, na którym mamy założoną pocztę
    Adres serwera, na którym mamy założoną pocztę
  • Portu serwera poczty np. 587 – jeśli mamy pocztę na gmail.com
Port serwera poczty
Port serwera poczty
  • Loginu – adres naszego konta mailowego
Adres konta mailowego
Adres konta mailowego

Czyszczenie plików cookies po zainstalowaniu aplikacji pod portem wcześniej odinstalowanej witryny

Po zainstalowaniu aplikacji pod tym samym portem, który wykorzystywano wcześniej na potrzeby innej witryny Comarch APS, zalecane jest wyczyszczenie plików cookies, danych witryn oraz pamięci podręcznej przeglądarki lub otwarcie przeglądarki w trybie prywatnym.

Weryfikacja działania usługi z poziomu harmonogramu zadań oraz menedżera zadań

W Harmonogramie zadań możemy zweryfikować stan usług APSConfigurationService, APSCredentialService, APSScheduleService, Consul oraz Nginx. Do poprawnego działania aplikacji Comarch APS ich stan powinien mieć status „Działa”. W przypadku gdy status stanu jest inny niż „Działa” należy go zmienić wybierając opcję Uruchom (punkt Ponowne uruchamianie usług APS z poziomu Harmonogram zadań).

Stan działania usług APSConfigurationService, APSCredentialService, APSScheduleService, Consul z poziomu okna Harmonogram zadań.
Stan działania usług APSConfigurationService, APSCredentialService, APSScheduleService, Consul z poziomu okna Harmonogram zadań

W Menedżerze zadań możemy sprawdzić, czy Comarch APS został uruchomiony. Do poprawnego działania aplikacji Comarch APS na liście powinny pojawić się:

  • procesy dotnet.exe
Procesy dotnet.exe na zakładce Szczegóły z poziomu aplikacji Menedżer zadań
Procesy dotnet.exe na zakładce Szczegóły z poziomu aplikacji Menedżer zadań
  • dwa procesy nginx.exe
Procesy nginx.exe na zakładce Szczegóły z poziomu aplikacji Menedżer zadań.
Procesy nginx.exe na zakładce Szczegóły z poziomu aplikacji Menedżer zadań

Ponowne uruchamianie usług APS z poziomu Harmonogram zadań

Aby ponownie uruchomić usługi APS w Harmonogramie zadań, należy najpierw na liście znaleźć daną usługę np. APSConfigurationService. Następnie z menu kontekstowego dla wiersza wybrać opcję Zakończ. Stan usługi zostanie zmieniony z „Działa” na „Gotowy”.

Uwaga
Usługi powinny być restartowane według następującej kolejności: APSConsul → APSConsulTemplate → APSConfigurationService/APSScheduleService/APSProductionPlanning/APSCredentialService → APSNginx
Przykład zakończenia usługi APSConfigurationService z poziomu Harmonogram zadań poprzez wybranie opcji z menu kontekstowego.
Przykład zakończenia usługi APSConfigurationService z poziomu Harmonogram zadań poprzez wybranie opcji z menu kontekstowego

Daną usługę można również zamknąć w programie Harmonogram zadań poprzez naciśnięcie opcji Zakończ w prawej części okna. Należy najpierw na liście znaleźć usługę APSConfigurationService, a następnie w prawej dolnej części okna w sekcji Wybrany element wybrać opcję Zakończ. Stan usługi zostanie zmieniony z „Działa” na „Gotowy”.

Przykład zakończenia usługi APSConfigurationService poprzez wybranie opcji z sekcji Wybrany element z poziomu Harmonogram zadań.
Przykład zakończenia usługi APSConfigurationService poprzez wybranie opcji z sekcji Wybrany element z poziomu Harmonogram zadań

Aby uruchomić usługę APSConfigurationService należy znaleźć ją na liście w Harmonogramie zadań. Po jej wskazaniu należy z menu kontekstowego wybrać opcję Uruchom. Stan usługi zostanie zmieniony z „Gotowy” na „Działa”.

Przykład uruchomienia usługi APSConfigurationService z poziomu Harmonogram zadań poprzez wybranie opcji z menu kontekstowego.
Przykład uruchomienia usługi APSConfigurationService z poziomu Harmonogram zadań poprzez wybranie opcji z menu kontekstowego.

APSConfigurationService można również ponownie uruchomić w programie Harmonogram zadań poprzez naciśnięcie opcji Uruchom w prawej części okna. Stan usługi zostanie zmieniony z „Gotowy” na „Działa”

Przykład uruchomienia usługi APSConfigurationService poprzez wybranie opcji z sekcji Wybrany element z poziomu Harmonogram zadań.
Przykład uruchomienia usługi APSConfigurationService poprzez wybranie opcji z sekcji Wybrany element z poziomu Harmonogram zadań.

Ponowne uruchamianie usługi Nginx

Aby ponownie uruchomić usługę Nginx w Harmonogramie zadań, należy najpierw otworzyć Menedżer zadań. W Menedżer zadań na zakładce [Szczegóły] wyszukać proces nginx.exe.

Procesy nginx.exe na zakładce Szczegóły z poziomu aplikacji Menedżer zadań
Procesy nginx.exe na zakładce Szczegóły z poziomu aplikacji Menedżer zadań

Następnie w menu kontekstowym dla procesu nginx.exe należy wybrać opcję Zakończ zadanie. W ten sposób należy zakończyć oba procesy nginx.exe.

Przykład zakończenia usług nginx.exe z poziomu Menedżer zadań poprzez wybranie opcji z menu kontekstowego
Przykład zakończenia usług nginx.exe z poziomu Menedżer zadań poprzez wybranie opcji z menu kontekstowego

Po zakończeniu procesów należy przejść do Harmonogramu zadań i na liście zaznaczyć Nginx. Z menu kontekstowego dla pozycji wybrać opcję Zakończ.

Przykład zakończenia usługi Nginx z poziomu Harmonogram zadań poprzez wybranie opcji z menu kontekstowego
Przykład zakończenia usługi Nginx z poziomu Harmonogram zadań poprzez wybranie opcji z menu kontekstowego

Uruchomić usługę Nginx należy poprzez znalezienie oraz zaznaczenie na liście w Harmonogramie zadań usługi Nginx. Po wskazaniu pozycji należy z menu kontekstowego wybrać opcję Uruchom. Stan usługi zostanie zmieniony z „Gotowy” na „Działa”.

Przykład uruchomienia usługi Nginx z poziomu Harmonogram zadań poprzez wybranie opcji z menu kontekstowego
Przykład uruchomienia usługi Nginx z poziomu Harmonogram zadań poprzez wybranie opcji z menu kontekstowego

Nginx można również ponownie uruchomić również poprzez wybranie opcji Uruchom w sekcji Wybrany element. Stan usługi zostanie zmieniony z „Gotowy” na „Działa”.

Przykład uruchomienia usługi Nginx poprzez wybranie opcji z sekcji Wybrany element z poziomu Harmonogram zadań
Przykład uruchomienia usługi Nginx poprzez wybranie opcji z sekcji Wybrany element z poziomu Harmonogram zadań

Czy ten artykuł był pomocny?