Releases Youforce API & bestandsuitwisseling

Op 19-02-2024 hebben wij een nieuwe versie (1.22) van de PowerShell scripts gepubliceerd met de volgende verbeteringen: Vermelding van de minimale vereiste .NET versie 4.8 in de readme bestanden. Verbetering van het download proces. Verplicht gebruik van TLS 1.2 toegevoegd in het Upload script. Vermelding van versies van: de PowerShell scripts, Windows en .NET versie tbv een betere ondersteuning. Je vind de PowerShell scripts hier.  

Verbergen van bestanden in Ontvang pagina. We hebben regelmatig vragen gekregen of het mogelijk was om in Bestandsuitwisseling in de Ontvang pagina bestanden te kunnen verwijderen als je ze niet wilt ontvangen. Sommige van jullie krijgen zoveel bestanden in de lijst die je niet echt wilt ontvangen dat deze bestanden het moeilijker maken de bestanden die je WEL wilt ontvangen te vinden en te ontvangen.   Met ingang van 1 feb 2024 is het bij Bestandsuitwisseling nu mogelijk om bestanden in de Ontvang pagina te 'Verbergen' als je ze niet wilt ontvangen.   We hebben gekozen voor de term Verbergen omdat de bestanden niet echt worden verwijderd bij deze functionaliteit, maar ze worden niet meer getoond in de Ontvang bestandslijst waardoor je eenvoudiger de bestanden die je WEL wilt ontvangen kunt vinden. Doordat de bestanden niet echt worden verwijderd is het gedurende 30 dagen nog mogelijk om met de juiste filters de verborgen bestanden weer zichtbaar te maken en eventueel alsnog te ontvangen.  Dit artikel beschrijft hoe je de Verberg functionaliteit kunt gebruiken.   LET OP! Als je bestanden verbergt zijn ze ook niet meer zichtbaar voor andere gebruikers van Bestandsuitwisseling binnen jouw bedrijf. De bestanden worden zoals vermeld echter niet verwijderd uit Bestandsuitwisseling. Verderop in het artikel wordt uitgelegd hoe je met de juiste filters ook de verborgen bestanden weer in de lijst zichtbaar kan maken zodat je ze eventueel nog kunt ontvangen.   Nieuw Acties ikoon Verberg      Er is een nieuw Acties ikoon zichtbaar waarmee het geselecteerde bestand verborgen kan worden. Als je op het ikoon klikt dan wordt het bestand direct verborgen en is hij niet meer zichtbaar in de lijst.  Deze optie kan heel handig zijn als je meerdere bestanden tegelijkertijd wilt ontvangen maar er staan in de lijst ook bestanden die je niet wilt ontvangen. Als je de gewenste bestanden niet allemaal individueel wilt selecteren, verberg dan eerst de bestanden die je niet wilt ontvangen en vink daarna de Selectie box aan in de rij met kolomnamen om alle nog zichtbare bestanden te selecteren voor ontvangen.   Aangepaste filters   Om optimaal gebruik te kunnen maken van de nieuwe functionaliteit zijn de filters iets aangepast. Als de Ontvang pagina wordt geopend worden standaard de bestanden die Ontvangen status 'Nog Niet Ontvangen' en Verberg status 'Zichtbaar' hebben, getoond. Dat is dezelfde  functionaliteit als in de oude situatie.    Het is mogelijk de verborgen bestanden weer in de lijst te tonen door bij de Verberg status de optie 'Verborgen' te activeren. Door op de 'Bekijk Resultaten' knop te klikken worden nu ook de verborgen bestanden getoond. Met dit 'Verberg status' filter worden alle bestanden, Zichtbaar en Verborgen, getoond.  Verborgen bestanden kun je herkennen aan een vinkje in de Verberg kolom. Net als bij ontvangen bestanden kun je bij verborgen bestanden op het (naar beneden) vinkje klikken in de meest linkse kolom om te zien wie het bestand verborgen heeft.   Ontvangen van verborgen bestanden. Belangrijk om te weten is dat ook verborgen bestanden nog steeds kunnen worden ontvangen. Hiervoor moet je dan wel eerst de Verborgen optie activeren in het Verberg status filter. Als het bestand dan in de lijst wordt getoond kun je het, zoals gewend, ontvangen door op het Acties ikoon Ontvangen te klikken.      

Het endpoint Assignment (inzet) is toegevoegd aan de learning & Recruitment API De url van het endpoint is respectievelijk: GET https://api.youforce.com/learning/v1.0/Assignments GET https://api.youforce.com/recruitment/v1.0/Assignments   Het endpoint laat de volgende gegevens zien: Deze gegevens zijn afkomstig van het scherm "inzet" uit Beaufort.        

