Spelregels Afspraken

Uit ROSA Wiki
Naar navigatie springen Naar zoeken springen

Deze pagina is vastgesteld door Architectuurraad, op 20 april 2023.

Bekijk ook Afspraak in het ROSA metamodel voor meer informatie over dit type architectuurelement.

Criteria voor het opnemen van een Afspraak[bewerken]

  • Een afspraak is gepubliceerd op Edustandaard.nl en heeft daar de status “geregistreerd” of “aangemeld”.
  • Een afspraak gepubliceerd op Edustandaard.nl met het gebruiksadvies "verplicht”, “aangeraden”, “onbekend” of “onder voorwaarden” en voldoet ook aan bovenstaand criterium.
  • Afspraken gepubliceerd op Edustandaard.nl met de beheerstatus “uit registratie” of “afgewezen” worden niet in de ROSA getoond.
  • Afspraken gepubliceerd op Edustandaard.nl die het gebruiksadvies “afgeraden” hebben worden niet in de ROSA opgenomen.
  • Standaarden die op de lijst 'Pas toe leg uit'-standaarden (verplicht) van het Forum Standaardisatie voorkomen en waarvan vastgesteld is door de Architectuurraad dat ze relevant zijn voor het onderwijs, worden opgenomen in de ROSA.
    • Uitzondering hierop zijn de standaarden die geregistreerd zijn bij Edustandaard.nl als een profiel of onderdeel daarvan gericht voor het onderwijs. Bijvoorbeeld TLS is voor het onderwijs geregistreerd onder de afspraak UBV-TLS. Alleen deze laatste wordt in de ROSA opgenomen in dit geval.
  • 'Standaarden die op de lijst aanbevolen standaarden van het Forum Standaardisatie voorkomen en waarvan vastgesteld is door de Architectuurraad dat ze relevant zijn voor het onderwijs, worden opgenomen in de ROSA.
  • Voor afspraken die niet op Edustandaard.nl zijn gepubliceerd, maar die wel relevant zijn voor het onderwijs als geheel of voor 1 onderwijsdomein, worden nog nadere criteria opgesteld. Denk bijvoorbeeld aan Europese standaarden en sectorspecifieke afspraken.

Wijzigingsverzoek

  1. Een afspraak wordt opgenomen als deze overlap heeft met het functioneel toepassingsgebied en wordt gebruikt bij het realiseren van de informatievoorziening ter facilitatie van het onderwijs.
  2. Afspraken van lagen 6 en 7 van het OSI model worden in beschouwing genomen. Afspraken die raken aan andere lagen, zoals IPv4/6, vallen buiten de scope.
  3. Een afspraak moet binnen één of meerdere van de ROSA domeinen passen.

Spelregels voor redactie van een Afspraak[bewerken]

  • De uitgebreide beschrijving van een afspraak staat op de Edustandaard website. Vanaf de ROSA wordt hiernaar verwezen.
  • Iedere afspraak wordt indien mogelijk ingedeeld in één of meerdere ROSA keten- of IV-domeinen.
  • Bij wijzigingen in de lijst van afspraken, wordt vanuit Bureau Edustandaard een notificatie gegeven aan het ROSA Beheerteam (NB vaak zal dat al via de ROSA scan bekend worden). In ieder geval elk jaar, wordt voor de eerste Architectuurraad de lijst met afspraken op de ROSA bijgewerkt conform het overzicht van de afspraken op de Edustandaard-website.
  • Wanneer een afspraak is vervangen door een andere, wordt de plaatsing van deze afspraak in alle ROSA views herzien.

Wijzigingsverzoek

  1. Bij het ontwikkelen van een viewpoint om afspraken weer te geven, wordt een directe koppeling gemaakt aan ketenprocessen of aan referentiecomponenten (RCs). Voorbeelden hiervoor worden uitgewerkt.
  2. Bij externe afspraken zo min mogelijk informatie handmatig overnemen: Naam van de afspraak + externe verwijzing is goed genoeg.

