Gebruikershandleiding NCIS Webportaal

Introductie

Het NCIS webportaal is een website voor het aanleveren of afnemen van datastromen van NCIS (NDW's applicatie voor realtime gegevenslevering). In dit document is beschreven hoe - door middel van het aanmaken van een contract of abonnement - met een directe aansluiting op het NDW-systeem NCIS data ontvangen of geleverd kan worden (voorbehouden voor specifieke leveranciers/afnemers). Hiervoor dient eerst ingelogd te worden door middel van een iam.ndw.nu account (beschreven in het hoofdstuk Inloggen), waarna gebruik kan worden gemaakt van de volgende hieronder beschreven functionaliteiten:

• Afnemen van NCIS data (beschreven in het onderdeel Abonnement);
• Leveren van data aan NCIS (beschreven in het onderdeel Contract).

Inloggen

Voordat u gebruik kunt maken van de functionaliteiten van het webportaal, moet u eerst inloggen met uw iam.ndw.nu inloggegevens.

Het NCIS webportaal kunt u bereiken door te navigeren naar https://ncis.ndw.nu/. U krijgt dan de volgende pagina te zien.

Vul bij de velden E-mail adres en Wachtwoord de iam.ndw.nu inloggegevens van uw account in. Mocht u uw inloggegevens niet meer weten, kunt u klikken op Wachtwoord vergeten? of contact opnemen met de NDW Servicedesk.

Wanneer u succesvol bent ingelogd, komt u terecht op de Dashboard pagina.

Vanaf de Dashboard pagina kunt u gebruikmaken van de voor u beschikbare functionaliteiten van het NCIS webportaal.

Abonnement

Om data van NCIS af te kunnen nemen, moet u door middel van een abonnement een verbinding met NCIS leggen. Alle functionaliteiten met betrekking tot abonnementen kunt u bereiken van de overzichtspagina van abonnementen. Hieronder is per functionaliteit beschreven wat deze inhoudt en hoe u er gebruik van kunt maken. De beschikbare functionaliteiten zijn:

• Overzichtspagina (beschreven in het onderdeel Abonnementen overzicht);
• Nieuw abonnement aanmaken (beschreven in het onderdeel Nieuw abonnement);
• Bestaand abonnement wijzigen (beschreven in het onderdeel Abonnement aanpassen);
• Bestaand abonnement verwijderen (beschreven in het onderdeel Abonnement verwijderen).

Abonnementen overzicht

Op de overzichtspagina voor abonnementen is een tabel met alle aangemaakte abonnementen te zien. Ook kunt u vanaf deze pagina de andere functionaliteiten voor abonnementen bereiken.

De overzichtspagina voor abonnementen kunt u bereiken door te klikken op het woord Abonnementen in de menubalk bovenaan de pagina.

In de abonnementenlijst is een overzicht van alle aangemaakte abonnementen te zien. Daarnaast is per abonnement ook in kolommen weergegeven:

• ID: het id van het abonnement;
• Eindproduct: het product waaraan het abonnement gekoppeld is (zie ook Nieuw abonnement);
• Naam: de naam of referentie van het abonnement (zie ook Nieuw abonnement);
• Filter formulier: de naam van het aan het abonnement toegevoegde filter;
• Organisatie: de naam van de organisatie die het abonnement afneemt;
• Implementatie: de voor het abonnement geselecteerde implementatie (zie ook Nieuw abonnement);
• URL: de URL waarmee de data afgenomen kan worden (zie ook Nieuw abonnement);
• Geactiveerd op: de datum waarop het abonnement geactiveerd is;
• Status: de huidige status van het abonnement. Een abonnement kan zich bevinden in de statussen Actief, Wacht op goedkeuring, Aan het updaten en Uitgeschakeld.

Per onderdeel (met uitzondering van de kolom Status) kunt u ook zoeken, filteren, sorteren en de volgorde en/of grootte van de kolommen aanpassen. Door op een rij te klikken kunt u navigeren naar de bewerkingspagina van het desbetreffende abonnement (zie ook Abonnement aanpassen).

Push vs pull abonnement

Bij het afnemen van NCIS data heeft u soms de keuze tussen een push of pull abonnement. Kort gezegd houdt push in dat de data rechtstreeks aan u geleverd wordt, terwijl u bij een pull abonnement zelf de data ophaalt. Afhankelijk van de datastroom en het bijbehorende data-afneem protocol kan een push of pull abonnement voor u een iets andere betekenis hebben. Documentatie van de verschillende protocollen kunt u hier vinden: interface-beschrijvingen. Raadpleeg verder alstublieft de gebruikershandleiding van de datastroom die u wilt afnemen voor meer informatie. Hieronder zijn de meest standaard betekenissen van de push en pull-opties van NCIS abonnementen beschreven.

• Een pull abonnement houdt in dat u zelf een URL moet raadplegen om de data op te halen. De inhoud van deze data is een periodiek gegenereerd snapshot die het volledige beeld van de data van dat moment bevat. Hierin zitten dus niet eventuele updates die na de laatste generatie van het snapshot hebben plaatsgevonden.
• Een push abonnement houdt in dat data naar u wordt verstuurd. Hierbij dient een verbinding opgezet te worden conform het gebruikte protocol, waarlangs een snapshot opgevraagd kan worden en wijzigingen direct geleverd worden.

Nieuw abonnement

Om NCIS data te kunnen afnemen, moet u een abonnement aanmaken in het webportaal. Hieronder is stap voor stap beschreven hoe u dat kunt doen.

Klik vanaf de overzichtspagina voor abonnementen (zie Abonnementen overzicht) op de knop Abonnement toevoegen om een nieuw abonnement te kunnen aanmaken.

U krijgt dan de volgende pagina te zien.

Afhankelijk van de datastroom en de voor u beschikbare functionaliteiten, zijn de velden op deze pagina aan te passen. In de gebruikershandleiding van de datastroom die u wilt afnemen, kunt u meer informatie vinden over de beschikbare velden van de desbetreffende stroom. Hieronder volgt een algemene beschrijving van de meest gebruikte velden (het is dus mogelijk dat onderdelen hiervan niet voor u van toepassing zijn):

• Bij het veld Referentie bent u vrij om zelf een naam te geven aan uw abonnement;
• Bij de keuzelijst onder Organisatie kunt u, afhankelijk van de voor u beschikbare opties, de organisatie kiezen waarvoor u dit abonnement aanmaakt;
• Bij de keuzelijst onder Product selecteert u de datastroom die u wilt afnemen;
• Bij de keuzelijst onder Implementatie kunt u kiezen in welke vorm u de data af wilt nemen. Dit is niet bij alle datastromen mogelijk, maar indien beschikbaar kunt u met dit veld een keuze maken tussen een push of een pull abonnement. Onder het kopje Push vs pull abonnement kunt u een uitleg vinden over de verschillen tussen deze twee vormen van het afnemen van data.
  • Pull: indien u gebruik maakt van de mogelijkheid tot een pull abonnement, verschijnen er na dat u de in de gebruikersdocumentatie van uw stroom aangegeven combinatie van 'Product' en 'Implementatie' heeft geselecteerd, nieuwe velden die u in de volgende stappen gaat gebruiken om zich te authenticeren om de data af te kunnen nemen.
  • Push: indien u gebruik maakt van de mogelijkheid tot een push abonnement, verschijnen er na dat u de in de gebruikersdocumentatie van uw stroom aangegeven combinatie van 'Product' en 'Implementatie' heeft geselecteerd, nieuwe velden die u in de volgende stappen gaat gebruiken om de data op te ontvangen.
• Bij het veld Toelichting bent u vrij om, indien gewenst, een toelichting of extra informatie aan het abonnement toe te voegen. Dit is uitsluitend voor uzelf, wat u hier invult heeft verder geen invloed op de configuratie van het abonnement.
• Onder het kopje Filtering kunt u, indien voor de datastroom beschikbaar, een filter toevoegen aan uw abonnement. Hierdoor ontvangt u niet de volledige datastroom, maar kunt u ervoor kiezen alleen data van een door u gekozen geografisch gebied te ontvangen.
• Andere velden kunnen, afhankelijk van de datastroom en voor u beschikbare opties, mogelijk verschijnen wanneer u bepaalde velden geselecteerd heeft.

Nadat u alle velden heeft ingevuld, ziet de pagina er bijvoorbeeld als volgt uit.

Klik onderaan de pagina op de oranje knop Opslaan om het abonnement met de gekozen instellingen op te slaan. U komt weer op de overzichtspagina voor abonnementen terecht. Onder het kopje Abonnementen overzicht kunt u daar meer informatie over vinden.

Het abonnement is nu aangemaakt, maar nog niet direct actief. Het duurt zo'n 10 minuten totdat u data van NCIS af kunt nemen met een nieuw aangemaakt abonnement.

Abonnement aanpassen

Een eerder aangemaakt abonnement kunt u indien gewenst ook wijzigen. Klik in de tabel op de overzichtspagina voor abonnementen (zie Abonnementen overzicht) op de rij van het abonnement dat u aan wilt passen. U komt nu terecht op een pagina met dezelfde layout als de pagina voor het aanmaken van een nieuw abonnement (zie Nieuw abonnement), maar dan met de eerder door u ingevulde velden en gekozen instellingen al ingevuld. Deze pagina ziet er bijvoorbeeld als volgt uit.

Vanaf deze pagina heeft u dezelfde mogelijkheden als u eerder had bij het aanmaken van een nieuw abonnement. Onder het kopje Nieuw abonnement kunt u uitleg over de meest voorkomende velden vinden. In de gebruikershandleiding van de datastroom die u wilt afnemen, kunt u meer informatie vinden over de beschikbare velden van de desbetreffende stroom.

Klik onderaan de pagina op de oranje knop Opslaan zodra u de instellingen van uw abonnement naar wens aangepast heeft. Hiermee komt u weer op de overzichtspagina voor abonnementen terecht. Onder het kopje Abonnementen overzicht kunt u daar meer informatie over vinden.

Het abonnement is nu aangepast, maar deze wijzigingen zijn nog niet direct actief. Het duurt zo'n 10 minuten totdat u data van NCIS af kunt nemen met de instellingen van uw aangepaste abonnement.

Abonnement verwijderen

Een eerder aangemaakt abonnement kunt u indien gewenst ook verwijderen. Klik in de tabel op de overzichtspagina voor abonnementen (zie Abonnementen overzicht) op de rij van het abonnement dat u wilt verwijderen. U komt nu terecht op een pagina met dezelfde layout als de pagina voor het aanmaken van een nieuw abonnement (zie Nieuw abonnement), maar dan met de eerder door u ingevulde velden en gekozen instellingen al ingevuld. Klik om het abonnement te verwijderen onderaan de pagina op de rode knop Verwijderen. Deze ziet er als volgt uit.

Het abonnement is nu aangemerkt als verwijderd, maar nog niet direct verdwenen. Het duurt zo'n 10 minuten totdat uw abonnement volledig verwijderd is.

Let op: deze handeling kan niet meer ongedaan gemaakt worden. Zodra u op Verwijderen heeft geklikt, is uw abonnement definitief verwijderd en zult u een nieuw abonnement met dezelfde instellingen als u hiervoor had gekozen aan moeten maken om dit te herstellen.

Contract

Hier wordt in de toekomst informatie over het aanmaken van een contract toegevoegd.