De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:   Extension API uitgebreid met een nieuw endpoint op basis van de historie tabel  De extension API is uitgebreid met een nieuw endpoint employment/timelines. Dit nieuwe endpoint is gebaseerd op de historie tabel in Beaufort, waardoor het mogelijk is per element een ingangdatum weer te geven. Het endpoint werkt op een vergelijkbare wijze als het employment endpoint in de extensie API.   Onderstaand voorbeeld laat het onderscheid tussen beide endpoints zien. employments Dit endpoint toont de waarde van de betreffende rubriek uit het actuele model van Beaufort.       Employments/timelines Dit endpoint toont de waarde van de betreffende rubriek uit de historie tabel van Beaufort.       Om dit endpoint te kunnen gebruiken moet de historie voor het betreffende veld geactiveerd zijn. Dit kunt u doen in het scherm Rubrieken in Beaufort.   Daarnaast moeten de rubrieken ook als extentie in de API geconfigureerd zijn. Dit kan gedaan worden door een API consultant van Visma Raet.      

De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:   Extensions API uitgebreid met endpoints voor de Basic API Vanaf nu is het ook mogelijk om de Youforce Extension API te gebruiken in combinatie met de Basic API.   De nieuwe endpoint zijn: GET ..extensions/v1.0/basic/persons  GET ..extensions/v1.0/basic/employments Deze endpoints zijn enkel te gebruik in combinatie met de Basic API. Zie voor meer Eigen rubrieken met de Extensions API    Recruitment API uitgebreid met endpoint voor aannemen medewerker De recruitment API is uitgebreid met een endpoint voor het aannemen van een nieuwe medewerker. Binnen dit proces wordt onderscheid gemaakt tussen het aannemen van een nieuwe medewerker en het creëren van een nieuw dienstverband voor een bestaande medewerker.   Om dit proces te ondersteunen, is er ook een endpoint ontwikkeld waarmee u kunt controleren of een persoon al in de Beaufort-omgeving bestaat.   Het endpoint "Search person" stelt u in staat om te zoeken op verschillende velden, zoals voornaam, geboortenaam, geboortedatum en geboorteplaats. Ten minste één van deze zoekvelden is verplicht. Dit endpoint geeft maximaal 10 resultaten terug.   Op basis van het resultaat van dit endpoint kan het recruitment systeem bepalen of er sprake is van een een geheel nieuwe medewerker of enkel van een nieuw dienstverband bij een bestaande medewerker. Het recruitment systeem kan vervolgens één van de volgende endpoints starten: POST hires: Hiermee wordt een workflow voor het aannemen van een nieuwe medewerker in HR Self Service gestart, waarbij de gegevens vanuit de API als standaardwaarden worden overgenomen. POST Contract: Hiermee wordt een workflow voor het creëren van een nieuw dienstverband in HR Self Service gestart, waarbij de gegevens vanuit de API als standaardwaarden worden overgenomen. Tevens is een endpoint toegevoegd waarmee contractwijzigen kunnen worden doorgegeven. Dit is bijvoorbeeld relevant bij interne sollicitaties.  Het endpoint is:   POST contract/adjustments: Hiermee wordt een workflow voor het wijzigen van een bestaand dienstverband in HR Self Service gestart, waarbij de gegevens uit de API als standaardwaarden worden overgenomen. Consultancy De recruitment API biedt diverse mogelijkheden om de API nader te configureren. Deze mogelijkheden kunnen tijdens de implementatie door onze consultants toegelicht worden.   Status De API is op dit moment nog Controlled Available.  Zodra de eerste integraties zijn ontwikkeld zullen we u hier nader over informeren.      

Met ingang van 16 oktober 2023 biedt Bestandsuitwisseling de mogelijkheid om meerdere bestanden in 1 keer te ontvangen.  Ga hiervoor als volgt te werk: Ga naar de Ontvang bestanden pagina Klik in de rij of zet het vinkje aan in de Selectie kolom van de bestanden die je wilt ontvangen Klik op de Ontvang Geselecteerde Bestanden knop rechtsboven op de pagina De bestanden worden nu in een zipbestand in je browser Download directory ontvangen De naam van het zipbestand heeft het formaat Bestandsuitwisseling_20231016103134.zip Unzip de bestanden door rechts te klikken op het zip bestand en Uitpakken te selecteren. Indien je Windows versie de zipbestanden niet standaard herkent moet je eerst een ZIP tool installeren. Extra informatie: Door het vinkje in de 1e rij aan te zetten selecteer je alle getoonde bestanden op deze pagina in 1 keer. Nogmaals op dat vinkje klikken de-selecteert alle geselecteerde bestanden. Als maar 1 bestand is geselecteerd en je klikt de Ontvangen Geselecteerde Bestanden knop, dan wordt het bestand niet gezipt maar ontvangen alsof je het bestand individueel hebt ontvangen. Je kunt nog steeds bestanden individueel ontvangen door zoals gewoonlijk op de Ontvang knop helemaal rechts in de rij te klikken.  

Met ingang van 11 oktober 2023 ondersteunt de Bestandsuitwisseling app ook de Nederlandse taal. De taal die wordt gebruikt volgt de persoonlijke instellingen die je in Mijn Youforce hebt gedaan.

