Koppel aan Valtimo
Gebruik de Valtimo plugin wanneer een zaakproces zelf een Epistola-document moet genereren, op de stap waar de zaak het nodig heeft. Het document wordt gemaakt op basis van zaakgegevens die al in Valtimo staan, zodat niemand tussen systemen hoeft te wisselen.
Wat de plugin toevoegt
De plugin configureer je eenmalig per Epistola-installatie: de basis-URL, een API-sleutel en de tenant waarbinnen je werkt. Je kunt hier ook een standaardomgeving instellen en die per actie overschrijven.
Daarnaast voegt de plugin drie acties toe die je op een processtap kunt plaatsen:
- Generate Document — dient een generatieverzoek in bij Epistola.
- Check Job Status — controleert de status van een verzoek apart.
- Download Document — haalt de afgeronde pdf op en stelt die beschikbaar aan het proces.
Stappen
- Configureer de Epistola-verbinding in Valtimo.
- Controleer dat de versie die je nodig hebt gepubliceerd en gedeployed is naar de doelomgeving.
- Voeg de Generate Document-actie toe aan de stap die het document nodig heeft.
- Kies de catalogus, de template en de variant.
- Map de zaakinformatie naar de documentvelden.
- Sla het proces op en doorloop het met een realistische zaak.
Kies een variant
Een template kan meerdere varianten hebben — dezelfde inhoud in een andere taal, kanaal of huisstijl. Laat de variant weg en Epistola gebruikt de default variant van de template. Noem een variant wanneer het proces precies weet welke presentatie nodig is. Of beschrijf de variant met attributen en laat Epistola degene kiezen die bij de zaak past. Een variant noemen en een variant met attributen beschrijven, kan niet samen.
Map de zaakdata
De mapping is een JSONata-expressie. Het zaakdocument en de procesvariabelen zijn erin beschikbaar, en de expressie moet een object opleveren dat past bij het datacontract van de template — dezelfde velden die de template verwacht te ontvangen. Werk vanuit het contract, niet vanuit het document dat je voor ogen hebt: de template toont wat het contract beschrijft.
Het document is niet direct klaar
Generatie gaat asynchroon. De actie geeft een verzoek-id terug zodra Epistola het verzoek heeft geaccepteerd, en zet dat in de procesvariabele die je hebt gekozen — maar de pdf bestaat op dat moment nog niet. Zet na de generatie een wachtstap die wacht op het voltooiingsbericht van Epistola, en laat het proces daarna op de uitkomst verdergaan. Een latere stap die ervan uitgaat dat het document er al is, gaat verder zonder document.
Sommige problemen worden al bij het insturen afgevangen: als een template, variant of omgeving niet bestaat — of als er geen omgeving is gekozen en de template helemaal geen gepubliceerde versie heeft — dan weigert Epistola het verzoek en mislukt de stap meteen. Maar een versie die wel gepubliceerd is en niet naar die omgeving is gedeployed, wordt dan niet afgevangen: Epistola accepteert het verzoek en de job mislukt later, wat naar voren komt zodra het voltooiingsbericht binnenkomt.
Houd de splitsing duidelijk
Gebruik Valtimo om te bepalen wanneer een document nodig is en welke zaakdata erin gaat. Gebruik Epistola om te bepalen wat erin staat en hoe het eruitziet: de template, de variant en het thema. Houd opmaak en formulering in Epistola, en proceslogica in Valtimo.