Procesitems exporteren via de webservice

In het artikel Procesarchitect: exportdefinitie (stap 9) kun je lezen hoe je kunt instellen dat je procesitems naar een bestand of via de webservice kunt exporteren. In dit artikel wordt ingegaan op het exporteren van procesitems via de webservice. Meer informatie over het exporteren van procesitems naar een bestand vind je in het artikel Procesitems exporteren naar een bestand.  

Procesitem exporteren

Ga naar het overzicht van de procesitems van het bedrijfsproces. Ga naar Start > [naam bedrijfsproces] > [naam bedrijfsproces] Beheer > Procesconfiguraties (leverancier is stakeholder) of Start > [naam bedrijfsproces] Beheer > Procesconfiguraties (leverancier is geen stakeholder). 

Bij een bedrijfsproces kun je nu als het procesitem de Exportstatus Klaar voor export heeft, het procesitem exporteren via de webservice. Als de kolom Exportstatus niet zichtbaar is in het overzicht, kun je die toevoegen via Kolommen en een vinkje zetten bij Exportstatus.

Procesitems met de Exportstatus Klaar voor export kunnen via de webservice worden geëxporteerd, zodat je een XML-bestand krijgt van het procesitem.

Webservice

Voor het exporteren van procesitems gebruik je de webservice functie: GetNewBusinessProcessItem. Deze heeft, naast de standaard 3 parameters van een webservice functie (username, password, callFrom), een extra parameter businessProcessId. Deze bepaalt van welk bedrijfsproces er een item wordt opgehaald. De waarde die hier moet worden meegegeven, moet overeenkomen met de waarde van het Externe nummer van het bedrijfsproces.

De webservice exporteert bij elke aanroep één procesitem van het geselecteerde bedrijfsproces dat Exportstatus Klaar voor export heeft. Als er geen procesitems meer over zijn om te exporteren wordt code 100 gegeven.

Het XML-bestand van een procesitem is opgemaakt zoals is ingesteld bij het bedrijfsproces onder stap 5 Exportdefinitie. De tags die in de exportdefinitie gespecificeerd zijn, worden onder elkaar in één overkoepelende tag gezet. De overkoepelende Tag is BusinessProcessItem. 

De webservice kan alleen met een leveranciersaccount worden gebruikt. Hierbij wordt rekening gehouden met de gekoppelde leverancierseenheden van de gebruiker waarmee de webservice aangeroepen wordt. Dit betekent dat een procesitem geëxporteerd mag worden als het leverancierseenheidsveld één van de leverancierseenheden van de gebruiker is, of als leverancierseenheid leeg is.

Voorbeeld

Voor het Bedrijfsproces Vraag aan bemiddelaar is de Exportdefinitie ingesteld. Het bedrijfsproces heeft A1234Z als Extern nummer. 

Het Externe nummer wordt als parameter meegegeven voor businessProcessId in de webservice functie GetNewBusinessProcessItem.

Er is één procesitem met Exportstatus Klaar voor export. Deze wordt nu naar het volgende XML-bestand geëxporteerd.

<?xml version="1.0" encoding="UTF-8"?> 

<BusinessProcessItem>   

    <Inlener>23</Inlener>

  <Flexkracht>Jan Groen</Flexkracht>   
  <Bemiddelaar>Bemiddelaar MD</Bemiddelaar>   
  <Vraag>Hoeveel uren kan ik invullen?</Vraag>   
  <Antwoord>Je kunt 40 uur invullen.</Antwoord> 

</BusinessProcessItem>   

De Exportstatus van het procesitem is hierna gewijzigd naar Geëxporteerd. 

In het log kun je het XML-bericht ook terugvinden. Ga naar Start > Applicatiebeheer > Log en bij Code Webservice kun je het Bericht vinden getbusinessprocessitem webservice resultaat: Geëxporteerd (). 

Ook vind je hier de melding terug als alle procesitems zijn geëxporteerd (code 100).