De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:   Eerste versie Basic API beschikbaar Er is een eerste versie van de Basic API beschikbaar. Deze API is bedoeld voor systemen die niet onder een van onze standaard domein API's vallen, maar toch  basis HR gegevens nodig hebben. De Basic API bevat een set basisfunctionaliteiten met endpoints die doorgaans voldoende zijn voor integratie met het HR Core-systeem. De Basic API bevat de volgende endpoints: GET Persons  GET Employments GET Organisation Units GET Role Assignments GET Job Profiles   Performance- & stabiliteitsverbeteringen De afgelopen maand zijn er een aantal performance- en stabiliteitverbeteringen doorgevoerd . We hebben de integratie met Beaufort geoptimaliseerd, waardoor mutaties in HR Core Beaufort sneller zichtbaar zijn in de API. Deze prestatieverbetering geldt voor alle endpoint, met uitgezonderd van het employee endpoint.   Het 'employee' endpoint is gebaseerd op een verouderde infrastructuur waardoor verdere prestatieverbetering niet mogelijk is.  Als u problemen ondervindt met het 'employee' endpoint dan raden wij u aan over te stappen op het 'Person' en 'employment' endpoint voor het ophalen van de gegevens.   Tevens is de afgelopen periode de filters from/to voor het ophalen van de gewijzigde records verbeterd. In eerdere release werd nog vaak een record als gewijzigd gemarkeerd, terwijl de gegevens ongewijzigd bleek te zijn. We hebben updateproces verbeterd om te voorkomen dat onnodig veel records als gewijzigd worden gemarkeerd.  Wij verwachten dat dit de belasting op uw systeem zal verminderen, met name voor systemen die werken op basis van gewijzigde records. Deze wijziging geldt voor alle endpoint, uitgezonderd van het employee endpoint   Het employee endpoint Zoals wij al eerder hebben aangegeven wordt het 'employee' endpoint niet verder ontwikkeld, en we raden u aan over te stappen op het 'person' en 'employment' endpoint. Het 'employee' endpoint blijft wel beschikbaar in de huidige vorm, maar verdere prestatieverbeteringen zijn niet mogelijk.   Als u momenteel het 'employee' endpoint gebruikt voor uw integratie, kan het langer duren voordat mutaties uit Beaufort zichtbaar zijn in de API. Mocht dit in uw geval tot problemen leiden, dan adviseren wij u om de integratie om te zetten naar de 'Person' en 'Employment' endpoints. Deze endpoint bevatten dezelfde informatie als het 'employee' endpoint maar kennen dus een betere performance. Uw software leverancier kan u informeren of hun applicatie al gebruikmaakt van deze verbeterde endpoints. Zie ook het eerdere bericht : Vervanging Employee endpoint door Persons en Employee endpoint  

De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:   IAM API Nieuwe endpoint voor Employments  De IAM API is uitgebreid met een nieuwe endpoint employmentTimelines . Het endpoint employmentTimelines is gebaseerd op de historie tabel van Beaufort waardoor het endpoint de ingangsdatum bevat.  Het endpoint  bevat dezelfde velden als het oorspronkelijk endpoint employments maar dus nu ook inclusief ingangsdatum waardoor er een soort tijdlijn ontstaat. Voor het endpoint geldt dat de ingangsdatum uit de historie tabel van Bo4 komt.  Onderstaand een voorbeeld van het nieuwe endpoint employmentTimelines:  

Autorisatiebeheer   De Bestandsuitwisseling module is nu “Algemeen Beschikbaar” voor HR Core Online gebruikers. Dit betekent dat je geen 4Me-ticket meer hoeft in te vullen om Bestandsuitwisseling voor de gebruikers te activeren (zie hier), maar dat je zelf de autorisatie kunt toekennen in Autorisatiebeheer. Bestandsuitwisseling is de vervanger van handmatig Zenden/Ontvangen met IBU. Vanaf heden zal de applicatie Bestandsuitwisseling standaard beschikbaar in Autorisatiebeheer. De autorisatie van elke gebruiker voor de verschillende file types kan door de Autorisatiebeheer administrator worden gedaan door het toekennen van de juiste rechten.   Jouw Actie    Volg de stappen zoals beschreven in dit artikel.   Als je gebruikers hebt die (handmatig) toegang hebben verkregen via de 4me template ‘Van Zenden & Ontvangen naar Bestandsuitwisseling HR Core Online’ autoriseer hun dan voor de juiste rollen (De handmatig toegevoegde rechten zijn niet zichtbaar in Autorisatiebeheer). De handmatig toegevoegde rechten zullen per 1 December worden verwijderd en vanaf dan gelden alleen de toegekende rechten in Autorisatiebeheer.   Nieuwe tegel op het Youforce Desktop   Bestandsuitwisseling is op dit moment beschikbaar in Mijn Youforce, maar kan ook worden bereikt via de "Bestandsuitwisseling" -tegel op de Youforce Desktop. In dat laatste geval moet de tegel wel worden geautoriseerd via Toegangsbeheer.      

