Webservice W023 Upload filer. Indhold ADM TEKN. Formål

Transkript

1 ADM TEK Webservice W023 Uplad filer Frmål At filer kan verføres fra et eksternt system til SIS vinduet S105 Filarkiv/tabellen PERSO_FILER. Desuden giver webservicen mulighed fr at hente en fil, slette en fil samt liste filer fr en given persn. Indhld Frmål... 1 Betingelser fr adgang til webservicen... 2 Kald af webservicen... 2 Kntekst... 3 Eksempel XML-input... 3 Mapning imellem XML-input g SIS tabeller... 4 Slutvalideringer... 5 Mapning imellem XML utput g SIS tabeller... 7 Prcessering af parameterliste... 7 XSD links... 8 Fejlkder... 9 Side 1 af 9

2 Betingelser fr adgang til webservicen Der kan ansøges m adgang til anvendelse af webservicen via ansøgningsskema / kntrakt på SIS-supprten, hvis der allerede freligger en kntrakt m adgang. Ved tildeling af adgang leverer UFM en adgangskde, sm i kmbinatin med den kaldende applikatins ip-adresse giver adgang til webservice mdulet. Bemærk, at adgangen til institutinens SIS data via denne webservice gså kan begrænses ved, at institutinen kan lukke fr webservicen på den enkelte institutinsafdeling lkalt (via SIS-vinduet B936 WebServiceautrisatin), uanset m der er tildelt adgang via UFM. Det lgges centralt, hvilke eksterne parter sm tilgår webservicen. Kald af webservicen WSDL: Metde: WSCallSis Frespørgselsparametrene til WSCallSis gennemgås i den generelle knceptbeskrivelse af webservices fr SIS. Side 2 af 9

