HRM Webservice

Inleiding

Veel onderwijsinstellingen hebben een HRM-systeem in gebruik voor de registratie van personeel. Het gaat hierbij om diverse systemen, zoals AFAS-Profit en RAET E-HRM. Deze HRM-systemen zijn primair voor het registreren van personeel.

Somtoday registreert ten behoeve van autorisatie, rooster, rapportagedoeleinden en dergelijke ook personeelsgegevens. Daarmee ontstaat de behoefte om personeelsgegevens  automatisch over te kunnen zetten van het primaire HRM-systeem naar Somtoday.

Het HRM-systeem is leidend voor de onderwijsinstelling. De mutaties in het HRM-systeem moeten daarom geautomatiseerd overgezet worden in Somtoday, zodat er één bron van personeelsinformatie is. Om dit mogelijk te maken, biedt Somtoday een HRM-koppeling (webservice) om personeel in Somtoday toe te voegen en te muteren.

Het doel

Het doel van deze webservice is het mogelijk maken om personeelsgegevens te schrijven naar Somtoday vanuit een HRM-systeem, zonder tussenkomst van een medewerker.

Uitgangspunten

• Deze webservice is eenrichtingsverkeer: er kunnen alleen personeelsgegevens worden geschreven en niet gelezen.
• Voor het lezen van personeelsgegevens uit Somtoday kan het bedrijf die deze koppeling gaat opzetten toegang aanvragen tot Somtoday Connect. Daarmee zijn alle benodigde velden van personeel uit te lezen. Neem contact op met de servicedesk als het bedrijf nog geen toegang heeft tot Somtoday Connect.
• Er kunnen vanuit een HRM-pakket alleen gegevens worden overgenomen die in ‘vaste’ velden voor Somtoday toegankelijk zijn. Vrije velden zijn uitgesloten van de koppeling.

Toegang

Het gebruik van de HRM-webservice is afgeschermd met behulp van WSSecurity. Je moet het SOAP-request voorzien van een aangepaste header en de benodigde authenticatiegegevens. De school moet Somtoday inrichten voor het gebruik van de HRM-webservice.

WSDL

Productieomgeving

De HRM-webservice voor Somtoday in de productieomgeving is te benaderen via de URL:

https://oop.somtoday.nl/services/HRMService?wsdl 

Testomgeving

De HRM-webservice voor Somtoday in de testomgeving is te benaderen via de URL:

https://oop.test.somtoday.nl/services/HRMService?wsdl

WSSecurity

In het SOAP-request moet deze header gebruikt worden.

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:hrm="http://hrm.webservices.iridium.topicus.nl/">
<soapenv:Header>
<hrm:Brinnummer
xmlns:hrm="http://hrm.koppelingen.iridium.topicus.nl/">?</hrm:Brinnummer>
</soapenv:Header>

Toegang HRM webservice

De school is verantwoordelijk voor het aan derden doorgeven van gegevens uit Somtoday en levert daarvoor zelf de benodigde accountgegevens aan.

Voor het gebruik van deze webservice moet je in Somtoday onder Rollen en rechten een rol te creëren met het recht op de Webservices HRM Service. Maak een account aan en koppel deze aan de eerder aangemaakt rol. Gebruik dit account om het request naar de webservices te authenticeren.

Functionaliteit Somtoday

Met de webservice kun je nieuw personeel toevoegen aan Somtoday of velden van een personeelslid muteren. De velden, die meegegeven kunnen worden aan de webservice, zijn in Somtoday zichtbaar in de schermen van de wizard Personeel toevoegen.

Request

De webservice bestaat uit één request:

• CreatePerson

Advies

Stuur bij het updaten van gegevens van een personeelslid vanuit het HRM-systeem alle gegevens mee. Dus ook de velden die niet gewijzigd zijn. Als je objecten weg laat, kan het zijn dat Somtoday deze velden leeg maakt.

Details

Toelichting op de velden van het request beschreven.

Voor de datumvelden geldt dat als het object niet wordt meegestuurd (het weglaten van de objecten in de XML), dat Somtoday dit veld leeg maakt. Dit geldt voor de objecten:

• ​geboorteDatum
• datumInDienst
• datumUitDienst
  
  

De keuze voor geheim adres staat standaard op Nee in Somtoday. Als een personeelslid wel een geheim adres wil hebben, moet je dit aanleveren via de HRM-service. Als het niet in een HRM-systeem staat, kan de data ook niet aangeleverd worden om daarmee een personeelslid aan te maken in Somtoday.

Velden