Nieuwe functionaliteit en verbeteringen in Powershell Voorbeeld Scripts  Support voor logbestanden Upload in blokken verhoogt bestandsgrootte limiet voor zenden van 100MB naar 10GB Download in blokken verhoogt bestandsgrootte limiet voor ontvangen van 2GB naar 10GB Verbeterde betrouwbaarheid Toegevoegd: Standaard Proxy Settings detectie Commentaar toegevoegd  Configureer logbestanden in upload en download voorbeelden   Er is een nieuwe sectie toegevoegd aan het configuratiebestand van de voorbeelden om logbestanden te kunnen configureren.     Volg deze stappen om de logbestanden te configureren:   1 - Download de laatste versie van de Powershell voorbeelden hier  2 - Pas in de config.xml de setting : “Logs” - “Enabled” aan met waarde “true” 3 - Pas in de config.xml de setting : “Logs” - “Path” aan met de directory waar de logbestanden worden opgeslagen. 4 - Pas in de config.xml de setting: “Logs” - “MonitorFile” aan met de naam van de Monitor file. De Monitor file wordt opslagen in dezelfde directory waar de logbestanden worden opgeslagen.   Voor de gedetailleerde logbestanden wordt elke dag een nieuw bestand aangemaakt. Het Monitor bestand behoudt altijd dezelfde naam en bevat, i.t.t. de andere logbestanden, alleen die regels die nodig zijn om te beoordelen of de scripts correct functioneren of dat er fouten zijn opgetreden. Het Monitor bestand is met name geschikt voor geautomatiseerde controle op het correct functioneren van de scripts en voor fout detectie. Bij fouten kan het gedetailleerde logbestand meer informatie geven over de mogelijke oorzaak van de opgetreden fout. Voor verdere bijzonderheden lees de Readme bij de powershell voorbeelden. Readme Upload voorbeeld  Readme Download voorbeeld    Upload voorbeeld uitgebreid met uploaden in blokken (chunks)   Een verbetering in het upload voorbeeld zorgt er voor dat bestanden nu in blokken worden verzonden. Met deze nieuwe functionaliteit wordt de bestandsgrootte limiet voor in te zenden bestanden verhoogt van 100MB naar 10 GB.   Een nieuw veld (<ChunkSize>) is toegevoegd aan de configuratie waarmee de blokgrootte kan worden geconfigureerd.  De aanbevolen blokgrootte (beste performance) voor inzenden is 4MB.   Volg deze stappen om inzenden met blokken te configureren:   1 - Download de laatste versie van de Powershell voorbeelden hier  2 - Pas in de config.xml de setting : “Upload” - “ChunkSize” aan met waarde “4”   Voor verdere bijzonderheden lees de Readme bij het powershell voorbeeld. Readme Upload voorbeeld  Download voorbeeld uitgebreid met downloaden in blokken (chunks)   Een verbetering in het download voorbeeld zorgt er voor dat bestanden nu in blokken worden ontvangen. Met deze nieuwe functionaliteit wordt de bestandsgrootte limiet voor te ontvangen bestanden verhoogt van 2GB naar 10 GB.   Een nieuw veld (<ChunkSize>) is toegevoegd aan de configuratie waarmee de blokgrootte kan worden geconfigureerd.  De aanbevolen blokgrootte (performance) voor ontvangen is 100MB.   Volg deze stappen om ontvangen met blokken te configureren:   1 - Download de laatste versie van de Powershell voorbeelden hier  2 - Pas in de config.xml de setting : “Download” - “ChunkSize” aan met waarde “100”   Voor verdere bijzonderheden lees de Readme bij het powershell voorbeeld. Readme Download voorbeeld  Verbeteringen in Betrouwbaarheid   De betrouwbaarheid van de scripts is verbeterd door voor elk request een retry mechanisme te implementeren zodat bij een mogelijke internet en/of server fout de bestandsoverdracht niet direct stopt, maar dat het request nog een keer wordt geprobeerd.   Proxy Server settings Er is code aan de scripts toegevoegd zodat uw standaard Proxy Server settings automatisch worden gedetecteerd.   Commentaar toegevoegd De scripts zijn voorzien van meer commentaar om de code/functionaliteit van de verschillende onderdelen van de scripts duidelijker te maken.

In de Bestandsuitwisseling module hebben we de omschrijvingen van verschillende bestandstypes eenvoudiger en duidelijker gemaakt. In onderstaande tabel vindt u de veranderingen.   Bestandstype Oud Nieuw Zend/Ontvang 101014 BO4 Hosted Files Downloads HR Core Online Hosted Ontvang 101017 BO4 Hosted Uploads HR Core Online Hosted Zend 101029 BO4 DIGIZSM UWV HR Core UWV DigiZSM Zend 106000 Salarisdossier Exports Salarisdossier Gemal Ontvang 107001 Personeelsdossier Exports Personeelsdossier Ontvang 107003 Personeelsdossier Imports Personeelsdossier Zend 114000 Betaalmanager PB&Core Downloads Betaalmanager VIPS Disbursements Downloads Ontvang 114001 Betaalmanager PB&Core Payment Files (Opdracht) Betaalmanager VIPS Disbursements Opdrachten Ontvang 119000 PB&Core Imports VIPS Disbursements Zend 119001 PB&Core Exports VIPS Disbursements Ontvang 121003 IAM XSSO Import Gebruikersbeheer XSSO Zend 128001 Payroll Gemal Exports Payroll Gemal Ontvang 129000 Payroll Gemal HR Import (SBFT) Payroll Gemal SBFT Zend 129001 Payroll Gemal Integration (WIG) Payroll Gemal Integratiebestanden WIG Zend 129003 Payroll Gemal HR Import (EHRM) Payroll Gemal EHRM Zend 129004 Payroll Gemal Integration (PSG) Payroll Gemal Integratiebestanden PSG Zend 129006 Payroll Gemal Integration (SPG) Payroll Gemal Integratiebestanden SPG Zend 135000 Betaalmanager Gemal Downloads Betaalmanager Gemal Downloads Ontvang 135001 Betaalmanager Gemal Payment Files (Opdracht) Betaalmanager Gemal Opdrachten Ontvang 8003 Bestandsuitwisseling Test Bestandsuitwisseling Test Zend