Attributen[bewerken]

Naast een beschrijving en attributen worden er ook relaties gelegd met andere mogelijke architectuurentiteiten (zoals beschreven in het metamodel). Die relaties worden niet als attributen weergegeven, want die zijn al zichtbaar in het gegenereerde "plaatje" onder de balk 'Meer informatie'.

Aanduiding[bewerken]

Attribuut: Naam
Omschrijving De aanduiding waaronder de afspraak bekend staat. Deze moet zowel de essentie van de regel representeren, als makkelijk te onthouden zijn.
Toelichting Als de afkorting zeer gangbaar is in communicatie/documentatie dan wordt die ook tussen haakjes achter de volledige aanduiding opgenomen.
Voorbeelden Afspelen educatieve content, Edukoppeling, Hoger Onderwijs Voorlichtings Informatie (HOVI)
Kardinaliteit 1..1
Verwerken in Archi In te vullen in de sectie Main onder Name
Attribuut: Afkorting
Omschrijving Een notatie of code die als verkorte aanduiding van de afspraak fungeert
Toelichting Als de afkorting zeer gangbaar is in communicatie/documentatie dan wordt die ook tussen haakjes achter de volledige aanduiding opgenomen bij het attribuut Aanduiding.
Voorbeelden CEVO, HOVI, iUD
Kardinaliteit 0..1
Verwerken in Archi In te vullen als Value in de sectie Properties bij Name “Afkorting”

Betekenis[bewerken]

Attribuut: Beschrijving
Omschrijving Omschrijving van de afspraak
Toelichting De omschrijving is beperkt tot 1 tot 2 zinnen. Is meer informatie gewenst dan opnemen in toelichting.
Voorbeelden -
Kardinaliteit 1..1
Verwerken in Archi In te vullen in de sectie Main onder Documentation. Overnemen van de korte beschrijving van de Edustandaard-website cq Forum Standaardisatie-website (zoals getoond in de lijst van afspraken/standaarden).
Attribuut: Type
Omschrijving De aanduiding van het type van object / modelentiteit in het ROSA-metamodel.
Toelichting Afspraak is een modelentiteit in het ROSA Metamodel. Door dit als attribuut expliciet op te nemen bij de beschrijving wordt de samenhang met het metamodel voor de gebruiker meteen duidelijk. Bovendien wordt dit attribuut gebruikt bij het kunnen samenstellen van views en pagina's.
Mogelijke waarde(n) Afspraak
Kardinaliteit 1..1
Verwerken in Archi In te vullen als Value in de sectie Properties bij Name “Type”
Attribuut: Toelichting
Omschrijving Inhoudelijke toelichting op de omschrijving van de afspraak en/of nadere details
Toelichting Regel is dat een toelichting alleen nodig is, als de afspraak niet binnen Edustandaard of Forum Standaardisatie is geregistreerd. In alle andere gevallen is de toelichting te vinden op de website van Edustandaard cq Forum Standaardisatie. Uitzondering hierop is als een nadere duiding in de context van de ROSA relevant is voor het gebruik.
Voorbeelden -
Kardinaliteit 0..1
Verwerken in Archi In te vullen als Value in de sectie Properties bij Name “Toelichting”


Herkomst[bewerken]

Attribuut: Externe verwijzing
Omschrijving URL waar de uitleg/documentatie van de afspraak te vinden is.
Toelichting Bij afspraken beheerd door Edustandaard: URL naar pagina op Edustandaard waar de afspraak staat gedocumenteerd. Dit is een link naar de bron van de afspraak op Edustandaard waar verdere beschrijving en documentatie is opgenomen.

Idem voor de standaarden van het Forum Standaardisatie. Bij andere afspraken: De vermeende hoofd-URL waar de afspraak te vinden is.

