Main content

Dit  is de leeswijzer voor de documentatie van de SETU (HR-XML)-OHNL 2.0 berichtenstandaard van het EBF Domein (Elektronisch Bestellen en Factureren).

Versiegegevens

Publicatiedatum: Maart 2020

Versie: 1.1

Inleiding

Berichtenstandaard Nederlandse Overheid (OHNL)

De berichtenstandaard geeft een functionele en technische beschrijving van de EBF berichten. De berichtenstandaard is een profiel van (inter)nationale standaarden om de berichten te vereenvoudigen en beter te laten aansluiten op de werkprocessen van de Rijksoverheid. Afhankelijk van het soort inkoop (goederen/diensten of inhuur) worden er twee berichtstandaarden gebruikt:

  • UBL Overheid NL voor goederen/diensten. Dit is gebaseerd op de internationale UBL standaard.
  • SETU (HRXML) Overheid NL voor Inhuur. Dit is gebaseerd op de nationale SETU standaard, welke weer een nadere specificatie is van HRXML.

Dit document is de leeswijzer voor de Inhuur-berichten (SETU).

DigiPoort

De distributie van alle EBF berichten gaat via de DigiPoort.

Gerelateerde documenten

Deze pagina maakt onderdeel uit van een bredere set aan documentatie die u kunnen helpen bij het implementeren van EBF berichten. Hieronder zijn de documenten in samenhang weergegeven.

Afbeelding: Documentatie Leeswijzer

SETU (HR-XML)-OHNL 2.0

Profiel

OHNL is gebaseerd op:

  • SETU 1.2 voor HumanResource en StaffingOrder
  • SETU 1.3 voor Assignment, Invoice en TimeCard

SETU is gebaseerd op HR-XML 2.5,

Berichttypen

SETU (HR-XML)-OHNL 2.0 bevat de volgende berichttypen:

  • HumanResource
  • StaffingOrder
  • Assignment
  • TimeCard
  • Invoice

Dit betreft de HRXML invoice. Voor informatie over de NLCIUS Invoice zie de standaarden documentatie op www.stpe.nl

Documentatie

De documentatie van de berichtenstandaard bestaat uit de volgende onderdelen

Implementatiewijzer

De implementatiewijzer bevat toelichtingen op een aantal onderdelen:

  • Opbouw SETU HR-XML-OHNL
  • Generieke toelichting
  • XML schema’s en Schematron
  • Berichttypen en Berichtsoorten
  • Configuratiebestanden
  • Voorbeeldscenario’s met voorbeeldberichten

Configuratiebestanden

Van ieder berichttype is een Excel document opgesteld waarin van alle velden uit het bericht de volgende informatie is opgenomen:

  • Technische gegevens, zoals XML-XPath en datatype
  • Cardinaliteit. Elk element in de hiërarchie van HR-XML kent een cardinaliteit: het aantal malen dat het minimaal en maximaal mag/moet voorkomen in het bericht.
  • Definities
  • Gebruikersaanwijzing; een nadere toelichting op het gebruik van een specifiek veld
  • Business Rules; controles waaraan het bericht moet voldoen.

In de Implementatiewijzer worden de configuratiebestanden nader toegelicht.

Functionele documentatie

De functionele documentatie bestaat uit:

  • De configuratiebestanden
  • Functionele documentatie van de SETU. Op de site http://www.setu.nl kunt u zich aanmelden en vervolgens documentatie downloaden via tabblad Downloads.

Technische bestanden

Voor geautomatiseerd gebruik, zoals het valideren van berichten, wordt de gekozen syntax in XML-bestanden gegoten. Dit zijn XML schema’s en Schematron bestanden.