Learning API verbeterd Afgelopen maand is de learning API verbeterd. Hieronder wordt een overzicht gegeven van de belangrijkste verbeteringen:   Performance & stabiliteit alle endpoints In het verleden kon het nog wel eens voorkomen dat de API geen response gaf waardoor er time-outs ontstonden. De afgelopen maand is de architectuur van de API gewijzigd waardoor de performance van de API is verbeterd en de kans op time-outs is geminimaliseerd.    Loonverdelingsregels als endpoint toegevoegd Endpoint: costAllocations Aan de learning API is een nieuwe endpoint met de Cost Allocation toegevoegd. Dit endpoint komt overeen met de entiteit Loonverdeling uit Beaufort. Met behulp van het endpoint kan per medewerker de kostenplaats, kostensoort en eventueel kostendrager uit Beaufort gehaald worden.     Adresgegevens uitgebreid Endpoint : Employees  Bij de adresgegevens naast de landcode ook de naam van het land getoond. Dit betreft de naam zoals ook wordt weergegeven in Beaufort zelf.      Naam van onder andere organisatie eenheid, functie en classificatie als extra veld toegevoegd Endpoint Employees In de endpoints Employee wordt bij de dienstverband gegevens naast een code voor functie, classificatie, organisatie eenheid, ect ook de naam getoond. Hierdoor wordt het eenvoudiger om vanuit één endpoint de naam in het IAM systeem op te nemen.  Voor organisatie eenheid is naast de naam ook nog een extra veld met de logisch code toegevoegd.       Meer records per page [alle endpoints] Door het verbeteren van de architecture is het ook mogelijk meer records in response weer te geven. Standaard wordt bij elke endpoint maximaal 100 records terug gegeven. Mocht de tabel meer records bevatten dat wordt middels een NextLink de volgende data set aangeboden. Vanaf deze release is het echter ook mogelijk meer dan 100 records in één pagina op te vragen. Dit kan middels de parameter take toe te voegen aan de url.   Hieronder een voorbeeld waarbij 125 records per pagina wordt opgehaald. GET https://api.youforce.com/learning/v1.0/employees?take=125 In de nextLink wordt deze page size overgenomen, zodat ook de vervolg pagina's maximaal 125 records bevat.         U kunt een page size tot maximaal 1000 records opvragen.    

De afgelopen periode zijn de volgende verbeteringen in de API doorgevoerd.   Learning API  Nieuw endpoints Person & Employment ter vervanging van Employees endpoint Endpoints: Persons  and Employments; Employees endpoint deprecated Het het huidige employee endpoint is een samengesteld endpoint dat zowel de persoons- als dienstverbandgegevens van medewerkers bevat. Afgelopen jaar is gebleken dat het combineren van deze data de complexiteit van het endpoint heeft verhoogd en de performance en stabiliteit achter blijft op de door ons gestelde eisen. We hebben dan ook besloten om het employee endpoint te splitsen in een endpoint met de persoonsgegevens en een endpoint met de dienstverbandgegevens.  Hiervoor hebben wij 2 nieuwe endpoints aan de learning API toegevoegd, te weten het endpoint Persons en het endpoint Employments. Beide endpoint bevatten alle gegevens uit het employees endpoint die horen tot de respectievelijk de persoon of het bijbehorende dienstverband.  Het huidige Employee endpoint blijft voorlopig bestaan, echter het endpoint zal niet verder uitgebreid worden. Nieuwe velden of andere verbeteringen zullen enkel in de nieuwe endpoint voor Persons en Employments doorgevoerd worden. Wij adviseren u om nieuwe koppelingen te baseren op de endpoints Persons en Employments en geen gebruik meer te maken van het Employee endpoint. Op termijn zal het huidige employee endpoint komen te vervallen.    IAM API Person & Employment ter vervanging van Employees endpoint Ook in de IAM api hebben wij naast het Employees endpoint een endpoint Persons en Employments beschikbaar. Deze Persons endpoint en Employments endpoint bevatten alle velden die ook in het employees endpoint voor respectievelijk persoon en dienstverband zitten. Het huidige Employee endpoint blijft voorlopig bestaan, echter het endpoint zal niet verder uitgebreid worden. Nieuwe velden of andere verbeteringen zullen enkel in het endpoint voor Persons en Employments doorgevoerd worden. Wij adviseren u om nieuwe koppelingen te baseren op de endpoints Persons en Employments en geen gebruik meer te maken van het Employees endpoint. Op termijn zal het huidige employees endpoint komen te vervallen.    autorisatie filters De IAM api is uitgebreid met autorisatie mechanisme.  Op basis van dit autorisatie mechanisme kan de API consultant bij Visma Raet een autorisatie filter inrichten. Dit autorisatie filter zorgt ervoor dat het externe systeem alleen die medewerkers in de API te zien krijgt die voldoen aan het filter. Zo kunt u bijvoorbeeld ervoor kiezen om alleen interne medewerkers op basis van het veld Soort Arbeidsrelatie in de IAM api te laten opnemen. De consultant kan deze een autorisatie filter inrichten op basis van de volgende velden: P01103 CEA-nummer / Payroll Client Code    P01104 Instelling nummer / Payroll Institution Code  P01102 Soort arbeidsrelatie / Employment type  P01110 Code doelgroep / Classification  P05041 Learning API Raadpleeg uw customer succes manager als u in contact wilt komen met de API consultant voor het inrichten van deze filters.  

