Skip to main content

Youforce (Visma)

Category: Direct connection · preview, from v1.57

HR data from Visma's Youforce reaches your data warehouse through the Youforce Data API. Yres requests the data per source in one go and then loads each entity into its own table, with its own line in monitoring.

Preview

Youforce is available as a preview in v1.57, which is why the web app lists the source as Youforce (Preview). The end of this page describes how the connection works in the preview.

Expected input​

You pick the source in Data sources via Create source under Services & Apps › Youforce (Preview). Besides the fields that apply to every source (source name, type, integration runtime, whether the credentials are the same for all environments, an optional credential expiry date, tags), the Youforce form asks for the following fields:

FieldNotes
Client idThe client id of your application in the Visma Developer Portal.
Client secretThe matching client secret.
Configuration idThe configuration that defines which entities and fields Youforce delivers, for example default-4028868. You get it from Visma|Raet.
Tenant id (optional)The Visma tenant id. Only needed when your application serves more than one tenant.

Authentication: OAuth through Visma Connect (client credentials). Yres requests an access token itself with the client id and client secret, and renews it automatically while a load is running. When your application serves several tenants, Yres sends the tenant id along with the token request. That way you connect each tenant as a source of its own.

Integration runtime: the Youforce Data API is publicly reachable over HTTPS, so the cloud runtime AutoResolveIntegrationRuntime is enough.

Where the credentials go: the web app stores no secrets. The backend writes the values to the Azure Key Vault of your own environment, under the name group adf-{sourcename}-…:

  • adf-{sourcename}-clientId
  • adf-{sourcename}-clientSecret
  • adf-{sourcename}-configurationId
  • adf-{sourcename}-tenantId (only when you filled in a tenant id)

Preparation (at Visma)​

  1. Register an application in the Visma Developer Portal. That is where you find the client id and create a client secret.
  2. Subscribe the application to the Youforce Data API with the scopes youforce-data-api:metadata:read, youforce-data-api:data:read and youforce-data-api:jobs:manage.
  3. Have the organization grant the application access to its Youforce tenant.
  4. Ask Visma|Raet for the configuration id. That configuration defines which entities and fields Yres can retrieve.

Adding tables​

Youforce uses the regular table flow. After connecting, click Refresh metadata: the pipeline GetMetaData - <source> reads the entities and their fields from the configuration. You then add entities with the Add table wizard, as described in Connect & load a data source. Each entity gets its own STAGE and HIS table.

How Yres loads Youforce​

Most sources load table by table. Youforce loads per source:

  1. Yres starts one request at the Youforce Data API for all entities of the configuration.
  2. Yres follows the progress of that request until Youforce has finished it.
  3. Yres then loads each entity into its own table and processes the history (SCD2). Each entity has its own line in monitoring, with its own status and counts.

The first load retrieves everything. After that, Yres only requests the changes since the previous load, based on the change version that Youforce keeps. A full request happens again when you start a load as FULL or when an entity has been added that was not loaded before. Yres therefore decides per load whether the request is full or incremental.

Visma allows one running request at a time and at most three full requests per day. Plan your loads well within those limits.

How it works in the preview

In the preview Yres requests the data as CSV and one change version applies to the whole source. Yres loads the data as soon as Youforce has fully completed the request. The source loads into the data warehouse; the Data Lake path is not yet available for Youforce.

Official documentation: Visma Developer Portal.


See also: Integration catalog · All data source requirements · Connect & load a data source · Integrations — overview