Naam	Verpl.	VeldnaamSomtoday	Opmerkingen
medewerkernummer		Nummer (Personalia)	Identificerend. Leeg laten bij nieuw personeelslid, wordt gegenereerd door Somtoday.
afkorting	ja	Afkorting (Personalia)	Afkorting personeelslid (uniek voor de gehele organisatie). Identificerend samen met achternaam.
achternaam	ja	Achternaam (Personalia)
meisjesnaam		Meisjesnaam (Personalia)	Alleen beschikbaar als het geslacht VROUW is opgegeven.
voorletters		Voorletters (Personalia)
voorvoegsel		Voorvoegsel (Personalia)	Moet waarde zijn uit Somtoday-tabel.
roepnaam		Roepnaam (Personalia)
voornamen		Voornamen (Personalia)
geslacht	ja	Geslacht (Personalia)	Mogelijke waarden: MAN, VROUW, ONBEKEND.
geboortedatum		Geboortedatum (Personalia)	Formaat: JJJJ-MM-DD Het weglaten van dit object in de XML maakt het veld leeg. Mag niet in de toekomst liggen.
geboorteplaats		Geboorteplaats (Personalia)
geboortelandcode		Geboorteland (Personalia)	Alleen de code: moet voorkomen in de codetabel van Somtoday.
nationaliteitscode		Nationaliteit (Personalia)	Alleen de code: moet voorkomen in de codetabel van Somtoday.
burgerlijkestaat		Burgerlijke staat (Personalia)	Mogelijke waarden: Gehuwd, Geregistreerd partnerschap, Gescheiden, Ongehuwd, Ontbonden geregistreerd partnerschap, Weduwe/Weduwnaar.
bsn		BSN (Personalia)	Moet voldoen aan de 11-proef.
ibanNummer		IBAN nummer (Personalia)
bicNummer		BIC nummer (Personalia)
casoNummer		Casonummer (Personalia)
HRMAdres
straat		Straat (Personalia)
huisnummer		Huisnummer (Personalia)	Verplicht voor binnenlandse adressen.
postcode		Postcode (Personalia)	Verplicht voor binnenlandse adressen.
plaatsnaam		Plaats (Personalia)
buitenland1		Adresregel 1 (Personalia)	Verplicht voor buitenlandse adressen.
buitenland2		Adresregel 2 (Personalia)
buitenland3		Adresregel 3 (Personalia)
telefoonnummer		Huistelefoon (Personalia)
geheimAdres		Geheim adres (Personalia)	Mogelijke waarden: 0 of 1 (0 staat voor Nee, 1 staat voor Ja).
geheimTelefoonnummer		Geheim telefoonnummer (Personalia)	Mogelijke waarden: 0 of 1 (0 staat voor Nee, 1 staat voor Ja).
landcode		Land (Personalia)	De landcode in de codetabel van Somtoday. Landcode Nederland-> 6030 Indien landcode leeglaten dient het buitenland1 gevuld te worden.
Einde HRMAdres
mobielNummer		Mobiel nummer (Personalia)
geheimMobielNummer		Geheim (mobiel)nummer (Personalia)	Mogelijke waarden: 0 of 1 (0 staat voor Nee, 1 staat voor Ja).
internNummer		Intern nummer (Personalia)
onderwijsPersoneel		Onderwijzend personeelslid (Aanstelling)	Mogelijke waarden: 0 of 1 (0 staat voor Nee, 1 staat voor Ja).
ondersteunendPersoneel		Onderwijsondersteunend personeelslid (Aanstelling)	Mogelijke waarden: 0 of 1 (0 staat voor Nee, 1 staat voor Ja).
externMedewerkerNummer		Extern medewerkernummer (Account)	Identificerend bij update van bestaand personeelslid.
vestigingen			Deze sectie mag meerdere keren worden opgenomen. De eerst vestiging in de XML wordt de hoofdvestiging in Somtoday.
afkorting		Afkorting (Beheer > Instelling > Vestigingen > Algemeen)
brinNummer		Brinnummer (Beheer > Instelling > Vestigingen > BRIN instellingen)	Voorbeeld: 99AA05
Einde vestigingen
gebruikersnaam		Gebruikersnaam (Account)	Indien leeg of niet gevuld wordt voor nieuwe personeelsleden de afkorting  gebruikt en voor bestaande personeelsleden de huidige gebruikersnaam.
wachtwoord		Wachtwoord (Account)	Alleen verplicht voor nieuwe gebruikers.
email		E-mailadres (Account)
functie		Functie (aanstelling)	Moet voorkomen in tabel Somtoday (Beheer > Instelling > Functies).
datumInDienst	ja	Datum in dienst (Aanstelling)	Formaat: JJJJ-MM-DD
datumUitDienst		Datum uit dienst (Aanstelling)	Formaat: JJJJ-MM-DD Het weglaten van dit object in de XML zal het veld leeg maken. Verplicht bij het opgeven van redenUitDienst.
redenUitDienst		Reden uit dienst (Aanstelling)	Moet voorkomen in tabel Somtoday (Beheer > Instelling > Redenen uit dienst). Verplicht bij het opgeven van datumUitDienst.
uitsluitenCorrespondentie		Uitgesloten van correspondentie (Aanstelling)	Mogelijke waarden: 0 of 1 (0 staat voor Nee, 1 staat voor Ja).