3 Kntekst Webservicen kan uplade en fil fra et eksternt system til tabellen PERSO_FILER, give mulighed fr at hente en fil, slette en fil samt liste filer fr en given persn. Eksempel XML-input <?xml versin="1.0" encding="utf-8"?> <!--Sample XML file generated by XMLSpy v2012 rel. 2 (x64) ( <ParameterListe xsi:namespaceschemalcatin="w023_parameterlist.xsd" xmlns:xsi=" <Operatin>U</Operatin> <PefiId></PefiId> <Persn> <Cprr>aaaaaaaaaa</Cprr> <AlternativId></AlternativId> <PersnId></PersnId> <InstitutinsAktivitet>aaaa</InstitutinsAktivitet> <UddannelsesOrdning>aaaa</UddannelsesOrdning> <KtOmrader>aaaaaa</KtOmrader> <Optag>aaaaaaaaaaaaaaa</Optag> </Persn> <UpladFil> <Fil> </Fil> <FilavnInternt>aaaaaaaaaaaaaaaaaaaaaaaa</FilavnInternt> <FilavnBrugervendt>aaaaaaaaaaaaaaaaaaaaaaaa</FilavnBrugervendt> <Type>aaaaaaaaaaaaaaaaaaaa</Type> <Beskrivelse>aaaaaaaaaaaaaaaaaaaaaaaaa</Beskrivelse> <UpladDat> </UpladDat> <FreldelseDat> </FreldelseDat> <Udgaaet></Udgaaet> <Laest></Laest> </UpladFil> <Serviceavn>aaaaaaaaaaaaaaaaaaa</Serviceavn> </ParameterListe> Side 3 af 9

4 Mapning imellem XML-input g SIS tabeller XML-element Database felt Type Beskrivelse Tvungen Operatin - String længde Mulige værdier: 10 tegn 'U','L','H','S' PefiId PERSO_FILER.PEFI_ID umber længde 10 Persn Cprr PERSOER.CPR_R / String længde 10 tegn 'Hent fil' eller 'Slet fil' 'Uplad fil' eller 'List filer' skal præcis ét af elementerne Cprr, PersnId eller AlternativId være udfyldt AlternativId PERSOER.ALTERATIVT _ID String længde 50 tegn 'Uplad fil' eller 'List filer' skal præcis ét af elementerne Cprr, PersnId eller AlternativId være udfyldt PersnId PERSOER.PERS_ID umber længde 10 'Uplad fil' eller 'List filer' skal præcis ét af elementerne Cprr, PersnId eller AlternativId være udfyldt InstitutinsAktivitet COSA_FORMAL.COSA_FO RMAL String max længde 4 InstitutinsAktivitet må kun udfyldes hvis UddannelsesOrdning gså er udfyldt UddannelsesOrdning UDDAELSER.VERSIO String max længde 4 UddannelsesOrdning må kun udfyldes hvis InstitutinsAktivitet gså er udfyldt KtOmrader KOT_OPTAGELSESOMRAD ER.KOT_OPTAGELSESOMRAD ER String max længde 6 tegn 'Uplad fil' g Type er 'Optagelse' Optag OPTAG.OPTAG String max længde 15 tegn 'Uplad fil' g Type er 'Optagelse' UpladFil Fil PERSO_FILER.FILIDHO LD BLOB 'Uplad fil' Side 4 af 9

5 FilavnInternt PERSO_FILER.FILAV_ ITERT String længde 2000 tegn Default 'WS_dkument' FilavnBrugervendt PERSO_FILER.FILAV String længde 2000 tegn Type FILTYPEKARTOTEK.TYPE String længde 20 tegn Default PERSO_FILER.FILA V_ITERT Mulige værdier: Alle typer i tabellen FILTYPEKARTOTEK 'Uplad fil' Beskrivelse PERSO_FILER.BESKRIVE LSE String længde 2000 tegn UpladDat PERSO_FILER.UPLOAD_ DATO Date Frmat YYYY-MM-DD Default SYSDATE FreldelseDat PERSO_FILER.FORELDEL SE_DATO Dat Frmat YYYY-MM-DD Udgaaet PERSO_FILER.UDGAAET String længde 1 tegn Laest PERSO_FILER.LAEST String længde 1 tegn Serviceavn ASOGIGER.OPDIIT String max længde 30 dvs. Serviceavnmå være max 19 Mulige værdier: ''/'' Default '' Mulige værdier: ''/'' Default '' 'Webservice' ' ' Serviceavn Der kan ikke anvendes wildcards i ngle af inputfelterne. Slutvalideringer At det maksimale antal tegn i parameterlistens elementer ikke verskrides (WEB-WA001) At kun gyldige værdier indtastes (WEB-WA005) At persn med alternativt id eksisterer i SIS (WEB-WA008) At persn med CPR-nr. eksisterer i SIS (WEB-WA014) Hvis Uddannelsesrdning udfyldes, skal Institutinsaktivitet være udfyldt.( WEB-WA017) At persn med persid eksisterer i SIS (WEB-WA039) At hvis PersId, Cprr eller AlternativtId g InstitutinsAktivitet g UddannelsesOrdning er udfyldt, tjekkes det, at persnen er prettet sm studerende på uddannelsen uanset m de er aktive eller ikkeaktive (WEB-WA045) At Serviceavn er udfyldt (WEB-WA057) At hvis InstitutinsAktivitet g UddannelsesOrdning er udfyldt, skal denne kmbinatin findes i SIS (WEB-WA063) At KOT-Optagelsesmrådenummer findes i SIS (i A911) (WEB-WA202) Side 5 af 9

6 At Optag findes i SIS (i S113) (WEB-WA224) At Optag g KtOmrader udfyldes hvis Type er 'Optagelse' (WEB-WA250) Præcis ét af elementerne Cprr, PersId eller AlternativId skal være udfyldt (WEB-WA251) At filen med PefiId sm ønskes slettet eksisterer i SIS (WEB-WA252) At det valgte Optag hører til KOT-Optagelsesmrådenummeret (i A911) (WEB-WA253) At Type er udfyldt (WEB-WA254) At Uddannelsesrdning udfyldes hvis Institutinsaktivitet er udfyldt (WEB-WA255) At PefiId er udfyldt (WEB-WA256) At Operatin er udfyldt (WEB-WA257) At Fil er udfyldt (WEB-WA258) At filens størrelse ikke verstiger 50MB (WEB-WA259) At Type eksisterer i SIS (WEB-WA260) Eksempel XML-utput <?xml versin="1.0" encding="utf-8"?> <!--Sample XML file generated by XMLSpy v2012 rel. 2 (x64) ( <Result xsi:namespaceschemalcatin="w023_result.xsd" xmlns:xsi=" <TimeStamp>text</TimeStamp> <ParameterList>text</ParameterList> <W023Resultat> <PefiId></PefiId> <Fil></Fil> <FilListe> <PefiId> </PefiId> <FilavnInternt>aaaaaaaaaaaaaaaaaaaa</FilavnInternt> <FilavnBrugervendt>aaaaaaaaaaaaaaaaaa</FilavnBrugervendt> <Type>aaaaaaaaaaaaaaaaaaaa</Type> <FilStr>aaaaaaa</FilStr> <Beskrivelse>aaaaaaaaaaaaaaaaaaaaaaaaaaa</Beskrivelse> <Oprindelse>aaaaa</Oprindelse> <KtOmrader>aaaaaa</KtOmrader> <Optag>aaaaaaaaaaaaaaa</Optag> <UpladDat> </UpladDat> <FreldelseDat> </FreldelseDat> <Udgaaet></Udgaaet> <Laest></Laest> </FilListe> <Fejl> <FejlKde>text</FejlKde> <FejlTekst>text</FejlTekst> </Fejl> </W023Resultat> </Result> Side 6 af 9

7 Mapning imellem XML utput g SIS tabeller XML-element PefiId Fil FilListe PefiId FilavnInternt FilavnBrugervendt Type FilStr Beskrivelse Oprindelse KtOmrader Optag UpladDat FreldelseDat Udgaaet Laest Database felt PERSO_FILER.PEFI_ID PERSO_FILER.FILIDHOLD PERSO_FILER.PEFI_ID PERSO_FILER.FILAV_ITERT PERSO_FILER.FILAV FILTYPEKARTOTEK.TYPE PERSO_FILER.FILSTR PERSO_FILER.BESKRIVELSE PERSO_FILER.OPRIDELSE KOT_OPTAGELSESOMRADER.KOT_OPTAGELSESOMRADER OPTAG.OPTAG PERSO_FILER.UPLOAD_DATO PERSO_FILER.FORELDELSE_DATO PERSO_FILER.UDGAAET PERSO_FILER.LAEST Prcessering af parameterliste Webservicen skal både kunne uplade, hente g slette en fil eller liste alle filer fr en given persn. Den skal dg kun gøre én af delene ad gangen. Der skelnes mellem de frskellige peratiner ved at kigge på elementet Operatin (WEB-WA257) i parameterlisten: Hvis elementet Operatin = 'U' Skal webservicen uplade en fil fr en given persn: Præcis ét af elementerne Cprr, PersnId eller AlternativId skal være udfyldt (WEB-WA251 samt WEB-WA008, WEB-WA014, WEB-WA039) InstitutinsAktivitet g UddannelsesOrdning er frivillige at udfylde. Udfyldes de tjekkes det at begge felter er udfyldt, at uddannelsen eksisterer i SIS g at persnen er prettet sm studerende på uddannelsen (WEB-WA017, WEB- WA255, WEB-WA063 samt WEB-WA045) Optag g KtOmrader skal udfyldes, hvis Type er 'Optagelse' ellers er elementerne frivillige at udfylde (WEB- WA250, WEB-WA202, WEB-WA224 samt WEB-WA253) Derudver skal sm minimum elementerne Fil (WEB-WA258, WEB-WA259, WEB-WA260 g WEB-WA261), FilavnInternt (WEB-WA262) g Type (WEB-WA254) udfyldes. Hvis uplad af filen går gdt skal PefiId returneres samt en OK meddelelse. Ved fejl returnes en fejlmeddelelse. Ud ver at indsætte værdier sendt med webservicen, skal flg. felter indsættes i tabellen PERSO_FILER: PERSO_FILER.PEFI_ID sættes til PEFI_SEQ.EXTVAL PERSO_FILER.OPRIDELSE sættes til 'WEB' PERSO_FILER.UPLOAD_BRUGER sættes til ' ' Serviceavn Side 7 af 9

8 PERSO_FILER.UPLOAD_DATO sættes til SYSDATE medmindre brugeren har angivet andet i parameteren UpladDat PERSO_FILER.FILAV_ITERT sættes til en defaultværdi medmindre brugeren har angivet andet i parameteren FilavnInternt. Defaultværdien skal være 'WS_dkument'. år der uplades et dkument med et internt filnavn, der allerede eksisterer fr persnen g fr typen, skal der tilføjes et løbenummer der starter med 1 g tælles p med +1. Dvs. hvis defaultværdien anvendes, vil de interne filnavne blive 'WS_dkument', 'WS_dkument1', 'WS_dkument2', 'WS_dkument3' sv, fr den pågældende persn g type. Samme princip skal gøre sig gældende i tilfælde, hvr der er angivet en værdi i parameteren FilavnInternt. PERSO_FILER.FILAV sættes til PERSO_FILER.FILAV_ITERT medmindre brugeren har angivet andet i parameteren FilavnBrugervendt PERSO_FILER.FILSTR findes ud fra filen på samme måde sm i vinduet S105 Filarkiv PERSO_FILER.OPDIIT sættes til 'Webservice ' ' ' Serviceavn PERSO_FILER.OPDTID sættes til SYSDATE PERSO_FILER.OPDMOD sættes til 'W023' Hvis elementet Operatin = 'L' skal webservicen liste alle filer fr en given persn: Præcis ét af elementerne Cprr, PersnId eller AlternativId skal være udfyldt (WEB-WA251 samt WEB-WA008, WEB-WA014, WEB-WA039) Webservicen skal returnere en liste af filer fr den ønskede persn samt en OK meddelelse. Ved fejl returnes en fejlmeddelelse. Hvis elementet Operatin = 'H' skal webservicen hente filen med det angivne PefiId: Elementet PefiId skal være udfyldt (WEB-WA256, WEB-WA252) Webservicen skal returnere den ønskede fil samt en OK meddelelse. Ved fejl returnes en fejlmeddelelse. Hvis elementet Operatin = 'S' skal webservicen slette filen med det angivne PefiId men kun hvis filen er prettet af webservicen dvs. hvis PERSO_FILER.OPRIDELSE er 'WEB'. Elementet PefiId skal være udfyldt (WEB-WA256, WEB-WA252) Hvis sletning af filen går gdt skal webservicen blt returneres OK. Ved fejl returnes en fejlmeddelelse. B. Serviceavn skal udfyldes uanset værdien i elementet Operatin (WEB-WA057) XSD links Link til XSD parameterlist: Link til XSD svar: Side 8 af 9

9 Fejlkder Tjek Fejlkde Fejltekst y? At udtrækket er gået gdt 0 OK - At det maksimale antal tegn i parameterlistens elementer ikke verskrides. WEB-WA001 Du har søgt på et eller flere felter, hvr antallet af tegn verskrides [XML-element liste] At kun gyldige værdier indtastes WEB-WA005 Du har indtastet en værdi sm ikke er tilladt i et eller flere felter [XMLelement liste] At persn med alternativt id eksisterer i SIS WEB-WA008 Persn med alternativt id findes ikke At persn med CPR-nr. eksisterer i SIS WEB-WA014 Persn med CPR-nr. findes ikke At Institutinsaktivitet udfyldes, hvis Uddannelsesrdning er udfyldt WEB-WA017 Hvis Uddannelsesrdning udfyldes, skal Institutinsaktivitet være udfyldt. At persid eksisterer i SIS WEB-WA039 Persn med PersId findes ikke At hvis PersId, Cprr eller AlternativtId g InstitutinsAktivitet g UddannelsesOrdning er udfyldt, tjekkes det, at persnen er prettet sm studerende på uddannelsen uanset m de er aktive eller ikke-aktive WEB-WA045 Persnen findes ikke sm studerende på uddannelsen At Serviceavn er udfyldt WEB-WA057 Serviceavn skal ufyldes Hvis deferred_pack.d_cmmit returnerer en fejl WEB-WA061 Ukendt fejl At hvis InstitutinsAktivitet g UddannelsesOrdning er udfyldt, skal denne kmbinatin findes i SIS WEB-WA063 Kmbinatinen af InstitutinsAktivitet g UddannelsesOrdning findes ikke i SIS At Optag g KtOmrader udfyldes hvis Type er 'Optagelse' WEB-WA250 Optag g KtOmrader skal udfyldes når Type = 'Optagelse' At KOT-Optagelsesmrådenummer findes i SIS (i A911) WEB-WA202 KOT-Optagelsesmrådenummer findes ikke i SIS At Optag findes i SIS (i S113) WEB-WA224 Optag findes ikke i SIS At præcis ét af elementerne Cprr, PersId eller AlternativId udfyldes WEB-WA251 Præcis ét af elementerne Cprr, PersId eller AlternativId skal være udfyldt At filen med PefiId sm ønskes slettet eksisterer i SIS WEB-WA252 Filen findes ikke i SIS At det valgte Optag hører til KOT- Optagelsesmrådenummeret WEB-WA253 Det valgte Optag hører ikke til KOTmrådet At Type er udfyldt WEB-WA254 Type skal ufyldes At Uddannelsesrdning udfyldes hvis Institutinsaktivitet er udfyldt WEB-WA255 Hvis Institutinsaktivitet udfyldes, skal Uddannelsesrdning være udfyldt At PefiId er udfyldt WEB-WA256 PefiId skal udfyldes At Operatin er udfyldt WEB-WA257 Operatin skal udfyldes At Fil er udfyldt WEB-WA258 Fil skal udfyldes At filens størrelse ikke verstiger 50MB WEB-WA259 Der kan kun uplades filer, hvis størrelse er 50MB eller mindre Side 9 af 9