Een XML-schema is een syntax of grammatica specificatie. Het bepaalt onder andere de hiërarchische structuur van het bericht en de toegestane waarden van ieder XML element. Maar er zijn nog andere “regels” waaraan het gespecificeerde bericht moet voldoen. Voorbeelden daarvan zijn de regels die afhankelijkheden tussen meerdere elementen leggen of de beperkingen van berichtonderdelen die volgen uit beschrijvingen zoals die van de 11-proef voor een Burgerservicenummer. Dergelijke regels kunnen niet in een XML-schema worden uitgedrukt. Hiervoor wordt ISO Schematron gebruikt. Alle beperkingen die de  ederlandse Overheid wil uitoefenen op de HR-XML schema’s worden gerealiseerd middels de ISO Schematron validatie techniek.

De technische documentatie van de SETU (HR-XML)-OHNL 2.0 bestaat uit de volgende onderdelen:

  • XSD Schema’s van HR-XML
  • XSD Schema’s van SETU (dit betreft een extensie op het HR-XML schema). Bij ieder berichttype heeft SETU een XSD-extensie opgesteld.
  • OHNL Schematron

Voorbeeldbestanden

In de oplevering worden ook XML voorbeeldberichten geleverd. Deze zijn alleen ter illustratie en vormen geen volledig overzicht van de berichtenstandaard. Dat wordt alleen gegeven in de configuratiebestanden. In de Implementatiewijzer worden de technische bestanden nader toegelicht.

Vindplaats documentatie

De documentatie is te vinden op de website van Logius. De documentatie is opgenomen in twee zip-bestanden: één voor de OHNL die per release verschillend zal zijn, en één waarin de technische bestanden van de SETU 1.2 / 1.3 en HR-XML 2.5 standaarden zijn opgenomen die voor meerdere releases van toepassing zijn. .

OHNL-zip

Dit .zip bestand geeft na uitpakken de volgende folderstructuur:

Versie

├─ doc

├─ sch

└─ xml

  • Versie: Dit is de versie van de uitlevering. De versienummering kent het formaat X.Y[.Z], waarbij X de ‘major’ versie is ,Y de ‘minor’ versie en Z optioneel de ‘bugfix’ versie. Deze folder bevat de releasenotes voor deze versie en een kopie van de leeswijzer (dit
  • document).
  • doc:  Dit is de folder voor de door de mens leesbare documentatie bestanden. Deze folder bevat de configuratiebestanden en de implementatiewijzer.
  • sch: Dit is de folder voor de ISO Schematron (c040833_ISO_IEC_19757-3_2006(E)) validatie bestanden. Er is één schematron bestand per berichttype.
  • xml: Dit is de folder voor de XML voorbeeldberichten.

Op de website van Logius kan ook een .zip bestand worden gedownload waarin de technische bestanden van de SETU 1.2 / 1.3 en HR-XML 2.5 standaarden zijn opgenomen: SETU-1.2_1.3 (HR-XML-2.5).zip.

Dit .zip bestand geeft na uitpakken de volgende folderstructuur:

SETU-1.2_1.3 (HR-XML-2.5)

├─ CPO

├─ SEP

├─ SIDES

│ └─ NL

│ └─── 2012-01

└─ TimeCard

  • CPO: Dit is de componenten folder van HR-XML. Hier worden de XML Schema typen gedefinieerd.
  • SEP: Dit is een folder van HR-XML voor separate XML schema’s
  • SIDES: Dit is de HR-XML implementatie van specifieke berichten in de personeel inhuur.
  • NL: Dit is de folder waar de XSD Schema’s van SETU (uitbreidingen op HR-XML) worden ondergebracht. Voor SETU 1.2 en 1.3 staan deze in de 2012-01 folder, m.u.v. de Invoice extensie, die staat direct in de NL folder.
  • TimeCard: Dit is de folder voor het HR-XML bericht ‘TimeCard’.

Om een volledig werkende set te verkrijgen moeten de folders uit de SETU-1.2_1.3 (HR-XML-2.5).zip worden samengevoegd met de corresponderende folders van OHNL.zip.