Popis datového rozhraní k iFIS*Objednávky: Porovnání verzí

Z BBM Dokumentace iFIS
Skočit na navigaciSkočit na vyhledávání
Jana.dankova (diskuse | příspěvky)
Bez shrnutí editace
Jana.dankova (diskuse | příspěvky)
Bez shrnutí editace
Řádek 7: Řádek 7:
Webová služba BbmZsWs je obvykle provozovaná na aplikačním serveru iFIS (Oracle iAS), data se na jejím rozhraní předávají v podobě XML souboru, struktura tohoto souboru je popsána v přiložených souborech [[Media:ifis_obj.xsd|ifis_obj.xsd]] a [[Media:ifis_common.xsd|ifis_common.xsd]]. Popis webové služby ve formátu WSDL je pro oprávněné externí aplikace dostupný na aplikačním serveru.<br>
Webová služba BbmZsWs je obvykle provozovaná na aplikačním serveru iFIS (Oracle iAS), data se na jejím rozhraní předávají v podobě XML souboru, struktura tohoto souboru je popsána v přiložených souborech [[Media:ifis_obj.xsd|ifis_obj.xsd]] a [[Media:ifis_common.xsd|ifis_common.xsd]]. Popis webové služby ve formátu WSDL je pro oprávněné externí aplikace dostupný na aplikačním serveru.<br>
Příklad předávaných XML dat najdete v přílohách [[Media:XML data k vícezdrojové objednávce 1110480001.xml|XML data k vícezdrojové objednávce 1110480001.xml]] nebo [[Media:Náhled na data vícezdrojové objednávky 1110480001.png|Náhled na data vícezdrojové objednávky 1110480001.png]].
Příklad předávaných XML dat najdete v přílohách [[Media:XML data k vícezdrojové objednávce 1110480001.xml|XML data k vícezdrojové objednávce 1110480001.xml]] nebo [[Media:Náhled na data vícezdrojové objednávky 1110480001.png|Náhled na data vícezdrojové objednávky 1110480001.png]].
====Metody služby BbmZsWs====
'''ZpracujObjednavku (PozadavekZs)'''
Této metodě je při volání předáván objekt PozadavekZs. V tomto objektu musí být uveden atribut pro určení ekonomické jednotky (EJIDNO). Metoda slouží k importu/úpravě/zrušení objednávky v iFIS.
Pokud je zakládána nová objednávka, metoda vrací objekt OdpovedZs, kde je uveden stav operace a identifikátor objednávky, který byl vygenerován v iFIS.
V požadavku je možné uvést i identifikaci objednávky v externím systému, pokud existuje (PozadavekZs.Objednavka.Hlavicka.EXT_ID). Součástí hlavičky objednávky může být mimo jiné seznam elementů dilci_zdroj, který obsahuje případné dílčí zdroje financování spolu s částkou a textem. Pokud jsou uvedeny i dílčí zdroje, znamená to, že pro objednávku vzniká více záznamů v iFIS. V odpovědi potom budou uvedeny všechny identifikátory nově vzniklých záznamů (HOBJIDNO), odlišené interním identifikátorem rozhraní (Zdroj.ID).
Aktualizace objednávky se provádí v případě, že je v objektu PozadavekZs vyplněn identifikátor objednávky (PozadavekZs.Objednavka.Hlavicka.HOBJIDNO). Aktualizovány jsou všechny položky, které jsou uvedené v požadavku.
'''CheckWs()'''
Metoda vrací řetězec s výsledkem operace, slouží pouze pro testovací účely.
'''Zabezpečení služby BbmZsWs'''
Pro zabezpečení přenosu dat se využívá upraveného standardu OASIS Web Services Security - UsernameToken Profile 1.1. (Wssp1.2-2007-Https-UsernameToken-Plain-noTS). V tomto případě se při komunikaci nevyužívá údaj pro timestamp.
===Předání dat přes databázové konektory iFIS===
Externí aplikace přistupuje do databáze iFIS obvykle přes privátní db-link a volá databázové konektory uvnitř package PA303_OBJ. Těmto konektorům předá data hlavičky objednávky, následně i data jednotlivých řádků. Na závěr volá konektor pro uzavření objednávky, návratovou hodnotou tohoto volání je číslo objednávky, která byla v iFIS* uložena. Popis jednotlivých argumentů volání konektorů i postup volání je naznačený v příloze [[Media:Příklad volání db-konektoru PA303_OBJ pro zápis OBJ do iFIS.sql|Příklad volání db-konektoru PA303_OBJ pro zápis OBJ do iFIS.sql]].

