Dokumentacja struktury bazy danych AMAGE

Wstęp

Dokument przedstawia informacje dotyczące struktury bazy danych AMAGE oraz przeglądarki udostępnianej dla programistów i projektantów ze strony Klientów w celu integracji systemu AMAGE z zewnętrznymi systemami i narzędziami typu Business Intelligence.

Schemat bazy danych - po co i dlaczego?

Schemat bazy danych opisuje wszystkie tabele bazy danych systemu AMAGE wraz z ich relacjami i powiązaniami. Znacząco ułatwia to tworzenie raportów, analizę danych oraz integrację z innymi systemami. Pozwala na dostęp do danych bezpośrednio przechowywanych w tabelach baz danych oraz tworzenie własnych raportów na podstawie widoków w bazie danych.

Dostęp do schematu

Dostęp do schematu jest przekazywany Klientowi poprzez dedykowany login do sekcji klienta na portalu wsparcia AMAGE. Za pomocą logowania użytkownik/hasło klient ma dostęp do aktualnych i archiwalnych schematów bazy danych.

Przeglądanie danych

Uruchomienie przeglądarki wyświetla ogólną informację podsumowującą schemat bazy danych wraz z podstawowymi nawigacjami do tabel, widoków oraz innych elementów schematu bazy danych. Przeglądarka jest interaktywna oraz nawigowalna pomiędzy poszczególnymi elementami schematu.

image 2024 05 24 10 47 26 716
Rysunek 1. Widok początkowy przeglądarki schematu bazy danych

Wybierając dowolną tabelę lub obiekt przechodzimy do szczegółowego widoku z informacjami o danej tabeli lub obiekcie. Dla przykładu dokumentacja tabeli zawiera wszystkie informacje o polach tabeli, ich typach, ograniczeniach oraz powiązaniach z innymi tabelami.

image 2024 05 24 10 47 54 236
Rysunek 2. Dokumentacja tabeli

Dodatkowo schemat zawiera wizualny i nawigowalny diagram relacji pomiędzy tabelami. Diagram ten pozwala na szybkie zrozumienie struktury bazy danych oraz relacji pomiędzy poszczególnymi tabelami.

image 2024 05 24 10 48 16 980
Rysunek 3. Powiązania pomiędzy tabelami

Wszystkie dane pozwalają lepiej poznać schemat bazy danych bez konieczności analizy powiązań bezpośrednio po podłączeniu do bazy danych.

Możliwości zastosowania

Dostęp do informacji o schemacie i zależnościach danych w bazie danych AMAGE pozwala m.in na:

  • Wygenerowanie nowych widoków, które będą zawierały szczegółowe i dostosowane do danego klienta dane. Widoki te można udostępnić jako dedykowany raport. Istnieje raport z widoku bazy danych. Zadaniem użytkownika jest utworzenie specjalnego widoku w schemacie Views bazy danych. Automatycznie ten widok zostanie udostępniony w dostępnym raporcie.

  • Widoki opracowane na podstawie schematu bazy danych mogą być również udostępnione poprzez interfejs API. Dzięki temu możliwe jest pobieranie danych z bazy danych AMAGE w formie JSON i wykorzystanie ich w innych systemach.

Howto powstało na bazie wersji systemu 1.27.0.0 (05.2024) oraz przedstawia funkcje, które mogą nie być dostępne w Twoim systemie. Zapytaj AMAGE o udostępnienie tej funkcjonalności.
Ze względu na ciągły rozwój systemu niektóre ekrany lub pliki konfiguracji mogą wyglądać nieznacznie inaczej, ale zachowają nadal pełną funkcjonalność tutaj opisaną. Nie wpływa to na zasadnicze funkcje opisywane w tym dokumencie.