Over Scenarios: je interface indelen in onderwerpen

Over Scenarios: je interface indelen in onderwerpen

Overzicht

Info
Een Scenario is één afleverroute binnen een interface voor één onderwerp. 

Info
Een Template (interface) is de volledige integratie. Deze bevat meerdere Scenarios.

Info
Elk scenario heeft een naam en bestaat uit een verzameling records. Een record laat zien hoe bepaalde velden uit het bronsysteem worden gekoppeld aan velden in het doelsysteem.

IdeaVergelijking: Zie het als het sorteren van post. De doelapplicatie is je archiefkast, de bronapplicatie is de binnenkomende post en elk Scenario is een medewerker die de binnenkomende post in de juiste lade opbergt.

Wat is een scenario

Wat is een Scenario?

Het HR-bronsysteem en het salarisdoelsysteem zijn allebei ingedeeld in onderwerpen, zoals persoonsgegevens, adressen, contract, salaris, enzovoort. 
BrynQ verwerkt je gegevens per onderwerp, en een Scenario bepaalt hoe zo'n onderwerp wordt behandeld.

Concreet beschrijft een Scenario hoe een onderwerp er in beide systemen uitziet en hoe BrynQ de gegevens voor dat onderwerp tussen de systemen synchroniseert.

Belangrijke punten over Scenarios:

  1. De interface is opgedeeld in Scenarios: één per onderwerp.
  2. Elk Scenario bepaalt WELKE gegevens worden gesynchroniseerd en HOE: het beschrijft de gegevens en de logica achter de synchronisatie voor dat onderwerp.
  3. Elk Scenario hoort meestal bij één bestemming in het salarisdoelsysteem: aan de bronkant kunnen de gegevens wel uit meerdere plekken in het HR-systeem komen.
  4. Scenarios draaien in een vaste volgorde: wanneer een synchronisatie start, voert de interface de Scenarios één voor één in een bepaalde volgorde uit.

Belangrijk: Scenarios zijn altijd opgebouwd rond het doelsysteem. Omdat BrynQ gegevens naar het salarisdoelsysteem stuurt, volgt de inrichting van elk Scenario de manier waarop dat onderwerp in het doelsysteem is georganiseerd, niet in het bronsysteem.




Scenarios maken de integratie betrouwbaar:

  • Eenvoudig problemen oplossen
  • Nauwkeurige routering: het systeem weet altijd waar elke wijziging thuishoort
  • Gericht overzicht: je ziet alleen de velden die relevant zijn voor die bestemming

Waar vind ik scenarios?
Voorwaarde: je hebt een interface in live- of conceptmodus. Scenarios maken deel uit van een interface.
Ga naar de scenarios van je interface



 

Open een interface en klik op het tabblad Scenarios.

Linkerpaneel: lijst met Scenarios

  • Klik op de naam van een Scenario om het te openen
  • Sleep aan de gestippelde greep om de volgorde van Scenarios te wijzigen
  • Klik op het ⋮ menu naast een naam om:
    • Disable scenario: stopt met het versturen van gegevens, maar bewaart de configuratie
    • Delete scenario: alleen beschikbaar voor Scenarios die je zelf hebt aangemaakt; template-Scenarios kun je alleen uitschakelen
  • Klik op Add new scenario om een nieuw scenario aan te maken

Let op: Bij sommige abonnementen is het toevoegen van nieuwe Scenarios vergrendeld. Als dat voor jouw account geldt, zie je een melding om te upgraden.

Uitgeschakelde Scenarios staan onder Inactive scenarios onderaan de lijst. Klik op het pictogram met de ronde pijl om er een opnieuw in te schakelen.

Een rode waarschuwingsdriehoek (⚠) naast de naam van een Scenario betekent dat er een configuratieprobleem is. Open het Scenario om het te bekijken en op te lossen.

Rechterpaneel: details van het Scenario

Bovenaan kun je het volgende bewerken:

  • Name: de titel van het Scenario
  • Description: een korte toelichting op wat dit Scenario doet (maximaal 500 tekens)
  • Additional comments: interne notities voor je team (onderaan het paneel weergegeven)

Onder deze velden staat de lijst met Records.


Wat is een Record?

Een Record is één regel binnen een Scenario. Het definieert één koppeling:

"Neem deze waarde uit de bron. Zet hem hier in het doel."

Elke regel heeft vier kolommen:

KolomOmschrijving
Source fieldsWaar de waarde vandaan komt
Target fieldsWaar de waarde naartoe gaat
MappingHoe de waarde onderweg wordt omgezet (indien nodig)
ActionsDe knop Unique key en de bediening voor uitschakelen/verwijderen

De Unique key

De Unique key vertelt BrynQ hoe een specifiek record (een persoon, contract, adres, enzovoort) in de doelapplicatie te herkennen is. Zonder deze sleutel kan het systeem binnenkomende gegevens niet aan de juiste vermelding koppelen.

