Last modified: Nov 10, 2024

Prefilling data using configuration

How to configure prefill for an app using configuration files.

Using configuration only, Altinn apps support prefill with data from the Central Coordinating Register (Enhetsregisteret), the National Population Register (Folkeregisteret) and user profile in Altinn.

By following the description below, you will during instantiation of a form prefill the data model with the defined values obtained from Altinns data base.

Prefill from national register and user profile

Setup of prefill in the application repository

Create a new json file in the app repo under App/models. The name of the file should contain the name of the data model and have the postfix “.prefill.json”. If the data model is called appModel you should now be able to find these three files in the map: appModel.metadata.json, appModel.schema.json, appModel.prefill.json

Paste the code below into the file.

{
    "$schema": "https://altinncdn.no/schemas/json/prefill/prefill.schema.v1.json",
    "allowOverwrite": true,
    "ER": {
    },
    "DSF": {
    },
    "UserProfile": {
    }
}

Configuration of prefill.json

  • $schema points to the json schema definition of the file. The current version is v1. Because of this file, Visual Studio Code will validate and offer intellisense/autocomplete when you edit the file locally.

  • allowOverwrite determines whether prefill defined in this file can overwrite a field in the data model if it already has a value.

  • ER here you enter fields from the data model that are to be prefilled with data from the Central Coordinating Register. Fields that are prefilled with ER-data will only have a value if you instantiate on behalf of an organization. Instantiation will fail if you attempt to prefill ER-data, but do not have an organization available.

The example below will populate the field Datamodell.Organisasjon.Organisasjonsnummer with the organization number retrieved from the Central Coordinating register.

"ER": {
    "OrgNumber":"Datamodell.Organisasjon.Organisasjonsnummer"
}
  • DSF here you enter fields from the data model that are to be prefilled with data from the National Population Register. The field that is prefilled with DSF-data will only have a value if you instantiate on behalf of a person. Instantiation will fail if you attempt to prefill DSF-data, but do not have a person available.

The example below will populate the field Datamodell.Person.Nummer with the phone number retrieved from the National Population Register.

"DSF": {
   "TelephoneNumber":"Datamodell.Person.Nummer"
}
  • UserProfile here you enter fields from the data model that are to be prefilled with data from the users profile in Altinn. Note that it is the logged in user who instantiates the app the data is collected for.

The example below will populate the field Datamodell.Bruker.Epost with the email retrieved from the users profile in Altinn.

"UserProfile": {
    "Email":"Datamodell.Bruker.Epost"
}

Available prefill values

The JSON-schema definition of the prefill file is also available here. The use of a schema enables editors, e.g. Visual Studio Code, to validate and offer intellisense for faster editing.

The National Population Register

The personal data that is exposed is attached to the person the form is instantiated on behalf of. If Ola Nordmann were to instantiate a form on behalf of Kari Nordmann, it would be Kari’s data that would be exposed. Available values for prefill includes:

  • SSN
  • Name
  • FirstName
  • MiddleName
  • LastName
  • TelephoneNumber
  • MobileNumber
  • MailingAddress
  • MailingPostalCode
  • MailingPostalCity
  • AddressMunicipalNumber
  • AddressMunicipalName
  • AddressStreetName
  • AddressHouseNumber
  • AddressHouseLetter
  • AddressPostalCode
  • AddressCity

The Central Coordinating Register

The unit exposed is that which is attached to the organization a form is instantiated on behalf of. Available values for prefill includes:

  • OrgNumber
  • Name
  • UnitType
  • TelephoneNumber
  • MobileNumber
  • FaxNumber
  • EMailAddress
  • InternetAddress
  • MailingAddress
  • MailingPostalCode
  • MailingPostalCity
  • BusinessAddress
  • BusinessPostalCode
  • BusinessPostalCity

User profile

The user profile exposed is the profile belonging to the one who instantiated the service. If Ola Nordmann instantiates a form on behalf of Kari Nordmann, the data retrieved from here would belong to Ola. For the objects Party.Organization and Party.Person, you will find the same fields that are included in ER and DSF-prefill. Note that Party.Organization will be null if the user is logged in as an individual, and the equivalent if they are logged in with a business user. The prefill will fail if the object you prefill from does not exist, so if you wish to dynamically prefill based on these values it has to be setup as custom prefill.. Available values for prefill includes:

  • UserId
  • UserName
  • PhoneNumber
  • Email
  • PartyId
  • Party.PartyId
  • Party.PartyTypeName
  • Party.OrgNumber
  • Party.SSN
  • Party.UnitType
  • Party.Name
  • Party.isDeleted
  • Party.OnlyHierarchyElementWithNoAccess
  • Party.Person
  • Party.Organization
  • Party.ChildParties
  • UserType
  • ProfileSettingPreference.Language
  • ProfileSettingPreference.PreSelectedPartyId
  • ProfileSettingsPreference.DoNotPromptForParty