Wprowadzenie
Aplikacja Obiekty deweloperskie pozwala na rejestrowanie i przeglądanie obiektów deweloperskich różnych typów. W niniejszym artykule opisany został obiekt o typie Search extension.
Opis
Search extension pozwala na dodawanie atrybutów i połączeń do istniejących wyszukiwań. Korzystając z rozszerzeń wyszukiwania, można rozszerzać wyszukiwania w kolejnych systemach bez konieczności ich dostosowywania. Eliminuje to potrzebę przetwarzania konfliktów dla tych wyszukiwań po zainstalowaniu aktualizacji oprogramowania.
Rozszerzeń wyszukiwania można również używać do rozszerzania wyszukiwania w aplikacji. Oznacza to, że atrybuty dodane w aplikacji mogą być również wyszukiwane w konfigurowalnych listach.
Zakładka Edytor
Zakładka Edytor składa się z kilku podzakładek:
- From
- Atrybuty
Dodatkowo na zakładce Edytor dostępne są poniższe pola:
Szukanie – należy wprowadzić w pełni kwalifikowaną nazwę wyszukiwania, które jest rozszerzane przez rozszerzenie wyszukiwania. Wyszukiwanie nie może być utworzone w systemie deweloperskim, w którym wprowadzane jest rozszerzenie wyszukiwania; może ono pochodzić z innej aplikacji, pod warunkiem, że można się do niej odwołać.
W systemie używany jest również prefiks, ponieważ kilka rozszerzeń wyszukiwania może mieć zastosowanie do wyszukiwania w kolejnych systemach, definicje aliasów muszą być unikalne. Dlatego prefiks dla nazw aliasów obiektów biznesowych i nazw atrybutów jest predefiniowany.
W systemach deweloperskich prefiks odpowiada prefiksowi deweloperskiemu systemu. W systemach deweloperskich aplikacji prefiks składa się z prefiksu deweloperskiego i nazwy aplikacji.
TCDV_APP1_: system deweloperski aplikacji z prefiksem deweloperskim TCDV; rozszerzenie wyszukiwania należy do aplikacji „APP1”.
Podzakładka From
Na zakładce From można zdefiniować obiekty biznesowe i widoki OQL oraz ich wzajemne relacje dla rozszerzenia wyszukiwania. Definicja musi być zgodna z definicją wyszukiwania bazowego za pomocą REMOVABLE LEFT JOIN. Do każdego obiektu należy odwoływać się za pomocą unikalnego aliasu.
Dostępne są następujące pola:
REMOVABLE LEFT JOIN – pozwala zdefiniować własne obiekty biznesowe lub widoki OQL dla rozszerzenia wyszukiwania. W tym celu należy wprowadzić definicję obiektów biznesowych lub widoków OQL w tym polu. Rozszerzenie wyszukiwania znajduje się na liście Wykazów zastosowania obiektów biznesowych i widoków OQL.
FROM – w polu prezentowana jest definicja klauzuli FROM wyszukiwania bazowego. Klauzula FROM zawiera obiekty biznesowe i widoki OQL oraz ich wzajemne relacje. Relacje te są wyrażone jako JOIN.
Podzakładka Atrybuty
Na zakładce Atrybuty można określić atrybuty z używanych obiektów biznesowych i widoków OQL, które mają być dostępne w konfigurowalnych listach.
Atrybuty można dodać ręcznie lub skorzystać z akcji Wybierz atrybuty.
W tabeli dostępne są poniższe kolumny:
Nazwa – należy wprowadzić nazwę atrybutu. Nazwa musi zaczynać się od określonego prefiksu i musi być unikalna w ramach rozszerzenia wyszukiwania. Służy ona do identyfikacji w celu uzyskania dostępu do atrybutów wyszukiwania.
Jeśli atrybut ma należeć do atrybutu wirtualnego, atrybut musi zaczynać się od nazwy atrybutu wirtualnego, po której następuje kropka.
Wyrażenie – należy wprowadzić atrybut obiektu biznesowego lub widoku OQL z klauzuli FROM rozszerzenia wyszukiwania, wyszukiwania bazowego lub wprowadź wyrażenie, które ma zostać obliczone przez bazę danych, która używa jednego lub więcej takich atrybutów. Nazwa atrybutu musi być wywołana za pośrednictwem określonego aliasu i zgodna ze składnią Alias:Nazwa atrybutu.
Wyrażenie do obliczenia może zawierać tylko funkcje agregujące OQL UPPER, AVG, MAX, MIN, SUM, COUNT, operatory: *, /, +, – i atrybut. Wszystkie operandy muszą mieć ten sam typ, tj. albo wszystkie operandy są funkcjami, albo atrybutami. Argument funkcji może składać się tylko z jednego atrybutu.
boAlias1:attr1 + boAlias1:attr2
Sum(boAlias1:attr1) – SUM(boAlias2:attr1)
Jeśli atrybut jest oznaczony jako:
- obiekt biznesowy, w razie potrzeby można pominąć nazwę atrybutu
- wirtualny, nie wolno wprowadzać wyrażenia
Użyte atrybuty są zawarte w wykazie zastosowania obiektu biznesowego lub widoku OQL.
Wirtualny – atrybuty można grupować, tj. kilka atrybutów można podsumować w ramach jednego atrybutu. Ten atrybut podsumowujący musi być oznaczony jako wirtualny. Atrybut wirtualny nie ma odniesienia do atrybutu obiektu biznesowego lub widoku OQL w bazie danych, a zatem nie ma wprowadzonego wyrażenia. Atrybuty należące do atrybutu wirtualnego muszą zaczynać się od nazwy atrybutu wirtualnego, po której następuje kropka.
Jeśli dla atrybutu wirtualnego zaznaczono parametr:
- Możliwość sortowania – oznacza, że dokładnie jeden atrybut grupy musi być oznaczony jako sortowalny. Atrybut ten jest używany do sortowania w ramach atrybutu wirtualnego.
- Możliwość filtrowania – co najmniej jeden atrybut grupy musi być również oznaczony jako możliwy do filtrowania. Tylko tak oznaczone atrybuty w grupie są używane do ograniczenia zapytania do bazy danych. Inne atrybuty w grupie nie są używane.
- Możliwość wyświetlenia – co najmniej jeden atrybut grupy powinien być oznaczony jako możliwy do wyświetlenia. Tylko atrybuty oznaczone w ten sposób są prezentowane jako wynik zapytania do bazy danych.
Należy wprowadzić logiczny typ danych dla atrybutu wirtualnego, który może być użyty do określenia opisu danych, który zapewnia edytor i/lub renderer dla wizualizacji. Nie jest możliwe zagnieżdżanie atrybutów wirtualnych. Atrybut wirtualny nie może być oznaczony jako obiekt biznesowy ani jako zaprogramowany filtr.
Obiekt biznesowy – jeśli atrybut jest oznaczony jako obiekt biznesowy, funkcja łącza jest widoczna na tym atrybucie na wybranych listach. Menu kontekstowe jest tworzone w odniesieniu do powiązanego obiektu biznesowego. Oznacza to, że menu kontekstowe można utworzyć na dowolnym atrybucie obiektu biznesowego. Ponadto, gdy atrybut jest oznaczony jako obiekt biznesowy, obowiązują następujące zasady i ograniczenia:
- atrybut może być traktowany jako obiekt-wartość w zapytaniu: Oprócz opcji zapytania o wartość atrybutu, można również zapytać o cały obiekt biznesowy.
- użyte wyrażenie można zredukować do aliasu. W takim przypadku można zapytać tylko o obiekt. Ma to jednak wpływ na inne właściwości atrybutu: atrybut nie może być wtedy oznaczony jako filtrowany lub sortowany. Jeśli atrybut jest również oznaczony jako Możliwy do wyświetlania, należy określić logiczny typ danych. Powinien on odnosić się do opisu danych, który wprowadził renderer.
- nie jest konieczne wprowadzanie logicznego typu danych w atrybucie wirtualnym, ponieważ atrybut wirtualny jest odpowiedzialny za wizualizację.
- atrybut nie może być również oznaczony jako wirtualny lub jako zaprogramowany filtr.
Zaprogramowany filtr – żaden atrybut nie może być oznaczony jako zaprogramowany filtr w rozszerzeniu wyszukiwania.
Typ danych – kolumna prezentuje typ danych, jaki został określony dla atrybutu. Ten typ danych jest używany do ogólnego tworzenia pól funkcji wyszukiwania, kolumn wyświetlania itp.
Możliwość filtrowania – parametr należy zaznaczyć aby istniała możliwość filtrowania atrybutu. Pole wyszukiwania jest tworzone dla tych atrybutów w obszarze zapytań listy.
Pola wyszukiwania nie są tworzone dla atrybutów:
- oznaczonych jako filtr zaprogramowany
- znajdujących się w grupie pola wirtualnego
W przypadku tych atrybutów wyrażenie filtru jest wyszukiwane w powiązanym atrybucie wirtualnym.
Jeśli atrybut wirtualny jest oznaczony jako możliwy do filtrowania, wówczas dokładnie jeden atrybut powiązanej grupy musi być również oznaczony jako możliwy do filtrowania. Atrybut ten jest używany do filtrowania w ramach atrybutu wirtualnego.
Możliwość sortowania – parametr należy zaznaczyć aby istniała możliwość sortowania atrybutu. Jeśli atrybut wirtualny jest oznaczony jako możliwy do sortowania, wówczas dokładnie jeden atrybut powiązanej grupy musi być również oznaczony jako możliwy do sortowania. Ten atrybut jest używany do sortowania w ramach atrybutu wirtualnego.
Możliwość wyświetlania – należy zaznaczyć parametr, aby istniała możliwość wyświetlenia atrybutu. Jeśli atrybut wirtualny jest oznaczony jako możliwy do wyświetlenia, co najmniej jeden atrybut powiązanej grupy musi być również oznaczony jako możliwy do wyświetlenia. Tak oznaczone atrybuty są odczytywane przez bazę danych, gdy atrybut wirtualny jest włączony do wyświetlania.
Klucz zwrotny – żaden atrybut nie może być oznaczony jako klucz zwrotny w rozszerzeniu wyszukiwania.
Logiczny typ danych – określając logiczny typ danych, można zmienić właściwości atrybutu, na przykład etykietę, pomoc wejściową, specjalne renderery lub edytory. Należy wprowadzić logiczny typ danych dla atrybutów wirtualnych i atrybutów oznaczonych jako obiekty biznesowe, które mają tylko alias jako wyrażenie. W przeciwnym razie wpis jest opcjonalny. Logiczny typ danych musi być oparty na tym samym typie danych co atrybut. Nie jest to konieczne w przypadku atrybutu wirtualnego, ponieważ nie ma odniesienia do atrybutu w bazie danych.
Przycisk [Atrybut wyszukiwania]
Za pomocą przycisku [Atrybut wyszukiwania] można wyświetlać i ukrywać atrybuty określone w wyszukiwaniu bazowym.
Przycisk [Wybierz atrybuty]
Po wybraniu przycisku [Wybierz atrybuty] otwarte zostanie okno dialogowe, w którym można wybrać atrybuty tych obiektów biznesowych lub widoków OQL z listy, które są zdefiniowane w klauzuli FROM rozszerzenia wyszukiwania i wyszukiwania bazowego.
Dostępne są następujące pola wyszukiwania:
Alias – alias obiektu, którego atrybuty mają zostać wyświetlone na liście. Wszystkie aliasy zdefiniowane w klauzuli FROM rozszerzenia wyszukiwania i wyszukiwania bazowego są dostępne do wyboru. Nazwa obiektu jest wyświetlana dla każdego aliasu.
Prefiks – prefiks, który zostanie umieszczony przed nazwą atrybutu na liście. Więcej informacji można znaleźć tutaj.
Po wybraniu przycisku [Aktualizacja listy] na pasku narzędzi, wyświetlone zostaną wyniki wyszukiwania funkcji.
Dostępne są następujące kolumny:
Ścieżka atrybutu – ścieżka atrybutu w wybranym obiekcie biznesowym lub widoku OQL. Jeśli jest to atrybut w Part, nazwa jest oddzielona od nazwy atrybutu kropką.
Nazwa – nazwa atrybutu. Nazwa składa się z prefiksu i ścieżki atrybutu. Wszystkie kropki w ścieżce atrybutu są usuwane, a następująca po nich litera jest zastępowana wielką literą.
Jeśli określono prefiks, jest on umieszczany z przodu. Jeśli prefiks kończy się kropką, reszta nazwy pozostaje niezmieniona. Jeśli przedrostek nie kończy się kropką, pierwsza litera pozostałej części nazwy jest zastępowana odpowiednią wielką literą.
Wyrażenie – wyrażenie, które składa się z aliasu wybranego obiektu, po którym następuje dwukropek i ścieżka atrybutu.