IAM API verbeterd Afgelopen maand is de IAM api verbeterd.  Hieronder wordt een overzicht van de belangrijkste verbeteringen.   Performance & stabiliteit alle endpoints In het verleden kon het nog wel eens voorkomen dat de API veel tijd nodig had om de response te genererende API waardoor er soms time-outs konden ontstaan. De afgelopen maand is de architectuur van de API gewijzigd waardoor de performance API is verbeterd en minder kans op time-outs ontstaat.  Adresgegevens uitgebreid Person en Employee endpoint Bij de adresgegevens naast de landcode ook de naam van het land getoond. Dit betreft de naam zoals ook wordt weergegeven in Beaufort zelf.        Naam van onder andere organisatie eenheid, functie en classificatie als extra veld toegevoegd Employee  en Employment endpoint In de endpoints Employee en Employment wordt bij de dienstverband gegevens naast een code voor functie, clasificatie, organizatie eenheid, ect ook de naam getoond. Hierdoor wordt het eenvoudiger om vanuit één endpoint de naam in het IAM systeem op te nemen.  Voor organisatie eenheid is naast de naam ook nog een extra veld met de logisch code toegevoegd.       Veld Youforce Account toegevoegd  [Person en Employee endpoint] In de endpoints Person en Employee is een nieuw veld YouforceAccount toegevoegd. Dit betreft de rubriek P15013 Youforce gebruiker uit Beaufort. Met dit veld aangegeven voor de betreffende persoon een Youforce account is aangemaakt.  Alleen voor personen waarvoor een Youforce account is aangemaakt, kan het User endpoint gebruikt worden om de Identity terug te schrijven. Bij medewerkers zonder Youforce account zal het User endpoint een foutmelding geven. Note: Om van dit veld gebruik te kunnen maken, dient u wel over te zijn op de nieuwe werkwijze in Beaufort. Meer hierover kunt u lezen in de Beaufort release 2022-02    Consistentie tussen endpoints Person, Employments en Employee verbeterd [Endpoints Employee , Person en Employment] Het endpoint Employee is een gecombineerd van de endpoints Person & Employment.  Functioneel betreft het echter dezelfde entiteiten uit Beaufort. Het bleek echter dat in beide endpoints (Person/Employment versus Employee) niet dezelfde velden zichtbaar waren. Daardoor moest soms het employee endpoint gecombineerd worden met het Employment endpoint, terwijl beiden eigenlijk vergelijkbaar zijn.   Vanaf nu bevatten de endpoints Person & Employment dezelfde velden als het endpoint Employee en visa versa. Enige verschil tussen deze endpoints is dat bij het Employee endpoint de data gecombineerd is en bij het Person en Employment de data per entiteit gescheiden is.   Ook is het gedrag van beide endpoints vergelijkbaar. Bij de inrichting van de API wordt een bewaartermijn vastgelegd. Deze bewaartermijn bepaald hoe lang dienstverbanden nog zichtbaar zijn in de API als deze dienstverbanden uitdienst zijn. Bij de default inrichting van de API wordt deze bewaartermijn op 90 dagen ingesteld. Dat wil zeggen dat alleen de dienstverbanden worden getoond waarvoor de datum uitdienst jonger is dat de systeem datum [minus] 90 dagen. Als de datum uitdienst ouder is dan deze 90 dagen dan wordt het dienstverband niet getoond. Zowel niet in het Employment endpoint als ook niet in het Employee endpoint. Als op basis van deze regel er geen enkele dienstverband bij een persoon is vastgelegd dan wordt ook het bijbehorende persoon record niet getoond of verwijderd beschouwd. Bij verwijderen wordt enkel het ID van de persoon getoond met een attribute IsActive = False.   Meer records per page [alle endpoints] Door het verbeteren van de architecture is het ook mogelijk meer records in response op te nemen. Standaard wordt bij elke endpoint maximaal 100 records terug gegeven. Mocht de tabel meer records bevatten dat wordt middels een NextLink de volgende data set aangeboden. Vanaf deze release is het echter ook mogelijk meer dan 100 records in één paging op te vragen. Dit kan middels de parameter take toe te voegen aan de url.   Hieronder een voorbeeld waarbij 125 records per pagina wordt opgehaald. GET https://api.youforce.com//iam/v1.0/persons?take=125 In de nextLink wordt deze page size overgenomen, zodat ook de vervolg pagina's maximaal 125 records bevat.     U kunt een page size tot maximaal 1000 records opvragen.              

