Dotyczy wersji: 2024 R1 i powyżej; autor: Konrad Keppert
1 Wstęp
Aktualizacja do nowszej wersji jest nieunikniona dla każdego środowiska WEBCON BPS ze względu na pozyskanie nowych funkcjonalności, naprawy błędów, a także wgranie poprawek bezpieczeństwa. W związku z tym, w interesie administratora systemu jest zapoznanie się z możliwościami instalatora WEBCON BPS oraz opanowanie procedury aktualizacji środowiska.
Niniejsza instrukcja przedstawia uogólnioną procedurę aktualizacji w postaci listy kontrolnej zadań do wykonania przed aktualizacją, opisu każdego kroku procedury oraz kilku praktycznych wskazówek.
Uwaga: przykładowe zrzuty w tym dokumencie pochodzą z aktualizacji środowiska w wersji 2023 do wersji 2024, natomiast zawarte w nim informacje będą uniwersalne. W innych przypadkach została zawarta odpowiednia informacja.
2 Przed rozpoczęciem aktualizacji
2.1 Spełnienie wymagań systemowych
Docelowa wersja WEBCON BPS może posiadać inne wymagania dot. komponentów systemowych. Lista wymagań znajduje się:
- w instrukcji instalacji (plik PDF dostarczany w folderze z instalatorem),
- w instalatorze, w kroku „Weryfikacja systemu” (punkt 3.3 niniejszej instrukcji).
W przypadku niespełnienia wymagań systemu, instalator uniemożliwi przejście do kroku “Wyboru komponentów”, a tym samym przeprowadzenie aktualizacji.
2.2 Weryfikacja licencji
Paczka licencji wgrana do środowiska zawiera informację o numerze wydania (release) wersji, z którą będzie współpracować. Środowisko można zaktualizować do tej wersji lub niższej. Jeśli zainstalowana wersja będzie większa niż ta dostępna w paczce, środowisko nie będzie działać poprawnie. Aby uniknąć problemów, upewnij się, że paczka wgrana na środowisku zawiera licencję na wersję, do której ma ono zostać zainstalowane.
Informacja o najwyższej wersji WEBCON BPS, którą można zainstalować w ramach zakupionej licencji, dostępna jest do sprawdzenia po zalogowaniu się do aplikacji https://activation.webcon.com.
W razie potrzeby należy zaktualizować paczkę licencji (punkt 3.3 artykułu Aktywacja licencji platformy WEBCON BPS – Blog techniczny WEBCON BPS).
2.3 Aktualizacja dodatków SDK
Dodatki SDK są kompatybilne jedynie z główną wersją (major version) WEBCON BPS, dla której zostały napisane. Jeśli w procesach są używane dodatki SDK, a środowisko będzie aktualizowane do nowszej głównej wersji (np. 2023 à 2024), konieczne jest przygotowanie ich nowej wersji, zgodnej z wymaganiami SDK dla docelowej wersji aktualizowanego środowiska WEBCON BPS.
Dostawcy dodatków SDK mogą znaleźć dokumenty migracyjne pod adresem https://developer.webcon.com/versions/.
2.4 Wykonanie kopii zapasowych
W przypadku niepowodzenia lub przerwania aktualizacji, aby odzyskać możliwość pracy ze środowiskiem, konieczne będzie przywrócenie baz danych oraz komponentów WEBCON BPS do wersji sprzed rozpoczęcia aktualizacji. Jeśli serwery hostowane są w maszynach wirtualnych, prostym rozwiązaniem może być wykonanie snapshotów tych maszyn.
3 Aktualizacja
3.1 Wybór typu instalacji
Po zaakceptowaniu postanowień licencyjnych w menu głównym instalatora należy wybrać „Aktualizacja lub rozszerzenie istniejącej instalacji WEBCON BPS”.
Instalator następnie nawiąże połączenie z SQL Server, na którym znajdują się bazy środowiska WEBCON BPS. Począwszy od wersji WEBCON BPS 2024, jeśli instalator wykryje, że certyfikat SQL Servera nie jest zaufany, wyświetli poniższy komunikat, który umożliwi zaufanie certyfikatowi.
3.2 Farma WEBCON BPS
W tym kroku znajdują się informacje o aktualizowanym środowisku, które zostały pobrane z bazy konfiguracyjnej. Dodatkowe czynności nie są wymagane. Należy kliknąć „Dalej”.
3.3 Weryfikacja systemu
Wyświetlana jest lista wymagań, które muszą zostać spełnione, aby można było przeprowadzić aktualizację środowiska. Lista może obejmować komponenty systemowe oraz uprawnienia, jakie musi posiadać użytkownik uruchamiający instalator.
Dotyczy WEBCON BPS 2024 i nowszych: jednym z wymaganych komponentów jest Java w wersji 11 lub nowszej (we wcześniejszych wersjach WEBCON BPS, Java była instalowana zawsze wraz z komponentem WEBCON BPS Search Server). Jeśli odpowiednia wersja Javy nie jest zainstalowana, w kroku „Weryfikacji systemu” instalator da możliwość jej wygodnego zainstalowania (zrzut poniżej).
Lista komponentów będzie inna dla różnych wersji platformy. Pełna lista wymagań systemowych znajduje się w instrukcji instalacji dołączanej w paczce z instalatorem.
3.4 Wybór komponentów
W tym kroku należy określić, które z komponentów WEBCON BPS mają zostać zaktualizowane (lub zainstalowane, jeśli wcześniej nie były). Domyślnie dla wszystkich komponentów wskazane jest wybranie opcji „Aktualizuj”.
3.5 Wymagania wstępne
Na etapie wymagań wstępnych weryfikowane są elementy niezbędne do prawidłowego przebiegu aktualizacji oraz do poprawnego działania WEBCON BPS po aktualizacji. Jeśli w toku przeprowadzonych weryfikacji konieczne będzie podjęcie dodatkowych działań, zostaną wyświetlone odpowiednie komunikaty.
Dotyczy WEBCON BPS 2024 i nowszych: w przypadku aktualizacji ze starszych wersji, jedną z istotnych zmian jest aktualizacja wersji silnika Apache Solr. Wymaga to przeinstalowania całego komponentu (za co odpowiada instalator), jednak wiąże się z utratą zindeksowanych danych. Wszystkie kolekcje poza BPS_Activities (aktywności użytkowników Portalu BPS) można odzyskać wykonując pełną reindeksację baz danych. Z tego powodu instalator zaproponuje wykonanie kopii zapasowej kolekcji BPS_Activities, aby móc ją przywrócić po zakończeniu aktualizacji.
Po wybraniu przycisku „Dalej” wyświetli się kolejne okno, które pozwoli wybrać lokalizację kopii zapasowej.
Po pomyślnym wykonaniu kopii zapasowej wyświetlone zostanie potwierdzenie.
3.6 Instalacja komponentów
W tym kroku wyświetlana jest lista komponentów, które zostaną zmienione. W przypadku instalacji wcześniej nieobecnych komponentów wymagane będzie wskazanie dla nich ścieżki instalacyjnej. Po kliknięciu przycisku „Dalej” rozpocznie się instalacja komponentów w nowszej wersji.
Podczas aktualizowania komponentu WEBCON BPS Search Server instalator może poprosić o podanie poświadczeń użytkownika „solr” (użytkownik z uprawnieniami administratora w serwerze Solr).
Również podczas aktualizacji komponentu WEBCON BPS WorkFlow Service instalator może poprosić o poświadczenia konta, na którym działa ta usługa. Będzie to miało miejsce, jeśli podczas konfiguracji komponentu WorkFlow Service nie zaznaczono opcji „Zapamiętaj dane logowania na potrzeby aktualizacji serwisu”.
3.7 Aktualizacja bazy danych
Etap ten odpowiada za wykonanie zmian w bazach danych WEBCON BPS niezbędnych do prawidłowego działania nowej wersji. Należy zweryfikować listę baz danych do aktualizacji, a następnie rozpocząć proces instalacji przez wybranie przycisku „Dalej”.
3.8 Status serwisu
Na tym etapie zostanie uruchomiona usługa WEBCON BPS WorkFlow Service. Należy kliknąć przycisk „Uruchom serwis”.
W komunikatach serwisu zostanie wyświetlona informacja o jego statusie. W przypadku problemu z uruchomieniem serwisu, należy sprawdzić dziennik zdarzeń dla usługi WEBCON BPS WorkFlow Service w celu ustalenia przyczyny problemu.
Po poprawnym uruchomieniu serwisu należy kliknąć przycisk „Dalej”.
3.9 Zakończenie
W tym kroku przedstawiono podsumowanie aktualizacji – wszystkie wykonane operacje. Dodatkowe czynności nie są wymagane.
Zasadnicza część aktualizacji środowiska WEBCON BPS została zakończona.
4 Praktyczne wskazówki i informacje
4.1 Weryfikacja poprawności działania
W przystawce „Services” systemu Windows dostępnej z panelu sterowania, należy sprawdzić, czy można poprawnie uruchomić usługi WEBCON BPS Search Service oraz WebCon WorkFlow Service.
Aby sprawdzić, czy usługa WEBCON BPS Search Service odpowiada poprawnie, wystarczy wyszukać dowolną frazę w wyszukiwarce globalnej WEBCON BPS Portal (zrzut poniżej).
Dobrym pomysłem jest otwarcie dowolnego elementu obiegu w trybie edycji (lub wystartowanie nowego obiegu). W przypadku problemów z serwisem licencji WEBCON BPS Portal działa w trybie tylko do odczytu. Jeśli na formularzu możliwe będzie wejście w tryb edycji, serwis licencji odpowiada poprawnie.
4.2 Utrata hasła użytkownika solr
Hasła użytkownika administracyjnego solr nie da się zmienić. W przypadku gdy aktualizacja wymaga wprowadzenia hasła tego użytkownika (przykład na zrzucie w kroku „3.6 Instalacja komponentów”), ale zostało ono utracone, konieczne jest przeinstalowanie komponentu WEBCON BPS Search Server.
Najprostszym rozwiązaniem tego problemu podczas aktualizacji jest:
– Wykonanie kopii zapasowej kolekcji BPS_Activities przed aktualizacją (jest to jedyna kolekcja, której danych nie da się odzyskać wykonując reindeksację baz danych SQL).
– Całkowite odinstalowanie komponentu WEBCON BPS Search Server.
– Rozpoczęcie aktualizacji środowiska z użyciem instalatora nowszej wersji. W kroku „3.4 Wybór komponentów” należy wskazać WEBCON BPS Search Server do instalacji, a pozostałe komponenty do zaktualizowania.
– Po zakończeniu aktualizacji, przywrócenie BPS_Activities z kopii zapasowej oraz pełna reindeksacja wszystkich baz danych za pomocą raportu „Kolejka indeksowania SOLR” w Designer Studio.
4.3 Aktualizacja kopii środowiska produkcyjnego
Aby poznać przybliżony czas, jaki będzie potrzebny na aktualizację środowiska produkcyjnego, oraz upewnić się, że aktualizacja przebiegnie bezproblemowo, dobrym pomysłem może być tzw. wyrównanie środowisk, czyli operacja polegająca na nadpisaniu baz środowiska DEV/TEST bazami danych środowiska PROD. W ten sposób możliwe będzie wykonanie aktualizacji na bazach produkcyjnych na innym, dowolnym środowisku.
Procedurę wyrównania środowisk opisano w artykule Instrukcja wyrównywania środowiska WEBCON 2023 StandAlone – Blog techniczny WEBCON BPS.
4.4 Środowisko rozszerzone
W przypadku gdy komponenty WEBCON BPS zainstalowane są na więcej niż jednym serwerze aplikacyjnym (scenariusze HA/failover), aktualizacja musi zostać wykonana na każdej maszynie, bowiem wszystkie komponenty muszą pracować w jednakowej, nowszej wersji platformy.
Krok „3.6 Instalacja komponentów” zostanie zatem wykonany na każdym serwerze, jednak bazy danych mogą zostać zmigrowane tylko raz. W kroku „3.7 Aktualizacja bazy danych” instalator sprawdzi numer ostatnio wykonanego skryptu, rozpozna, że bazy zostały już wcześniej zaktualizowane i nie wykona żadnych skryptów.
Aby uniknąć problemów związanych ze skryptami migracyjnymi baz danych, aktualizacji na kilku serwerach aplikacyjnych nie należy wykonywać równolegle. W innym przypadku, gdyby dwa instalatory znalazły się w tym samym czasie w kroku „3.7 Aktualizacja bazy danych”, wykonałyby te same skrypty na jednej bazie, co doprowadziłoby do błędów.
Dobrą praktyką jest aktualizowanie serwerów jeden po drugim, choć kolejność nie ma w tym przypadku znaczenia.