De MLM API is uitgebreid met een nieuw endpoint Payroll Clients. Dit endpoint komt overeen met de referentie tabel Opdrachtgever uit HR Core Beaufort.
GET https://api.youforce.com/mlm/v1.0/payrollClients
Hieronder een voorbeeld van het endpoint en het bijbehorende HR Core Beaufort scherm.
De recruitment API is uitgebreid met een nieuw endpoint employmentTypes. Dit endpoint komt overeen met de referentie tabel Soort Arbeidsrelatie uit Beaufort.
GET https://api.youforce.com/recruitment/v1.0/employmentTypes
Onderstaand een voorbeeld van de API en het bijbehorende HR Core Beaufort scherm.
Het endpoint JobProfile is uitgebreid met de volgende velden:
type
costUnit
costType
Deze velden komen overeen met de HR Core Beaufort velden functie type, kostendrager en kostensoort.
Deze velden zijn beschikbaar in alle API's waar het endpoint jobProfile beschikbaar is.
De recruitment API is uitgebreid met aantal nieuwe endpoints voor het aannemen kandidaat uit een recruitment systeem. Vanuit het proces worden de volgende situaties ondersteund:
Aannemen nieuwe medewerker van een nog onbekende persoon, waarbij zowel een nieuw persoon als dienstverband wordt aangemaakt. De zogenaamde new hire.
Aannemen van een medewerker die eerder indienst is geweest, waarbij de persoonsgegevens geactualiseerd kunnen worden en er een nieuwe contract aangemaakt kan worden. De zogenaamde new contract.
Aannemen van een interne medewerker waarbij de medewerker via een interne sollicatie is aangenomen en het bestaande contract wordt aangepast. De zogenaamde contract adjustment.
In de API wordt voor een aangenomen medewerker een workflow in HR Self Service gestart. Afhankelijk van bovenstaande situatie kunnen dat andere workflows zijn. Ook is het mogelijk om bij het aannemen van de kandidaat attachements mee te geven.
API & Connector
De integratie tussen Youforce en het recruitment systeem is een complex proces waarbij interactie tussen het Recruitment systeem en de recruitment API vereist is. In onderstaand schema worden deze interactie tussen beide systemen weergegeven.
Belangrijk om te vermelden is dat de recruitment API enkel een single tenant omgeving ondersteunt. Dat wil zeggen dat het niet mogelijk is de recruitment API te gebruiken als je in Beaufort en HR Self Service meerdere klanten in één database heb samengevoegd.
Endpoint search Person
Hiervoor biedt de API een endpoint waarmee het recruitment systeem kan zoeken of de betreffende kandidaat als persoon bestaat in het HR Core systeem. Velden waarop gezocht kan worden zijn:
knownAs
lastNameAtBirth
lastNameAtBirthPrefix
birthDate
birthPlace
Het endpoint is:
GET https://api.youforce.com/recruitment/v1.0/persons/search
Note:
Het endpoint is bedoeld om te bepalen of de persoon al in het Core systeem bestaat en daarbij het persoonsnummer op te halen. Dit betekent dat er altijd één of meerdere zoekcriteria opgegeven moeten worden. Bij meer dan 10 resultaten wordt er een foutmelding gegeven en wordt verzocht de zoekcriteria meer specifiek te maken.
Het endpoint zoekt altijd over de hele populatie van de klant. Dus ook oud-medewerkers en eventuele andere personen die de klant in zijn core systeem heeft opgenomen
De endpoints new hire, new contract en contract change
Op basis van het feit of het om een nieuwe of een bestaand persoon gaat wordt het endpoint voor een nieuwe hire of een nieuw contract opgestart.
Het endpoint voor de hire is:
POST https://api.youforce.com/recruitment/v1.0/hires
Het endpoint voor een re-hire is:
POST https://api.youforce.com/recruitment/v1.0/persons/xxxx/contracts
waarin xxxx het persoonsnummer van de bestaande medewerker is.
Het endpoint voor een change contract:
POST https://api.youforce.com/recruitment/v1.0/persons/xxxx/contracts/yyy/Adjustments
waarin xxxx het persoonsnummer van de bestaande medewerker is en yyy het dienstverband volgnummer.
De endpoints werken asynchroon. Dat wil zeggen dat een POST eerst intern in de API wordt weggeschreven en op de achtergrond een workflow start. De POST call geeft dan ook enkel een ID teruggeeft. Dit ID kan gebruikt worden om via een status endpoint, de status van de API call en de workflow informatie op te vragen.
De endpoints die gebruikt kunnen worden om de status op te vragen zijn:
GET https://api.youforce.com/recruitment/v1.0/hires/zzzz-zzzzz-zzzz/status
waarin zzzz-zzzzz-zzzz het ID van de API call is
GET https://api.youforce.com/recruitment/v1.0/persons/xxxx/contracts/zzzz-zzzzz-zzzz/status
waarin xxx de persoonscode is en zzzz-zzzzz-zzzz het ID van de API call is
Te starten workflow
Default workflow: Indien in de header van de API call geen workflow wordt meegegeven, dan wordt de workflow gestart zoals die bij de configuratie door de API consultant is ingericht.
Specifiek workflow: Bij de API call kan ook een workflow meegegeven worden. Bijvoorbeeld om onderscheid te maken tussen een Nieuwe verloonde medewerker of een Inhuurkracht (PNIL).
De header X-Raet-Workflow stuurt welke workflow wordt gestart.
De medewerker gegevens
Voor zowel de hire en re-hire wordt de medewerker data in de body meegegeven.
Bij een hire worden de persoonsgegevens gebruikt om een nieuwe persoon te creëren.
Bij de Re-hire worden de persoonsgegevens gebruikt om bestaande gegevens bij te werken. Bijvoorbeeld als de medewerker sinds zijn laatste uitdiensttreding is verhuisd.
De API werkt met een standaard mapping tussen de API en de Beaufort rubrieken. Eventueel kan de API consultants afwijkende mapping voor specifieke rubrieken vastleggen. Bijvoorbeeld als u een eigen rubriek gebruikt voor het vastleggen van de soort arbeidsrelatie.
Eigen rubrieken
Naast dat de consultant de mapping van de velden kan aanpassen, is het ook mogelijk om extra rubrieken in de API mee te geven. Hiervoor dient u wel de rubrieksnummers uit HR Self Service te gebruiken en dient het een PS of DV rubriek te zijn.
De extra rubrieken kunnen in de body meegegeven worden als customFields.
"customFields": [ {"fieldCode": "B12071", "fieldValue": "BE56363123456788"}, {"fieldCode": "B12081", "fieldValue": "BBRUBEBB"} ]
Attachements
Bij zowel de hire, re-hire en contract changes endpoint kan naast de medewerker data ook één of meerdere attachements toegevoegd worden.
Hierbij geldt wel de volgende restricties:
Maximaal 20 attachments per kandidaat
Maximale file size is 4 mb per bestand
Maximale bericht omvang (data + bestanden) is 28 mb
De volgende bestandstypen worden ondersteund:
Simpele tekst bestanden zonder opmaak (text/plain)
Pdf documenten (application/pdf)
MS Word documenten DOCX formaat (vanaf 2007) (application/vnd.openxmlformats-officedocument.wordprocessingml. document)
MS Word documenten (pre-2007) (application/msword)
Open document formaat bijvoorbeeld van OpenOffice en LibreOffice (application/vnd.oasis.opendocument.text)
Diverse soorten images (image/*)
Voor het toevoegen van de attachements kan een sectie files aan de API call toegevoegd worden met de volgende informatie:
Name : De file name (maximaal 150 tekens lang).
Category(optional) : De label of category indien dit in HRSS in geconfigureerd.
contentBase64 : Het bestand in Base64 formaat
"files": [ {"name": "Application letter.txt", "category": "Demo", "contentBase64": "VGhpcyBpcyBhIHRlc3Q=" }, {"name": "curriculum vitae.txt", "category": "Demo", "contentBase64": "VGhpcyBpcyBhIHRlc3Q=" } ]
Verdere informatie
Meer technische informatie is te vinden op Youforce API Documentation. Daar vindt u de swagger documentatie en een link naar een postman collectie met voorbeeld.
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.
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
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.
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
Nieuwe functionaliteit en verbeteringen
Veld effectiveDate toegevoegd aan adresgegevens (Alle API's)
In het endpoint Person is bij de adresgegeven het veld effectiveDate toegevoegd. Dit veld komt overeen met het veld 'Adres m.i.v.' uit het Beaufort scherm Additionele adresgegevens Persoon (rubriek P011012 / P01011) . Het veld is beschikbaar in alle API met een endpoint Person.
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.
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
In de afgelopen weken hebben we hard gewerkt aan nieuwe updates en verbeteringen van de Bestandsuitwisseling module. Hier volgt een overzicht van de belangrijkste nieuwe features en wijzigingen:
File Type Autorisaties
De autorisatie van file types is verplaatst van organisatieniveau naar gebruikersniveau.
Dit betekent dat Product Development nu op gebruikersniveau autorisatie tot specifieke file types kan verlenen. Bestaande Bestandsuitwisseling gebruikers zijn geautoriseerd voor alle file types waar voorheen hun organisatie voor was geautoriseerd.
Autorisaties voor nieuwe gebruikers of extra autorisaties voor bestaande gebruikers moeten worden aangevraagd via 4me.
Toegang Autorisatie voor HR Core Online gebruikers
HR Core Online gebruikers blijven Policy Management gebruiken om toegang tot de Bestandsuitwisseling module te verlenen.
Omdat er nu gebruik wordt gemaakt van gebruikersniveau autorisatie, zijn de toe te kennen rechten in Policy Management versimpeld. Het enige verplichte recht nodig voor toegang tot de applicatie is “Toegang tot Bestandsuitwisseling”.
Toegang Autorisatie voor Niet HR Core Online gebruikers
Niet HR Core Online gebruikers zullen geen gebruik maken van Policy Management om toegang te verlenen tot de Bestandsuitwisseling module.
Voor nu zal de toegang in de Bestandsuitwisseling module zelf worden geregeld door Product Development, en wel op hetzelfde moment als de gebruikers autorisatie voor de verschillende file types.
In de toekomst zal deze functionaliteit terug te vinden zijn in Toegangsbeheer.
Hernoemd
De naam van de module is gewijzigd van Visma Files naar File Exchange. Op dit moment wordt nog alleen de Engelse taal ondersteund. In de nabije toekomst zal de Nederlandse taal worden ondersteund en zal de module de naam Bestandsuitwisseling voeren.
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.