Ogólne

Aplikacja w trakcie pierwszego uruchomienia przez użytkownika wyświetla mu ekran powitalny. Tekst informuje o aplikacji oraz życzy udanego korzystania z aplikacji.

Dodatkowo w zależności od uprawnień użytkownika oraz właściwości systemu wyświetla odpowiednie komunikaty o dostępności innych typów interfejsów. Jeśli użytkownik posiada uprawnienia do dostępu do sekcji Mobilnej, Desktop to w zależności od zalogowania do danej sekcji system przypomina o istnieniu innej wersji interfejsu i wskazuje miejsca gdzie można się przełączać między interfejsami.

W przypadku, gdy logowanie następuje przez użytkownika, który nie ma podanego swojego imienia i nazwiska, to w oknie powitalnym pojawia się dodatkowa informacja o konieczności podania tych danych.

Dla uproszczenia w dokumentacji będą stosowane skróty dotyczące nazw poszczególnych sekcji aplikacji lub całych systemów. Poniżej lista i jej wyjaśnienie:

W przypadku gdy instancja systemu jest instancją testową (np. dodatkowa instancja testowa dla szkoleń/weryfikacji funkcjonalności) to przy zalogowaniu do aplikacji pojawia się informacja o pracy na instancji testowej oraz w dolnej części ekranu zawsze jest wyświetlany pasek informujący o pracy na instancji testowej.

W przypadku systemów bez czasu wersji testowej pokazywany jest standardowy komunikat.

W przypadku wersji limitowanej czasowo pojawiają się informacje o czasie ważności licencji/wersji czasowej w pasku dolnym oraz w menu narzędziowym.

System informuje również w przypadku braku licencji dla danej instancji, przy wygaśnięciu terminu ważności licencji itp.

Aplikacja w zależności od ustawień posiada możliwość autoryzacji za pomocą różnych źródeł. Obsługiwane mechanizmy to: autoryzacja wewnętrzna, autoryzacja za pomocą serwera LDAP lub autoryzacja za pomocą zewnętrznego systemu OAuth2 (np. Azure Active Directory/Oauth).

Podstawową metodą autoryzacji jest autoryzacja za pomocą haseł zapisanych w głównej bazie danych. Pozwala to na autoryzację dowolnego użytkownika na podstawie porównania wprowadzonych danych logowania z wewnętrzną ich reprezentacją.

Otwarcie głównego adresu systemu w przeglądarce internetowej przedstawi podstawowe okno logowania w którym można wprowadzić swój login oraz wybrać język interfejsu aplikacji.

Na podstawie wprowadzonych danych przeprowadzana jest dalsza autoryzacja użytkowników. W przypadku gdy użytkownik jest użytkownikiem lokalnym następuje wyświetlenie okna wprowadzania hasła. W przypadku użytkowników korporacyjnych z zewnętrznym systemem autoryzacji następuje przekierowanie do tego systemu a następnie powrót do systemu AMAGE i autoryzacja na podstawie otrzymanych danych z tego systemu.

Po poprawnym zalogowaniu użytkownikowi przedstawiane jest okno główne. W zależności od uprawnień licencji oraz typu urządzenia (komputer stacjonarny, laptop czy urządzenie mobilne) przedstawiane jest okno z interfejsem dostosowanym do możliwości danego urządzenia (rozmiar ekranu, rozdzielczość).

W głównym menu dostępne jest akcja dostępu do menu systemowego. Jest to przycisk z ikoną trybika. Jest to menu, które pozwala na wykonanie dodatkowych operacji systemowych.

Pozwala ono na zmianę swoich ustawień, konfigurację instancji oraz płatności (dla wersji systemów obsługujących tą funkcjonalność np. AMAGE24) oraz wykonanie dodatkowych operacji.

Po wybraniu akcji Ustawienia następuje wyświetlenie okna informacyjnego danego użytkownika. Wyświetla ono informacje o identyfikacji użytkownika m.in. imię, nazwisko oraz adres email.

