New 'Java report'

To create print documents in Lobster Data Platform / Orchestration, a Jasper report is required as a template. The data basis is the XML structure, which is available for each business object in Lobster Data Platform / Orchestration in the tab 'Export' under 'View print xml'.

1. Export sample data from Lobster Data Platform / Orchestration

Before creating a new template (report) for an Lobster Data Platform / Orchestration business object in Jaspersoft Studio, it is best to first create sample data in an XML file. For this purpose create a business object in Lobster Data Platform / Orchestration (e.g. order, shipment, manifest, etc.), which contains the data, which should be printed later with the document, and then copy the XML data from 'View print xml' into a file.

images/download/attachments/62851427/image2018-8-27_14_41_37-version-1-modificationdate-1603704371705-api-v2.png

Figure 1: The XML structure used to create a print document can be viewed in Lobster Data Platform / Orchestration for each business object under Export (1)/Show print xml (2) and then copied to a file

2. Create new 'Java Report'

A new Java report is usually created by right-clicking on the designated Java Project in the 'Object Explorer' of Jaspersoft Studio.

images/download/attachments/62851427/image2018-8-27_15_18_16-version-1-modificationdate-1603704371716-api-v2.png

Figure 2: Creating a new Jasper Report (2) via the context menu (right click) of the corresponding 'Java Project' (1)


If the entry Jasper Report (2) is not yet listed in the second context menu, the wizard for new objects must be opened again via Other.

images/download/attachments/62851427/image2018-8-27_15_37_5-version-1-modificationdate-1603704371718-api-v2.png

Figure 3: Selection of a Jasper Report (1) via the New Object Wizard and continue with Next (2)


images/download/attachments/62851427/image2018-8-27_15_42_13-version-1-modificationdate-1603704371720-api-v2.png

Figure 4: Selection of the page format, continue with Next (1)


images/download/attachments/62851427/image2018-8-27_16_23_39-version-1-modificationdate-1603704371725-api-v2.png

Figure 5: Assign a File name (1) and continue with Next (2)


images/download/attachments/62851427/image2018-8-27_16_26_6-version-1-modificationdate-1603704371728-api-v2.png

Figure 6: Selection of the data source via New... (1)


images/download/attachments/62851427/image2018-8-27_16_29_6-version-1-modificationdate-1603704371730-api-v2.png

Figure 7: Selection of the XML document adapter (1) and continue with Next (2)


The following information must be provided when configuring the data adapter:

  • Name: any

  • File/URL: the example file exported under 1 (see above)

  • Enable namespaces support: true

  • Use the report Xpath expression when filling the report: true

images/download/attachments/62851427/27-08-_2018_16-31-27-version-1-modificationdate-1603704371732-api-v2.jpg

Figure 8: Configuration of the 'Data Adapter' (1) and continue with Finish (2)


Back in the 'Data Source' dialog, you should now select the first element from the XML to be iterated over when creating the print document. This is usually the position (lineItem) of a business object, i.e. the Xpath should be /core:Print/printObjects/[BusinessObject]/lineItems/lineItem.

images/download/attachments/62851427/image2018-8-27_16_53_42-version-1-modificationdate-1603704371737-api-v2.png

Figure 9: Selection of the first object (1) to be iterated over (e.g. the first position of a shipment). Continue with Finish (2)


When the data source is created, the new report is created, correctly configured and the implementation can begin.

images/download/attachments/62851427/image2018-8-27_17_1_58-version-1-modificationdate-1603704371739-api-v2.png

Figure 10: A new report is ready for implementation