Tato integrační příručka slouží k popisu Národního katalogu otevřených dat (NKOD), části projektu OD2.0.
- NKOD
- Národní katalog otevřených dat
- LKOD
- Lokální katalog otevřených dat
- RDF
- Resource Description Framework
Čtenář této příručky by měl být obeznámen s:
- Kubernetes
- Oracle Cloud Infrastructure (OCI)
- Inštalačná príručka a pokyny na inštaláciu (úvodnú/opakovanú)
- Aplikační příručka
- Uživatelská příručka
Aplikační architektura řešení je přehledově popsána v Aplikační příručce sekce 3.2 ZOZNAM A ZÁKLADNÝ POPIS SUBSYSTÉMOV A FUNKCIÍ.
Tento popis architektury také ukazuje komunikačními rozhraní, které je většinou také integračními body. Ve zbytku této kapitoly nejprve zevrubně popíšeme jednotlivá komunikačními rozhraní a následně integrační body.
Komunikační rozhraní jsou součástí rozhraní popsaných v Aplikační příručce sekce 3.5 POPIS EXISTUJÚCICH ROZHRANÍ V IS. Pro plné porozumění rozhraním je doporučeno přečíst jak tuto sekci tak sekci odkázanou.
V této sekci jsou popsána komunikační rozhraní směrem k:
- Poskytovali dat
- Externímu IS
- Návštěvník
Webová stránka umožňuje vybrat před připravený SPARQL dotaz nebo napsat vlastní, a nechat ho vykonat na rozhraní SPARQL endpoint nad RDF úložištěm NKOD a zobrazit výsledky. Přes komponentu webové stránky je zpřístupněn i obsah NKOD v podobě souborů ke stažení. Adresy souborů ke stažení jsou popsané v Uživatelské příručce.
Webová stránka je k dispozici vícejazyčně, nyní v 5 jazycích dostupných na relativní URL:
/- Slovenština/de/- Němčina/en/- Angličtina/hu/- Maďarština/uk/- Ukrajinština
Pro samotnou práci se SPARQL dotazem využívá knihovnu Yasgui.
Tato knihovna je součástí repositáře NKOD-SW v cestě components/website/www/libs.
Vyhodnocuje dotazy v jazyce SPARQL nad RDF úložištěm NKOD. Toto rozhraní je také využíváno formulářem pro SPARQL dotaz na Webové stránce.
Endpoint je ve výchozím nastavení dostupný na URL /api/sparql a využívá CORS.
Toto nastavení je možné změnit v configuration/nginx.conf.
Vstupním rozhraním pro Metadatový procesor - LinkedPipes ETL jsou registrované instance LKODů. Jejich obsah musí odpovídat specifikaci DCAT-AP-SK 2.0.
V oblasti vstupní komunikace dochází k získávání dat potřebných pro vytvoření dat NKODu. Hlavním datovým vstupem jsou lokální katalogy LKOD, ze kterých jsou data harvestována dle specifikace DCAP-AP-SK 2.0.
Za integrační API lze považovat i komunikační rozhraní popsaná v sekci 3.1. Komunikačné rozhrania. Tato komunikační rozhraní slouží zejména pro integraci z venku systému, tedy třetích stran. Rozhraní popsaná v této sekci slouží pro integraci uvnitř NKOD.
Struktura synchronizačních záznamů je popsána v Uživatelské příručce, sekce 3.2 Registrační záznamy.
Ve výchozím nastavení jsou registrační záznamy načítány z GitHub repositáře NKOD-REG.
Z tohoto umístění jsou před každým spuštěním harvestování synchronizovány do nodc-registration-pvc definovaném v ./k8s/linkedpipes/registration-pvc.yaml.
Synchronizaci zajišťuje skript z komponenty Manažer.
Konkrétně se jedná a skript v repositáři NKOD-SW v souboru ./components/manager/entrypoint.sh.
Ve sdíleném úložišti musí být souboru uložené v adresáři repository.
Důvodem je nemožnost vytvoření git repository přímo v rootu PVC, neb ten obsahuje skrytý soubor pro potřeby OCI.
URL repositáře s registračními záznamy je nastavené v konfiguračním souboru ./configuration/nodc-configuration.properties.
Toto je integrační bod využitelný pro budoucí Portál otevřených dat, kde se registrační záznamy budou spravovat a ukládat jiným způsobem, který nahradí stávající synchronizaci z GitHub repozitáře.
Metadatový procesor - LinkedPipes ETL provádí harvestování na základě definovaných pipeline. Před každým spuštěním se provede stažení pipeline a template z NKOD-PPL. Stažené pipeliny a templaty jsou následně zkopírovány do úložiště LinkedPipes ETL a importovány.
URL repositáře je nastavené v konfiguračním souboru ./configuration/nodc-configuration.properties.