Ga naar hoofdinhoud

K005 - Koppeling

Beschrijving​

Koppelingen beschrijven de technische integraties tussen applicaties (modules) onderling en/of met buitengemeentelijke voorzieningen. Hetzelfde koppeling object wordt gebruikt voor zowel het aanbod (welke koppelingen zijn beschikbaar voor een applicatie) als voor het gebruik (welke koppelingen hebben afnemers daadwerkelijk geïmplementeerd).

Schema Eigenschappen​

naam
string (Naam)

Naam van de koppeling

beschrijvingKort
string (Samenvatting)

Korte beschrijving van de koppeling

beschrijvingLang
string <markdown> (Beschrijving)

Uitgebreide beschrijving van de koppeling

type
string (Type)
Enum: "n.v.t." "bestandsoverdracht" "digikoppeling" "message que" "upload naar portaal" "webservices" "api"

Het type koppeling, bijvoorbeeld 'bestandsoverdracht', 'digikoppeling', of 'api'.

status
string (Status)
Enum: "in ontwikkeling" "in gebruik" "einde ondersteuning" "teruggetrokken"

De status van de koppeling

datumInOntwikkeling
string <date> (Datum In Ontwikkeling)

Startdatum van de ontwikkelingsfase

datumInGebruik
string <date> (Datum In Gebruik)

Startdatum van gebruik

datumEindeOndersteuning
string <date> (Datum Einde Ondersteuning)

Startdatum einde ondersteuning

datumTeruggetrokken
string <date> (Datum Teruggetrokken)

Datum waarop de koppeling teruggetrokken is

gegevensuitwisselingRichting
string (Gegevensuitwisseling Richting)
Enum: "AnaarB" "BnaarA" "bi-directioneel"

De richting van de gegevensuitwisseling

object (Module)

Een module is een softwarecomponent (applicatie of systeemsoftware)

object (Module)

Een module is een softwarecomponent (applicatie of systeemsoftware)

object (Element)

AMEF Element - Architectuur elementen uit het ArchiMate model

Array of objects (Standaard Versies)

Standaardversies die door deze koppeling geïmplementeerd worden

object (Module)

Een module is een softwarecomponent (applicatie of systeemsoftware)

object (Organisatie)

Een organisatie die voorzieningen aanbiedt

object (Dienst)

Een specifiek aanbod van een dienst op een of meerdere modules door een leverancier

{
  • "naam": "Bijvoorbeeld: API Koppeling",
  • "beschrijvingKort": "Bijvoorbeeld: Korte beschrijving van de koppeling",
  • "beschrijvingLang": "Bijvoorbeeld: Uitgebreide beschrijving van de koppeling",
  • "type": "Bijvoorbeeld: api",
  • "status": "in ontwikkeling",
  • "datumInOntwikkeling": "Bijvoorbeeld: 2025-01-01",
  • "datumInGebruik": "2019-08-24",
  • "datumEindeOndersteuning": "2019-08-24",
  • "datumTeruggetrokken": "2019-08-24",
  • "gegevensuitwisselingRichting": "AnaarB",
  • "moduleA": {
    },
  • "moduleB": {
    },
  • "buitengemeentelijkVoorziening": {
    },
  • "standaardversies": [
    ],
  • "gerealiseerdMetIntermediairModule": {
    },
  • "aanbieder": {
    },
  • "dienst": {
    }
}

Relaties​

Modules (Applicaties)​

  • Module A: De bron module waarvan gegevens worden uitgewisseld
  • Module B: De doel module waarnaar gegevens worden uitgewisseld (optioneel)
  • Intermediair Module: Module die wordt gebruikt voor realisatie van de koppeling

Buitengemeentelijke Voorzieningen​

  • Buitengemeentelijke Voorziening: Externe voorziening waarmee wordt gekoppeld (alternatief voor Module B)

Organisatie en Diensten​

  • Aanbieder: De organisatie die de koppeling aanbiedt
  • Dienst: De dienst die deze koppeling gebruikt

