Standardowy szablon procedury i instrukcji ENERGA

Załącznik do
działania pozaprocesowego
komórki: Departament Informatyki
Wdrażanie nowych interfejsów komunikacyjnych
na Korporacyjnej Szynie Danych
Akceptacja/Odpowiedzialność za
aktualizację zapisów:
Wersja: 01
Data wydania:
Zatwierdzenie:
Zakres podmiotowy:
Dyrektor Departamentu Informatyki
 Departament Informatyki
Kierownik Biura Usług IT
Minimalne wymagania dla Koncepcji Funkcjonalnej usługi
systemu informatycznego
1 Cel dokumentu
Niniejszy dokument opisuje minimalne wymagania w odniesieniu do tworzenia Koncepcji
Funkcjonalnej usługi systemu informatycznego z punktu widzenia wdrożenia usługi na Korporacyjnej
Szynie Danych.
Opracowanie Koncepcji Funkcjonalnej usługi systemu informatycznego powinno pozwolić na
opracowanie Kontraktu Usługi KSD, Projektu Technicznego Usługi KSD, plików WSDL i XSD oraz w
efekcie na uruchomienie usługi na KSD.
2 Zakres stosowania
2.1 Zakres podmiotowy
Dokument powinien być wykorzystywany przez zespoły projektowe pracujące nad wdrożeniem
nowych usług systemów informatycznych. W szczególności dokument dedykowany jest do
analityków odpowiedzialnych za opracowanie koncepcji funkcjonalnych nowopowstających usług
systemów informatycznych.
2.2 Zakres przedmiotowy
Integracja systemów informatycznych Energa-Operator S.A.
Załącznik do działania pozaprocesowego komórki: Departament Informatyki
Wdrażanie nowych interfejsów komunikacyjnych na Korporacyjnej Szynie Danych
Strona 1
3 Minimalne wymagania dla Koncepcji Funkcjonalnej usługi
systemu informatycznego
3.1 Opis usługi systemu informatycznego
3.1.1 Cel wprowadzenia usługi
Koncepcja Funkcjonalna usługi systemu informatycznego wskazywać musi biznesowy cel
wprowadzenia usługi. Opis procesów biznesowych realizowanych przez usługę itp.
3.1.2 Zakres funkcjonalny usługi
Koncepcja Funkcjonalna usługi systemu informatycznego wskazywać musi biznesowy opis operacji
realizowanych przez usługę.
3.1.3 Zależności względem zakresów innych usług
Koncepcja Funkcjonalna usługi systemu informatycznego wskazywać musi biznesowe lub techniczne
powiązanie usługi z innymi usługami systemów informatycznych.
3.1.4 Zastępowane usługi
Koncepcja Funkcjonalna usługi systemu informatycznego wskazywać musi wszystkie usługi systemów
informatycznych które zostaną wycofane po wdrożeniu nowej usługi.
3.2 Dane
3.2.1 Specyfikacja danych
Dla każdej metody wdrażanego interfejsu Koncepcja Funkcjonalna usługi systemu informatycznego
specyfikować powinna komunikaty które wymieniane będą przez systemy informatyczne.
Dla każdego komunikatu wskazywać powinna typy elementów z repozytorium Korporacyjnego
Modelu Danych CIM EOP które przesyłane będą w komunikatach XML.
W przypadku gdy Korporacyjny Model Danych CIM EOP nie będzie dostarczał gotowego modelu
danych niezbędnego dla realizacji interfejsu, we współpracy z Architektami EOP należy ten model
rozbudować o nowe obszary.
Jeżeli niemożliwe będzie skorzystanie z KMD CIM EOP oraz niemożliwa będzie jego rozbudowa,
koncepcja funkcjonalna interfejsu specyfikować powinna przynajmniej:

Nazwa pola – krótka (max. 20 znaków) nazwa składająca się ze znaków [a-z][A-Z][0-9]

Opis – biznesowy opis danych przesyłanych za pomocą pola

Wystąpienia – minimalna i maksymalna ilość wystąpienia pola w komunikacie

Typ – wskazanie typu prostego pola zgodnego ze specyfikacją typów prostych XSD

Walidacja – zasady walidacji pola (min/max długość, maska wprowadzania itp.)
3.2.2 Specyfikacja błędów biznesowych usługi
Dla każdej z metod Koncepcja Funkcjonalna powinna definiować i opisać wszystkie błędy biznesowe
usługi i opisać za pomocą kodów i opisów błędów.
Załącznik do działania pozaprocesowego komórki: Departament Informatyki
Wdrażanie nowych interfejsów komunikacyjnych na Korporacyjnej Szynie Danych
Strona 2

ErrorCode - kod (max. 15 znaków) błędu biznesowego składający się ze znaków [a-z][A-Z][09]. Kody błędów biznesowych powinny się rozpoczynać od liter BIZ oraz skrótu nazwy
systemu, np. BIZAMI, BIZSID itp.

ErrorDescription – zrozumiały dla użytkownika biznesowego opis błędu.
3.3 Sposób wykorzystania usługi i wolumetria
Dla każdej z metod Koncepcja Funkcjonalna powinna definiować przynajmniej:

Synchroniczna/Asynchroniczna

Kierunki komunikacji

Opis sposobu w jaki usługa będzie wykorzystywana.

Określenie charakterystyki pracy i wolumetrii usługi w skali dnia, tygodnia, miesiąca i roku.

Spodziewana wolumetria podczas normalnej pracy usługi (ilość komunikatów na sekundę).

Maksymalna spodziewana wolumetria chwilowa (ilość komunikatów na sekundę).

Spodziewana i maksymalna wielkość komunikatu.
3.4 Sekwencja przetwarzania
Koncepcja Funkcjonalna usługi powinna obrazować przy pomocy diagramu sekwencji sposób
realizacji usługi. W szczególności diagram obrazować musi sekwencję wywoływania kolejnych metod
usługi, powiązanie z innymi usługami itp. W przypadku wdrażania usług o skomplikowanej logice
przetwarzania, koncepcja funkcjonalna powinna dostarczać także diagramy przypadków użycia.
Załącznik do działania pozaprocesowego komórki: Departament Informatyki
Wdrażanie nowych interfejsów komunikacyjnych na Korporacyjnej Szynie Danych
Strona 3