Przewodnik instalacji, wersja nAxiom 1.14.6.0 i nowsze

Ostatnia aktualizacja: 2025-04-15

Spis treści

Wstęp
Wymagania
1. Wymagania sprzętowe
2. Wymagany system operacyjny
Przebieg instalacji
Witryna nAxiom w na serwerze IIS
Pierwsze logowanie
1. Import licencji
Instalacja kolejnych witryn nAxiom
Znane problemy — błąd uprawnień
1. Błąd uprawnień
2. Po poprawnej instalacji witryna nie uruchamia się
Dodatek: samodzielna instalacja wymaganych składników i programów pomocniczych

Wstęp

nAxiom to uruchamiana w przeglądarce aplikacja ASP.NET Core działająca w środowisku .NET 8. Jako magazyn danych aplikacja wykorzystuje program Microsoft SQL Server. Pierwsza instalacja nAxiom może przebiegać zupełnie bezobsługowo, o ile ustawienia domyślne będą wystarczające. Instalator sprawdza, a w razie potrzeby pobiera i instaluje komponenty niezbędne do działania nAxiom, takie jak platforma .NET Core, pakiet .NET Hosting Bundle, oprogramowanie Microsoft SQL Server oraz usługa Internet Information Services z niezbędnymi dodatkami. Dostępny jest także tryb zaawansowany, w którym użytkownik może indywidualnie określić szereg ustawień. Skorzystanie z trybu zaawansowanego jest także konieczne, gdy użytkownik chce zainstalować kolejne witryny nAxiom na tej samej maszynie. W indywidualnych przypadkach możliwe jest również samodzielne przygotowanie środowiska do działania witryny nAxiom. Opis samodzielnej instalacji i konfiguracji tych komponentów opisano w dalszej części przewodnika. Do uruchomienia witryny nAxiom wymagana jest licencja wygenerowana dla podawanej podczas instalacji nazwy klienta.

Wymagania

Wymagania sprzętowe

Stacja robocza lub serwer, na którym ma działać witryna nAxiom używana jako środowisko do tworzenia i/lub testowania aplikacji biznesowych musi spełniać wymagania poniższe minimalne wymagania sprzętowe.

Pamięć RAM

8 GB

Dysk twardy

systemowy: 100 GB
bazodanowy: 100–500 GB
aplikacyjny: 20 GB

Liczba rdzeni procesora

Taka konfiguracja może także służyć jako środowisko produkcyjne dla ok. 20 użytkowników. Przy czym podana wielkość przestrzeni dyskowej nie uwzględnia miejsca do przechowywania załączników oraz zakłada ciągłe odzyskiwanie miejsca poprzez archiwizację danych.

Instalator nAxiom obsługuje wyłącznie architekturę procesorów x64. Architektura x86 nie jest już obsługiwana.

Wymagany system operacyjny

Platforma nAxiom może być instalowana w następujących systemach operacyjnych: Windows 10 (kompilacja 1607 lub nowsza), Windows Server 2016, Windows Server 2019.

Ponadto platforma nAxiom jest dostępna jako zestaw obrazów Docker dla systemu Linux. Więcej informacji na ten temat zawiera artykuł Wdrożenie nAxiom z obrazów Docker.

Przebieg instalacji

Kliknij dwukrotnie plik instalacyjny. Program jest domyślnie uruchamiany z uprawnieniami administratora. W przypadku uruchomienia z konta użytkownika standardowego zostanie wyświetlone okno dialogowe w celu podania poświadczeń administratora. Zostanie wyświetlony pierwszy ekran kreatora instalacji.

Kliknij przycisk Dalej.

Instalacja wymaganych komponentów

Instalacja komponentu .NET Framework 4.8 kończy się ponownym uruchomieniem systemu wykonywanym bez ostrzeżenia. Aby to nie prowadziło do niepożądanych skutków, należy wcześniej zatrzymać działające programy i usługi. W razie wykrycia braku tego komponentu, instalator wyświetli odpowiedni komunikat przed rozpoczęciem instalacji wymaganych komponentów.

Od wersji 1.14.0.12 nAxiom wymaga do działania platformy .NET 8. Do czasu aktualizacji instalatora odpowiednie biblioteki należy zainstalować samodzielnie, pobierając pakiet .NET Hosting Bundle (https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-aspnetcore-8.0.11-windows-hosting-bundle-installer). Patrz także Środowisko .Net Core w dalszej części przewodnika.

W kolejnym kroku instalator wyświetla listę komponentów potrzebnych do działania nAxiom. W przypadku niektórych składników możliwe jest nadpisanie istniejącej instalacji, w tym celu należy zaznaczyć pole wyboru obok tego składnika. W przypadku serwera MS SQL Server można anulować zaznaczenie pola wyboru, jeśli użytkownik ma zamiar korzystać np. ze zdalnej instalacji. W razie wyłączenia instalacji programu SQL Server dostępny będzie jedynie tryb zaawansowany instalacji, ponieważ konieczne będzie podanie ustawień połączenia z bazą danych.

Instalator nie instaluje programu SQL Server Management Studio, który może być potrzebny do obsługi bazy danych SQL Server. Użytkownik musi zainstalować ten program samodzielnie; patrz Dodatek.

Kliknij przycisk Zainstaluj wymagane. Instalator rozpocznie pobieranie i instalowanie wymaganych składników.

Po zainstalowaniu serwera internetowych usług informacyjnych (IIS) wymagane jest ponowne uruchomienie systemu.

Instalator sprawdza, czy w magazynie certyfikatów danego komputera znajduje się certyfikat o nazwie nAxiom SSL Localhost. Jeśli nie znajdzie takiego certyfikatu, tworzy go. Ten certyfikat jest wymagany do działania nAxiom na komputerze lokalnym.

Po ponownym uruchomieniu instalator wznowi działanie i zainstaluje pozostałe składniki. Następnie zostanie wyświetlony ekran wyboru trybu instalacji.

Jeśli instalator instaluje program SQL Server, domyślnie aktywuje konto użytkownika sa z hasłem !2qwASzx. Aby zamiast tego używać konta z minimalnymi wymaganymi uprawnieniami, utwórz je zgodnie z opisem i wybierz instalację zaawansowaną.

Szybka instalacja domyślna

Opcja szybkiej instalacji domyślnej jest dostępna w dwóch przypadkach:

