Verwerken OLO-bijlagen vanuit digi-koppelaar
Voor het uploaden vanuit de digi-koppelaar van OLO-bijlagen naar OpenWave is een endpoint aanwezig.
Authenticatie op het endpoint vindt plaats met een username en password, met HTTP AUTH Basic. De bestanduploads hebben per upload twee parameters nodig: de filename en het OLO-nummer waar het bestand bij hoort.
De bestandsupload is een POST request (enctype=“multipart/form-data). De twee parameters kunnen in de POST payload of als GET parameter worden meegestuurd.
Voorbeeld
Een voorbeeld:
- a) filename='test.docx'
- b) OLO-nummer='0123456789'
- Een voorbeeldaanroep in het geval van een request met twee GET parameters:
https://[serveradres]/OLO_upload/olo_upload.php?filename=test.docx&olonummer=0123456789
Verwerken OLO-bijlagen
De olo_upload.php-luisterservice plaatst de binnengekomen file op een andere map op de webserver. Deze map is gedefinieerd in kolom Tekst van de instelling: Sectie: OWB Item: TussenMapOloUploadfiles. In de kolom Tekst staat de mapnaam op de webserver: deze mapnaam MOET eindigen op de karakterreeks: '/openwave/uploadolo/' en beginnen met een '/'. De luisterservice roept hiertoe de API getAuthorisation aan en daarna met de verkregen sessie-sleutel de API geefInstellingen (om de OloUploadmap op te halen) en tenslotte de API Uploadfile.
Adres en poort waar deze OpenWave API's staan te luisteren staan in de map config in de file openwave.ini op dezelfde machine als de luisterservice. Dit is een systeembeheerinstelling.
De user/pass waarmee getAuthorisation aangeroepen wordt (dezelfde als afgesproken met de leverancier van het document) moet wel opgenomen zijn in de medewerkerstabel waarbij:
- de user toegang moet hebben tot de browserversie
- EN passworddatum verloopt nooit aangevinkt is
- EN de kolom 2-factor authentication opheffen aangevinkt is
- EN de user lid is van een rechtengroep die minimaal bij de omgevingszaken het recht Creëren en uploaden documenten aangevinkt heeft staan
- EN de user lid is van een rechtengroep die minimaal op één van de modules (bouw/sloop, horeca, handhavingen, APV/overig/ milieu/gebruik/ info, omgeving of inrichtingen) kijkrechten heeft.
Alle overige rechten kunnen dus uitgevinkt staan voor deze medewerker.
De luisterservice roept nu per document de API uploadfile aan. De API uploadfile moet - naast de parameter paramidentifier met daarin de filenaam - voorzien worden van de parameter paramauto die aangeeft welk automatisch proces een document probeert op te slaan. Het luisterproces geeft de waarde 'OLO' door en als paramidentifier de documentnaam opgebouwd volgens het masker olonr_filenaam. Dus bijvoorbeeld 123456_Plaatje.jpg.
Zo gauw de API uploadfile de focus heeft worden alle files die op de TussenMapOloUploadfiles staan en die een filedatum/timestamp hebben ouder dan het aantal uren hetgeen is ingesteld in Getal1 van de instelling van Sectie: OWB en Item: MaxUurUpload, verwijderd.
Het OLO-nummer wordt gebruikt om de Omgevingszaak te traceren (tbomgvergunning.dvlvonr) en daarbij eventueel het nodige externe zaak/DMS nummer op te halen (dvintzaakcode). Aangezien deze laatste ook door automatische processen worden aangemaakt kan er een vertraging wenselijk zijn: als het programma het OLO-nummer niet kan vinden of aan het OLO-nummer is nog geen externe zaakidentificatie gekoppeld dan kan in een loop nog een aantal maal een poging worden gedaan. Deze loop is qua aantal en wachtduur instelbaar met de instelling Sectie: KoppelingDOCNAARDMS en Item: WachtOpExtAantalSeconden. In Getal1staat het aantal seconden dat gewacht wordt (default 2, maar aanbevolen: 180) alvorens opnieuw te zoeken en in Getal2 staat het aantal maal dat dat herhaald mag worden (default 5, maar aanbevolen: 3).
Er is een extra instelling m.b.t. OLO-nummer en prefix bij Vooroverleg. De kolom Tekst van de instelling Koppeling OLO en Item: Vooroverleg moet dan gevuld zijn met een tekst waarvan de lengte kleiner of gelijk 5 is. OpenWave kijkt of het OLO-nummer bestaat. Zo ja, dan worden de documenten bij de omgevingskaart met dat OLO-nummer geplaatst. Zo nee, dan kijkt OpenWave of er een prefix is ingesteld en – indien dat het geval is EN de instelling Sectie: Koppeling OLO en Item: Vooroverleg is ook aangevinkt – dan wordt het OLO-nummer nogmaals gezocht met de prefix eraan vastgeplakt.
Indien:
- er op één OLO-nummer meerdere adviesaanvragen (vrgDi01AanvragenAdvies) binnenkomen, waarbij ook meerdere zaken worden aangemaakt (instelling Sectie: Koppeling OLO Item: MeerdereAdviesaanvragen is aangevinkt)
- EN dat de bijlages eerder worden verwerkt dan het leverenaanvraag bericht van dat OLO-nummer (omvDu01LeverenAanvraag), hetgeen OpenWave niet in de hand heeft
kan het zijn dat er extra controle nodig is om ervoor te zorgen dat de bijlages niet bij de verkeerde zaak terechtkomen. OpenWave kan die extra check doen indien bijlages ook worden geregistreerd in tbcorrespondentie (indien dus Sectie: Documentregisteren en Item: AlleOLODSOUploads is aangevinkt). OpenWave kijkt - indien ook de instelling Sectie: Koppeling OLO en Item: CheckOpDubbeleDocumentnaam is aangevinkt - in dat geval of de documentnaam reeds voorkomt in de geregistreerde documenten bij de gevonden zaak (kolom dvdocfilenaam). Zo ja, dan wordt het document niet geplaatst en wel een kaart gemaakt in tabel mislukte OLO/DSO-bijlages.
Het daadwerkelijk plaatsen van de file (op fileshare of Stuf zaak/DMS) gaat gelijk aan het beschrevene in het lemma Upload document(en), waarbij het volgende extra geldt:
- bij plaatsing via fileshare kijkt het programma naar de unieke map gedefinieerd door Sectie: AanmaakMappen en Item begint met 'Omgeving_' EN Getal2 = 1
- bij plaatsing via STUF Zaken kijkt het programma wat betreft het documenttype indien er GEEN compartiment van toepassing is naar kolom Tekst van instelling Sectie: KoppelingDOCNAARDMS en Item: OloDocType (defaultwaarde 'OLO'), indien er WEL compartiment van toepassing is naar de tekst in het veld OLO/DSO documenttype in het detailscherm van de compartimentsrechten in het beheerportaal-Nieuw
- bij plaatsing via STUF Zaken kijkt het programma ook wat betreft metadata vertrouwelijkheid indien er GEEN compartiment van toepassing is naar kolom Tekst van instelling Sectie: KoppelingDOCNAARDMS en Item: OloVertrouwelijkheid (defaultwaarde 'OPENBAAR') en indien er WEL compartiment van toepassing is naar de tekst in het veld OLO/DSO vertrouwelijkheid in het detailscherm van de compartimentsrechten in het beheerportaal-Nieuw
- wat betreft Auteur bij StUF zaken: deze krijgt de waarde onbekend
- indien zowel is ingesteld dat documenten op de fileserver geplaatst kunnen worden als in een DMS, dan zullen de OLO-bijlages in het DMS worden geplaatst, tenzij de instelling Sectie: Koppeling OLO en Item: BestandenNaarFileserver aangevinkt is: dan krijgt de fileserver-variant de voorkeur.