W przypadku użytkowników lokalnych, w tym miejscu użytkownik ma możliwość zmiany hasła. Po wybraniu akcji Zmień hasło następuje przejście do formatki zmiany hasła. Użytkownik w tym oknie ma możliwość zmiany również kodu PIN dla urządzeń pracujących w trybie offline (aplikacje takie jak AMAGE Fx pracujące w tym trybie). PIN jest czterocyfrowym kodem, który służy do autoryzacji użytkownika na takich urządzeniach.

Użytkownik ma również możliwość wprowadzenia/zmiany aktualnego adresu email oraz wgrania skanu własnego podpisu oraz swojego zdjęcia. Wszystkie te operacje dostępne są tła tego użytkownika.

Po wybraniu akcji zmiany hasła aplikacja wyświetla okno z opcjami do wprowadzenia aktualnego hasła oraz nowego.

Okno zmiany hasła podaje informacje na temat siły hasła - wynika ono z wykorzystania odpowiednich typów znaków znajdujących się w nowym haśle (duże/małe litery, znaki specjalne, cyfry). Oprócz tego przy sprawdzaniu nowego hasła weryfikowane są inne elementy ustawione w polityce haseł takie jak minimalna długość hasła itp. Użytkownik może wykorzystać przycisk "Generuj" do wygenerowania losowego hasła. Hasło zostanie automatycznie skopiowane do odpowiednich pól formularza oraz wyświetlone w dodatkowym oknie. UWAGA! Po zamknięciu okna nie ma możliwości wyświetlenia danego hasła w formie jawnej ponownie.

Aplikacja wyposażona jest we własny portal pomocy. Portal ten jest dostępny również bezpośrednio ze strony internetowej, ale jest również wbudowany w aplikację dodając kilka nowych funkcji. Pomoc w systemie dostępna jest w kilku miejscach, w zależności od kontekstu, wybranej wersji systemu oraz uprawnień dostępu.

W interfejsie Desktop pomoc kontekstowa dostępna jest w menu systemowym aplikacji (górny prawy róg okna) pod przyciskiem pytajnika. Wybierając akcję tego przycisku wyświetlamy menu z opcjami dotyczącymi pomocy.

Menu pomocy pozwala na dostęp do kilku opcji:

W przypadku gdy w portalu pomocy pojawią się nowe informacje - wiadomości lub informacje o nowych funkcjach systemu to przy przycisku pomocy pojawia się nakładka z informacją o liczbie nieprzeczytanych informacji.

Po wybraniu akcji pomocy wyświetlamy dodatkowo informacje o nieprzeczytanych wiadomościach oraz nowych funkcjach. Kliknięcie na liczbach otworzy wyskakujące okno z tymi informacjami i nawigacją.

W widoku szczegółów elementów aplikacji istnieje możliwość wyświetlenia listy wszystkich prezentowanych informacji. Po włączeniu jej przyciskiem w górnej części ekranu pojawia się lista, która pozwala na przejście do interesujących nas informacji bez konieczności przechodzenia poprzez wszystkie elementy w liście zmian.

W interfejsie Mobile dostęp do pomocy jest realizowany przez osobne menu "Narzędzia". Po wybraniu tego menu pojawia się widok z opcjami. Wybór "Pomoc" wyświetli pomoc kontekstową.

Po wybraniu jednej z w/w akcji otwierane jest dodatkowe okno z zawartością kontekstową pomocy. Pomoc jest specyficzna dla każdego typu aplikacji i widoku. Jeśli otworzymy pomoc w interfejsie Desktop, to będzie wyświetlana dokumentacja tej części systemu oraz z listą funkcjonalności specyficznych dla danej instancji systemu np. dzierżawy, utrzymanie ruchu itp.

W górnej części okna pojawiają się przyciski, które pozwalają na wyświetlenie pomocy w wyskakującym oknie, przejście do sekcji dokumentacji lub akademii oraz funkcji dodatkowych portalu/pomocy/samouczków.

