Open Proceshuis | skryvdocs

Inleiding

Via deze functionaliteit is het mogelijk om BPMN-definities vanuit Skryv Studio te uploaden naar het Open Proceshuis platform. Dit platform is een initiatief van het Vlaams Agentschap voor Binnenlands Bestuur (ABB) om kennisdeling tussen lokale besturen te stimuleren. Het idee is dat een proces ontwikkeld door de ene gemeente ook nuttig kan zijn voor de andere gemeente.

Setup

App-instellingen

Voor deze stap moet je aankloppen bij een eGovFlow-medewerker.

De koppeling met het Open Proceshuis platform is op te zetten vanuit het applicatie instellingen scherm in Studio. Hier moet je de toggle activeren waarna je de juiste OVO-code en URL kan toevoegen. Deze informatie verkrijg je na onboarding via het Vlaams Agentschap Binnenlands Bestuur.

Achterliggend activeert de toggle de ophEnabled instelling in het application-configuration json-bestand.

{
  "targetedVersion": "snapshot",
  "ophEnabled": true,
  "ophOvoCode": "12345",
  "ophEndpointUrl": "https://data.vlaanderen.be"
}

Koppeling activeren voor specifieke gebruikers

Voor deze stap moet je aankloppen bij het development-team van Skryv Studio.

De Upload naar oph-functionaliteit verschijnt enkel bij specifiek aangeduide gebruikers. Dit zijn Studio gebruikers die toegevoegd zijn aan de oph feature group.

Functionaliteiten

Upload naar OPH

Het uploaden van een BPMN naar OPH gebeurt vanuit het workflow overzicht in Studio.

Klik op het ‘three dots’-icoon naast de workflow die je wil uploaden.
Kies Bewerk en vul vervolgens de nodige eigenschappen in zoals Type (BPMN of CMMN), Naam(naam van het proces), Omschrijving (omschrijving proces) en E-mailadres contactpersoon. Dit zijn metadata die straks meegestuurd worden naar het Open Proceshuis platform. Opslaan via de knop Bijwerken.
Klik opnieuw op het ‘three dots’-icoon naast de workflow die je wil uploaden.
Kies Uploaden naar OPH om het proces effectief door te sturen naar het platform. De upload van de BPMN-definitie gebeurt als XML-bestand. De opgegeven metadata worden in dezelfde call meegestuurd.

Screenshot 1: workflow overzicht met ‘bewerk’ en ‘uploaden naar OPH’-functionaliteiten

Workflow overzicht: bewerken en uploaden naar OPH

Screenshot 2: ‘bewerk proces’ metadata invullen

Opmerking

Vlak voor het uploaden wordt de BPMN definitie zo veel mogelijk gestript van technische attributen en specifieke data. Concrete info over hierover:

Alle <bpmn:extensionElements> worden verwijderd (denk aan extenties zoals inputOutput , inputParameters, executionListeners, taskListeners, properties, formDefinition, candidateGroups).
Alle expression elementen worden omgezet naar lege strings:
- elk attribuut waarvan de naam "expression" bevat → waarde wordt "", bv. camunda:expression=""
- elk element waarvan de tag "expression" bevat → tekst en body-attribuut worden leeg, bv. <bpmn:conditionExpression/>, <bpmn:expression body=""/>
E-mailadres contactpersoon (metatag). Dit wordt in de XML opgeslagen wanneer je het proces bewerkt, maar er bij het uploaden weer uit gehaald. Het gaat dus wél naar OPH als metadata van het proces, maar het staat niet meer in het BPMN-bestand dat anderen kunnen downloaden. De omschrijving van het proces blijft wel staan in de XML zelf én wordt bijkomend meegestuurd als metadata van het proces.

Disclaimer: de gebruiker die een procesdefinitie uploadt naar het Open Proceshuis moet zelf verifiëren of er geen privacygevoelige info staat in de naam van het proces, de namen van de verschillende BPMN-elementen en enkele technische attributen zoals camunda:resultVariable en camunda:assignee.

Je kan enkel processen van het type BPMN doorsturen. Bij CMMN-modellen verschijnt de optie ‘Uploaden naar OPH' niet.

Import vanuit OPH

BPMN-processen die vanuit de Studio omgeving van het ene bestuur werden opgeladen naar het Open Proceshuis platform, kunnen geïmporteerd worden binnen de Studio omgeving van een ander bestuur. De import gebeurt niet rechtstreeks, maar onrechtstreeks via download op een lokale pc.

Log in op Open Proceshuis.
Zoek de BPMN-definitie die je wil gebruiken en download lokaal.
Upload van de BPMN-definitie naar Studio gebeurt via het workflow overzicht. Klik op het arrow down icoon naast de + Voeg proces toe knop en kies voor Proces importeren.
Selecteer het te importeren BPMN-bestand op je lokale pc.
Bewerk de metadata voor het te importeren bestand via de dialog box Proces importeren. Hier verschijnen naast de geslecteerde bestandsnaam, de metadata Type, Naam, Omschrijving en E-mailadres contactpersoon die meegegeven zijn bij de upload naar OPH. Belangrijk: zorg ervoor dat de Key van het proces uniek is binnen jouw applicatie. Bevestig door op de knop Aanmaken te klikken.

Opgelet: BPMN-modellen die gedownload worden uit OPH en vervolgens terug opgeladen worden in Studio zijn geen uitvoerbare modellen gezien ze eerder gestript werden van technische attributen en specifieke data. Deze informatie moet je dus terug opbouwen om het proces werkende te krijgen binnen de doelapplicatie.

Screenshot 3: workflow overzicht met ‘proces importeren’-functionaliteit

Proces importeren via het workflow overzicht

Screenshot 4: ‘proces importeren’ dialog box