Tijdens de vorige stimuleringsregeling in 2019 hebben een aantal instellingen, in samenwerking met CACI, een OOAPI v3 endpoint gerealiseerd. Hieronder vindt je een samenvatting van de relevante documentatie.

Oplossing in Osiris

De Osiris applicatie wordt door meerdere opleidings instituten gebruikt en is in de loop van het traject door Caci voorzien van een endpoint, die op zichzelf volledig aansluit op de OOAPI specificatie. De Osiris oplossing van de TUe kan hiermee in feite ook direct aangesloten worden op de OOAPI gateway van Surf.

UU oplossing

   +--------+  +----+                +-----+ +---+       +---------+      +---------+      +---+
   |        |  |    |                |     | |   |       |         |      | +-----+ |      |0 0|
   |        |  |    +<---------------+     | |   +<------+  Surf   +<-----+ +-----+ |      +---+
   |        |  |    |                | ESB | |API|       |  Portal |      |         |    XXXXXXXXX
   | Osiris |--|Link|                |     |-| GW|       |         |      | Browser |        X
   |        |  |    +--------------->+     | |   +------>+         +----->+         |       X XX
   |        |  |    |                |     | |   |       |         |      |         |     XX   XX
   +--------+  +----+                +-----+ +---+       +---------+      +---------+
Nr     1         2                      3      4              5                6             7

High level beschrijving van de high level componenten:

  1. Osiris is het bronsysteem. Voor meer gedetailleerde informatie zullen ook andere bronnen aangesproken moeten worden, die op dit moment nog onvoldoende gestructureerd zijn. Echter Osiris vormt een redelijk complete basis.
  2. ESB van Caci die de toegang tot de API verzorgt. Autorisatie op basis van een API key.
  3. De ESB bij de UU heeft een beperkte taak, omdat Osiris de berichten al compleet aanlevert. De UU ESB doet het volgende:
    1. Strippen van persoonlijke gegevens van docenten en ander personeel wegens AVG.
    2. Omzetten van de links zodat die blijven werken als er op geklikt wordt.
  4. De UU API Gateway is de toegangspoort die o.a. voor authenticatie zorgt.
  5. Surf Portal die middels de APIs van alle deelnemende instellingen de "course information" ontsluit. Waar nodig worden gegevens ge-cache-d in een database. Er wordt dus niet altijd een complete roundtrip gemaakt.
  6. Web browser
  7. User (student)

Configuratieparameters Osiris

Voor resource institution dienen de parameters in onderstaande tabel ingevoerd te worden. In Osiris zijn ze te vinden in Scherm 3.8.03 onder Rubriek OOAPI vanaf OSIRIS release 19.44.

Ze zijn allemaal nodig voor de SurfPortal behalve "AcademicCalendar – Year/ URL".

Veld

Toelichting OSIRIS

InstitutionId

Een unieke id van de institution. Wordt nergens voor gebruikt, daarom gelijk gehouden met de brincode

Brin

De brincode van de instelling, ligt al vast in ost_brincode met muterende_instelling = ‘J’

Name (verplicht)

De naam van de instelling, opgegeven via een configuratieparameter (OOAPI/INSTITUTION-NAME)

Description (verplicht)

De beschrijving van de instelling, opgegeven via een configuratieparameter (OOAPI/INSTITUTION-DESCRIPTION)

AcademicCalendar – Year/ URL

Het collegejaar en URL waarvoor de link naar de academische kalender opgenomen is.

Opgehaald via configuratieparameters OOAPI/INSTITUTION-CALENDAR-YEAR en OOAPI/INSTITUTION-CALENDAR-URL

Address

Het adres van de instelling, opgegeven in 5 configuratieparameters:

- OOAPI/INSTITUTION-ADDRESS-STREET

- OOAPI/INSTITUTION-ADDRESS-ADDITION

- OOAPI/INSTITUTION-ADDRESS-CITY

- OOAPI/INSTITUTION-ADDRESS-ZIP

- OOAPI/INSTITUTION-ADDRESS-COUNTRY

Let op: Indien een adres opgegeven is dan zijn alle velden (muv ADDITION) verplicht.

Het object address zal alleen opgenomen worden als de vier verplichte velden ingevuld zijn bij de configuratieparameters.

Logo

De url naar een logo van de instelling opgehaald via configuratieparameter OOAPI/URL-LOGO-INSTELLING.

Daarnaast zijn er nog een aantal parameters die de mapping aansturen. Deze zijn bij oplevering ingesteld door Caci.

TU/e oplossing - BizTalk

De architectuur regels van de TUe laten  een directe koppeling naar een externe partij als SURF met de Osiris omgeving van de TUe niet toe. Alle externe afnemers en leveranciers van gegevens dienen aan te sluiten op de middleware oplossing van de TUe (Microsoft BizTalk met WCF koppelingen). Meer informatie over die koppeling is hier te vinden: https://github.com/InformationServicesDevTue/TUe-OOAPI


Meer informatie?

Wil je meer informatie dan hierboven te vinden is? Neem dan contact met ons op, we overleggen dan met de TU/e of UU of we de volledige documentatie mogen doorspelen.




  • No labels