W przypadku, gdy użytkownik posiada uprawnienia do dostępu do interfejsu konfiguracyjnego systemu (zarządzanie użytkownikami itp.) otrzymuje dostęp do portalu dokumentacji, który zawiera pełną dokumentację systemu AMAGE - wszystkie typy aplikacji, przypadki użycia, samouczki, dzienniki zmian itp. Aby dostać się do portalu dokumentacji należy przejść do interfejsu konfiguracyjnego (Config) i w nim wybrać menu główne "Narzędzia" → "Portal pomocy".

Po wybraniu tej opcji zostanie załadowana dokumentacja użytkownika w formie portalu pomocy. Można przeglądać portal jak każdą inną stronę internetową. Portal podzielony jest na sekcje zawierające dokumentację użytkownika, przypadki użycia, instrukcje jak wykorzystać poszczególne komponenty systemu oraz obszar API programistycznego (raporty itp.) pozwalające samodzielnie projektować raporty.

Po wybraniu akcji pomocy kontekstowej przechodzimy do określonego miejsca w dokumentacji systemu.

Cześć funkcjonalności jest wspólna dla wszystkich komponentów systemu. W tym rozdziale opisujemy część wspólną dostępną w różnych miejscach interfejsu.

Podczas uruchomienia instancji system nie posiada określonej domyślnej lokalizacji tj. takiej, od której startujemy. Może to być lokalizacja zakładu lub budowy. W takim przypadku system wyświetla komunikat (dla osób z odpowiednimi uprawnieniami !) pozwalający na ustawienie tej domyślnej lokalizacji.

Selektor położenia na mapach geograficznych lub definiowanych planach. W miejscach, gdzie system pozwala na definicję takiego położenia (lokalizacja, produkt, zlecenie, kontrakt) dostępny jest selektor lokalizacji. Po jego wyborze pojawia się dodatkowe okno z widokiem map.

Jeśli posiadamy własne definiowalne mapy, to zmianę widoku (podkładu) możemy wykonać wybierając ikonę warstw. Zmiana przybliżenia realizowana jest przez przyciski (+/-) ma widoku mapy.

Widok pozwala również na wyszukanie miejsca geograficznego. Jeśli w polu wyszukiwania wprowadzimy tekst i zatwierdzimy to przyciskiem wyszukiwania to system przedstawi listę potencjalnych miejsc odpowiadający takiemu wyszukiwaniu. Każde z nich wybieramy klikając na dany wpis.

Aplikacja pozwala również szukać miejsca podając współrzędne geograficzne w formie dwóch liczb np. "50.125 20.195".

Aktualną pozycję geograficzną można uzyskać klikając na kolejny przycisk wskaźnik. Wymagane jest dodanie uprawnień/pozwoleń w przeglądarce na dostęp do danych lokalizacyjnych. Po zezwoleniu mamy możliwość określenia swojej lokalizacji.

Dodatkowymi przeglądarkami wewnętrznymi są przeglądarka dokumentów PDF oraz obrazów. Pozostałe dokumenty system otwiera za pomocą domyślnie dostępnych aplikacji na komputerze użytkownika.

W systemie dostępne są w różnych miejscach selektory obiektów. Pozwalają one wybrać w danym kontekście obiekt niezbędny do dalszego określenia wykonywanych czynności.

Za jego pomocą mamy możliwość dodania identyfikatorów w sposób ręczny lub skanując za pomoca skanera kodów dołączonego do komputera. Formularz identyfikatora zapamiętuje ostatnio wybrany typ identyfikatora i wykorzystuje go jako domyślny przy kolejnym otwarciu tego formularza przez danego użytkownika.

