Přejít na drobečkovou navigaci Přejít na hlavní obsah
Vyhledávání

Příprava dokumentace a technické specifikace

Menu stránky

V tomto kroku je třeba mít připravený základní návrh logického rozložení dat do jednotlivých kontextů a datových obsahů, které budete chtít publikovat, včetně jejich označení s ohledem na jejich účel, obsah a využití. 

Vycházejte při tom z popisu dat a zaregistrovaných údajů v publikující agendě. Kontext nemusí obsahovat všechny údaje uvedené k danému subjektu/objektu v agendě v RPP. Pokud ale obsahuje údaje, které RPP uvedeny nejsou, musí jít pouze o technické informace (např. datum poslední změny, pomocný identifikátor atd.).

Pokud je již k dispozici OVM a čtenářský AIS/SSVÚ, který bude konzumovat příslušné služby, je vhodné ve spolupráci s jeho zástupci ověřit čitelnost a pochopitelnost dokumentace. 

Zpracovanou dokumentaci a technickou specifikaci pošlete před podáním žádosti o publikaci DIA na kontrolu (kontexty@dia.gov.cz).

Věcný záměr: 2-4 týdny
Dokumentace: 1 týden
Technická specifikace: 2-4 týdny

1. Zpracování věcného záměru

Věcným záměrem se rozumí popis, který stručně shrnuje účel a předpokládané využití kontextu. Jedná se o nepovinný, ale doporučený krok. 

Účelem zpracování věcného záměru je vyřešit již v rané fázi případné nejasnosti a upozornit na možné nedostatky. 

V rámci věcného záměru je nutné uvést:

  • jaké je předpokládané využití kontextu,
  • kdo bude předpokládaným konzumentem kontextu (agendy, až sekundárně ISVS/OVM),
  • zda se bude jednat o nové kontexty a datové obsahy, nebo o novou verzi stávající technické specifikace,
  • jaký bude předpokládaný datový obsah kontextu,
  • jaké služby ISSS budou využívány. 

Více informací k podobě věcného záměru je uvedeno v dokumentu Metodika realizace kontextu. 

2. Zpracování dokumentace

Pokud máte zpracovaný a schválený věcný záměr, připravte dokumentaci kontextu, která bude z věcného záměru vycházet. Bližší informace o obsahových náležitostech najdete v Popisu použití kontextu.

Pokud se jedná o kontext, který nahrazuje již schválený kontext, není třeba vytvářet zcela novou dokumentaci, ale jen dokument s popisem změn, který přiložíte k původní dokumentaci.

Připravte také příklady volání, tzn. jak budou vypadat dotazy a odpovědi, a to úspěšné (výsledek volání je v pořádku) i chybové. Tyto příklady volání můžete případně doplnit testovacími daty. 

Dokumentaci i příklady volání vložíte do samostatných podsložek v ZIP souboru s technickou specifikací kontextu (viz následující krok), kterou nahrajete do aplikace RAZR při podání žádosti o publikaci kontextu. 

3. Příprava technické specifikace

Příprava technické specifikace zahrnuje vytvoření odpovídajícího popisu SOAP služeb, včetně vytvoření WSDL popisu služby a odpovídajících XSD schémat, které definují struktury služeb a dat. Součástí je rovněž definice rozhraní, která je ze strany AIS popsána v souboru katalog.xml. 

Při tvorbě technického návrhu vycházejte z XSD popisů služeb. Doporučujeme také využít aplikaci Testovací AIS (více info na stránce Testovací nástroje) 

Technická specifikace kontextu se předává jako ZIP archiv, který obsahuje tyto složky:

  • xsd (soubory definující datový obsah),
  • katalog.xml (metadata popisující obsah definice rozhraní),
  • wsdl (soubory s vystavovanými službami publikačních AIS - nepovinné),
  • xml (příklady volání)
  • doc (dokumentace).

Podrobné informace k technické specifikaci a pravidla pro předávání naleznete v dokumentu Publikace AIS na ISSS.