Dokumentacja

Rozwiązania oparte o platformę StudioSystem oferują administratorowi narzędzie generujące automatycznie dokumentację techniczną bazy SQL z której korzysta system.

W celu wyświetlenia dokumentacji użytkownik Administrator lub SuperVisor musi uruchomić moduł administratora

Z menu moduł administratora dostępna jest sekcja DOKUMENTACJA, która wyświetla listę dostępnych elementów bazy danych:

  • Tabele;
  • Widoki;
  • Procedury;
  • Funkcje;
  • Assembly;
  • Trigery

 

Extended Properties

Wyświetlona lista tabel zawiera dodatkowe dwie kolumny opisujące każdą z nich, są to TYTUŁ i OPIS, informacje te odczytywane są bezpośrednio z bazy SQL za pomocą właściwości tabeli.

Istnieje możliwość dodawania wielu opisów dla jednej tabeli

Przykładowo dla tabeli _dziennik dodajemy drugi opis EXTENDED PROPERTIES

 

W efekcie w dokumentacji opis tabeli zawierać będzie dwie linie opisu dla jednej tabeli

 

W przypadku tabel które mają uniwersalne zastosowanie dodawane są zapisy o tytule ZASTOSOWANIE, ale także z opisem jakie jest wykorzystanie w zależności od roli, przykładowa tabela KNASO

knaso	ZASTOSOWANIE	Kartoteki towarowe, magazynowe inne
knaso	Rola WMS	Kartoteki magazynowe
knaso	Rola NAR	Kartoteki magazynowe i wypożyczeń
knaso	Rola MMS	Kartoteki części i materiałów eksploatacyjnych

 

 

 

Tabele

Wybór Tabele powoduje wyświetlenie listy tabel bazy SQL które są zainstalowane w bazie StudioSystem

 

 

Widoki SQL

Wybór Widoki powoduje wyświetlenie listy widoków bazy SQL które są zainstalowane w bazie  StudioSystem

 

Procedury Składowane

Wybór Procedury powoduje wyświetlenie listy procedur składowanych bazy SQL które są zainstalowane w bazie  StudioSystem

 

Funkcje bazy SQL

Wybór Funkcje powoduje wyświetlenie listy funkcji bazy SQL które są zainstalowane w bazie StudioSystem

 

Assembly

Wybór Assemblypowoduje wyświetlenie listy Assembly bazy SQL które są zainstalowane w bazie StudioSystem

 

Triggery

Wybór Triggerypowoduje wyświetlenie listy Triggerów bazy SQL które są zainstalowane w bazie StudioSystem