Youforce (Visma)
Categorie: Directe koppeling · preview, vanaf v1.57
HR-gegevens uit Youforce van Visma komen via de Youforce Data API in je datawarehouse. Yres vraagt de gegevens per bron in één keer op en laadt daarna elke entiteit in een eigen tabel, met een eigen regel in de monitoring.
Youforce is in v1.57 beschikbaar als preview. In de webapp heet de bron daarom Youforce (Preview). Onderaan deze pagina staat hoe de koppeling in de preview werkt.
Verwachte input
Je kiest de bron in Data sources via Create source onder Services & Apps › Youforce (Preview). Naast de velden die voor elke bron gelden (bronnaam, type, integration runtime, of de credentials voor alle omgevingen gelijk zijn, eventuele vervaldatum van de credentials, tags) vraagt het Youforce-formulier de volgende velden:
| Veld | Toelichting |
|---|---|
| Client id | De client id van je applicatie in de Visma Developer Portal. |
| Client secret | Het bijbehorende client secret. |
| Configuration id | De configuratie die bepaalt welke entiteiten en velden Youforce levert, bijvoorbeeld default-4028868. Je krijgt hem van Visma|Raet. |
| Tenant id (optional) | De Visma-tenant-id. Alleen nodig als je applicatie meer dan één tenant bedient. |
Authenticatie: OAuth via Visma Connect (client credentials). Yres vraagt zelf een toegangstoken aan met de client id en het client secret. Zolang een laadactie loopt, vernieuwt Yres het token automatisch. Bedient je applicatie meerdere tenants, dan stuurt Yres de tenant-id mee bij het aanvragen van het token. Zo koppel je elke tenant als een eigen bron.
Integration runtime: de Youforce Data API is publiek bereikbaar via HTTPS, dus de cloud-runtime
AutoResolveIntegrationRuntime volstaat.
Waar de credentials terechtkomen: de webapp bewaart geen secrets. De backend schrijft de waarden naar de
Azure Key Vault van je eigen omgeving, onder de naamgroep adf-{bronnaam}-…:
adf-{bronnaam}-clientIdadf-{bronnaam}-clientSecretadf-{bronnaam}-configurationIdadf-{bronnaam}-tenantId(alleen als je een tenant-id hebt ingevuld)
Voorbereiding (bij Visma)
- Registreer een applicatie in de Visma Developer Portal. Daar vind je de client id en maak je een client secret aan.
- Abonneer de applicatie op de Youforce Data API met de scopes
youforce-data-api:metadata:read,youforce-data-api:data:readenyouforce-data-api:jobs:manage. - Laat de organisatie de applicatie toegang geven tot haar Youforce-tenant.
- Vraag bij Visma|Raet de configuration id op. Die configuratie legt vast welke entiteiten en velden Yres kan ophalen.
Tabellen toevoegen
Youforce werkt met de gewone flow voor tabellen. Na het koppelen klik je op Refresh metadata: de
pipeline GetMetaData - <bron> haalt de entiteiten en hun velden uit de configuratie op. Daarna voeg je
entiteiten toe met de Add table-wizard, zoals beschreven in
Databron koppelen & laden. Elke entiteit krijgt een eigen STAGE- en
HIS-tabel.
Hoe Yres Youforce laadt
Bij de meeste bronnen laadt Yres tabel voor tabel. Bij Youforce gaat het per bron:
- Yres zet één opvraging klaar bij de Youforce Data API voor alle entiteiten van de configuratie.
- Yres volgt de voortgang van die opvraging tot Youforce hem heeft afgerond.
- Daarna laadt Yres elke entiteit in haar eigen tabel en verwerkt de historie (SCD2). Elke entiteit heeft een eigen regel in de monitoring, met haar eigen status en aantallen.
De eerste laadactie haalt alles op. Daarna vraagt Yres alleen de wijzigingen sinds de vorige laadactie op, op basis van de wijzigingsversie die Youforce bijhoudt. Een volledige opvraging volgt opnieuw wanneer je een laadactie als FULL start of wanneer er een entiteit bij is gekomen die nog niet eerder is geladen. Yres bepaalt dus per laadactie zelf of de opvraging volledig of incrementeel is.
Visma staat één lopende opvraging tegelijk toe en maximaal drie volledige opvragingen per dag. Plan de laadacties daar ruim binnen.
In de preview vraagt Yres de gegevens op als CSV en geldt één wijzigingsversie voor de hele bron. Yres laadt de gegevens zodra Youforce de opvraging volledig heeft afgerond. De bron laadt naar het datawarehouse; het Data Lake-pad is voor Youforce nog niet beschikbaar.
Officiële documentatie: Visma Developer Portal.
Zie ook: Integratiecatalogus · Alle databron-vereisten · Databron koppelen & laden · Integraties — overzicht