instalacja nowej witryny: na serwerze IIS nie ma żadnej witryny nAxiom oraz

na danym komputerze nie ma instancji SQL Server lub

instalator ma dostęp sa do instancji SQL Server (hasło !2qwASzx)

aktualizacji istniejącej witryny: na serwerze IIS jest jedna witryna nAxiom i instalator ma dostęp sa do instancji SQL Server

Pozostaw zaznaczoną domyślnie opcję Szybka instalacja z ustawieniami domyślnymi i kliknij Dalej. Zostanie wyświetlone okno Klucz licencji.

Wpisz nazwę klucza licencji i wskaż położenie pliku licencji (rozszerzenie nlic). Zgodnie z informacją podaną w oknie, jeśli dla domyślnej nazwy witryny nAxiom plik licencji nie zostanie wskazany, platforma nAxiom zostanie zainstalowana w wersji z ograniczonym okresem ważności — czas ważności można sprawdzić po zainstalowaniu naxiom, wybierając w aplikacji AdminSPA polecenie Licencjonowanie z menu ADMINISTRACJA. Kliknij przycisk Dalej, aby potwierdzić informacje o licencji.

Zostanie wyświetlone okno wyboru rodzaju instalowanego środowiska. Instalowana witryna może pełnić rolę środowiska deweloperskiego (domyślnie), testowego lub produkcyjnego. Zaznacz odpowiednią opcję i kliknij przycisk Dalej. W kolejnym oknie ponownie kliknij Dalej, aby przejść do instalacji plików witryny. Na koniec instalator wyświetli informację o pomyślnym zakończeniu instalacji. Domyślnie zaznaczone jest pole wyboru Uruchom platformę nAxiom po zakończeniu instalacji. Po kliknięciu przycisku Zakończ witryna nAxiom zostanie uruchomiona w przeglądarce domyślnej.

W trybie szybkiej instalacji instalator tworzy witrynę o nazwie naxiom oraz bazy danych naxiom_tenantsAdmin i naxiom z poświadczeniami użytkownika sa utworzonymi na wcześniejszym etapie instalacji. Witryna jest dostępna pod adresem https://localhost:443, a jej folder instalacyjny to C:\inetpub\naxiom.

Predefiniowane konta użytkownika:

