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

Z BBM Dokumentace iFIS
Skočit na navigaciSkočit na vyhledávání
Jdankova (diskuse | příspěvky)
Bez shrnutí editace
Jdankova (diskuse | příspěvky)
Bez shrnutí editace
 
(Není zobrazeno 24 mezilehlých verzí od 2 dalších uživatelů.)
Řádek 1: Řádek 1:
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.).<br>
Rozhraní je využíváno externími subsytémy pro zápis interních žádanek nebo schválených dodavatelských objednávek do evidence [[:Kategorie:Objednávky|iFIS/Objednávky]]. Zápis bývá prováděn z důvodu potřeby zveřejnění objednávky na portále ISRS, z důvodu vytvoření blokace ve finančním rozpočtu příslušného zdroje financování nebo z důvodu pozdějšího párování objednávek s doklady v iFIS/Finance/Závazky. Objednávka od okamžiku svého zápisu do iFIS blokuje odpovídající finanční rozpočet, tato blokace se automaticky odstraní v okamžiku vyúčtování objednávky (spárování s fakturou, konečným vyúčtováním služební cesty apod.).<br>
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*.  
Samotný zápis dat do iFIS je možné realizovat buď pomocí webové služby (SOAP), nebo pomocí databázových konektorů na úrovni db Oracle (iFIS). Návratovou hodnotou volání datového rozhraní je vždy buď číslo vytvořené objednávky v iFIS, případně identifikace chyby, díky které nemohl být zápis proveden.  


Externí aplikace se v rámci integrace na [[:Kategorie:Objednávky|iFIS/Objednávky]] napojuje na tyto základní zdrojové evidence:
* iFIS/Objednávky - přehled o objednávkách a jejich aktuálním stavu zpracování
* iFIS/Deníky objednávek - deník určuje typ objednávky a její číselnou řadu
* iFIS/Organizace- dodavatelé, partneři
* Centrální registr osob - objednávající osoby, vyřizující kontaktní osoby
* iFIS/Zdroje financování - seznam aktuálně platných zdrojů financování (ZF) ve tvaru Nákladové středisko/Zakázka/Komplexní položka
* iFIS/Odpovědné osoby - Schvalovatelé zdrojů financování (Řešitelé, Příkazci operací, Správci rozpočtů, Hlavní účetní apod.)
* iFIS/Rozpočty - finanční plán ZF a jeho položková struktura, aktuální zůstatek finančního rozpočtu ZF
* iFIS/Registr smluv - platné smlouvy, na základě kterých se objednává
* Měny a aktuální kurzovní lístek
* Centrální uložiště dokumentů - nabídky, protokol o schválení žádanky do přílohy objednávky


===Předání dat přes webovou službu iFIS===
Dokumentace k napojení na rozhraní výše uvedených zdrojových evidencí není součástí totoho článku.


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ředání dat přes webovou službu iFIS/Objednávky BbmZsWs===
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]].


Webová služba BbmZsWs je obvykle provozovaná na aplikačním serveru iFIS (Oracle iAS), dokumentaci si lze stáhnout [[Media:BbmZsWs.zip|ZDE]]. Na rozhraní této služby sa předávají XML data, struktura předávaného XML je popsána v přiložených souborech [[Media:ifis_obj.xsd|ifis_obj.xsd]] a [[Media:ifis_common.xsd|ifis_common.xsd]]. Aktuální dokumentace webové služby ve formátu WSDL je dostupná na vyžádání u správce iFIS a nebo je k dispozici na aplikačním serveru iFIS.<br>
Náhled na strukturu 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====
Dále jsou uvedeny nejčastěji využívané základní metody webové služby BbmZsWs:


'''ZpracujObjednavku (PozadavekZs)'''
'''ZpracujObjednavku (PozadavekZs)'''
 
Této metodě je při volání předáván objekt PozadavekZs. Tato metoda slouží pro zápis nové objednávky, pro její pozdější editaci a nebo pro její zrušení.<br>
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.<br>
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.<br>
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.<br>
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).<br>
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 (vícezdrojové financování).<br>
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.
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 v požadavku uvedené.
 
 
'''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.
'''VlozZverDol()''' Metoda pro zápis zveřejňovací doložky ISRS k obejdnávce.


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


===Předání dat přes databázové konektory iFIS===
'''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.


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]].
===Předání dat přes databázové konektory na úrovni db Oracle (iFIS)===


