Wprowadzenie
Definicja hook contract służy do rejestrowania typu dokumentu oraz określania powiązanych z nim właściwości.
Standardowe typy dokumentów również zostają przekształcone do korzystania z tej definicji hook contract i mogą być wykorzystywane jako przykładowe implementacje.
W artykule opisano, jakie rozszerzenia można wdrożyć za pomocą definicji hook contract oraz jakie ograniczenia i szczególne przypadki należy wziąć pod uwagę.
Opis interfejsu znajduje się w powiązanym obiekcie deweloperskim typu hook contract. Szczegółowe informacje o metodach zadeklarowanych w interfejsach dostępne są w odpowiednich klasach języka Java.
Informacje dotyczące infrastruktury hooków można znaleźć w artykule Hook Contracts.
Grupa docelowa
- Deweloperzy
Opis
Ta definicja hook contract dostarcza informacji o dokumencie.
W szczególności wymagane są następujące elementy:
-
Typ dokumentu (order type)
-
Klasa obiektu biznesowego Typ
-
Klasa obiektu biznesowego Header
-
Klasa obiektu biznesowego Detail – jeśli dokument obsługuje pozycje; w przeciwnym razie — null
-
Informacja, czy w danych nagłówkowych dostępny jest opis wielojęzyczny.
Dodatkowo możliwe jest określenie następujących informacji opcjonalnych:
-
Klasa odpowiedzialna za reorganizację danego dokumentu
-
Schemat numeracji wykorzystywany do formatowania numerów dokumentów dla nagłówków i pozycji
Definicja hook contract: com.cisag.app.general.order.hook.OrderType
Jako przykładową implementację można wykorzystać implementację hook contractcom.cisag.app.sales.order.OrderTypeSalesOrderImpl dla typu dokumentu Zamówienie sprzedaży.
Typy dokumentów, które są rejestrowane za pośrednictwem tego hooka, są również automatycznie rejestrowane na potrzeby uprawnień opartych na zawartości. W tym procesie ustalany jest również parametr nazwy dla kontekstu wyszukiwania, który jest pochodną nazwy obiektu biznesowego.
Tylko w przypadku, gdy wymagany jest inny (niestandardowy) kontekst wyszukiwania, należy dodatkowo zaimplementować Definicja hook contract – rejestracje – będzie on miał wyższy priorytet działania.
Funkcje specjalne
Za pomocą aplikacji nie można rozszerzać ValueSet. Jeżeli w aplikacji wprowadzany jest całkowicie nowy typ dokumentu, konieczne jest rozszerzenie ValueSet com.cisag.app.general.OrderType w standardzie systemu.
Rozszerzenie to musi zostać wykonane przez zespół rozwoju standardu. W przypadku potrzeby takiej modyfikacji, należy przysłać zgłoszenia za pomocą systemu obsługi zgłoszeń.
Takie rozszerzenia ValueSet muszą być zgodne z określonymi konwencjami nazewnictwa dla wpisów typu EN_APP_SN.
W zgłoszeniu rozszerzenia należy podać następujące informacje:
-
EP – prefiks deweloperski
-
APP – nazwa aplikacji w ramach systemu deweloperskiego
-
SN – specyficzna nazwa wpisu
(poszczególne słowa oddzielane znakiem podkreślenia „_”)
Każdy składnik nazwy powinien składać się wyłącznie z wielkich liter.
Dodatkowo, dla każdego wpisu należy zdefiniować unikalne oznaczenie (etykietę).
- EP – sem
- APP – service
- SN – service request
- Oznaczenie (EN) – Service request
- Oznaczenie (PL) – Komunikat serwisowy