Superadministrator uprawnień: login: superuser, hasło: !Q2w3e4r%T
To konto pozwala wyznaczać administratorów uprawnień w modelu PBA.
Administrator: login: admin, hasło: !Q2w3e4r
Korzystając z tego konta można logować się do aplikacji FrontSPA (front office) i zarządzać użytkownikami, w tym nadawać im uprawnienia z obszaru zarządzania użytkownikami.
Konsultant: login: consultant, hasło: !Q2w3e4r
Konsultant loguje się do aplikacji AdminSPA (back office), w której buduje aplikacje biznesowe. Konsultant może także wyznaczać innych konsultantów, to jest przyznawać użytkownikom uprawnienia z obszaru globalnych uprawnień aplikacji.
Administrator tenantów: login: tenantsadmin, hasło: !Q2w3e4r%T
Administrator tenantów loguje się do aplikacji TenantAdminSPA (https://localhost/tenantsadmin/), w której może dodawać i usuwać tenantów oraz konfigurować ich ustawienia.

Instalacja zaawansowana

W tym trybie użytkownik jest przełączany do zaawansowanego instalatora, w którym może konfigurować poszczególne kroki instalacji, zależnie od potrzeb oraz wybranych ustawień (kroki oznaczone gwiazdką).

Instalator zaawansowany jest również dostępny w osobnym pakiecie instalacyjnym. Korzystając z tego pakietu należy uruchomić program instalatora (AppInstaller.exe) z uprawnieniami administratora. W przeciwnym razie instalacja nie powiedzie się.

Po uruchomieniu instalatora może zostać wyświetlone ostrzeżenie o ochronie komputera przez system Windows. Należy kliknąć link Więcej informacji, a następnie przycisk Uruchom mimo to.

Instalator nAxiom — Sprawdzanie wymagań aplikacji

W pierwszym oknie ponownie jest wyświetlana lista wykrytych komponentów. Wszystkie komponenty wymagane muszą być zainstalowane/skonfigurowane i oznaczone kolorem zielonym. Jeśli na liście znajdują się komponenty oznaczone kolorem czerwonym, kontynuowanie instalacji będzie niemożliwe.

Kolorem żółtym są oznaczone komponenty opcjonalne, których brak nie uniemożliwia kontynuowania instalacji, jednak może spowodować, że niektóre funkcje systemu będą niedostępne.

Program SQL Server jest komponentem opcjonalnym, ponieważ nie musi być zainstalowany na komputerze lokalnym. Użytkownik może wskazać zdalny serwer bazy danych na dalszym etapie instalacji.

Jeśli wszystkie wymagane komponenty są dostępne, kliknij przycisk Dalej.

Konfiguracja serwera IIS

W tym oknie należy wypełnić kilka pól w celu skonfigurowania serwera usług IIS.

Nazwa witryny: nazwa witryny (domyślnie naxiom); nazwa witryny będzie wyświetlana na liście witryn w programie Menedżer IIS.
Ścieżka instalacji: kliknij przycisk Wybierz i w drzewie folderów wskaż lokalizację folderu, w którym zostaną zainstalowane pliki witryny; domyślnie zawartość witryny i aplikacje Web udostępniane przez serwer internetowych usług informacyjnych są umieszczane w folderze C:\inetpub.
Rodzaj instalacji:
- Instalacja tylko z dostępem do lokalnym: (domyślnie) witryna nAxiom jest instalowana na komputerze lokalnym.
- Instalacja z dostępem zdalnym: witryna nAxiom jest instalowana na serwerze i będzie dostępna dla użytkowników zewnętrznych; po wybraniu tego ustawienia, w następnym kroku instalatora konieczne będzie skonfigurowanie powiązania witryny na serwerze IIS na potrzeby obsługi ruchu wewnętrznego między komponentami witryny; tę opcję należy również włączyć, aby dla komputera lokalnego ustawić nazwę hosta inną niż localhost (zgodnie z plikiem hosts); patrz także Certyfikat dla serwera IIS.
Host: nazwa hosta, na którym będą dostępne strony platformy nAxiom; wartość domyślna localhost odpowiada instalacji na komputerze lokalnym.
Adres IP: adres IP komputera, na którym jest instalowana witryna nAxiom; w przypadku instalacji lokalnej * (gwiazdka).
Protokół: https; jest to jedyny obsługiwany protokół.
Port: numer portu dla połączeń z serwerem; wartość domyślna to 443; każda witryna instalowana na danym hoście musi mieć unikalny numer portu.
Tożsamość: określa poziom uprawnień, z jakimi są uruchamiane poszczególne serwisy nAxiom (admin, api, auth itp.); dostępne wartości:
- ApplicationPoolIdentity: (wartość domyślna) nazwa wirtualnego konta użytkownika tworzonego w systemie Windows przez serwer IIS podczas tworzenia nowej puli aplikacji; takie konto ma najniższe uprawnienia.
- SpecificUser: określone konto użytkownika systemu Windows, wymaga podania nazwy logowania i hasła
- LocalSystem: Zaufane konto o wysokich uprawnieniach, które ma także dostęp do zasobów sieciowych.
Kliknij przycisk Wybierz, wybierz z listy rozwijanej odpowiednią pozycję, w razie potrzeby wypełnij pola Użytkownik i Hasło, a następnie ponownie kliknij przycisk Wybierz. Poświadczenia tożsamości puli aplikacji mogą być używane do logowania do programu SQL Server, w tym celu należy w krokach Tenant admin - konfiguracja oraz Pierwszy tenant - konfiguracja zaznaczyć pole wyboru Zintegrowane zabezpieczenia.

Wybór tożsamości dla puli aplikacji
Certyfikat: kliknij przycisk Wybierz certyfikat; zostanie wyświetlone okno Wyszukiwarka certyfikatów.

Wybór certyfikatu

W magazynach certyfikatów wyświetlane są tylko certyfikaty z kluczem prywatnym. Kliknij certyfikat utworzony dla hosta o nazwie podanej w polu Host (Położenie: Komputer lokalny, Magazyn: Osobisty) i kliknij przycisk Wybierz; patrz także Certyfikat dla serwera IIS.

Zaleca się wybór certyfikatu wyłącznie z magazynu Osobisty lub Usługa hosta sieci Web.

Kliknij przycisk Dalej.

Konfiguracja ruchu wewnętrznego

Ten krok konfiguracji jest wyświetlany tylko wtedy, gdy w poprzednim kroku wybrano opcję Instalacja z dostępem zdalnym. W tym kroku konfiguruje się ruch wewnętrzny między komponentami nAxiom. Ruch ten wykorzystuje hosta localhost. Użytkownik może skonfigurować rodzaj protokołu używanego dla tego ruchu (domyślnie http), port (domyślnie 8080) oraz wybrać certyfikat dla localhost, jeśli wybrano protokół https. Patrz także Certyfikat dla localhost.

Jeśli na danym hoście jest instalowanych kilka witryn dostępnych z zewnątrz, dla każdej z nich należy skonfigurować inny port dla ruchu wewnętrznego. Użycie tej samej wartości (np. domyślnej) dla wszystkich witryn spowoduje, że możliwe będzie uruchomienie tylko jednej z tych witryn. Ponadto przed konfigurowaniem portu dla ruchu wewnętrznego należy sprawdzić, czy nie jest on już używany przez inne oprogramowanie.

Wybór rodzaju środowiska

Wybór tej opcji jest możliwy tylko podczas pierwszej instalacji witryny, dlatego ten krok jest oznaczony gwiazdką jako zależny od konfiguracji. Domyślnie wybrana jest opcja Deweloperskie. Ta opcja jest również stosowana do witryn aktualizowanych z wersji nAxiom wcześniejszych niż 1.8. Pozostałe wartości to: Testowe i Produkcyjne.

Odpowiednie ustawienia dotyczące rodzaju środowiska są zapisywane w plikach appsettings.json dla serwisów api, auth, taskservice, tenantsapi, publicapi, mobileapi, bpmnapi i executorapi w kluczu Environment. Obsługiwane wartości to Development, Test, Production. Zmieniając tę wartość w obu plikach, można zmienić ustawienie środowiska dla witryny. Zastosowanie tej zmiany wymaga restartowania witryny (w Menedżerze usług IIS). W przypadku wdrożenia nAxiom z obrazów dokerowych zmiany można dokonać, używając plików appsettings-custom.json (patrz artykuł Wdrożenie nAxiom z obrazów Docker).

"AppConfiguration": {
  "Environment": "Test"
}

W środowisku deweloperskim i testowym witryna jest oznaczona kolorowym paskiem u góry okna przeglądarki z nazwą rodzaju środowiska (zarówno front office, jak i back office). Środowisko produkcyjne nie ma żadnych oznaczeń.

Wybór plików instalacyjnych

W tym kroku można wybrać inne niż domyślne ścieżki do paczek instalacyjnych dla różnych komponentów (serwisów) platformy, o ile użytkownik ma odpowiednie paczki spakowane jako archiwa zip. Można też indywidualnie włączać i wyłączać instalowanie komponentów platformy. Na przykład komponent MobileTools jako opcjonalny jest domyślnie wyłączony. Z kolei OcrApi i Ocr są domyślnie wyłączone, ponieważ są licencjonowane osobno, a ponadto wymagają zainstalowania dodatkowych składników w systemie. Komponenty Word i Outlook to wtyczki do programów Microsoft Word i Microsoft Outlook, za pomocą których można łączyć się z witryną nAxiom z dokumentów otwieranych w tych programach.

Przetwarzanie OCR opiera się na kolejce procesów OCR. Domyślnie sprawdzanie tej kolejki przez aplikację taskservice jest wyłączone. Aby je włączyć, należy ustawić wartość parametru Częstotliwość sprawdzania kolejki procesów wykonywanych przez OCR (w sekundach) (adminSPA > Ustawienia systemu > OCR) większą od 0. Zalecane wartości to 60 lub 120 s.

W przypadku standardowej instalacji należy pozostawić ustawienia domyślne.

Zaznaczenie pola wyboru Nie aktualizuj aplikacji, chcę tylko zmienić konfigurację pozwala pominąć kopiowanie plików do folderu docelowego w przypadku, gdy uruchomiono instalator, aby zmienić ustawienia konfiguracyjne. W przypadku, kiedy instalowana jest nowa witryna, to pole wyboru jest nieaktywne, jak na ilustracji poniżej.

Przycisk Zmień nad tabelką służy do zmiany ścieżki do katalogu, w którym znajdują się paczki instalacyjne poszczególnych komponentów.

Aby włączyć instalowanie komponentu, zaznacz ten komponent w tabelce i zaznacz pole wyboru Instaluj pod tabelką.

Aby zmienić ścieżkę do paczki instalacyjnej komponentu, zaznacz ten komponent w tabelce i kliknij przycisk Zmień poniżej tabelki.

Kliknij przycisk Dalej.

Tenant admin — konfiguracja

W tym kroku należy skonfigurować połączenie z bazą danych dla administratora tenantów.

Wykonaj poniższe czynności.

Wypełnij pola Serwer i Instancja, wpisując w nie wartości z programu SQL Server Management Studio. (Zamiast instancji, możesz wskazać numer portu).

Nazwa i instancja serwera SQL Server w programie SSMS
W sekcji Dane konta administratora serwera wypełnij pola Login i Hasło; muszą to być dane loginu z rolami dbcreator i securityadmin (lub sysadmin). Poświadczenia te są potrzebne tylko w przypadku, kiedy podczas instalacji na serwerze musi zostać utworzona baza danych i login administratora tenantów; jeśli odpowiednia baza i login istnieje, nie trzeba podawać tych poświadczeń. Patrz także Utworzenie konta, bazy danych i użytkownika bazy danych.

Należy pamiętać o konieczności włączenia trybu logowania SQL Server and Windows Authentication Mode w używanej instancji serwera, patrz także sekcja Tryb uwierzytelniania na serwerze MS SQL Server w tym przewodniku.
Wpisz nazwę w polu Baza danych i zaznacz opcję Utwórz automatycznie bazę danych; aby połączyć się z istniejącą bazą danych, wpisz nazwę tej bazy i zaznacz opcję Połącz do istniejącej bazy; domyślna nazwa bazy danych to nazwaWitryny_tenatsAdmin (gdzie nazwaWitryny to nazwa witryny podana w kroku Konfiguracja serwera IIS).
W pola Użytkownik i Hasło wpisz poświadczenia konta (login) na serwerze bazy danych; wartości domyślne to odpowiednio: tenantadmin i Pswrd@[ta]. Jeśli podany login już istnieje i ma inne hasło, zostanie ono nadpisane. Alternatywnie, zaznacz pole wyboru Zintegrowane zabezpieczenie — wówczas pola z nazwą i hasłem użytkownika staną się niedostępne, a nAxiom będzie korzystać z poświadczeń tożsamości puli aplikacji na serwerze IIS; patrz opis pola Tożsamość w kroku Konfiguracja serwera IIS instalatora.

Loginy dla administratora tenantów i pierwszego tenanta są tworzone z minimalnym wymaganym zestawem ról w bazie danych (dbcreator, securityadmin i public dla administratora tenantów oraz public dla pierwszego tenanta).

Jeśli konfigurowane jest połączenie do istniejącej bazy danych, możesz kliknąć przycisk Testuj połączenie. Powinien zostać wyświetlony komunikat jak na ilustracji poniżej.

Komunikat o wyniku testu połączenia

Kliknij przycisk Dalej. Zostanie wyświetlony komunikat o poprawnym utworzeniu bazy danych dla administratora tenantów.

Pierwszy tenant — konfiguracja

W tym kroku konfigurowane jest połączenie z bazą danych pierwszego tenanta. W oparciu o podane dane, podczas pierwszego uruchomienia witryny, na serwerze bazy danych zostanie utworzony login oraz baza danych. W przypadku aktualizacji z wersji nAxiom bez obsługi tenantów (wcześniejszych niż 1.11) pierwszy tenant zostanie powołany na podstawie dotychczasowej konfiguracji.

Wykonaj następujące czynności:

W sekcji Klient w polu Nazwa wpisz ciąg znaków, na podstawie którego wygenerowano plik licencji (patrz Import licencji); wpisanie wartości jest możliwe tylko w przypadku instalacji nowej witryny nAxiom, w przypadku aktualizacji witryny, to pole jest nieaktywne.
Wypełnij pola Serwer i Instancja, jak w poprzednim kroku instalatora.
Wpisz nazwę w polu Baza danych i zaznacz opcję Utwórz automatycznie bazę danych; aby połączyć się z istniejącą bazą danych, wpisz nazwę tej bazy i zaznacz opcję Połącz do istniejącej bazy; domyślna nazwa bazy danych to nAxiom.
W pola Użytkownik i Hasło wpisz poświadczenia konta (login) na serwerze bazy danych; wartości domyślne to odpowiednio: tenant1user i Pswrd@tenant1. Patrz także uwagi dotyczące tych pól w poprzednim kroku instalatora.
Jeśli konfigurowane jest połączenie do istniejącej bazy danych, możesz kliknąć przycisk Testuj połączenie. Powinien zostać wyświetlony komunikat z potwierdzeniem.

Pierwszy tenant — zasoby systemu

W tym kroku podczas instalacji nowej witryny można określić miejsce zapisu plików statycznych używanych w środowisku nAxiom przez pierwszego tenanta: załączników, wiadomości e-mail, rozpoznanych plików OCR i dodatkowych bibliotek. W przypadku aktualizacji witryny, zachowywane są jej ustawienia i nie można ich zmienić. Dostępne są następujące opcje (niektóre są dostępne tylko dla określonego typu zasobów):

Folder instalacyjny nAxiom: pliki zasobów będą zapisywane w podfolderze folderu wskazanego w drugim kroku instalacji nAxiom.

Domyślna struktura folderów dla plików zasobów
Baza danych: tabela bazy danych, w której będą przechowywane pliki zasobów; kliknij przycisk Konfiguracja bazy danych i w wyświetlonym oknie określ parametry połączenia z bazą danych, analogicznie jak w kroku Pierwszy tenant — konfiguracja. Dodatkowo, wypełnij pole Nazwa tabeli repozytorium; jeśli tabela o podanej nazwie nie istnieje, zostanie utworzona.
Wybrany folder: dowolny folder w systemie plików wskazany przez użytkownika; ta opcja jest dostępna tylko w przypadku aktualizacji witryny z niestandardowymi folderami repozytoriów.

Konfiguracja repozytorium w bazie danych
Zachowaj obecne ustawienia: opcja zaznaczona domyślnie w przypadku aktualizacji witryny nAxiom; nowe pozycje zasobów dodawane w przyszłych wersjach będą wymagały skonfigurowania lokalizacji podczas instalacji, pomimo że dla tych pozycji ta opcja będzie zaznaczona.

Zmiana lokalizacji zapisu plików w przypadku aktualizacji witryny wymaga ręcznego przeniesienia plików do nowej lokalizacji, ta procedura rodzi jednak ryzyko wystąpienia nieprzewidzianych błędów.

Po instalacji ustawienia lokalizacji zasobów są dostępne w następujących miejscach:

baza danych repozytorium, patrz DANE > Źródła danych
repozytoria załączników, wiadomości e-mail i bibliotek systemowych, patrz DANE > Repozytoria załączników
pliki OCR i raporty Telerik, patrz TenantAdminSPA > Tenants list > Edit > Configuration > Settings > sekcja FileStorageConfiguration.

Dodatkowo w ustawieniach można wybierać repozytorium używane przez daną witrynę nAxiom dla szablonów e-mail i załączników pobranych z wiadomości e-mail, patrz SYSTEM > Ustawienia > Email > Repozytorium zapisu plików dla szablonów e-mail i Exchange - Repozytorium zapisu plików dla załączników pobieranych z wiadomości.

Zmiana repozytorium wiadomości e-mail w Instalatorze będzie się odnosić do repozytorium o nazwie Domyślne repozytorium wiadomości e-mail i po zmianie to repozytorium zostanie wybrane jako aktywne w ustawieniach.

Maksymalny rozmiar załącznika w nAxiom zależy od parametru Maksymalna dozwolona długość zawartości (w bajtach) dostępnego w programie Menedżer internetowych usług informacyjnych (IIS). Aby skonfigurować ten parametr, należy kliknąć dwukrotnie funkcję Filtrowanie żądań, a następnie kliknąć polecenie Edytuj ustawienia funkcji w menu z prawej strony. W wyświetlonym oknie dialogowym należy wpisać żądaną wartość parametru. Parametr można zdefiniować dla wszystkich witryn na poziomie serwera (hosta) lub indywidualnie dla każdej witryny.

Ustawianie maks. wielkości załącznika w Menedżerze IIS

Ustawienia schematów

W tym kroku można określić nazwę schematu dla tabel systemowych i biznesowych. Domyślna nazwa schematu dla tabel systemowych to core. Podczas tworzenia tabel biznesowych użytkownik musi wybrać nazwę schematu tabeli z listy. Na tej liście będą dostępne schematy, które zostaną określone w tym miejscu. Wpisz w to pole nazwy schematów, rozdzielając je przecinkami, na przykład:

eod, hr, prod

Kliknij przycisk Dalej.

W celu uniknięcia ewentualnych problemów z migracją aplikacji między środowiskami nAxiom zaleca się używanie domyślnych ustawień schematów; domyślny schemat dla tabel użytkownika (biznesowych) to dbo.

Ustawienia restrykcji ruchu na stronie

W tym kroku można ograniczyć adresy IP, które będą miały dostęp do poszczególnych komponentów (aplikacji) platformy. W tym celu należy zaznaczyć komponent, wpisać adres IP i ewentualnie maskę, oraz określić typ ograniczenia (Zezwalaj, Blokuj). Zdefiniowaną restrykcję można usunąć przyciskiem Usuń restrykcję. W instalacji lokalnej ten krok można pominąć.

Kliknij przycisk Instaluj.

Instalacja aplikacji

W tym kroku program instalacyjny instaluje platformę nAxiom zgodnie z wybranymi ustawieniami. Po pomyślnej instalacji wyświetlany jest komunikat.

Kliknij przycisk OK, a następnie kliknij przycisk Dalej.

W przypadku aktualizacji nAxiom program instalacyjny zachowuje wszystkie foldery użytkownika utworzone bezpośrednio w folderze instalacyjnym witryny podanym w drugim kroku instalacji. Foldery użytkownika utworzone w podfolderach poszczególnych komponentów zostaną nadpisane. Instalator zachowuje także ustawienia użytkownika w plikach konfiguracyjnych.

Informacje poinstalacyjne

W tym kroku wyświetlane są adresy stron poszczególnych komponentów platformy.

Kliknij przycisk Zakończ. Nastąpi powrót do głównego okna instalacyjnego.

W przypadku witryny instalowanej w trybie zaawansowanym można przed jej pierwszym uruchomieniem umieścić plik licencji w folderze folderInstalacyjnyWitryny\api\InstallationConfiguration, aby został wczytany automatycznie, w przeciwnym razie należy zaimportować plik licencji po zalogowaniu się do witryny na konto konsultanta; patrz Import licencji.

Witryna nAxiom w na serwerze IIS

Po zainstalowaniu witryny w systemie Windows można nią zarządzać w programie Menedżer internetowych usług informacyjnych (IIS), w tym zatrzymywać i restartować całą witrynę lub indywidualne pule aplikacji oraz zmieniać ich ustawienia, jeśli będzie to potrzebne.

Witryna nAxiom w Menedżerze IIS, po lewej lista serwisów witryny, w środku lista pul aplikacji

Instalator konfiguruje ustawienia domyślne serwisów nAxiom wymagane do poprawnego działania. Między innymi włącza opcję wstępnego ładowania (menu kontekstowe indywidualnego serwisu > Zarządzaj aplikacją > Ustawienia zaawansowane > Włączono wstępne ładowanie = true) dla niektórych serwisów, aby po restarcie witryny lub serwisu oczekiwanie na uruchomienie nie powodowało przekroczenia limitów czasu. Te serwisy to:

api (back),
ocrapi,
publicapi,
reportsapi,
tenantsapi,
taskservice

Pierwsze logowanie

W celu sprawdzenia instalacji wpisz w przeglądarce adres https://localhost*:nrPortu* (standardowy numer portu 443 można pominąć). Powinna zostać wyświetlona strona logowania jak na poniższej ilustracji.

W środowisku nAxiom są cztery predefiniowane konta użytkownika:

Superadministrator uprawnień: login: superuser, hasło: !Q2w3e4r%T
To konto pozwala wyznaczać administratorów uprawnień w modelu PBA.
Administrator: login: admin, hasło: !Q2w3e4r
Korzystając z tego konta można logować się do aplikacji FrontSPA (front office) i zarządzać użytkownikami, w tym nadawać im uprawnienia z obszaru zarządzania użytkownikami.
Konsultant: login: consultant, hasło: !Q2w3e4r
Konsultant loguje się do aplikacji AdminSPA (back office), w której buduje aplikacje biznesowe. Konsultant może także wyznaczać innych konsultantów, to jest przyznawać użytkownikom uprawnienia z obszaru globalnych uprawnień aplikacji.
Administrator tenantów: login: tenantsadmin, hasło: !Q2w3e4r%T
Administrator tenantów loguje się do aplikacji TenantAdminSPA (https://localhost/tenantsadmin/), w której może dodawać i usuwać tenantów oraz konfigurować ich ustawienia.

Uruchamiając witrynę nAxiom po raz pierwszy, należy zalogować się na konto consultant i wczytać ważny plik licencji.

Import licencji

Nowa witryna zainstalowana w trybie zaawansowanym wymaga po zalogowaniu wczytania pliku licencji. W aplikacji AdminSPA jest dostępne tylko polecenie Licencjonowanie na panelu menu z lewej strony.

„Puste” menu aplikacji <i>AdminSPA</i> — „Puste” menu aplikacji *AdminSPA*

Po kliknięciu polecenia wyświetlana jest strona licencje, na której wszystkie pozycje są nieaktywne. Kliknij przycisk Importuj plik licencjii wskaż położenie pliku licencji.

Kliknij przycisk Importuj. Tabela z indywidualnymi pozycjami licencji zostanie zaktualizowana. W kolumnie Data wygaśnięcia można sprawdzić okres ważności licencji. Jednocześnie odblokowane zostały polecenia menu głównego.

Instalacja kolejnych witryn nAxiom

Na jednym komputerze można zainstalować wiele witryn nAxiom (w tym w różnych wersjach). Każda witryna musi mieć własną nazwę witryny, własny folder instalacyjny i własny numer portu w adresie. Każda witryna ma także osobną bazę danych tenantów.

W celu zainstalowania kolejnej witryny należy uruchomić program instalacyjny. W przypadku wykrycia więcej niż jednej witryny w danym środowisku, możliwa będzie tylko instalacja w trybie zaawansowanym. Użytkownik będzie mógł wtedy zdecydować, czy chce zaktualizować jedną z zainstalowanych witryn, czy zainstalować nową.

Jeśli w środowisku jest tylko jedna witryna instalowana w trybie szybkiej instalacji, użytkownik będzie mógł wybrać jej aktualizację w tym samym trybie lub tryb zaawansowanym, w którym będzie możliwe utworzenie nowej witryny.

Znane problemy — błąd uprawnień

Podczas testów instalatora stwierdzono możliwość wystąpienia pewnych problemów w rzadkich przypadkach określonej konfiguracji środowiska systemu Windows.

Błąd uprawnień

Ten błąd wystąpił podczas próby zainstalowania witryny naxiom w ścieżce intepub\wwwroot i wynikał z niestandardowych uprawnień do podfolderów w danym środowisku Windows.

Błąd usunięto, używając poniższego polecenia w wierszu polecenia uruchomionym z uprawnieniami administratora:

icacls.exe "C:\inetpub\wwwroot" /reset /T /C /L /Q

Po poprawnej instalacji witryna nie uruchamia się

Jeśli pomimo poprawnej instalacji witryna nAxiom nie chce się uruchomić, przyczyną może być to, że użytkownik miał już w systemie zainstalowany pakiet .NET Hosting Bundle przed instalacją serwera IIS. W takim przypadku konieczne jest ponowne ręczne zainstalowanie tego pakietu zgodnie z instrukcjami podanymi w Dodatku.

Dodatek: samodzielna instalacja wymaganych składników i programów pomocniczych

W indywidualnych przypadkach użytkownik może samodzielnie instalować składniki niezbędne do uruchamiania witryny nAxiom.

Platforma .NET Framework 4.8

W systemie należy zainstalować platformę .NET Framework, która obejmuje środowisko uruchomieniowe i biblioteki klas. Instalator offline można pobrać ze strony:
https://dotnet.microsoft.com/en-us/download/dotnet-framework/thank-you/net48-offline-installer

Internetowe usługi informacyjne (IIS)

Publikacja stron witryny nAxiom wymaga włączenia w systemie Windows komponentu Internetowe Usługi Informacyjne.

Uruchom aplet Funkcje systemu Windows.
Przewiń listę do pozycji Internetowe usługi informacyjne i rozwiń ją.
Zaznacz pola wyboru przy następujących składnikach:
- Usługi WWW > Zabezpieczenia (wszystkie pozycje podrzędne)
- Usługi WWW > Funkcje tworzenia aplikacji > Strona serwera zawiera*
- Usługi WWW > Funkcje tworzenia aplikacji > Inicjowanie aplikacji
- Usługi WWW > Funkcje wydajnościowe > Kompresja zawartości statycznej
- Usługi WWW > Kondycja i diagnostyka > Rejestrowanie HTTP
- Usługi WWW > Wspólne funkcje HTTP > Błędy HTTP
- Usługi WWW > Wspólne funkcje HTTP > Dokument domyślny
- Usługi WWW > Wspólne funkcje HTTP > Przeglądanie katalogów
- Usługi WWW > Wspólne funkcje HTTP > Zawartość statyczna
- Narzędzia zarządzania siecią Web > Konsola zarządzania usługami IIS
Kliknij przycisk OK. Jeśli to będzie konieczne, uruchom ponownie komputer.

Konfiguracja IIS

* Chodzi o dyrektywy Server-Side include (SSI)

Certyfikat dla serwera IIS

Od wersji 1.11 platforma nAxiom obsługuje tryb multitenancy. W tym trybie z witryny korzystają różne organizacje, których dane są przechowywane w różnych bazach danych. Każdy tenant łączy się z witryną nAxiom, używając podstawowego adresu URL z przedrostkiem konfigurowanym osobno dla każdego tenanta. Domyślnie pierwszy tenant powoływany podczas instalacji witryny nie ma definiowanego przedrostka, to jest używa podstawowego adresu witryny nAxiom definiowanego podczas instalacji.

Aby umożliwić połączenia https dla wielu tenantów wymagany jest certyfikat SSL typu wildcard na poziomie bazowego adresu URL witryny nAxiom. Ten adres jest określany w polu Host w kroku konfiguracji serwera IIS podczas instalacji i zapisywany w pliku appsettings.json serwisu api. Przykładowo:

Adres bazowy	Certyfikat dla
domena.com	domena.com, *.domena.com
sub.domena.com	sub.domena.com, *.sub.domena.com
test.sub.domena.com	test.sub.domena.com, *.test.sub.domena.com

W przypadku instalacji na komputerze lokalnym, konieczne jest wygenerowanie certyfikatu SSL typu wildcard. Nie można jednak tego zrobić dla domeny najwyższego poziomu jaką jest nazwa localhost. Z tego powodu należy w pliku hosts (%windir%/system32/drivers/etc/hosts) dodać wpisy dla nowej nazwy domeny zmapowanej na adres IP 127.0.0.1. Na przykład:

0.0.1       nax-deploy.local
0.0.1       tenant1.nax-deploy.local
0.0.1       tenant2.nax-deploy.local

Wpisy z przedrostkiem tenant… definiują nazwy domenowe nAxiom do wykorzystania w środowisku z dwoma tenenatami (każdy tenant wymaga osobnego wpisu; przedrostki te są definiowane dla tenantów w aplikacji TenantAdminSPA).

Następnie można przystąpić do utworzenia certyfikatu:

Uruchom aplikację Power Shell jako administrator.

Użyj polecenia New-SelfSignedCertificate* z podanymi parametrami:

New-SelfSignedCertificate `
 -DnsName "nax-deploy.local", "*.nax-deploy.local" `
 -FriendlyName "SSL nax-deploy.local" `
 -CertStoreLocation cert:\LocalMachine\My

Uruchom przystawkę Zarządzaj certyfikatami komputerów (zachowaj ostrożność, omyłkowo może się zdarzyć uruchomienie przystawki Zarządzaj certyfikatami użytkowników) i sprawdź, czy w magazynie Osobisty znajduje się certyfikat nax-deploy.local.

Certyfikat nax-deploy.local w magazynie Osobisty
Zaznacz wiersz certyfikatu nax-deploy.local i z menu Akcja wybierz polecenie Kopiuj.
Przejdź do magazynu Zaufane główne urzędy certyfikacji i z menu Akcja wybierz polecenie Wklej.

Podanej wyżej nazwy witryny (nax-deploy.local) oraz wygenerowanego dla niej certyfikatu (nax-deploy.local) należy użyć w kroku Konfiguracja serwera IIS podczas instalacji zaawansowanej; aby witryna nAxiom działała w tej konfiguracji, konieczne jest także wybranie opcji Instalacja z dostępem zdalnym w tym samym kroku.

Certyfikat dla localhost

Jeśli witryna nAxiom ma być używana tylko z jednym tenantem lub połączenia dla innych tenantów nie muszą być szyfrowane (np. w środowisku deweloperskim), można podczas instalacji pozostawić nazwę hosta localhost i użyć certyfikatu dla domeny localhost.

Taki certyfikat będzie również potrzebny, aby korzystać z szyfrowanych połączeń w ruchu wewnętrznym.

Procedura generowania takiego certyfikatu różni się od opisanej powyżej jedynie samym poleceniem, które może wyglądać następująco:

New-SelfSignedCertificate `
    -DnsName localhost `
    -FriendlyName "SSL localhost" `
    -CertStoreLocation cert:\LocalMachine\My

* Więcej informacji na temat tego polecenia można znaleźć na stronie:
https://docs.microsoft.com/en-us/powershell/module/pkiclient/new-selfsignedcertificate?view=win10-ps.

Rozszerzenie IIS — URL Rewrite

Rozszerzenie serwera IIS URL Rewrite (pol. Ponowne zapisywanie adresów URL) jest potrzebne do prawidłowego wyświetlania podglądu raportu i plików w formacie PDF, a ponadto pozwala odświeżać strony nAxiom używając polecenia/przycisku odświeżania w przeglądarce, dlatego zaleca się jego zainstalowanie, chociaż instalator zalicza je do komponentów opcjonalnych. Plik rozszerzenia należy pobrać ze strony pobierania Microsoft pod adresem https://www.iis.net/downloads/microsoft/url-rewrite.

Środowisko .Net Core

Pamiętaj, aby najpierw zainstalować usługi IIS, a dopiero potem pakiet środowiska .NET (Hosting Bundle). W przeciwnym razie, konieczne będzie ponowne uruchomienie instalatora Hosting Bundle po zainstalowaniu usług IIS.*

* https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/iis/hosting-bundle?view=aspnetcore-8.0

Platforma nAxiom wymaga do działania środowiska uruchomieniowego ASP.NET Core 6, które jest dostępne w ramach pakietu .NET Hosting Bundle. Odpowiedni plik dotnet-hosting-8.0.11-win.exe można pobrać ze strony: https://dotnet.microsoft.com/download/dotnet/8.0.

Aby sprawdzić wynik instalacji, otwórz wiersz polecenia i uruchom polecenie dotnet --info.

Jeśli w wyświetlonych informacjach znajdzie się wpis jak poniżej, to znaczy że środowisko .NET 8 zostało zainstalowane poprawnie.

C:\>dotnet --info

...

Host:
  Version:      8.0.11
  Architecture: x64
  Commit:       9cb3b725e3

...

Microsoft SQL Server

Wszystkie dane wprowadzane przez użytkowników platformy nAxiom są zapisywane w bazie danych na serwerze Microsoft SQL Server. Platforma obsługuje wersje Microsoft SQL Server 2016 i 2019. Instalator edycji Microsoft SQL Server 2019 Express można pobrać ze strony:
https://go.microsoft.com/fwlink/?linkid=866658.

Po uruchomieniu programu instalacyjnego wystarczy wybrać opcję instalacji podstawowej (Basic).

Instalacja SQL Server 2019 Express, opcja <code>Basic</code> — Instalacja SQL Server 2019 Express, opcja `Basic`

Po zaakceptowaniu postanowień licencji oraz kilku sugestii instalatora oprogramowanie zostanie zainstalowane. Zostanie także utworzona domyślna instancja serwera bazy danych (o nazwie SQLEXPRESS).

Okno wynikowe instalatora SQL Server 2019 Express

SQL Server Management Studio

SQL Server Management Studio (SSMS) to zintegrowane środowisko do zarządzania serwerem Microsoft SQL Server. Ten program zapewnia dostęp do wszystkich komponentów programu SQL Server i umożliwia konfigurację, zarządzanie, administrowanie oraz prace deweloperskie.
Program można zainstalować po instalacji oprogramowania SQL Server, klikając przycisk Install SSMS (zainstaluj SSMS) w oknie dialogowym wyświetlanym na zakończenie procesu instalacji. Spowoduje to wyświetlenie strony internetowej, z której można pobrać instalator programu (https://aka.ms/ssmsfullsetup).

W programie SSMS konieczne jest ustawienie trybu uwierzytelniania w programie SQL Server oraz utworzenie konta, które umożliwi logowanie się na serwerze SQL Server. W niektórych przypadkach może to być wbudowane konto administratora systemu (sa), które należy odblokować. Domyślnie z konta sa korzysta instalator w trybie ‘Szybka instalacja z ustawieniami domyślnymi’. Poniżej opisano, jako odblokować konto sa oraz jak utworzyć konto na serwerze bazy danych z uprawnieniami niezbędnymi do korzystania z platformy nAxiom.

Tryb uwierzytelniania na serwerze MS SQL Server

Uruchom program SSMS. Podczas pierwszego uruchomienia wskaż serwer bazy danych w formacie nazwa_komputera/nazwa_instancji (na ilustracji poniżej NBS-0256\SQLEXPRESS) i z listy Authentication (Uwierzytelnianie) wybierz pozycje Windows Authentication (Uwierzytelnianie Windows), aby połączyć się z serwerem bazy danych jako zalogowany użytkownik systemu Windows.

Okno dialogowe połączenia z serwerem SQL Server z programu SSMS
Kliknij prawym przyciskiem myszy serwer, dla którego chcesz zmienić tryb uwierzytelniania, i wybierz polecenie Properties z menu kontekstowego.

Microsoft SQL Server Management Studio
Z menu po lewej stronie wyświetlonego okna dialogowego wybierz pozycję Security.
Włącz opcję SQL Server and Windows Autenthication Mode.
Kliknij przycisk OK.

Tryb uwierzytelniania na serwerze SQL Server

Odblokowanie konta sa

Rozwiń kolejno gałęzie Security > Logins dla serwera SQL Server, dla którego chcesz włączyć konto sa.

Wybór konta sa
Kliknij konto sa prawym przyciskiem myszy i wybierz polecenie Properties z menu kontekstowego.
Kliknij pozycję Status w wyświetlonym oknie dialogowym i zaznacz opcję Enabled w grupie opcji Login.

Włączenie logowania
Kliknij pozycję General i podaj hasło logowania w polach Password i Confirm password.

Ustawienie hasła
Kliknij przycisk OK. Kliknij gałąź Security prawym przyciskiem myszy i wybierz polecenie Refresh z menu kontekstowego; sprawdź, czy z nazwy konta sa zniknął czerwony krzyżyk, który sygnalizował, że konto jest nieaktywne.
Kliknij prawym przyciskiem myszy serwer bazy danych i z menu kontekstowego wybierz polecenie Restart.

Restartowanie serwera bazy danych
Potwierdź wyświetlony komunikat i poczekaj na ponowne uruchomienie serwera bazy danych.

Utworzenie konta, bazy danych i użytkownika bazy danych

Aby podczas instalacji nowej witryny utworzyć login i bazę danych dla administratora tenantów, należy podać dane administratora serwera bazy danych (sysadmin albo co najmniej dbcreator i securityadmin). Można jednak to pominąć, jeśli administrator utworzy wcześniej na serwerze login z odpowiednimi uprawnieniami oraz pustą bazę danych ze schematem ta oraz kontem użytkownika powiązanym z loginem, które będzie właścicielem tego schematu. Wtedy w kroku instalacji Połącz do istniejącej bazy wystarczy podać poświadczenia takiego loginu i nazwę bazy danych oraz zaznaczyć opcję Połącz do istniejącej bazy. Umożliwi to także utworzenie bazy danych i loginu dla pierwszego tenanta w kolejnym kroku instalatora.

Poniżej opisano procedurę tworzenia loginu i bazy danych z minimalnymi niezbędnymi uprawnieniami.Opisane czynności wykonuje administrator serwera SQL Server.

Rozwiń gałąź Security dla serwera SQL Server, na którym chcesz utworzyć nowe konto.
Kliknij prawym przyciskiem myszy pozycję Logins i z menu kontekstowego wybierz polecenie New Login....
Zostanie wyświetlone okno dialogowe Login - New
Wpisz nazwę w pole Login name, zaznacz opcję SQL Server authentication i wypełnij pola Password oraz Confirm password.

Nowe konto na serwerze
W tym samym oknie dialogowym, przejdź do kategorii Server roles z lewej strony i na panelu głównym zaznacz pola wyboru dla ról dbcreator, securityadmin i public.

Role na serwerze
Kliknij przycisk OK. Nowe konto zostanie utworzone.
Kliknij prawym przyciskiem myszy pozycję Databases i z menu kontekstowego wybierz polecenie New Database.
Wpisz nazwę bazy danych i kliknij przycisk OK.
Nowa baza danych zostanie utworzona.

Nowa baza danych
Rozwiń gałąź utworzonej bazy danych, rozwiń gałąź Security, kliknij prawym przyciskiem myszy pozycję Users i kliknij polecenie New User.
Zostanie wyświetlone okno dialogowe Database User - New.

Nowy użytkownik bazy danych
W pole User name wpisz nazwę użytkownika, w pole Login name nazwę loginu utworzonego wcześniej, a w pole Default schema wpisz dbo.
Przejdź do kategorii Membership i zaznacz pola wyboru obok ról db_datareader, db_datawriter i db_ddladmin. Anuluj zaznaczenie pole wyboru obok roli db_owner.

Role w bazie danych
Kliknij przycisk OK.
W gałęzi Security kliknij prawym przyciskiem myszy gałąź Schemas i kliknij polecenie New schema.
W wyświetlonym oknie dialogowym w polu Schema name wpisz ta, a w polu Schema owner nazwę utworzonego wcześniej użytkownika bazy danych.

Nowy schemat
Kliknij przycisk OK.
Przekaż poświadczenia utworzonego loginu oraz nazwę bazy danych konsultantowi, który ma zainstalować witrynę nAxiom.