Externí aplikace přistupuje do databáze iFIS obvykle přes privátní db-link nebo přes zabezpečené ODBC rozhraní, 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]].


<br>


[[Kategorie:Datová rozhraní iFIS]]
[[Kategorie:Datová rozhraní iFIS]]

Aktuální verze z 7. 1. 2022, 10:17

Rozhraní je využíváno externími subsytémy pro zápis interních žádanek nebo schválených dodavatelských objednávek do evidence iFIS/Objednávky. Zápis bývá prováděn z důvodu potřeby zveřejnění objednávky na portále ISRS, z důvodu vytvoření blokace ve finančním rozpočtu příslušného zdroje financování nebo z důvodu pozdějšího párování objednávek s doklady v iFIS/Finance/Závazky. Objednávka od okamžiku svého zápisu do iFIS blokuje odpovídající finanční rozpočet, tato blokace se automaticky odstraní v okamžiku vyúčtování objednávky (spárování s fakturou, konečným vyúčtováním služební cesty apod.).
Samotný zápis dat do iFIS je možné realizovat buď pomocí webové služby (SOAP), nebo pomocí databázových konektorů na úrovni db Oracle (iFIS). Návratovou hodnotou volání datového rozhraní je vždy buď číslo vytvořené objednávky v iFIS, případně identifikace chyby, díky které nemohl být zápis proveden.

Externí aplikace se v rámci integrace na iFIS/Objednávky napojuje na tyto základní zdrojové evidence:

  • iFIS/Objednávky - přehled o objednávkách a jejich aktuálním stavu zpracování
  • iFIS/Deníky objednávek - deník určuje typ objednávky a její číselnou řadu
  • iFIS/Organizace- dodavatelé, partneři
  • Centrální registr osob - objednávající osoby, vyřizující kontaktní osoby
  • iFIS/Zdroje financování - seznam aktuálně platných zdrojů financování (ZF) ve tvaru Nákladové středisko/Zakázka/Komplexní položka
  • iFIS/Odpovědné osoby - Schvalovatelé zdrojů financování (Řešitelé, Příkazci operací, Správci rozpočtů, Hlavní účetní apod.)
  • iFIS/Rozpočty - finanční plán ZF a jeho položková struktura, aktuální zůstatek finančního rozpočtu ZF
  • iFIS/Registr smluv - platné smlouvy, na základě kterých se objednává
  • Měny a aktuální kurzovní lístek
  • Centrální uložiště dokumentů - nabídky, protokol o schválení žádanky do přílohy objednávky

Dokumentace k napojení na rozhraní výše uvedených zdrojových evidencí není součástí totoho článku.

Předání dat přes webovou službu iFIS/Objednávky BbmZsWs

Webová služba BbmZsWs je obvykle provozovaná na aplikačním serveru iFIS (Oracle iAS), dokumentaci si lze stáhnout ZDE. Na rozhraní této služby sa předávají XML data, struktura předávaného XML je popsána v přiložených souborech ifis_obj.xsd a ifis_common.xsd. Aktuální dokumentace webové služby ve formátu WSDL je dostupná na vyžádání u správce iFIS a nebo je k dispozici na aplikačním serveru iFIS.
Náhled na strukturu 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.

Dále jsou uvedeny nejčastěji využívané základní metody webové služby BbmZsWs:

ZpracujObjednavku (PozadavekZs) Této metodě je při volání předáván objekt PozadavekZs. Tato metoda slouží pro zápis nové objednávky, pro její pozdější editaci a nebo pro její zrušení.
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 (vícezdrojové financování).
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 v požadavku uvedené.

VlozZverDol() Metoda pro zápis zveřejňovací doložky ISRS k obejdnávce.

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 na úrovni db Oracle (iFIS)

Externí aplikace přistupuje do databáze iFIS obvykle přes privátní db-link nebo přes zabezpečené ODBC rozhraní, 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.