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.
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.UserIntegrationId AS NetvisorFieldEmployeeId,
'number' AS NetvisorAttributeEmployeeIdType
For example:
SELECT UserSalaryData.*, SUM(UserSalaryData.Amount) As OverrideAmount,
UserData.UserIntegrationId 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. Instructions can be found here (under "Creating API Identifiers"). 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. Instructions can be found here (in Finnish). Nepton integration key can be found in working community settings: Worktime -> Administration -> Working community settings -> External services -> Netvisor.
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 -> Netvisor.
Tietojen ajastettu ajo
Ajastettu ajo saadaan määritettyä kuten "Sääntöjoukon siirron automatisointi" ohjeessa neuvotaan. Erona määrityksessä on se, että SFTP-palvelimen tietoja ei tarvitse määrittää, sillä tiedot lähetetään suoraan verkkopalvelun kautta Netvisoriin.
Tietojen manuaalinen lähettäminen
Tämä tapahtuu normaalisti, kuten mikä tahansa työajan integraation ajo. Ohjeet siihen löytyvät täältä.
Integraation ajossa voidaan valita, ladataanko työaikatiedot vai lähetetäänkö ne suoraan Netvisoriin.
Rajoitukset
- Työntekijät henkilönumerolla 0 eivät tule osaksi aineistoa
Kyselyn tiedot
Taso | Kentän nimi | Muoto | Esiintymiskerrat | Selite |
---|---|---|---|---|
Juuri | root | XML element | 1 | Yhden henkilön yhden päivän työaikatiedot. Nepton tekee useamman kutsun jos henkilöitä ja/tai päiviä on useita. |
1 | workday | XML element | 1 | |
2 | date | päivämäärä | 1 | Päivämäärä, minkä työaikatiedot viedään. Muoto YYYY-MM-DD . |
attribuutti | format | string | 1 | date -kentän attribuutti. Päivämäärän muoto, oletusarvona ansi . Can be overridden with the ruleset field NetvisorAttributeDateFormat |
attribuutti | method | string | 0..1 | date -kentän attribuutti. Työaikatietojen käsittelytapa.
NetvisorAttributeDateMethod |
2 | employeeidentifier | string | 1 | Henkilön tunniste. Tunnisteena käytetään oletuksena henkilön henkilötunnusta. Can be overridden with the ruleset field NetvisorFieldEmployeeId |
attribuutti | type | string | 0..1 | employeeidentifier -kentän attribuutti. Henkilön tunnisteen tyyppi.
NetvisorAttributeEmployeeIdType |
attribuutti | defaultdimensionhandlingtype | string | 0..1 | employeeidentifier -kentän attribuutti. Nepton ei oletuksena täytä tätä atribuuttia. Mahdolliset arvot:
NetvisorAttributeDefaultDimensionHandlingType |
2 | workdayhour | XML element | 0..n | Tietoa ei oletuksena viedä. Jos tieto halutaan viedä, ruleset kentän NetvisorElementWorkDayHourElementVisible arvoksi täytyy asettaa Y |
3 | hours | desimaali | 1 | Määrä, esimerkiksi yksikkömäärä tai tunnit desimaalilukuna. Can be overridden with the ruleset field NetvisorFieldHours |
3 | collectorratio | string | 1 | Kirjauslaji, lajin on löydyttävä Netvisorista. Neptonissa palkkalajikoodi. Can be overridden with the ruleset field NetvisorFieldCollectorRatio |
attribuutti | 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 | crmprocessidentifier | string | 0..1 | CRM tehtävän linkitystieto, oletuksena ei viedä. Can be overridden with the ruleset field NetvisorFieldCrmProcessIdentifier |
attribuutti | billingtype | string | 0..1 | crmprocessidentifier -kentän attribuutti. Laskutustyyppi, Nepton ei oletuksena täytä tätä atribuuttia. Mahdolliset arvot:
NetvisorAttributeCrmProcessBillingType |
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ä, 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 | dimensionname | string | 1 | Laskentakohde, jos kohdetta ei löydy, se perustetaan. Oletuksena projektin nimi. Can be overridden with the ruleset field NetvisorFieldDimensionItem |
attribuutti | 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 |
attribuutti | 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 |
attribuutti | 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 |
Kyselyn esimerkki
<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>
Vastaus
Taso | Kentän nimi | Muoto | Esiintymiskerrat | Selite |
---|---|---|---|---|
Root | Root | XML element | 1 | |
1 | ResponseStatus | XML element | 1 | |
2 | Status | string | 1 | Pyynnön onnistumisen tila. Jos pyyntö onnistui, arvona on OK . Epäonnistuneet pyynnöt kirjataan Neptonin palvelulokiin. |
2 | TimeStamp | datetime | 1 |
Vastauksen esimerkki:
<Root>
<ResponseStatus>
<Status>OK</Status>
<TimeStamp>01.01.2020 12:00:00</TimeStamp>
</ResponseStatus>
</Root>