W większości okien szczegółów obiektów lub oknach dialogowych edycji pojawia się przycisk informacji (I). Po wywołaniu tego przycisku pojawia się okno, które wyświetla wszystkie unikalne identyfikatory danego obiektu. Zawsze są to identyfikator lokalny z bazy danych oraz identyfikator unikalny (UUID) generowany w systemie AMAGE. Dodatkowo jeśli obiekt pochodzi np. z importu z systemu BIM/IFC może on zawierać dodatkowe pola informacyjne takie jak GlobalId lub IFC Tag. Okno to pozwala wykorzystać ten identyfikator do tworzenia skryptów lub zewnętrznych integracji.

Edytory pozwalają na wprowadzenie i konfigurację obiektów w systemie. W zależności od typu obiektu edytory mogą różnić się od siebie. Wszystkie edytory posiadają jednak pewne wspólne elementy. Są to: przyciski zapisu, anulowania zmian, zapisu i zamknięcia okna edycji. Każdy edytor również posiada swoje własne mechanizmy sprawdzenia poprawności danych wprowadzonych i ich kompletności. W przypadku błędów system wyświetla stosowne komunikaty oraz oznacza błędne/brakujące elementy za pomocą odpowiedniego obramowania i komunikatu dodatkowego. W pasku dolnym również pojawia się komunikat o konieczności poprawienia danych.

Każdy element wybieralny np. wybór pracownika może posiadać dodatkowy przycisk kasowania wyboru. Po jego wybraniu element zostaje usunięty z listy wybranych elementów. Tylko elementy opcjonalne mają taką możliwość. Dodatkowo w systemie każdy przycisk posiada swój dodatkowy opis, który pojawia się po najechaniu na niego kursorem. Jest to tzw. tooltip. Jest to szczególnie przydatne w przypadku, gdy przycisk nie posiada swojego widocznego opisu.

W systemie istnieją możliwości tworzenia użytkowników poprzez zaproszenie ich z podaniem adresów email. Pozwala to na przesłanie do tych użytkowników informacji z tzw. tokenem autoryzującym. Tylko za pomocą tego linka lub tokena użytkownik ma możliwość ustawienia własnego hasła logowania do systemu i tym sposobem otrzymać dostęp do systemu.

Funkcjonalność zaproszenia została opisana w sekcji dotyczącej użytkowników oraz głównego menu narzędziowego. Tutaj opisujemy tylko widoku i informacje wyświetlane podczas procedur związanych z hasłami.

Użytkowników można zaprosić do systemu poprzez prosty interfejs, w którym wpisujemy adresy email oraz opcjonalnie dodatkowy komunikat dla nich. Zostanie do nich wysłany email z linkiem aktywującym. Po szczegóły odnieś się do sekcji konfiguracji użytkowników, w której ta funkcja została szerzej opisana.

W przypadku, gdy system jest skonfigurowany i powiązany z zewnętrznymi źródłami autoryzacji typu Azure AD/Google/Oauth2 itp. udostępniane są linki do bezpośredniego logowania przez te systemy. Pozwala to na integrację z nadrzędnymi aplikacjami i zapewnienie pełnego logowania SSO (Single-Sign-On) bez konieczności wpisywania loginu na oknie początkowym. W zależności od konfiguracji systemu należy skorzystać z następujących adresów:

W każdej aplikacji pojawiają się błędy. System AMAGE wyświetla komunikaty o błędach w oknie dialogowym. W wersjach produkcyjnych wyświetlany jest ogólny komunikat o błędzie, natomiast w wersji beta wyświetlany jest szczegółowy komunikat o błędzie.

Instancje systemu AMAGE, które zakończyły swój aktywny tryb działania np. budowa została zakończona, mogą być nadal dostępne dla użytkowników, ale w trybie archiwalnym. Tryb archiwalny pozwala na przeglądanie danych, ale nie pozwala na wprowadzanie zmian w danych. Instancje archiwalne systemu AMAGE identyfikowane są poprzez odpowiednią informację po zalogowaniu do nich. W dolnej części ekranu pojawia się informacja o pracy instancji w trybie archiwalnym. Tryb archiwalny pozwala na przeglądanie zawartości instancji, ale nie pozwala na wprowadzanie zmian w danych.