De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:     Alle API's Privé contactgegevens niet standaard zichtbaar in API In alle API's is een aparte scope opgenomen voor de privé contactgegevens, zoals adres, telefoonnummer en emailadres. Dit betreft de scope GetPrivateContactDetails.  Standaard is deze scope niet geactiveerd en worden de privé contactgegevens niet in de API weergegeven, alleen het zakelijke emailadres (P01035) en het telefoonnummer werk (P01037) wordt dan in de API getoond. Wilt u privé contact gegevens wel willen gebruiken in uw applicatie dan zult u dat bij uw uw software leverancier moeten aangeven zodat zij de scope voor de applicatie kunnen activeren. Ook zal een de API consultants de autorisatie op uw data moeten wijzigen. Zie ook eerdere bericht Nieuwe scope voor privé contactgegevens zoals adres, telefoonnummer en emailadres      IAM API Het Veld UserUID is toegevoegd aan het endpoint persons Voorheen was het alleen mogelijk om het UserUID op te halen via het GET User endpoint in de IAM API, wat betekende dat het UserUID per persoon opgevraagd moest worden. Vanaf nu is het mogelijk om het veld standaard op te halen via het Person endpoint, waardoor alle UserUID's van alle medewerkers eenvoudig opgehaald kunnen worden.   Extra controles in PATCH User endpoint Er zijn enkele controles toegevoegd aan het patch user endpoint. Er wordt nu strenger gecontroleerd op het formaat van de aangeboden json in de body, waarbij het veld "id" vereist is en niet mag worden ondergebracht in een sub-entiteit zoals "User" of "Users". Raadpleeg het artikel IAM user endpoint  voor de juiste aanroep. Daarnaast wordt er bij de update van de identiteit gecontroleerd of het gebruikersaccount bestaat. Als het gebruikersaccount niet in de Youforce-omgeving wordt gevonden, wordt er een 404-not found melding teruggegeven. Dit kan bijvoorbeeld het geval zijn als het veld "Youforce gebruiker" (P15013) in Beaufort op "Nee" staat. Endpoints voor het schrijven van zakelijk email adres en telefoonnummer toegevoegd Er zijn nieuwe endpoints toegevoegd aan de IAM API voor het terugzetten van het zakelijke e-mailadres (P01035) en telefoonnummer (P01037).       De endpoints zijn: Endpoint Toelichting POST /iam/v1.0/contactDetails/[PersonCode] Met in de body: {     "emailAddress": "demo@visma.com",     "phoneNumber": "010-12345678" } Voor het schrijven van het zakelijk email adres en/of telefoonnummer van een individuele medewerker. POST /iam/v1.0/contactDetails/bulk met in de body: [     {         "personCode": "10000",         "emailAddress": "bulk.01@visma.com",         "phoneNumber": "030-12344567"     },     {         "personCode": "100001",         "emailAddress": "bulk_02@visma.com",         "phoneNumber": "0341-23457"     } ] Voor het schrijven van het zakelijk email adres en/of telefoonnummer van meerdere medewerkers gelijktijdig. Maximaal 100 medewerker per API call. GET /iam/v1.0/ContactDetails/[ticketId]/status waarbij het [ticketId] uit de response van oorspronkelijke POST endpoint gebruikt moet worden. Endpoint voor ophalen van de status van het terugschrijven.    

De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:     Alle API's Extra scope voor het onboarding van klanten  Bij alle API's een extra scope toegevoegd. Deze extra scope is onderdeel van het goedkeuringsproces binnen Visma Raet. Deze extra scope heeft als voordeel dat wij sneller de invite code voor een bepaalde klant kunnen accepteren en invite codes dus minder snel zullen verlopen.   Als software leverancier vragen wij u om deze scope standaard toe te voegen aan nieuwe applicaties die u aanmaakt. Ook als u een applicatie heeft waarop nog nieuwe klanten aan toegevoegd zullen worden, dan vragen wij u deze scope te activeren. De scope heeft geen effect op de werking van de API zelf maar is uitsluitend bedoeld om het proces sneller en transparanter te laten verlopen. Youforce MLM master data API Concept versie beschikbaar De afgelopen periode is de eerste versie van de Youforce MLM master data API op de Visma developer Portal gepubliceerd. Deze API bevat de basis HR gegevens voor een Medical Leave Management systeem en kan in combinatie met het SIVI bericht gebruikt worden. De API zelf bevat geen verzuimgegevens. Voor de verzuimgegevens is het SIVI bericht Verzuimmeldingen beschikbaar. Onderstaand domein model geeft een overzicht van entiteiten en endpoint die beschikbaar zijn binnen deze API.  Voor een volledige beschrijving van de API wordt verwezen naar de documentatie over de Youforce MLM master data API.   

