Update 19-04-2024
Op vrijdag 19 april is het certificaat op onze server api.youforce.com vervangen. Het nieuwe certificaat is geldig tot 4 mei 2025 en vervangt het oude certificaat op de server.
Bericht van 15-04-2024 Wij willen u informeren dat het huidige certificaat voor de URL api.youforce.com op 23 april 2024 verloopt. Deze week zal dit certificaat worden vervangen door een nieuwe versie, waarbij de volgende fingerprint wordt toegepast: 2581422998C313AAFCA55D948ECCA393EF9E5197.
Indien u in uw IT-landschap een controle heeft ingesteld voor dit certificaat, willen wij u vriendelijk verzoeken om deze te updaten naar de nieuwe versie zodra deze beschikbaar is. Dit zorgt ervoor dat uw systemen correct blijven functioneren zonder onderbrekingen als gevolg van het verlopen certificaat.
Deze releasenotes zijn technisch van aard en bedoeld voor File API-ontwikkelaars die direct met de File API integreren of bekend zijn met de technische werking ervan.
Deel deze release notes graag met de IT-afdeling van jullie organisatie.
Inleiding
De file API maakt op dit moment gebruik van het veilige OAUTH 2.0 protocol om gebruikers te authenticeren en bestanden uit te wisselen. Dit OAUTH 2.0 protocol is een wereldwijde standaard voor gegevensuitwisseling via API’s en wordt beschouwd als zeer veilig. Een 100% veiligheid is in onze huidige IT wereld echter moeilijk te garanderen. We proberen dan ook steeds de kansen op gegevensverlies nog verder te minimaliseren. Zo is er ook voor het OAUTH 2.0 protocol een uitbreiding bedacht die deze kansen nog verder minimaliseert, de DPOP-token implementatie.
Het implementeren van het DPoP token vereist een programmatische aanpassing aan de klantzijde. Daarom is deze optie vooral bedoeld voor klanten die zelf software ontwikkelen/hebben ontwikkeld voor gebruik met de File API.
Neem zo nodig contact op met je IT afdeling of dit voor jullie een optie is.
Gebruiken jullie op dit moment de powershell scripts om met de File API te communiceren, houd dan dit kanaal in de gaten. In de nabije toekomst zullen we het DPoP-token ook in de powershell scripts implementeren.
Huidige situatie
Momenteel ondersteunt de File API geen DPoP-tokens als OAuth-bewijstype.
Nieuwe situatie
Vanaf vandaag, 26 februari 2025, worden DPoP-tokens ook ondersteund.
Jouw actie:
Indien je er zorg voor wilt dragen dat uitsluitend de rechtmatige ‘client’ een specifiek toegangstoken kan gebruiken, kun je de DPoP-stroom implementeren in je File API applicatie. Zodra de wijzigingen aan jullie kant zijn geïmplementeerd, kan je de onderstaande toggle activeren in het Visma Developer Portal → My Applications → Details. Deze wijziging zorgt voor een nog betere beveiliging van jouw File AP integratie.
Officiële specificatie:
RFC 9449 - OAuth 2.0 Demonstrating Proof-of-Possession (DPoP)
Ondersteunde cryptografische algoritmen:
Onze implementatie hanteert strikte beveiligingsmaatregelen en ondersteunt uitsluitend de volgende cryptografische algoritmen:
RSA: RS256, RS384, RS512, PS256, PS384, PS512
ECDSA: ES256, ES384, ES512
Het gebruik van het algoritme 'none' wordt expliciet geweigerd.
Unieke identificator voor de DPoP-proof JWT:
Deze implementatie bevat een validatie om reply-aanvallen te voorkomen. Hiervoor worden de waarden die in de jti-claim worden verzonden gedurende het geldigheidsvenster opgeslagen, zodat wordt gewaarborgd dat deze waarde uniek is en slechts één keer wordt gebruikt. Zorg ervoor dat je bij elke aanvraag een unieke GUID opgeeft in de jti-claim.
Dit zijn de fixes sinds versie 1.22:
Het upload script logde nog niet in de Monitor file. Dit is verholpen.
Verbeterde afhandeling bij het verwijderen van tijdelijke bestanden
Bug opgelost waarbij het genoemde aantal bestanden voor uploaden verkeerd werd getoond als er maar 1 bestand klaar stond om te uploaden.
Upload script maakte log bestand aan met de verkeerde naam. Dit is verholpen.
Volg de instructies in ons kennisbank artikel om de nieuwste scripts (1.24) te installeren.
De afgelopen periode zijn er weer een aantal verbeteringen in de API's doorgevoerd.
API's nu ook beschikbaar via Visma developer portal
De Visma developer portal is binnen de Visma groep de centrale plaats voor delen en publiceren van API's uit de Visma groep voor derden. Om hierbij aan te sluiten hebben we de afgelopen periode de IAM en Learning API op de Visma developer portal gepubliceerd. De IAM en Learning API is ook nog beschikbaar via de oude Raet developer portal waardoor bestaande integraties niet zullen wijzigen.
Voor nieuwe integraties zal er door de API consultant veelal voor gekozen worden om deze via de nieuwe Visma developer Portal te ontsluiten. Ook nieuwe API zullen in de toekomst enkel nog via deze nieuwe Portal gepubliceerd worden. Onze API consultants zullen developers en klanten tijdens de implementatie hierbij begeleiden.
Een uitgebreide beschrijving voor het aanmaken van een account staat beschreven op de deze pagina. Wij adviseren uit echter om vooraf eerst contact op te nemen met onze API consultant (api.consulting.raet@visma.com). Zij kunnen aanvullende uitleg geven over het gebruik van de Visma Developer portal.
Extension API toegevoegd aan Visma developer portal
In de nieuwe Visma Developer portal is de Extensie API als uitbreiding op een domein API, zoals zoals de IAM of Learning API, beschikbaar gekomen. Met deze extensie API is het mogelijk om extra velden aan de domein API toe te voegen. Bijvoorbeeld het toevoegen van een klant eigen rubriek behorende bij de persoon of het dienstverband.
De extensie API dient altijd in combinatie met één van de domein API gebruikt te worden. Tevens kunnen enkel niet-ingedeelde rubrieken op het niveau Persoon of Dienstverband aan de API toegevoegd worden. Het toevoegen van extra velden kan op dit moment geregeld worden door een API consultant. Uiteraard geldt wel dat het ontvangende systeem ook met extra velden en endpoints overweg moet kunnen gaan. Een uitgebreide beschrijving is te vinden op deze pagina
De extensies kunnen per per klant en domain API verschillend. Voor respectievelijk de IAM en learning API hebben wij de volgende endpoints beschikbaar. api.youforce.com/extensions/v1.0/IAM/persons api.youforce.com/extensions/v1.0/IAM/employments api.youforce.com/extensions/v1.0/learning/persons api.youforce.com/extensions/v1.0/learning/employments
Afhankelijk van de gekozen endpoint worden de extensies op persoons- of dienstverband niveau weergegeven. Indien de rubriek in Beaufort bestaat uit veld met een referentie tabel dan wordt ook de bijbehorende omschrijving uit de referentietabel in het endpoint weergegeven. Zie onderstaand voorbeeld bij rubriek API002.
Het endpoint Job profiel is uitgebreid met de volgende velden:
De velden zijn beschikbaar in alle API met het endpoint Job Profile.
De data van de velden is afkomstig van het scherm Functie uit Beaufort.
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:
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.
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.
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.
De afgelopen periode zijn de volgende verbeteringen in de API's doorgevoerd:
WFM API
Nieuwe endpoints voor Employments en Salary Details beschikbaar De WFM API is uitgebreid met 2 nieuwe endpoints voor Employments en Salary Details. Beide endpoint zijn gebaseerd op de historie tabel van Beaufort waardoor de endpoints de ingangsdatum bevat. De nieuwe endpoints zijn:
employmentTimelines
salaryDetailTimelines
Het endpoint employmentTimelines bevat dezelfde velden als het oorspronkelijk endpoint employments maar dus nu ook inclusief ingangsdatum waardoor er een soort tijdlijn ontstaat. Hetzelfde geldt voor de endpoints salaryDetailTimelines en salaryDetails. Voor zowel het endpoint employmentTimelines als ook het endpoint SalaryDetailTimelines geldt dat data met ingangsdatum uit de historie tabel komen. In de standaard inrichting van Beaufort staat voor deze rubrieken de historie aan (zie Beaufort scherm standaard rubrieken). Onderstaand een voorbeeld van het nieuwe endpoint employmentTimelines
Op dit moment wordt de API data voor deze nieuwe endpoints één keer per dag om 18:00 UTC met Beaufort gesynchroniseerd.
Alle domein API's
Het endpoint organisation units is uitgebreid met de velden indicatie geblokkeerd, kostenplaats en adresgegevens.
Het endpoint organisation units van zowel de Learning, IAM als ook de WFM api is uitgebreid met de volgende API velden:
isBlocked (True/false)
Address
PhoneNumber
CostCenterCode
Deze velden komen overeen met de volgende gegevens uit Beaufort.
Note: het veld isBlocked (Inactief) wordt in Beaufort vaak gebruikt om organisatie eenheden inactief te maken tijdens een reorganisatie. Deze indicatie wordt dan gebruikt om aan te geven dat er geen nieuwe medewerkers meer op de organisatie eenheid mogen worden geplaatst. Echter bij een reorganisatie komt het regelmatig voor dat bestaande medewerkers nog herplaatst moeten worden. De indicatie IsBlocked wil dus niet zeggen dat er geen medewerkers meer aan gekoppeld zijn.
Visma Developer Portal
Vanaf nu zijn alle domein API inclusief alle endpoints te gebruiken via de Visma Developer portal. De Visma Developer Portal (https://oauth.developers.visma.com/) vervangt hiermee de oudere developer portal als de Youforce developer portal (https://developers.youforce.com/) of Raet developer portal (https://developers.raet.com/)
note: De meest recente aanpassing betreft het endpoint Get users. Vanaf nu werkt ook dit GET users endpoint in de learning en IAM api met een Visma account uit de Visma developer portal. Heeft u nog credentials op één van de oude developer Portal dan kunt u die nog blijven gebruiken. Echter nieuwe credentials kunnen alleen nog aangemaakt worden via de Visma Developer Portal. Zie hiervoor: Aanmaken credentials Visma Developer Portal
Ook adviseren wij u om met uw applicatie over te gaan naar de nieuwe Visma Developer portal. De Visma developer portal heeft als voordeel dat u en u collega samen de apps en credentials kunt beheren. Wel zijn daarbij enkele aandachtspunten waarmee uw development omgeving rekening moet houden, zie onderstaande tabel.
Oude Raet developer portal
Oude Youforce Developer Portal
Nieuwe Visma developer Portal
Authencation token
url: https://api.raet.com/authentication /token
Met in de Body de volgende authenticatie gegevens uit de Raet developer portal:
client_id
client_secret
url: https://api.youforce.com/authentication /token
Met in de Body de volgende authenticatie gegevens uit de Youforce developer portal:
client_id
client_secret
url: https://connect.visma.com /connect/token
Met in de Body de volgende authenticatie gegevens uit de Visma developer portal:
client_id
client_secret
tenant_id
Let op: De tenant_id is dus toegevoegd aan de authencation en wordt tussen de endpoint meegegeven in de bearer token.
GET User endpoint
niet beschikbaar
In learning API is het endpoint beschikbaar via verschillende url versie zoals v0.1 en v.1.0 GET https://api.youforce.com//learning/v0.1/ users (employeeId=xxxx) GET https://api.youforce.com//learning/v1.0/ users (employeeId=xxxx)
In de Learning en IAM is het endpoint enkel beschikbaar via de url versie v1.0 GET https://api.youforce.com//learning/v1.0/ users(employeeId=10010)
All endpoints
base url: api.raet.com met de volgende gegevens in de header
bearer authorisation token uit het raet.com authorisation token
Tenant_id. Dit is een 7-cijferig nummer dat de klant binnen Raet identificeert
base url: api.youforce.com met de volgende gegevens in de header
bearer authorisation token uit het youforce.com authorisation token
Tenant_id. Dit is een 7-cijferig nummer dat de klant binnen Raet identificeert
base url: api.youforce.com met de volgende gegevens in de header
bearer authorisation token uit het visma.com authorisation token. In dit visma token zit de tenant_id al verwerkt
Note: Het tenant_id hoeft dus niet meer bij elke API call meegegeven worden. Wordt de tenant_id per ongeluk wel meegegeven in de API call dan wordt deze genegeerd Daarnaast blijven de endpoints via de base url api.youforce.com
Met het veld Reden einde dienstverband (P01113) in Beaufort wordt aangegeven op welke grond het dienstverband is beëindigd. Afhankelijk van de reden is het soms wenselijk in een Learning systeem of in een IAM systeem anders te handelen. Om dit mogelijk te maken, is het veld Termination Reason toegevoegd aan het employment endpoint in zowel de Learning als de IAM API.
De Youforce Suite is uitgebreid met een nieuwe API voor sociale werkbedrijven. Deze API is speciaal ontworpen om beter aan te sluiten bij systemen voor de uitvoering van de Participatiewet en de Wet Sociale werkvoorziening. De API biedt alle noodzakelijke informatie om Youforce effectief te gebruiken als het primaire HR-systeem voor de registratie van alle medewerkers, waarbij de API zorgt voor de integratie met een cliëntvolgsysteem dat voldoet aan de wettelijke eisen van de Participatiewet en de WSW.
De kernfunctionaliteiten van deze API omvatten:
Medewerker Data: Mogelijkheden voor het ophalen van gedetailleerde gegevens over medewerkers, wat essentieel is voor zowel het beheer van human resources als het volgen van cliënten binnen de wettelijke kaders.
Organisatiestructuur & Roltoewijzing: Biedt endpoints die inzicht geven in de hiërarchie en structurele opbouw van een organisatie, samen met de koppeling van rollen aan specifieke medewerkers. Deze informatie is cruciaal voor het begrijpen van de verantwoordelijkheden binnen een organisatie, alsook voor het toewijzen van cliënten aan specifieke casemanagers of begeleiders.
Werkpatronen & Afwezigheid: Functionaliteit voor het bijhouden van de werkschema's van medewerkers, evenals eventuele afwezigheid door ziekte of verlof. Deze aspecten zijn belangrijk voor rapportage in het kader van de wet- & regelgeving zoals vastgelegd in de Participatiewet en de WSW
Extensie API
Tevens is het mogelijk om de API uit te breiden via een extensie API, waarmee aanvullende gegevens uitgewisseld kunnen worden. Dit biedt flexibiliteit en zorgt ervoor dat de API kan worden aangepast aan de specifieke behoeften van elke organisatie.
Autorisatie Wanneer de API wordt geactiveerd, wordt in samenspraak met een API-consultant bepaald welke endpoints beschikbaar komen op basis van scopes. Daarnaast kan een autorisatiefilter worden geconfigureerd om nauwkeurig te bepalen welke medewerkers in de API worden opgenomen.
Technische informatie
Technische informatie, zoals swagger documentatie en een voorbeeld postman collectie is terug te vinden op de Youforce API Documentation
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.
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
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.
Improvements
Learning API: New endpoints for uploading other type of documents
We have added new endpoints for the following document types:
certificate / Certificaat
diploma / Diploma
career agreement / Loopbaan afspraak
career mail / Correspondentie loopbaan
career other / Overige loonbaan documenten
appraisal Review / Beoordelingsgesprek
performance Review / Functioneringsgesprek
To use these endpoints, the document type needs to be activated in the personal file system (authorisation & configuration Personal file system). All these endpoint are available as version 1.1.
See here for more information
Solved issues
SIVI API : Postal code in uppercase and without spaces
In HR Core Beaufort it is possible to store the postal code in different formats. For instance with spaces (1234 AB) or in lower case (1234 ab). The Sivi standard requires a fixed format without spaces and in uppercase (1234AB). Note: The API will not change the postal code if it's invalid or doesn't exists.
The issue is solved
In this update you can find the improvements and solved issues in the domain api's.
Improvements
IAM API: New fields are added to the employment endpoint
The following fields are added to the employment endpoint.
PayrollClientCode ( P01103 Opdrachtgever)
PayrollInsittutionCode ( P01104 Instelling)
Classification ( P01110 - Code doelgroep)
Learning API: User endpoint added to version 1.0
The user endpoint is added to version 1.0 of the learning API. This endpoint will return the unique ID of the user which can be used for the SSO process of a customer.
For example:
GET https://api.youforce.com/learning/v1.0/users(employeeId=10010)
By adding this endpoint version 1.0 of the learning API is backwards compatible with version 0.1.
Action API Consumer:
We ask you to change the url of you api call to this new version. Version 0.1 is deprecated from now.
Solved issues
Learning API : Texts with special chars were not displayed correctly [VRINA-1613]
Special characters for the fields 'FirstNames' or 'KnownAs' were not correctly processed in the API database. As result to API shows the name incorrectly.
For example:
-> "KnownAs": "Desirée"
was showed as:
-> "KnownAs": "Desir?e"
The issue is solved.
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 Sickleave in HR Core Beaufort biedt nu uitgebreidere informatie over ziekteregistraties van medewerkers. Voorheen werd alleen de ingangsdatum van een ziekteperiode getoond. Vanaf deze update wordt ook de einddatum van het ziekteverlof weergegeven, rechtstreeks afkomstig uit HR Core Beaufort. Deze toevoeging maakt het sluiten van ziekteperiodes eenvoudiger en overzichtelijker.
GET https://api.youforce.com/wfm/v1.0/sickleaves