Waarom krijg ik een foutmelding bij het uploaden van mijn sjabloon (.docx)?
Ons Tags controleert tijdens het uploaden of de tags in het sjabloon overeenkomen met de ingerichte tags. Ons Tags doet een poging te bepalen welke tag incorrect is en vermeldt dit in de foutmelding.
Een paar vaak voorkomende oorzaken:
Typfouten
Xml-elementen: Microsoft Word voegt soms onder water xml-elementen binnen stukken tekst toe, bijvoorbeeld bij het kopiëren/plakken. Dit is helaas niet te zien op het scherm. Dit is op te lossen door tekst in Word te selecteren en op Opmaak wissen (A met een gum) in Word te klikken.
Bestandsformaten: Zorg dat het bestandsformaat .docx is en het bestand niet in compatibiliteitsmodus is opgeslagen.
Header/footer: Het komt soms voor dat er problemen ontstaan bij tags in de header/footer. Controleer of het verwijderen van de header/footer het probleem op lost.
Lijsttags: Zorg er in Word voor dat een lijsttag in een tabel staat en een openings- en sluitingstag heeft. Een geneste lijsttag moet in een geneste tabel in Word staan.
Waarom zie ik het sjabloon niet terug in Ons Administratie/Ons DBC?
Een sjabloon wordt enkel getoond als:
Ons Tags is geactiveerd op de omgeving. Die activatie bestaat uit twee stappen die door Support uitgevoerd moeten worden:
Ons Tags-beheer moet worden geactiveerd voor de omgeving (de webapplicatie)
Het vinkje Cliënt-documenten genereren met Ons Tags aanzetten moet in Ons Administratie worden ingeschakeld.
je de juiste rechten hebt voor het sjabloon (zie hoofdstuk Autorisatie hierboven)
de cliënt in jouw bereik zit
het sjabloon de correcte parameters heeft die nodig zijn voor het uitvoeren ervan
het sjabloon geen fouten bevat.
Dit kun je testen door het sjabloon opnieuw te uploaden.
Door in Ons Tags het sjabloon uit te voeren, zie je snel welke parameters nodig zijn voor het uitvoeren van het sjabloon. De benodigde parameters zijn een samenstelling van parameters om elke tag binnen het sjabloon uit te kunnen voeren. Op de pagina van de tagcollectie is te zien welke parameters nodig zijn voor de geselecteerde tagcollectie.
Ons Administratie toont enkel sjablonen die een clientId (vereist) en/of een locationId (optioneel) nodig hebben.
Ons DBC toont enkel sjablonen die een occurenceId (vereist) en/of een clientId (optioneel) nodig hebben. Sjablonen die aanvullende parameters nodig hebben (zoals startDate), worden niet weergegeven. We raden aan om tijdens het opbouwen van het sjabloon tussendoor te testen. De voorgestelde volgorde tijdens het maken van sjablonen is als volgt:
Tagcollectie (bij aangepaste tags)
Sjabloon in Ons Tags
Sjabloon via Ons Administratie
Het kan voorkomen dat als je het sjabloon uploadt, deze succesvol gevalideerd is maar de tags naderhand niet meer correct zijn door een gewijzigde taginrichting. In dit geval kun je dat testen door het bestand (.docx/.xlsx) opnieuw te uploaden om het opnieuw te valideren.
Waarom worden bepaalde tags niet ingevuld bij genereren van een document/brief?
Indien bij het genereren van een document sommige tags wel worden ingevoerd, maar andere niet, kan dit meerdere oorzaken hebben. Probeer eerst de tag collectie te testen (via Ons Tags) om te kijken of het als misgaat bij het ophalen van de informatie uit de APIs, of dat het mis gaat bij briefgeneratie.
De informatie komt niet mee vanuit de API's.
Zie Waarom wordt een bepaald veld niet gevuld bij het uitvoeren van een tagcollectie? hieronder.
Er gaat iets mis tijdens het genereren van de brief bij het invullen van de informatie bij de tag.
De tag bestaat niet of bevat een spelfout.
De tag ziet er visueel goed uit, maar het Word-bestand bevat verborgen tekens binnenin de tag. Word heeft zonder dat je het door hebt xml-data in de tag geplaatst. Dit kun je oplossen door de tekst te selecteren en opmaak te verwijderen. Verwijder en typ de tag opnieuw in het Word-sjabloon. Wees vooral voorzichtig bij het kopiëren/plakken als er opmaak mee komt of er regelafbrekingen ontstaan.
Waarom wordt een bepaald veld niet gevuld bij het uitvoeren van een tagcollectie?
Het veld ontbreekt in de uitvoer.
In de uitvoer worden lijsttags enkel ingevoerd zodra er onderliggende datavelden ingesteld zijn (te herkennen aan een blauw blokje met een label-icoon). Zorg dus bij het toevoegen van een node met een lijst-icoontje dat je doorklikt tot een node met een label-icoon.
De informatie wordt niet gevuld door de API.
Niet elk object dat door een API teruggegeven wordt, bevat de volledige informatie die je initieel zou verwachten.
Als bijvoorbeeld het geretourneerde object van de call Careplan.currentCareplanByClientId geen Careplan Entries bevat, terwijl CarePlanAPI.byid deze wel bevat, dan wordt er in dat geval een lege lijst meegestuurd. Dit zie je echter pas bij het testen/uitvoeren van de tagcollectie.
Je moet in dit geval dus eerst via de eerste call het Careplan ID van het huidige Careplan van een bepaalde client moeten uitvragen om vervolgens in de tweede API-call dit ID te gebruiken om het volledige Careplan op te vragen. Mocht dit het probleem niet oplossen, dan kan het zijn dat er een fout in de API zit. Maak in dat geval een ticket aan.
Hoe filter ik op meerdere niveaus?
Het is niet mogelijk om op meerdere niveaus diep te filteren. Dit betekent dat enkel binnen API-nodes op direct onderliggende velden gefilterd kan worden. Als onder een API-node eerst een grijs blokje en dan een blauw blokje ligt, is het niet mogelijk om op de waarde uit het blauwe (of grijze) blokje te filteren.
Hoe gebruik ik geneste lijsten?
Bij lijsten in lijsten moet je in Word een tabel binnen een tabel maken. Bij de instellingen van API-calls staat of er een object, waarde of een lijst wordt opgehaald.
Hoe haal ik de huisarts van een cliënt op?
Gebruik de tag ${client/contacten/bijType[type=huisarts]}. Deze geeft een lijst met alle contactpersonen van het type huisarts van de client terug.
Hoe haal ik het type van een externe zorgleverancier (bijvoorbeeld huisartsen) op?
Haal een externe zorgleverancier op (bijvoorbeeld CareProviderAPI.byClientId).
Pak hieruit de getOrganisationCategoryId.
Start een nieuwe API-call OrganisationCategoryAPI.byId en geef de getOrganisationCategoryId mee als bovenliggende waarde.
Maak een tag van de getName.
Waarom is het veld ID niet automatisch gekoppeld bij een node op basis van een cliënt-ID?
Bij het instellen van een node met daarin een nieuwe API-call op basis van opgehaalde informatie (zoals een ID), wordt dit niet automatisch voor je gekoppeld. Bij een node die op basis van een cliënt-ID het client*object opvraagt via de ClientAPI.byId, kan het voorkomen dat het veld Id niet automatisch gekoppeld wordt met het hiervoor verkregen cliënt-ID. Dit kun je oplossen door het veld id/client id op Parent Value in te stellen.
Hoe filter ik op datum?
Als bij een API een startdatum/einddatum als parameter meegegeven kan worden, dan kan een vaste datum (bijvoorbeeld 2023-01-25) worden opgegeven of een relatieve datum (bijvoorbeeld vandaag - 7 dagen).
Een voorbeeld van zo'n API is de AgendaOccurrence.byClientId die alle agenda-afspraken in een periode opzoekt:
Als een API geen startdatum/einddatum als parameter accepteert is het alsnog mogelijk achteraf (na het ophalen van alle data) te filteren. Het nadeel is dat er meer data opgehaald wordt uit de API dan strikt noodzakelijk is. Als je wilt filteren op afspraken die al zijn afgelopen, kan je filteren op een einddatum kleiner dan vandaag:
Einddatums zijn in het algemeen inclusief (dus een einddatum van 2023-01-01 betekent tot en met 1 januari).
Filteren op actieve datums
De waarde null wordt als oneindig groot gezien. Dit betekent dat als je filtert op bijvoorbeeld begindatum kleiner dan of gelijk aan vandaag staat en einddatum groter dan vandaag, je filtert op periodes die momenteel actief zijn
