In the person imports the fields in use are dependent on the source system of the person information imported and the import format used. The fixed fields supported by the person import are listed in the table below. In addition to the generic person import some of the source system dependant import formats support these fields but that is separately mentioned in the source system dependent guidance.
The field names/titles by which the fields are identified are listed in this article. In addition to the English field names you can also use the Finnish titles described in the Finnish version of this guidance. The generic person import also supports customer specific person additional fields. The identifier for these fields for import is the Work contract identifier field. Guidance for setting the field is described here.
Emptying the person information field can be ensured using the RESET keyword in the fields where it is supported. In some fields (in particular, in cases where there can be multiple values imported within a single field) the RESET keyword has a different behaviour, which is described in the description and/or the Person import page.
Mandatory Fields
For insert
- First name
- Last name
For update
- Nepton Id, Username or Employee number (for identifying the person)
- Providing the Nepton Id or the username will identify user with these fields, allowing the employee number to be changed
- Usernames cannot be changed using the person importer. If username is trying to be updated then all data on that row is skipped and a warning message is shown for that row.
Field name | XML field name | Description | Support for validity | Support for RESET keyword |
---|---|---|---|---|
Nepton Id |
Nepton_Id |
The Nepton globally unique person identifier which is a value automatically generated by Nepton for all persons and displayed on person form. You can identify an existing person in Nepton with this field value in import but you cannot change the value for an existing person or set it for a new person to be imported. |
No |
No |
Employee number |
Employee_number |
The employee number. This is used to identify person in the import file if the Nepton Id or Username is not imported: if a person is found from Nepton with the imported employee number then the import row updates information of that person. |
Yes |
Yes |
Username |
Username |
The login name used for person identification in the login page. Can also be used in Single Sign-On for identifying the person. If the username field is provided without Nepton Id field in the import, an existing Person in Nepton is identified by it. This also allows updating of employee number. |
Yes |
No |
Valid from date |
Valid_from_date |
The date from which the information to be imported is valid from. Please see the article about importing validities here. |
No |
No |
First name |
First_name |
First name of the person. Mandatory. |
Yes |
No |
Last name |
Last_name |
Last name of the person Mandatory. |
Yes |
No |
User account enabled |
User_account_enabled |
Is persons account active. Default to Yes (supports inputs 0,1, Y, N, Yes, No, Kyllä, Ei). This field is not case sensitive. |
No |
No |
Personal identity code |
Personal_identity_code |
Finnish personal identity code |
Yes |
Yes |
|
|
Email address |
Yes |
Yes |
Web page |
Web_page |
Website/Homepage of the Person (eg. supplier homepage for a subcontractor) |
Yes |
Yes |
Street address |
Street_address |
Street address |
Yes |
Yes |
Postcode |
Postcode |
Postal code |
Yes |
Yes |
Town/city |
|
City |
Yes |
Yes |
Phone number |
Phone_number |
Phone number |
Yes |
Yes |
IBAN |
IBAN |
IBAN bank account number |
Yes |
Yes |
BIC |
BIC |
Bank identifier code (BIC) |
Yes |
Yes |
RFID tag identifier |
RFID_tag_identifier |
RFID tag code. Used in identifying for a worktime terminal. |
Yes |
Yes |
Pin code |
Pin_code |
Pin code. Used in identifying for a worktime terminal. |
Yes |
Yes |
Password |
Password |
Plain text password for person. We do not recommend importing passwords to the platform, in which case a password is automatically generated. Every person can set their own password with the Forgot password function. |
Yes |
No |
Role |
Role |
Person role. Accepts the following values
If value doesn't match to listed values, "Employee"-role will be set for new user; existing users role won't be changed. |
Yes |
No |
Worktime roles |
Worktime_roles |
Worktime roles. Enter either the role name or id |
No |
Yes |
Job title |
Job_title |
Job title |
Yes |
Yes |
Work area |
Work_area |
Working area |
Yes |
Yes |
Weekly hours MIN |
Weekly_hours_MIN |
Weekly hours minimum value. This field also supports decimal value. Use comma ',' as decimal separator e.g. 15,5. Presented in the work shift planning for the planner. |
Yes |
Yes |
Weekly hours MAX |
Weekly_hours_MAX |
Weekly hours maximum value. This field also supports decimal value. Use comma ',' as decimal separator e.g. 35,5. Presented in the work shift planning for the planner. |
Yes |
Yes |
Employment start date |
Employment_start_date |
Use date format DD.MM.YYYY. Read more. |
No |
Yes |
Employment end date |
Employment_end_date |
Use date format DD.MM.YYYY. For an ongoing work contract without end date specified the field should be imported as empty. Read more |
No |
Yes |
Trial period end date |
Trial_period_end_date |
Trial period ends date (DD.MM.YYYY) |
Yes |
Yes |
Units |
Units |
Unit(s). Enter either the unit name or code. If applying multiple units separate each with the pipe "|" character. The given values will replace existing unit memberships for the person. This field is case insensitive. |
No |
Yes |
Default project |
Default_project |
Default Project for the person |
No |
Yes |
Default cost group |
Default_cost_group |
Cost group for the person |
Yes |
Yes |
Primary supervisor |
Primary_supervisor |
Primary supervisor's employee number. Empty value or RESET keyword will remove the primary supervisor. Read more. |
No |
Yes |
Secondary supervisors |
Secondary_supervisors |
Pipe (|) separated list of secondary supervisor employee numbers. If the RESET keyword is included, the listed supervisors will replace all the existing secondary supervisors for the person. Read more. |
No |
Yes |
Integration ids fields: Aastra |
Integration ids fields: Aastra |
External system id for the person. There is an IntegrationId field for each supported integration listed. The field value accepts a string. |
Yes |
Yes |
Balance |
Balance |
Inserts a balance accrual reset value in minutes to the current day. This field accepts integer value. |
No |
No |
Additional administrative information |
Additional_administrative_information |
Additional Information (free text field) |
Yes |
Yes |
Next of kin |
Next_of_kin |
Next of Kin (free text field for next of kin names) |
Yes |
Yes |
Next of kin phone number |
Next_of_kin_phone_number |
Next of Kin Phone number (validated as phone number or empty) |
Yes |
Yes |
Additional information for reports |
Additional_information_for_reports |
Additional Report Information (free text field. Information is shown in various reports) |
Yes |
Yes |
Reason for ending employment |
Reason_for_ending_employment |
Reason for working contract end (free text field) |
Yes |
Yes |
Monthly salary |
Monthly_salary |
Working contract monthly salary (numeric string which allows decimal values, but cannot start with zero. You can use dot '.' or comma ',' as decimal separator e.g. 2600, 3733.33 or 4595,45). |
Yes |
Yes |
Hourly wage |
Hourly_wage |
Working contract hourly wage (numeric string which allows decimal values, but cannot start with zero. Use dot '.' or comma ',' as decimal separator e.g. 20, 25.50 or 37,50) |
Yes |
Yes |
Tax number |
Tax_number |
Finnish Tax number (must be exactly 12 numeric characters long, or empty) |
Yes |
Yes |
Person group |
Person_group |
Persons person group code. Use either this field or "Person group code path in hierarchy" and "Person group name path in hierarchy". Read more. |
No |
Yes |
Person group name path in hierarchy |
Person_group_name_path_in_hierarchy |
A pipe separated list of persongroup names representing the persongroup structure the person is part of. Both "Person group code path in hierarchy" and "Person group name path in hierarchy" are needed if one is transferred. Hierarchy is created and updated automatically. E.g. 'Office|Sales' will import person group 'Office' with a subgroup 'Sales'. Imported person will be part of person group 'Sales'. |
No |
No |
Person group code path in hierarchy |
Person_group_code_path_in_hierarchy |
A pipe separated list of persongroup codes representing the persongroup structure the person is part of. Both "Person group code path in hierarchy" and "Person group name path in hierarchy" are needed if one is transferred. Hierarchy is created and updated automatically. Value is person group complete code hierarcy pipe separated. E.g. '10|20' with the example provided above will import code '10' for person group 'Office' and '20' for person group 'Sales'. |
No |
Yes |
Worktime setting group |
Worktime_setting_group |
Person setting group code. Entering ‘RESET’, ‘NOLLA’, or nothing (no text), will remove the person from all settings groups from the beginning of the day until infinity
This field is case insensitive. |
Yes |
Yes |
Work time percentage |
Work_time_percentage |
Work time percentage for person, which is used to calculate work day and work week length. If percentage changes, the new percentage will be in effect from current day onwards. The decimal format is with comma, example ’80,00’.
This field is case insensitive. |
Yes |
No |
Service usage language |
Service_usage_language |
Persons language. The value in this field should be English name of a language. Currently supported are Finnish, English, Swedish, Danish, Polish and Estonian. If language is omitted, the default language for the customer is used. By default the default language is Finnish. If default language needs to be changed, this can be requested from Nepton customer service. |
Yes |
No |
Short term loan permit | Short_term_loan_permit | Short term loan allowed | Yes | No |
Microsoft AX hourly cost | Microsoft_AX_hourly_cost | currency with two decimals | Yes | Yes |
Visma cost centre |
Visma_cost_centre |
Visma cost center |
Yes |
No |
Payment group
|
Payment_group |
A person's membership to a payment group, indicates they should be compensated according to its payment periods. The value can be either the code, name or the identifier of the payment group.
This field is case insensitive. |
Yes |
No |
Classification of occupations |
Classification_of_occupations |
This field defines the code of Income register's classification of occupations (TK10) for the person's occupation. |
Yes |
Yes |
Unique Identifier fields
Nepton Id
The Nepton globally unique person identifier which is a value automatically generated by Nepton for all persons and displayed on person form. This field can not be reused and is always unique.
Employee Number
Employee number is a unique person identifier and cannot be reused. If a person A has an employee number 1234 and you want to reuse it for a person B, then you need to first remove it from person A.
User Name
User name is a unique person identifier and cannot be reused. If a person A has a user name SOMEUSERNAME and you want to reuse it for a person B, then you need to first remove it from person A.