Aangepaste rapporten maken

Met Data Crow kunnen gebruikers hun eigen rapporten toevoegen of de bestaande rapporten wijzigen.
De rapporten worden gemaakt met de Jaspersoft Studio software. Deze software kan gratis worden gedownload.

Vereisten #

• Voor het maken van rapporten moet de Jaspersoft studio software geïnstalleerd worden. Download de software van: https://community.jaspersoft.com/project/jaspersoft-studio. Download de nieuwste versie die beschikbaar is.
• U hebt Data Crow versie 4.0.7 of hoger nodig.
• Je moet Java geïnstalleerd hebben (versie 17 of hoger). Deze kun je downloaden van de Oracle-site: https://www.oracle.com/java/. Dit is ook een vereiste voor het uitvoeren van Data Crow.

Het rapportageproces
#

Rapportsjablonen

Data Crow gebruikt samengestelde rapporten van Jaspersoft (.jasper bestand). Deze worden in de rapportenmap van de Data Crow installatiemap geplaatst.
Wanneer de software wordt geüpgraded, wordt de gebruiker gevraagd of hij/zij de rapporten wil kopiëren naar de rapportagemap van de installatie naar de gebruikersmap. Als je je gemaakte of gewijzigde rapporten wilt testen, kopieer ze dan naar de rapportenmap van de gebruikersmap.

Telkens wanneer het rapportvenster wordt geopend, scant Data Crow de rapportenmap van de gebruikersmap voor bestaande .jasper rapporten. Aangezien Data Crow uit meerdere modules bestaat, moeten de rapporten in de rapportenmap van de module worden geplaatst. De mapstructuur voor rapporten voor een bepaalde module is als volgt
volgt: /Rapporten/<modulenaam

Voorbeeld voor Microsoft Windows:

D:\Data CrowDataRapportenSoftware

D:\Data CrowDataRapportenfilm

Voorbeeld voor Linux:

/Home/Data Crow Data/Rapporten/Software

Opmerking: Het kan zijn dat uw gebruikersmap ook submappen bevat met de namen PDF en HTML. Dit zijn restjes van oudere Data Crow versies. Deze worden niet meer gebruikt en kunnen veilig verwijderd worden. Hetzelfde geldt voor de bestanden die erin staan.

Rapportcreatie

Wanneer je een rapport uitvoert vanuit Data Crow (Extra > Rapport maken) doet Data Crow drie dingen:

• Data Crow maakt een XML-export van de geselecteerde items.
• Data Crow vult het .jasper rapportbestand met de XML-gegevens.
• En als laatste stap wordt het ingevulde rapport opgeslagen in het geselecteerde doelformaat (RTF, PDF of HTML).

Het belangrijkste om op te merken is dat Data Crow XML-extracten gebruikt voor het maken van de rapporten in plaats van rechtstreeks toegang te krijgen tot de database. We zullen de XML in het volgende hoofdstuk gebruiken om een nieuw rapport te ontwerpen (of een bestaand rapport aan te passen).

Ten tweede is het niet langer nodig voor het rapportageproces om de afbeeldingen te exporteren. Jaspersoft doet dit automatisch indien nodig, zoals het geval is voor de HTML-rapporten.

Een nieuw rapport maken #

Laten we een nieuw rapport ontwerpen! We hebben een XML-bestand nodig met Data Crow-items (als bron) om een rapport te maken en te ontwerpen in Jaspersoft.

Een XML-export maken

Eerst hebben we een voorbeeld XML-bestand nodig zodat we dit kunnen gebruiken om ons rapport te ontwerpen.

1. Gegevenskraai starten
2. Selecteer de module waarvoor je een rapport wilt maken
3. Selecteer een of meer items in het overzicht, klik met de rechtermuisknop en selecteer Wizard exporteren van items:
   
4. Selecteer XML-export en druk op Volgende
5. Selecteer het doelbestand en druk op Volgende
   
   Laat de optie afbeeldingen standaard staan
   
6. Laat alle velden geselecteerd en druk op Volgende
   
7. De XML wordt nu aangemaakt en opgeslagen op schijf.

Merk op dat we deze XML alleen zullen gebruiken als voorbeeld voor het maken van ons nieuwe rapport. Data Crow zal het XML-extract automatisch aanmaken wanneer u het rapport uitvoert vanuit Data Crow (Extra > Rapport aanmaken). Het is belangrijk dat u items selecteert die de meeste informatie bevatten en een paar items met zeer beperkte informatie. Dit is altijd goed om het rapport te testen.

JasperSoft Studio #

Start vervolgens Jaspersoft Studio. Bij de eerste start wordt u gevraagd om een locatie voor de werkruimte te selecteren. Kies een locatie naar keuze. Zodra u gestart bent, sluit u alle welkomstschermen totdat u in het eigenlijke werkgebied bent.

