Dotyczy wersji 2024 R1, autor: Marcin Kapusta
Wprowadzenie
W wersji WEBCON BPS 2024 R1, komponent WEBCON BPS Search Server wykorzystuje do wyszukiwania danych nową wersję indeksu Apache Solr – 9.6.0.
W związku z tym, aktualizacja do tej wersji wymaga podjęcia dodatkowych kroków. Większość tych kroków wykonuje instalator, jednak część musi być wykonana ręcznie przez administratora przeprowadzającego aktualizację.
W tym artykule znajduje się lista dodatkowych kroków, wraz z instrukcją wykonania. Zawiera też informacją o tym, które z tych kroków wykonane będą automatycznie przez instalator, a które musi wykonać ręcznie administrator.
Krok I – Instalacja i konfiguracja Javy na środowisku, gdzie jest instalowany WEBCON BPS Search Server
WEBCON BPS Search Server wykorzystuje indeks wyszukiwania tekstowego Apache Solr. Jest to aplikacja wymagająca Javy do poprawnego działania.
Do wersji 2023 R3 włącznie, Java była dostarczana wewnątrz pakietu WEBCON BPS Search Server
Od wersji 2024 R1, WEBCON BPS Search Server nie zawiera Javy. Jest ona wymaganym prerekwizytem w systemie operacyjnym, gdzie ma być zainstalowany Search Server.
Takie podejście pozwala administratorom środowiska podnosić Javę do najnowszych wersji (np. ze względu na poprawki bezpieczeństwa) bez konieczności podnoszenia wersji WEBCON BPS .
Wykonywane przez: administrator środowiska
Krok II – Kopia zapasowa aktywności użytkowników
Przy aktualizacji Apache Solr wszystkie dane z indeksów zostaną usunięte.
Dane elementów obiegu, nawigacji i wniosków o zmiany zostaną ponownie zaindeksowane. Nie ma takiej możliwości dla danych dotyczących ostatnich aktywności użytkowników – ponieważ są one przechowywane tylko w indeksach Solr.
Ze względu na powyższe, przed aktualizacją Apache Solr musi zostać wykonana kopia zapasowa aktywności użytkowników z ostatnich 30 dni.
Podczas aktualizacji do wersji 2024 R1, instalator utworzy taką kopię zapasową przed aktualizacją komponentów, i zapisze ją w postaci plików csv we wskazanym folderze.
Wykonywane przez: instalator
Krok III – Aktualizacja komponentu Search Server – usunięcie indeksów Solr i instalacja nowej instancji silnika Solr
Podczas aktualizacji WEBCON BPS Search Server, instalator usuwa dotychczasową wersję Apache Solr, wraz z całą zawartością indeksów i instaluje nową wersję Apache Solr z pustymi indeksami.
Wykonywane przez: instalator (w szczególnych przypadkach przez administratora)
Krok IV – Import aktywności użytkowników z kopii zapasowej
Po zaktualizowaniu WEBCON BPS Search Server i uruchomieniu Apache Solr, instalator wykona import aktywności z kopii zapasowej. Import zostanie wykonany automatycznie – pod warunkiem, że kopia zapasowa została wykonana na tym samym środowisku i istnieje do niej dostęp.
Po zakończeniu instalacji i poprawnym uruchomieniu systemu, plik z kopią zapasową może zostać usunięty.
Jeśli komponenty systemu są zainstalowane na wielu maszynach, import aktywności może wymagać pomocy administratora – niżej znajduje się dodatkowa instrukcja instalacji.
Wykonywane przez: instalator (w szczególnych przypadkach przez administratora)
Krok V – Zaindeksowanie danych wyszukiwania
Po zaktualizowaniu wszystkich komponentów systemu, oraz aktualizacji baz danych do wersji 2024 R1, zostaną zakolejkowane do zaindeksowania dane wszystkich elementów, załączników, nawigacji i wniosków o zmianę.
Zostanie to wykonane automatycznie przez WEBCON BPS WorkfFlow Service równolegle ze zwykłym działaniem systemu.
Instrukcje dla poszczególnych etapów instalacji
Poniżej znajdują się dodatkowe objaśnienia etapów instalacji.
Krok I – Instalacja i konfiguracja Javy na środowisku, gdzie jest instalowany WEBCON BPS Search Server
W przypadku środowisk, gdzie Java nie jest zainstalowana, najlepiej zainstalować Javę z dystrybucji OpenJDK.
Jest ona udostępniona do użytku na licencji Open Source.
W momencie pisania tego artykułu, najnowsza wersji OpenJDK znajduje się tutaj:
Instalacja polega na pobraniu edycji dla Windows x64, rozpakowaniu jej do wybranego folderu
Następnie należy dodać w systemie zmienną środowiskową JAVA_HOME wskazującą na główny folder z Javą (zawierający foldery bin i lib). Przykładowo, dla OpenJDK 22.0.1 jest to folder:
C:\PROJ\java\jdk-22.0.1
Opcja znajduje się:
Edit system environment variables -> Environment variables -> System variables -> New
W Instalatorze na etapie weryfikacji systemu, również będziemy mieli możliwość zainstalowania Javy.
Krok II, III oraz IV – Aktualizacja wersji systemu WEBCON BPS wraz z wykonaniem kopii zapasowej aktywności i odtworzeniem tych aktywności w nowej wersji.
Przed rozpoczęciem aktualizacji WEBCON BPS do wersji 2024 R1, należy zweryfikować który wariant instalacji znajduje się w danym środowisku – a następnie wykonać procedurę instalacji odpowiednią dla tego wariantu.
Wariant 1 – Wszystkie Komponenty na jednej maszynie
Podstawowe komponenty serwerowe systemu WEBCON BPS, czyli:
- WEBCON BPS WorkFlow Service,
- WEBCON BPS Portal,
- WEBCON BPS Search Server
są zainstalowane na tej samej maszynie, i były instalowane przy pomocy instalatora WEBCON BPS (którejś z poprzednich wersji)
W przypadku, gdy te trzy komponenty są zainstalowane na tej samej maszynie (Designer Studio oraz baza danych mogą być instalowane na innych) proces instalacji jest uproszczony.
Należy uruchomić instalator na maszynie z tymi komponentami, i przejść wszystkie kroki instalacji sugerowane przez instalator. Wszystkie te kroki zostaną wykonane automatycznie i nie wymagają użycia dodatkowych narzędzi.
Uwaga: Automatyczne działanie jest zapewnione przy aktualizacji z wersji 2023.x lub 2022.x. W przypadku aktualizacji z wcześniejszych wersji, należy wykonać wcześniej aktualizację pośrednią do wersji 2023.x lub 2022.x.
Wariant 2 – Komponenty na różnych maszynach
Przynajmniej jeden z trzech podstawowych komponentów serwerowych systemu WEBCON BPS:
- WEBCON BPS WorkFlow Service,
- WEBCON BPS Portal,
- WEBCON BPS Search Server
jest zainstalowany na innej maszynie niż pozostałe.
Wszystkie te komponenty były instalowane instalatorem BPS.
W przypadku takiej instalacji, nie ma znaczenia czy każdy komponent jest na osobnej maszynie, czy są rozłożone w dowolnej innej kombinacji na więcej niż jedną maszynę. Istotne jest, że do aktualizacji tych komponentów, będzie potrzebne wielokrotne uruchomienie instalatora na różnych maszynach.
Procedura instalacji w tym wariancie:
- Należy zatrzymać wszystkie serwisy WEBCON BPS WorkFlow Service
- Wykonać jako pierwszą aktualizację komponentu WEBCON BPS Search Server
Podczas tej aktualizacji można od razu zaktualizować pozostałe komponenty WEBCON BPS, o ile są zainstalowane na tej samej maszynie. Należy również wykonać aktualizację baz danych WEBCON BPS. - W dowolnej kolejności wykonać aktualizację pozostałych komponentów WEBCON BPS na pozostałych maszynach
- Uruchomić wszystkie serwisy WEBCON BPS WorkFlow Service
W takim scenariuszu, wszystkie dodatkowe kroki związane z aktualizacją Apache Solr zostaną wykonane automatycznie przez instalator podczas instalacji komponentu WEBCON BPS Search Server.
Uwaga: Automatyczne działanie jest zapewnione przy aktualizacji z wersji 2023.x lub 2022.x. W przypadku aktualizacji z wcześniejszych wersji, należy wykonać wcześniej aktualizację pośrednią do wersji 2023.x lub 2022.x.
Wariant 3 – Search Server w kontenerze lub zewnętrznie
Instalacja WEBCON BPS jest oparta o kontenery Docker i WEBCON BPS Search Server jest zainstalowany w kontenerze ALBO w instalacji nie jest wykorzystywany WEBCON BPS Search Server, a indeksy wyszukiwania WEBCON BPS zostały zainstalowane na zewnętrznie zarządzanej instalacji Apache Solr.
W tym wariancie, aktualizacja komponentu WEBCON BPS Search Server (a tym samym Apache Solr) nie będzie przeprowadzana przez instalator.
W procedurze instalacji w tym wariancie należy uwzględnić 3 istotne kroki.
- Przy pierwszym uruchomieniu instalatora WEBCON BPS 2024.1, przed aktualizacją dowolnego komponentu lub tylko aktualizacją baz danych, zostanie uruchomiony prerekwizyt, który utworzy kopię zapasową aktywności użytkowników przechowywaną w indeksie Apache Solr.
- Po wykonaniu kopii zapasowej aktywności dotychczas wykorzystywane indeksy wyszukiwania (przechowywane w kontenerze Docker lub dedykowanej instalacji Apache Solr) przestaną być potrzebne.
Należy przygotować kontener Docker dedykowany dla WEBCON BPS Search Server w wersji 2024.1 lub przygotować własną instalację Apache Solr w wersji 9.6 i utworzyć w niej indeksy wyszukiwania WEBCON BPS zgodnie z szablonami dostarczonymi z pakietem instalacyjnym. - Po aktualizacji bazy danych należy podać w instalatorze WEBCON BPS (na kroku konfiguracji Search Server) adres sieciowy oraz dane użytkownika do komunikacji z przygotowanymi w poprzednim kroku indeksami WEBCON BPS (w kontenerze lub dedykowanej instalacji Apache Solr 9.6.0).
- Po przeprowadzeniu aktualizacji wszystkich komponentów systemu WEBCON BPS i uruchomieniu środowiska należy jeszcze zaimportować aktywności użytkowników z kopii zapasowej wykonanej przed aktualizacją.
Do importu kopii zapasowej służy narzędzie konsolowe exe znajdujące się w folderze Tools instalatora.