Verze z 23. 7. 2018, 07:18

Rozhraní je běžně využíváno pro zápis žádanek nebo schválených objednávek ze strany externích aplikací do iFIS*Objednávky. Každá objednávka v libovolném stavu blokuje odpovídající finanční rozpočty, a to od okamžiku vzniku objednávky až do okamžiku vyúčtování objednávky (spárování s fakturou, konečným vyúčtováním služební cesty, ručním vyřazením objednávky z blokace apod.).
Samotný zápis dat je možné realizovat buď pomocí webové služby, nebo pomocí db konektorů pro zápis hlavičky objednávky, pro postupný zápis jednotlivých řádků objednávky i jednotlivých dílčích zdrojů financování. Návratovou hodnotou volání datového rozhraní je číslo vytvořené objednávky v iFIS*.


Předání dat přes webovou službu iFIS

Webová služba BbmZsWs je obvykle provozovaná na aplikačním serveru iFIS (Oracle iAS), data se na jejím rozhraní předávají v podobě XML souboru, struktura tohoto souboru je popsána v přiložených souborech ifis_obj.xsd a ifis_common.xsd. Popis webové služby ve formátu WSDL je pro oprávněné externí aplikace dostupný na aplikačním serveru.
Příklad předávaných XML dat najdete v přílohách XML data k vícezdrojové objednávce 1110480001.xml nebo Náhled na data vícezdrojové objednávky 1110480001.png.


Metody služby BbmZsWs

ZpracujObjednavku (PozadavekZs)

Této metodě je při volání předáván objekt PozadavekZs. V tomto objektu musí být uveden atribut pro určení ekonomické jednotky (EJIDNO). Metoda slouží k importu/úpravě/zrušení objednávky v iFIS.

Pokud je zakládána nová objednávka, metoda vrací objekt OdpovedZs, kde je uveden stav operace a identifikátor objednávky, který byl vygenerován v iFIS.

V požadavku je možné uvést i identifikaci objednávky v externím systému, pokud existuje (PozadavekZs.Objednavka.Hlavicka.EXT_ID). Součástí hlavičky objednávky může být mimo jiné seznam elementů dilci_zdroj, který obsahuje případné dílčí zdroje financování spolu s částkou a textem. Pokud jsou uvedeny i dílčí zdroje, znamená to, že pro objednávku vzniká více záznamů v iFIS. V odpovědi potom budou uvedeny všechny identifikátory nově vzniklých záznamů (HOBJIDNO), odlišené interním identifikátorem rozhraní (Zdroj.ID).

Aktualizace objednávky se provádí v případě, že je v objektu PozadavekZs vyplněn identifikátor objednávky (PozadavekZs.Objednavka.Hlavicka.HOBJIDNO). Aktualizovány jsou všechny položky, které jsou uvedené v požadavku.


CheckWs()

Metoda vrací řetězec s výsledkem operace, slouží pouze pro testovací účely.


Zabezpečení služby BbmZsWs

Pro zabezpečení přenosu dat se využívá upraveného standardu OASIS Web Services Security - UsernameToken Profile 1.1. (Wssp1.2-2007-Https-UsernameToken-Plain-noTS). V tomto případě se při komunikaci nevyužívá údaj pro timestamp.


Předání dat přes databázové konektory iFIS

Externí aplikace přistupuje do databáze iFIS obvykle přes privátní db-link a volá databázové konektory uvnitř package PA303_OBJ. Těmto konektorům předá data hlavičky objednávky, následně i data jednotlivých řádků. Na závěr volá konektor pro uzavření objednávky, návratovou hodnotou tohoto volání je číslo objednávky, která byla v iFIS* uložena. Popis jednotlivých argumentů volání konektorů i postup volání je naznačený v příloze Příklad volání db-konektoru PA303_OBJ pro zápis OBJ do iFIS.sql.