Het eerste wat we moeten doen is het XML-bestand dat we hebben geëxporteerd instellen als een Gegevensadapter. Gegevensadapters worden gebruikt om rapporten met gegevens te vullen. Selecteer de Archiefverkenner tabblad en klik met de rechtermuisknop op de Gegevensadapters. Selecteer in het rechtsklikmenu Gegevensadapter maken.

Selecteer XML-document;

Druk op Volgende om de XML-gegevensadapter verder te configureren

Vul ten minste de volgende velden in (andere velden zijn optioneel en worden uitgelegd in de documentatie van Jaspersoft Studio):

• Naam: voer een naam in die je wilt, herkenbaar voor jezelf.
• Bestand: selecteer de XML-export zoals gemaakt door Data Crow. In mijn geval was dit text.xml. Merk op dat voor het uitvoeren van het rapport door Data Crow dit bestand niet wordt gebruikt, dit is alleen voor het ontwerpen van het rapport.
• Vink "Gebruik de Xpath-expressie van het rapport bij het vullen van het rapport" aan. Dit is erg belangrijk omdat je anders een leeg rapport krijgt voor je testruns.

Druk op Test om je set-up te testen.
Druk op Afwerking om het aanmaken van de gegevensadapter te beëindigen.

Een leeg rapport maken

We hebben nu dus een XML-bestand dat is ingesteld als gegevensadapter in je Jaspersoft-omgeving. De volgende logische stap is het maken van een nieuw rapport met de data-adapter als invoer.

Navigeer naar de Project Verkenner. Standaard staat hier een project met de naam MyReports. Je bent vrij om een andere projectnaam te gebruiken, het is niet belangrijk voor de Data Crow rapporten.

Klik met de rechtermuisknop op het project en selecteer Nieuw, Jasper-rapport.

Nu kunt u een Rapportsjabloon. Voor Data Crow rapporten kun je elk gewenst rapportsjabloon kiezen. Voor meer details over deze sjablonen verwijs ik je naar de Jaspersoft Studio documentatie. Voor nu kies ik het sjabloon Blanco A4. Druk op Volgende.

Vervolgens vraagt Jaspersoft Studio je om het rapport een naam te geven, zodat het in je project kan worden opgeslagen.
Geef het een naam die zinvol is; de naam van het rapportbestand wordt getoond in de rapportselectie van Data Crow. Voor dit voorbeeld noem ik dit rapport Test. Druk op Volgende om door te gaan naar de volgende stap.

Nu zijn we bij de stap waar we de gegevensadapter aan het rapport koppelen. Hierdoor kan het rapport de beschikbare velden vinden en ze vullen met informatie wanneer het rapport wordt uitgevoerd.

• Selecteer de Data Adapter uit de vervolgkeuzelijst. In mijn geval heet deze Test XML.
• In het onderstaande veld wordt de structuur van het XML-bestand weergegeven. Nu moeten we definiëren hoe Jaspersoft Studio de XML-informatie moet gebruiken. Voor
  In het voorbeeld zie je dat ik software-items heb geëxporteerd. Er zijn in totaal 4 items, elk item wordt weergegeven als software-item. Als we naar één item kijken, kunnen we alle velden zien:
  
• Dubbelklik op het knooppunt dat alle velden bevat. Hierdoor worden alle items beschikbaar in het rapport.
  
  Merk op dat je voor XML-exports uit andere modules bijvoorbeeld Film, Boek, Muziekalbum, enzovoort ziet in plaats van software-item. De te volgen stappen zijn precies hetzelfde. Druk op Volgende.
• In de volgende stap moet je kiezen welke velden je in het rapport wilt opnemen. Als er geen velden in de lijst staan of als deze stap wordt overgeslagen, betekent dit dat je een fout hebt gemaakt in de vorige stap. Ik heb alle velden geselecteerd door op de knop >> te drukken. Ik raad aan om alle velden toe te voegen omdat dit de meeste flexibiliteit geeft.
  
• Op dit punt kunt u ervoor kiezen om Afwerking de wizard. U kunt ook doorgaan door op Volgende waarmee je bij de optie komt om groepering in te stellen. Groeperen wordt echter niet behandeld in deze gids; ik zal je moeten verwijzen naar de documentatie van Jaspersoft Studio. Het wordt wel ondersteund door Data Crow, dus daar hoef je je geen zorgen over te maken.

Nu hebben we een leeg rapport met een geconfigureerde gegevensadapter.

Ontwerptips & Trucs #

Voor volledige documentatie over het ontwerpen van uw rapport in de Jaspersoft Studio software verwijzen we u naar de documentatie die beschikbaar is op de Jaspersoft website:
https://community.jaspersoft.com/project/jaspersoft-studio

Er zijn handleidingen en Wiki's beschikbaar.

Om je op weg te helpen, zal ik een aantal basisprincipes uitleggen.

Rapportopmaak

In het midden van het scherm vind je het rapport zelf. Je ziet de verschillende secties, zoals Titel, Paginakoptekst enzovoort. Je kunt de grootte van de secties aanpassen met de muis.

Deze secties kunnen worden verwijderd (of toegevoegd) vanuit de Outline sectie:

Velden toevoegen

Alle velden die deel uitmaken van de XML data adapter zijn te vinden in het outline gedeelte van de werkruimte. Van hieruit kun je velden naar het rapport slepen:

Velden met meerdere verwijzingen

Merk op dat ik voor elk veld met meerdere verwijzingen een veldnaam-lijstveld (zie hierboven voor voorbeelden, zoals categorieën-lijst). Dit bevat de door komma's gescheiden waarden. Als je in plaats daarvan de individuele items wilt doorlopen, moet je een Lijst element.

Afbeeldingsvelden (afbeeldingen)

Optioneel kun je er ook voor kiezen om eerst een specifiek element aan het rapport toe te voegen en dan aan te geven welke waarde je wilt gebruiken. Laten we bijvoorbeeld een afbeelding toevoegen. Aan de rechterkant van het scherm vind je een sectie genaamd palet. Hier vind je alle beschikbare veldtypes. Selecteer Afbeelding en sleep dit naar het rapport.

Selecteer in het dialoogvenster dat verschijnt Aangepaste uitdrukking. Hierdoor wordt het veld Opties ingeschakeld.

Druk op de knop.

Door
Standaard worden alle Velden weergegeven. Selecteer het afbeeldingsveld dat je wilt toevoegen en dubbelklik erop. Ik heb het afbeeldingsveld vooraan geselecteerd.

Inhoud van lege velden

Jaspersoft drukt NULL af als het veld leeg is. Ik heb liever dat het veld niets weergeeft als een veld leeg is. Dit kan via de eigenschappen van het veld. Selecteer het veld door erop te klikken in de Hoofdrapport bekijken. In het onderstaande voorbeeld heb ik het veld Titel geselecteerd.

Laten we de eigenschappen van dit veld wijzigen. Klik op het veld (zoals in het bovenstaande voorbeeld). Navigeer nu naar de sectie Eigenschappen.
Selecteer Tekstveld.

Vink het vakje aan Uitrekken met overloop. Dat is precies wat het doet; als de inhoud te groot is, wordt het veld uitgerekt, waardoor alle inhoud zichtbaar wordt.

Veldpositionering

Elk veld dat aan het rapport wordt toegevoegd, wordt automatisch uitgelijnd, gerelateerd aan de bovenkant. Dit kan handig zijn als je wilt dat je veld altijd op dezelfde plaats blijft; als het rapport wordt uitgerekt, blijft de positie van het veld op dezelfde relatieve afstand van de bovenkant van het rapportgedeelte.

Dit is problematisch als je het veld onder een tekstveld hebt geplaatst (zie hierboven) dat Strekken met overloop.
Het veld wordt bovenop het uitgerekte veld geplaatst omdat het zich positioneert ten opzichte van de bovenkant van het rapportgedeelte, niet ten opzichte van het veld erboven.

Om dit aan te passen, stel je dit veld in op Positietype Vlotter in plaats daarvan:

Andere velden

Er zijn veel veldtypes beschikbaar om de broninhoud (de XML-informatie) weer te geven. Er zijn ook velden beschikbaar zoals het paginanummer. Deze velden zijn te vinden in het gedeelte Palet:

Verslag Voorbeeld #

Op elk moment tijdens het ontwerpproces kun je een voorbeeld van het rapport bekijken. Klik op de knop Voorbeeld, zoals hieronder weergegeven:

Door een preview te doen, krijg je te zien hoe het rapport er voor de eindgebruiker uitziet. Ook wordt het rapport gecontroleerd op fouten.

Het rapport samenstellen en implementeren #

Als je klaar bent met het rapport kun je het bouwen en beschikbaar maken voor Data Crow. Zorg er eerst voor dat je het rapportbestand opslaat. Het is het beste om de wijzigingen altijd op te slaan voordat je het rapport bouwt, omdat anders de wijzigingen die je hebt aangebracht mogelijk ontbreken in het uiteindelijke resultaat.

Navigeer naar Project > Schoon. Hierdoor wordt een .jasper-bestand aangemaakt.
Het enige wat je nu nog moet doen is het .jasper-bestand kopiëren naar de map Data Crow reports van de gebruikersmap. De rapportmapstructuur wordt uitgelegd in het hoofdstuk Rapportproces;
<user folder>/Rapporten/<module name>

U hoeft Data Crow niet opnieuw op te starten om het rapport uit te voeren. Open gewoon opnieuw de Report Dialog. Voor dit voorbeeld heb ik het bestand Test.jasper gekopieerd naar de rapportenmap van mijn gebruikersmap:

• C:\Gebruikersgegevensarchief software

Start de Rapport maken gereedschap:

Selecteer de Test rapport dat je net hebt gemaakt:

En selecteer de Rapporttype:

En natuurlijk het doelbestand - het bestand dat je rapport zal bevatten.
Selecteer uitvoeren om het rapport te maken;

Dat is alles - je zou nu een rapportbestand moeten hebben met informatie over je items!