De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:       Het veld expectedRecoveryDate toegevoegd aan het endpoint Sickleaves (WFM api) Aan het endpoint sickleaves is een nieuw veld "expectedRecoveryDate" toegevoegd. Dit veld komt overeen met de Beaufort rubriek  "P01605 Datum verwacht herstel" en wordt gebruikt om bij een ziekte een verwachte herstel datum vast te leggen.    GET https://api.youforce.com/wfm/v1.0/sickleaves   Synchronisatie met HR Core voor de Extension API verbeterd De afgelopen periode is de integratie tussen HR Core Beaufort en de Extension API verbeterd. Daardoor wordt de data vaker gesynchroniseerd en zullen  wijzigingen in Beaufort ook eerder zichtbaar zijn in de extensie API.    Youforce Extensions uitgebreid met extra endpoints voor het MLM domain Vanaf nu is het ook mogelijk om de Youforce Extension API te gebruiken in combinatie met de MLM base API.  Zie hiervoor het algemeen gebruik van de extension API Eigen rubrieken met de Extensions API    De nieuwe endpoint hiervoor zijn: api.youforce.com/extensions/v1.0/mlm/persons      api.youforce.com/extensions/v1.0/mlm/employments     Eerste versie Recruitment API beschikbaar Er is een eerste versie van de recruitment API beschikbaar. Deze eerste versie bevat endpoint voor het ophalen van de organisatie structuur en de basis gegevens van de medewerkers. Met deze eerste versie is het mogelijk om uw huidige medewerkers in uw recruitment systeem op te nemen als mogelijk interne kandidaten.   Beschikbare endpoints zijn: GET Persons  GET Employments GET Users GET Organisation Units GET Role Assignments GET Job Profiles Meer informatie over de recruitment API is te vinden op:  Kennisbank Recruitment API 

Nieuwe functionaliteit en verbeteringen Toegang via Autorisatiebeheer HR Core Online gebruikers en overige gebruikers maken nu gebruik van Autorisatiebeheer om toegang te krijgen tot de Bestandsuitwisseling module. Het toe te kennen recht is “Toegang tot Bestandsuitwisseling”.   File Type Autorisatie via Autorisatiebeheer Op dit moment vindt de gebruikers autorisatie voor de ondersteunde file types nog plaats via een 4me request en wordt afgehandeld door Product Development   In de nabije toekomst zal deze gebruikers autorisatie voor ondersteunde file types ook via Autorisatiebeheer verlopen, en zal het 4me request niet meer nodig zijn.   Nieuw Test File Type: Bestandsuitwisseling Test Een nieuw file type is gedefinieerd in Bestandsuitwisseling voor test doeleinden. Dit file type kan al geautoriseerd worden via Autorisatiebeheer.   Op dit moment kan het file type worden gebruikt om te testen of bestanden correct worden ingezonden door Bestandsuitwisseling. Doorloop de volgende stappen om dit file type te gebruiken:   1 - Voeg het nieuwe recht “Bestandsuitwisseling Test - Zenden” toe in Toegangsbeheer, onder de Applicatie “Bestandsuitwisseling”.    2 - Ga naar de Bestandsuitwisseling applicatie en click op “Send Files”. 3 - Selecteer het nieuwe file type in de dropdown en Zend een willekeurig test bestand.    4 - Als het bestand succesvol is ingestuurd verschijnt het in de “Sent Files” lijst

    Mededelingen  Youforce Developer Portal gaat offline Begin juni wordt de Youforce Developer Portal (https://developers.youforce.com/) offline gehaald. Daarmee is het niet meer mogelijk om applicaties te aan te melden op de Youforce Developer portal. Nieuwe applicatie en credentials moeten vanaf nu via de Visma Developer Portal (https://developer.visma.com/) aangemaakt worden.    Voor klanten die nog credentials uit de oude Youforce Developer Protal in gebruik hebben, veranderd er op dit momenteel nog niets. De credentials blijven geldig en werken met de domein api's en file API. Wel wordt u verzocht om, in samenspraak met uw software leverancier, over te stappen op de Visma Developer Portal.    Meer informatie over de Visma Developer Portal vindt u op de community via onderstaande links: De nieuwe Visma Developer Portal Een API-applicatie overzetten naar de Visma Developer Portal   Nieuwe functionaliteit en verbeteringen De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:   De velden kostenplaats, kostendrager, kostsoort en type toegevoegd aan het endpoint Assignment (WFM & IAM api)  Het endpoint Assignment in de WFM en IAM api is uitgebreid met de volgende velden: costCenter - P01128 - Kostenplaats Inzet costUnit - P01129 - Kostendrager Inzet costType - P01127 - Kostensoort Inzet type - P01123 - Soort Inzet     Extensions API uitgebreid met extra endpoints voor het Recruitment domain Vanaf nu is het ook mogelijk om de Youforce Extension API te gebruiken in combinatie met de Recruitment API.  Zie hiervoor het algemeen gebruik van de extension API Eigen rubrieken met de Extensions API    De nieuwe endpoint hiervoor zijn: api.youforce.com/extensions/v1.0/recruitment/persons      api.youforce.com/extensions/v1.0/recruitment/employments     Tips  Gebruik   api.youforce.com Op dit moment kunt u voor de domein API's zowel de url api.youforce.com als ook de url api.raet.com gebruiken. We adviseren u echter om zoveel mogelijk de url api.youforce.com te gaan gebruiken. De komende tijd blijven beide url's zeker nog actief maar de toekomst kan daar mogelijk verandering in komen. Om deze verandering voor te zijn, adviseren wij u de url api.youforce.com te gebruiken.