Voorbeelden https://www.edustandaard.nl/standaard_afspraken/edukoppeling-transactiestandaard
Kardinaliteit 1..1
Verwerken in Archi In te vullen als Value in de sectie Properties bij Name “Externe verwijzing”
Attribuut: Registrerende organisatie
Omschrijving De organisatorische entiteit waar de afspraak geregistreerd is.
Toelichting Bij de registrerende organisatie zal zoveel mogelijk ook de beschrijving worden opgehaald dan wel ter controle voorgelegd.

In het geval van afspraken die op Edustandaard.nl worden gepubliceerd is de registrerende organisatie Edustandaard. Het daadwerkelijke beheer ligt vaak bij een werkgroep die dit beheer conform het beheerproces en condities van Edustandaard uitvoert. Voor deze detailinformatie wordt verwezen naar Edustandaard.nl

Voorbeelden Edustandaard, Forum Standaardisatie, 1EdTech
Kardinaliteit 1..1
Verwerken in Archi In te vullen als Value in de sectie Properties bij Name “Registrerende organisatie
Herkomst www.edustandaard.nl
Attribuut: Registratiestatus Edustandaard
Omschrijving De verschillende fases in de levenscyclus van een afspraak (dus niet een versie van de afspraak) die bij Edustandaard zijn aangemeld of geregistreerd zijn (of dat waren).
Toelichting Het gaat om afspraken die op Edustandaard.nl zijn gepubliceerd. Zie ook: Uitleg filters Edustandaard

Voor afspraken die niet bij Edustandaard.nl voorkomen wordt vooralsnog de registratiestatus niet ingevuld.

Mogelijke waarde(n) Aangemeld, Geregistreerd, Afgewezen, Ingetrokken, Einde registratie (NB andere registratiestatussen leiden niet tot een opname in de ROSA)
Kardinaliteit 0..1
Verwerken in Archi In te vullen als Value in de sectie Properties bij Name “Registratiestatus”

Gebruik[bewerken]

Attribuut: Werkingsgebied
Omschrijving Het domein (organisatorisch, taakvelden) binnen het onderwijs waarin de afspraak wordt of kan worden toegepast.
Toelichting Werkingsgebied is niet exact gelijk aan de wettelijke indeling van de onderwijssectoren. Het speciaal onderwijs bijvoorbeeld is een apart werkingsgebied binnen ROSA, dat wettelijk gezien deel uitmaakt van de sector (en werkingsgebied) primair onderwijs.
Mogelijke waarde(n) Zie Werkingsgebieden
Kardinaliteit 1..*
Verwerken in Archi In te vullen als Value in de sectie Properties bij Name “Werkingsgebied”. Per werkingsgebied wordt een property aangemaakt.
Attribuut: Gebruiksadvies Edustandaard
Omschrijving Aanwijzing of de afspraak moet, kan of juist liever niet moet worden gebruikt.
Toelichting Voor afspraken gepubliceerd op Edustandaard.nl: de aanwijzing komt van de Edustandaard Standaardisatieraad. Zie ook: https://www.edustandaard.nl/afspraken/uitleg-filters/#Gebruiksadvies

Voor afspraken die niet bij Edustandaard zijn geregistreerd en ook niet bij Forum Standaardisatie worden geen gebruiksadviezen vastgelegd.

Mogelijke waarde(n) Verplicht, Aangeraden, Onder voorwaarden, Onbekend, Afgeraden
Kardinaliteit 1..1
Verwerken in Archi In te vullen als Value in de sectie Properties bij Name “Gebruiksadvies Edustandaard”
Attribuut: Gebruiksadvies Forum Standaardisatie
Omschrijving Aanwijzing of de afspraak moet, kan of juist liever niet moet worden gebruikt.
Toelichting Voor afspraken gepubliceerd op Forum Standaardisatie: de aanwijzing komt van het Forum Standaardisatie.
Mogelijke waarde(n) Verplicht (Pas toe of leg uit), Aanbevolen
Kardinaliteit 1..1
Verwerken in Archi In te vullen als Value in de sectie Properties bij Name “Gebruiksadvies Forum Standaardisatie”