Nepton can be configured to send work hour and work times data to Netvisor system. Data can be sent on a scheduled basis or with manual run. This guidance explains the integration when Nepton directly sends the information into Netvisor. This is a different implementation than using Nepton API and using the Netvisor export does not require Nepton API to be used.
The data being sent is defined in integration ruleset settings. The data is transferred using a REST API, which is described in more detail below.
Please make sure that all necessary settings have been done in Netvisor before you start data integration
Configuration
1. Setting person identifiers
Person's personal identification number can be set by editing person's information in Employees -> Person's information view.
It is also possible to use personnel number as identifier, which can be set person's personnel number by editing person's information in Employees -> Person's information view, in Identifiers section.
To use personnel number as identifier, you need to use UserData table and have the following addition in all integration ruleset rules:
UserData.Personnelnumber AS NetvisorFieldEmployeeId,
'number' AS NetvisorAttributeEmployeeIdType
For example:
SELECT UserSalaryData.*, SUM(UserSalaryData.Amount) As OverrideAmount,
UserData.Personnelnumber AS NetvisorFieldEmployeeId,
'number' AS NetvisorAttributeEmployeeIdType
FROM UserSalaryData
JOIN UserData ON (UserSalaryData.UserId = UserSalaryData.UserId)
WHERE UserSalaryData.CompensationType = 'BasicTime'
2. Creating an integration ruleset
Using this API requires an integration ruleset. You can read more about defining integration ruleset rules here.
3. Data export
To export data directly to Netvisor, you first need to
- Add a new API identifier to Netvisoriin. You can have the API identifier from your Netvisor service provider. Remember to record the user ID and key of the identifier as you need to enter them to Netvisor settings in Nepton.
- Grant access to API for Nepton service. You can have the instructions from your Netvisor service provider. Nepton integration key is C846174055BF5C1C633207B79780D1CA
Nepton will need access to workday.nv API interface resource.
After this, you can configure API identifier user ID and key to Nepton. This can be done from working community settings: Worktime -> Administration -> Working community settings -> External services -> Ruleset you created. Settings can be found under "Export to web service" heading.
In addition to API identifier user ID and key, you also need to configure the following:
- Export web service address. This needs to be https://integration.netvisor.fi/workday.nv
- API business ID. Business ID for which working hours are sent to Netvisor.
Export options
The scheduled export can be defined as instructed in the "Ruleset Export options" article. The difference in configuration is that the data on the SFTP server does not need to be configured, as the data is sent directly to Netvisor via the webservice. Export format is Netvisor.
Export from User interface
Limitations
- Persons with Employee number "0" (zero) will not be included in the export data
Sent data
Level | Field name | Format | Occurs | Notes |
---|---|---|---|---|
Root | root | XML element | 1 | One-day worktime data for one person. The service will make more calls if there are several people and / or days. |
1 | workday | XML element | 1 | |
2 | date | päivämäärä | 1 | The date on which worktime data is exported. Format YYYY-MM-DD . |
attribute | format | string | 1 | date -field attribute. Date format, default ansi . Can be overridden with the ruleset field NetvisorAttributeDateFormat |
attribute | method | string | 0..1 | date -field attribute. Method of processing worktime data.
NetvisorAttributeDateMethod |
2 | employeeidentifier | string | 1 | Person ID. By default, the person's Social Security Number (SSN) is used as the identifier. Can be overridden with the ruleset field NetvisorFieldEmployeeId |
attribute | type | string | 0..1 | employeeidentifier -field attribute. The type of person's identifier.
NetvisorAttributeEmployeeIdType |
attribute | defaultdimensionhandlingtype | string | 0..1 | employeeidentifier -field attribute. By default, the service does not fill this attribute. Possible values:
NetvisorAttributeDefaultDimensionHandlingType |
2 | workdayhour | XML element | 0..n | Data is not exported by default. If you want to export data, ruleset field NetvisorElementWorkDayHourElementVisible value must be set to Y |
3 | hours | desimaali | 1 | Amount, for example, the number of units or hours as a decimal number. Can be overridden with the ruleset field NetvisorFieldHours |
3 | collectorratio | string | 1 | Record type, the type must be found on Netvisor. In Nepton, the salary code. Can be overridden with the ruleset field NetvisorFieldCollectorRatio |
attribuutti | type | string | 0..1 | collectorratio -field attribute. The type of link information for the record type, by default number . Can be overridden with the ruleset field NetvisorAttributeCollectorRatioType |
3 | acceptancestatus | string | 1 | Status of the worktime event line. Possible values:
NetvisorFieldAcceptanceStatus |
3 | description | string | 1 | Description of the event. Can be overridden with the ruleset field NetvisorFieldDescription |
3 | crmprocessidentifier | string | 0..1 | CRM task link information, not exported by default. Can be overridden with the ruleset field NetvisorFieldCrmProcessIdentifier |
attribute | billingtype | string | 0..1 | crmprocessidentifier -field attribute. Billing type, by default, Nepton does not fill this attribute. Possible values:
NetvisorAttributeCrmProcessBillingType |
3 | invoicingproductidentifier | string | 0..1 | Billing Product ID, by default this is not exported. Can be overridden with the ruleset field NetvisorFieldInvoicingProductId |
3 | dimension | XML element | 0..n |
Projektitiedot, viedään oletuksena jos tapahtumalle on kirjattu projekteja. Jos tietoa ei haluta viedä, ruleset kentän Nepton vie vain ensimmäisen projektin tiedot. |
4 | dimensionname | string | 1 | Laskentakohdeotsikko, jos otsikkoa ei löydy, se perustetaan. Oletuksena projektin nimi. Can be overridden with the ruleset field NetvisorFieldDimensionName |
4 | dimensionitem | string | 1 | Laskentakohde, jos kohdetta ei löydy, se perustetaan. Oletuksena projektin nimi. Can be overridden with the ruleset field NetvisorFieldDimensionItem |
attribute | billingtype | string | 0..1 | dimensionname -kentän attribuutti. Laskentakohteen yläkohteen tunniste, Nepton ei vie tätä tietoa. |
2 | workdaytime | XML element | 0..n | Tieto viedään oletuksena. Jos tietoa ei haluta viedä, poimintasäännön kentän NetvisorElementWorkDayTimeElementVisible arvoksi täytyy asettaa N |
3 | starttimeofday | string | 1 | Työaikakirjauksen aloitusaika, muoto HH:MM . Can be overridden with the ruleset field NetvisorElementStartTimeOfDay |
3 | endtimeofday | string | 1 | Työaikakirjauksen lopetusaika, muoto HH:MM . Can be overridden with the ruleset field NetvisorElementEndTimeOfDay |
3 | breaktime | numero | 1 | Taukoaika minuutteina, oletuksena 0 . Can be overridden with the ruleset field NetvisorAttributeBreakTimeType |
attribute | billingtype | string | 1 | breaktime -kentän attribuutti. Oletuksena minutes . Can be overridden with the ruleset field NetvisorElementBreakTime |
3 | collectorratio | string | 1 | Kirjauslaji, lajin on löydyttävä Netvisorista. Neptonissa palkkalajikoodi. Can be overridden with the ruleset field NetvisorFieldCollectorRatio |
attribute | type | string | 0..1 | collectorratio -kentän attribuutti. Kirjauslajin linkitystiedon tyyppi, oletuksena number . Can be overridden with the ruleset field NetvisorAttributeCollectorRatioType |
3 | acceptancestatus | string | 1 | Työaikakirjausrivin tila. Mahdollisina arvoina:
NetvisorFieldAcceptanceStatus |
3 | description | string | 1 | Työtapahtuman kuvaus. Can be overridden with the ruleset field NetvisorFieldDescription |
3 | invoicingproductidentifier | string | 0..1 | Laskutuksen tuotetunniste, oletuksena ei viedä. Can be overridden with the ruleset field NetvisorFieldInvoicingProductId |
3 | dimension | XML element | 0..n |
Projektitiedot, viedään oletuksena jos tapahtumalle on kirjattu projekteja. Jos tietoa ei haluta viedä, poimintasäännön kentän Nepton vie vain ensimmäisen projektin tiedot. |
4 | dimensionname | string | 1 | Laskentakohdeotsikko, jos otsikkoa ei löydy, se perustetaan. Oletuksena projektin nimi. Can be overridden with the ruleset field NetvisorFieldDimensionName |
4 | dimensionname | string | 1 | Laskentakohde, jos kohdetta ei löydy, se perustetaan. Oletuksena projektin nimi. Can be overridden with the ruleset field NetvisorFieldDimensionItem |
Example of set data
<root>
<workday>
<date format="ansi" method="replace">2016-03-14</date>
<employeeidentifier type="personalidentificationnumber">111111-1111</employeeidentifier>
<workdaytime>
<starttimeofday>12:30</starttimeofday>
<endtimeofday>16:00</endtimeofday>
<breaktime type="minutes">0</breaktime>
<collectorratio type="number">123</collectorratio>
<acceptancestatus>confirmed</acceptancestatus>
<description>Iltapäivä</description>
</workdaytime>
</workday>
</root>
Expected response
Level | Field name | Format | Occurs | Notes |
---|---|---|---|---|
Root | Root | XML element | 1 | |
1 | ResponseStatus | XML element | 1 | |
2 | Status | string | 1 | Status of the request. If the request was successful, the value is OK . Unsuccessful requests are logged in Service log. |
2 | TimeStamp | datetime | 1 |
Example response:
<Root>
<ResponseStatus>
<Status>OK</Status>
<TimeStamp>01.01.2020 12:00:00</TimeStamp>
</ResponseStatus>
</Root>