** Implementatiehandleiding automatische organisatie-import (SFTP)
Inleiding
In dit document vindt u informatie met betrekking tot de geautomatiseerde import van organisatie-eenheden naar TriasWeb.
U legt eenmalig een verbinding via SFTP met een map op onze FTP-servers. In die map plaatst u, al dan niet geautomatiseerd en zo vaak u wilt, uw bestand met organisatiegegevens (OEs). Onze servers lezen enige malen per dag de map uit en verwerken de bestanden. Via onze importmodule worden nieuwe OEs in TriasWeb geĆÆmporteerd en bestaande OEs gemuteerd indien de gegevens in het aangeleverde bestand afwijken van die in TriasWeb. OEs die vervallen zijn worden gedeactiveerd. Uw bestand wordt bewaard onder een andere naam, zodat de geschiedenis bewaard blijft. U kunt zelf de logfiles van de import bekijken als u wilt.
Waarden die geĆÆmporteerd of gemuteerd kunnen worden zijn Extern ID, afdelingsnaam, koppelcode, kostenplaats, bovenliggende OE en hoofdverantwoordelijke.
Organisatiebestand
Om deze geautomatiseerde import te realiseren dient u een bestand aan te leveren (via SFTP) met daarin de te importeren gegevens.
De specificaties waaraan dit bestand dient te voldoen zijn:
Opgeslagen in UTF-16/Unicode (16).
Kolommen in willekeurige volgorde.
Het is niet erg als er in het bestand meer kolommen staan dan verwerkt dienen te worden, zolang daar maar geen gevoelige persoonsgegevens staan (ihkv de AVG)
Het aantal velden in de kopregel moet gelijk zijn aan het aantal velden in de overige regels in het bestand.
Gebruik van kopregel is optioneel.
Door puntkomma gescheiden kolommen
De in te lezen waarden zijn:
OE-code (verplicht, uniek, primaire sleutel, alfanumeriek).
OE-naam (alfanumeriek, verplicht).
Kostenplaats (numeriek, optioneel).
Koppelcodes (alfanumeriek, optioneel, door kommaās gescheiden). Indien uw organisatie gekozen heeft om de autorisatiemodus aan te zetten, is dit een verplicht veld. Op basis van deze waarde worden autorisaties vastgesteld.
Hoofdverantwoordelijke (e-mailadres, optioneel). Indien hoofdverantwoordelijke bij een of meerdere OEs niet is aangeleverd, wordt aan die OEs indien nodig, de standaard hoofdverantwoordelijke toegekend (zie onder).
MoederOE (alfanumeriek, verplicht voor locaties en afdelingen, moet leeg zijn voor Hoofdorganisaties)
Ā
Als we uitgaan van onderstaande structuur, zou het bestand daaronder aangeleverd moeten worden.
Ā
Voorbeeld bestand met kopregel
OEcode;Naam;Kostenplaats;Koppelcodes;Hoofdverantwoordelijke;MoederOE
10;Intramuraal;123;10;;
100;Utrecht centrum;453;100;a.locatiemanager@amberzorg.nl;10
1000;Kersentuin Rood;888;1000;hoofd1@amberzorg.nl;100
200;Utrecht Oost;222;200;a.locatiemanager@amberzorg.nl;10
2000;Appelhof 1;237;2000;hoofd1@amberzorg.nl;200
2001;Appelhof 2;1075;2001;hoofd2@amberzorg.nl;200
50;Extramuraal;;50;;
500;Utrecht;;500;b.locatiemanager@amberzorg.nl;50
5000;Witte vrouwen;;5000;hoofd3@amberzorg.nl;500
5001;Overvecht;;5001;hoofd4@amberzorg.nl;500
600;Hilversum;24;600;c.locatiemanager@amberzorg.nl;50
6000;Centrum;7788;6000;hoofd3@amberzorg.nl;600
Verwerken van gegevens
Nieuwe OEs
Het Extern ID is de sleutel van het bestand. Ofwel, onze importfunctie kijkt of het Extern ID al bestaat binnen TriasWeb. Als dat niet zo is, dan gaat het om een nieuwe OE. Het Extern ID en de bijbehorende gegevens worden opgeslagen in TriasWeb. De OE wordt automatisch op 'actief' gezet. Voor het toevoegen van de verantwoordelijke, zie hieronder.
Bestaande OEs
De update van bestaande OEs gaat op basis van Extern ID. Indien het Extern ID bekend is in TriasWeb (de OE is dan al eerder in TriasWeb ingevoerd), wordt de bijbehorende naam in TriasWeb overschreven met de naam die in het bestand staat. Ook koppelcodes en kostenplaats (indien deze zijn toegevoegd) worden overschreven. Het Extern ID wordt niet gewijzigd. Voor wijzigingen van de verantwoordelijke, zie hieronder.
Standaard worden OEs die in het aangeleverde bestand staan, geactiveerd. Ook indien de OE voordien niet actief was (gedeactiveerd) zal hij na de verwerking van het bestand actief zijn. In de tabel onderaan dit document vult u in of u OEs in het bestand WEL automatisch wilt activeren zoals beschreven, of dat u dat NIET wilt.
OEs die niet meer gebruikt worden
Standaard deactiveren we alle OEs van uw organisatie die niet in het aangeleverde bestand voorkomen. Als u handmatig een OE deactiveert die wel in het bestand staat, wordt deze bij de volgende import weer op actief gezet, behalve wanneer u het vinkje āHandmatig deactiverenā aan zet.
Een OE die deactief is, kan niet meer gekozen worden bij het doen van een melding. Echter, het is wel mogelijk om te analyseren op deze OEs, want ze blijven wel zichtbaar in de rapportages en de analyseschermen.
Verantwoordelijke koppelen
U levert een standaard verantwoordelijke aan (zie workflow) die gebruikt wordt indien er geen andere verantwoordelijke beschikbaar is voor een OE.
Indien er een verantwoordelijke is meegeleverd voor de OE, en de verantwoordelijke is actief en heeft de rol van afdelingsbeheerder of hoger, dan wordt deze verantwoordelijke gekoppeld aan de OE.
Indien geen verantwoordelijke is meegeleverd voor de OE, wordt de standaard verantwoordelijke als verantwoordelijke aan de OE gekoppeld.
Let op, bij een OE waarvan alleen de kostenplaats wijzigt kan de verantwoordelijke toch wijzigen. Dat gebeurt als er een verantwoordelijke gekoppeld is die niet actief is of niet de juiste rol heeft. Bij het opslaan van de wijzigingen (kostenplaats in dit geval) wordt namelijk door de importfunctie ook gecontroleerd of de verantwoordelijke de juiste rol heeft en actief is. Als dat niet zo is, wordt de standaard verantwoordelijke toegewezen.
Let op! Indien u gebruik maakt van e-mailtriggers naar bovenliggende organisatieonderdelen (dus van afdeling een niveau omhoog naar de locatie, of twee niveaus omhoog naar de hoofdorganisatie) en de standaard verantwoordelijke wordt gekoppeld aan de locatie of de hoofdorganisatie, dan wordt de standaard verantwoordelijke de nieuwe ontvanger van de e-mailtrigger.
Overstappen van handmatige invoer naar automatische import
Let op, wanneer u de organisatiegegevens voorheen handmatig heeft ingevuld, zijn er geen Extern IDās aanwezig. Aangezien TriasWeb aangeleverde en bestaande OEs vergelijkt op basis van het Extern ID, dienen eerst de Extern IDs toegevoegd te worden. Dat kan door middel van een handmatige actie gebeuren (bij elke OE in TriasWeb een Extern ID invullen) of via een conversie. Meer informatie hierover kunt u opvragen via info@triaspect.nl.
Controle op verwerking
U kunt ervoor kiezen om een e-mail te ontvangen wanneer uw bestand niet is aangekomen op onze server. Als parameter kunt u opgeven per hoeveel dagen dat moet gebeuren. Indien u eens per week de gegevens uploadt, wilt u niet elke dag een e-mail krijgen waarop de gegevens niet zijn geĆ¼pload. U geeft dan aan dat u eens per 7 dagen een controle wilt doen. Wij kijken dan of er een bestand staat dat maximaal 7 dagen oud is. Als het bestand ouder is, dan is de laatste upload dus niet goed gegaan.Wanneer u elke dag uploadt is de waarde van de parameter altijd 1.
We kunnen ook kijken of de verwerking goed gegaan is, en u een e-mail sturen wanneer dat niet zo is.
In de tabel onderaan dit document kunt u invullen of u hiervan gebruik wenst te maken.
Beveiliging
Indien gewenst kunnen we de SFTP verbinding opzetten met public key authenticatie. We ondersteunen diverse algoritmes. Meer informatie hierover is te verkrijgen via info@triaspect.nl.
Workflow
Om deze import tot stand te brengen dient er communicatie te zijn tussen de technische afdeling van Triaspect en de ICT dienst van uw organisatie. Hieronder kunt u zien wat u op welk moment moet aanleveren en wat wij er dan mee doen.
Uw organisatie | Triaspect |
Optioneel: stuurt een public key | |
Ā | Zet een SFTP-configuratie op en stuurt u uw inloggegevens voor de test-upload. |
Upload een testbestand met OE-gegevens. Op basis van dit bestand richt TriasWeb de import in. Bestandsnaam, kolomvolgorde en het al dan niet gebruik maken van header-regels ligt dan vast. | |
Controleert het testbestand en doet een import in een testomgeving. | |
Geeft aan
| |
Zet de gegevens import op de live omgeving |
Ā