Belangrijk: Elk Scenario moet minstens één regel hebben die als Unique key is gemarkeerd. Is er geen ingesteld, dan toont BrynQ deze melding en wordt het Scenario niet verwerkt:
"Your scenario needs at least one unique key in order for your scenario to be processed."

Je kunt meer dan één regel als Unique key markeren. Samen vormen ze dan een gecombineerde sleutel, bijvoorbeeld personeelsnummer + contractnummer.

Een Record uitschakelen

Sommige regels kun je uitschakelen als ze niet nodig zijn. Regels die als Required of Unique zijn gemarkeerd, zijn echter vergrendeld en kunnen niet worden uitgeschakeld.


Veldrelaties (1:1, 1:N, N:1, N:M)

Je stelt het relatietype niet handmatig in. BrynQ bepaalt het automatisch op basis van het aantal velden dat je aan elke kant selecteert:

SelectieRelatieVoorbeeld
1 bron → 1 doel1:1E-mail → E-mail
1 bron → meerdere doelen1:NVolledige naam → Voornaam + Achternaam
Meerdere bronnen → 1 doelN:1Straat + Huisnummer → Adresregel
Meerdere bronnen → meerdere doelenN:MLand + Burgerlijke staat → Belastingcode + Socialezekerheidscode

De meeste regels zijn 1:1.

Wanneer heb je N:M nodig? Wanneer één bronveld op zichzelf niet genoeg informatie geeft. Bijvoorbeeld een belastingcode die afhangt van zowel het land als de burgerlijke staat: geen van beide velden geeft alleen het juiste resultaat.

Wil je aanpassen hoe velden worden gecombineerd, open dan de regel en gebruik de keuzelijst Rename logic / Transformation. De opties zijn onder andere Automatic, Concatenate, Fill in order en Keep source fields. Laat dit op Automatic staan, tenzij je een specifieke reden hebt om het te wijzigen.


Wat is een Value Mapping?

Gebruik een Value Mapping wanneer de bron- en doelapplicatie dezelfde gegevens op een andere manier weergeven.

Value Mappings herkennen op het scherm

In de kolom Mapping:

  • Gevulde knop: er is een value mapping ingesteld
  • Omlijnde (lege) knop: geen mapping ingesteld
  • ✓-badge: de mapping is volledig
  • !-badge: de mapping is verplicht, maar nog niet ingesteld

Klik op de knop om de mappingtabel te openen.

Voorbeeld

Het woonland koppelen tussen Bob (bron) en Zenegy (doel):

Bronwaarde (Bob)Doelwaarde (Zenegy)
NetherlandsNL
United KingdomGB
GermanyDE

Zonder deze mapping weigert Zenegy "Netherlands", omdat het alleen landcodes accepteert.

Sommige Value Mappings zijn verplicht (de doelapplicatie vereist een specifiek formaat). Andere zijn optioneel (bedoeld om gegevens op te schonen of te standaardiseren).

Matchingstrategie

Als binnenkomende gegevens inconsistenties kunnen bevatten (extra spaties, andere hoofdletters), kun je instellen hoe streng BrynQ waarden vergelijkt. Kies een strategie bovenaan de mappingtabel:

StrategieNegeert
Exact match (standaard)Niets: moet precies overeenkomen
Ignore caseHoofdletters en kleine letters
Ignore spacesSpaties
Ignore special charactersSymbolen en spaties
Flexible matchHoofdletters, symbolen en spaties

Standaardwaarde

Je kunt een standaardwaarde instellen in de mappingtabel. Als een binnenkomende waarde niet in de lijst staat, gebruikt BrynQ de standaardwaarde in plaats van een fout te geven.


Veldtypen

Klik op het kleine pictogram naast een veld om het type te wijzigen:

TypePictogramOmschrijving
Library fieldDatabaseEen standaardveld dat bij de applicatie hoort. Gebruik dit standaard.
Custom fieldBestand / penEen niet-standaard veld dat specifiek is voor de inrichting van één klant.
FieldPotloodEen algemene veldselectie.
Fixed value (alleen bron)TypeStuurt altijd dezelfde waarde, bijvoorbeeld altijd "Active".
Empty value (alleen bron)VakStuurt geen waarde (leeg).

Library of Custom: Library fields zijn standaardvelden die voor alle klanten beschikbaar zijn. Custom fields zijn extra velden die alleen bestaan voor de configuratie van een specifieke klant.

Let op: Er is ook een veldtype Configuration, maar dit is aan klantzijde niet zichtbaar in het menu met veldtypen. Configuratiewaarden stel je in op het Configuration-tabblad van de interface, en het Scenario gebruikt ze als vaste invoer. Ondersteunde waardetypen zijn onder andere tekst, opgemaakte tekst, getal, datum, datumbereik, keuze uit een lijst en e-mail. Je kunt ook een bijlage toevoegen als referentiedocument, maar die wordt niet door de integratie zelf gebruikt.