Standaarden​

  • Standaardversies: Standaarden die door deze koppeling worden geïmplementeerd

Koppeling Types​

Het schema ondersteunt de volgende koppeling types:

🔌 API​

Moderne REST of GraphQL API koppelingen voor real-time data uitwisseling.

🌐 Webservices​

SOAP-gebaseerde webservice koppelingen, vaak gebruikt voor overheidsstandaarden.

📁 Bestandsoverdracht​

Batch-gebaseerde uitwisseling via bestanden (CSV, XML, etc.).

🔗 DigiKoppeling​

Overheidsstandaard voor veilige gegevensuitwisseling tussen overheden.

📨 Message Queue​

Asynchrone berichtuitwisseling via message brokers.

🌐 Upload naar portaal​

Handmatige of geautomatiseerde upload naar webportalen.

❓ N.v.t.​

Voor koppelingen waar het type niet van toepassing is of onbekend.

Koppeling Status​

De koppeling doorloopt verschillende statussen die de levenscyclus weergeven:

🛠️ In ontwikkeling​

De koppeling wordt ontwikkeld en getest.

Kenmerken:

  • Technische specificatie wordt uitgewerkt
  • Ontwikkeling en testing in gang
  • Nog niet beschikbaar voor productie gebruik

✅ In gebruik​

De koppeling is operationeel en beschikbaar voor gebruik.

Kenmerken:

  • Volledig getest en goedgekeurd
  • Beschikbaar voor implementatie door afnemers
  • Documentatie en support beschikbaar

⚠️ Einde ondersteuning​

De koppeling wordt niet meer actief ondersteund maar is nog beschikbaar.

Kenmerken:

  • Geen nieuwe features of updates
  • Beperkte support beschikbaar
  • Migratie naar alternatief wordt aanbevolen

🔚 Teruggetrokken​

De koppeling is niet meer beschikbaar.

Kenmerken:

  • Volledig uitgefaseerd
  • Geen ondersteuning meer
  • Alternatieve oplossing vereist

Gegevensuitwisseling Richting​

A naar B​

Gegevens stromen van Module A naar Module B (of buitengemeentelijke voorziening).

B naar A​

Gegevens stromen van Module B (of buitengemeentelijke voorziening) naar Module A.

Bi-directioneel​

Gegevens kunnen in beide richtingen stromen.

Gerelateerde Concepten​

Persona Perspectief​

🏛️ Voor Gemeenten (Maria - ICT-coördinator)​

  • Doel: Overzicht van alle integraties in het applicatielandschap
  • Gebruik: Inzicht in afhankelijkheden en risico's van koppelingen
  • Belang: Impact analyse bij wijzigingen en uitval scenario's

🏢 Voor Leveranciers (Jan - Directeur ICT Solutions)​

  • Doel: Koppelingen aanbieden en beschikbaar stellen
  • Gebruik: Integratie mogelijkheden van eigen applicaties registreren
  • Belang: Interoperabiliteit en ecosysteem participatie

🤝 Voor Samenwerkingen (Linda - Samenwerking Coördinator)​

  • Doel: Gestandaardiseerde koppelingen voor leden
  • Gebruik: Koppelingen definiëren die door meerdere leden gebruikt worden
  • Belang: Efficiëntie en consistentie in integraties

🔒 Voor Security Officers (Mark - Information Security Officer)​

  • Doel: Security aspecten van data uitwisseling beoordelen
  • Gebruik: Koppelingen controleren op veilige data overdracht
  • Belang: Data beveiliging en compliance waarborgen

🏗️ Voor Architectuur Experts (Sarah - Enterprise Architect)​

  • Doel: Architectuur compliance van integraties valideren
  • Gebruik: Standaarden en protocollen van koppelingen beoordelen
  • Belang: Interoperabiliteit en architectuur consistentie

Gerelateerde Functionaliteiten​

Koppeling Wizard​

De Koppeling wizard begeleidt gebruikers door het proces van het definiëren van een nieuwe integratie tussen applicaties.