1. Create Jasper Template

Simply go to the dashboard data editor, select the class DocumentTemplate, create a new instance and upload your Jasper template file into the attribute "mainTemplateFile".

Attention: Jasper templates are created in JRXML and have to be compiled to Jasper in order to work with the DocumentGenerator module.

Your DocumentTemplate instance should now look like this :

After posting the file the dataSetKeys and dataSourceNames are generated automatically from the template file.

DataSetKeys show keys of fields and dataSourceNames names of parameters in the template.

2. Create a SubTemplate (optional)

Next, select the class DocumentSubTemplate, create a new instance and upload your Jasper (sub-)template into the attribute "subTemplateFile".

The DocumentSubTemplate instance should now look like this :

To use your created instance of DocumentSubTemplate, reference it on the "subTemplates" attribute of your DocumentTemplate, so it looks something like this:

After referencing the DocumentSubTemplate object to the DocumentTemplate object the dataSetKeys and the dataSourceNames attributes get extended by the field and parameter names of the subTemplate file.

3. Create Template DataSources

Now, the empty fields in the templates need their referring datasources.

DataSources can be a "dataSource" or part of the "subDataSources" in the Document object.

The differences between dataSources and subDataSources are the following:

• every template has exactly one dataSource, but can have many subDataSources

• dataSources fill fields in the template that aren't in any sub dataset (i.e. tables or sub-templates)

• subDataSources are connected to their sub dataset via dataSourceName

If you are uncertain which keys or dataSourceNames are allowed, you can look them up in your previously created instance of Template under dataSetKeys and dataSourceNames.

The attribute OrdNr allows you to set the order for datasources. If the OrdNr of a datasources isn't set, it's simply added at the end.

If you need to link multiple datasources with equal keys to a superior dataSource, you can do that via the "refDataSources" and the "refDataSourceName" attributes, simply add a "refDataSourceName" to your lower datasources and reference them on the "refDataSources" attribute of your higher datasource.

In this example, two "subDataSources" (one with & one without a refDataSource) and a "dataSource" for our Document object are created.

Open your data editor and select the class DataSource in the navigation bar.

Create a new instance and fill in the values from the following table in the attributes :

Example for "subDataSources" with refDataSources:

Example for refDataSource:

Example for "subDataSources" without refDataSources:

Example for a/the "dataSource":

Your instance of DataSource should now look like this:

4. Generate Document

After the Document(Sub)Template and the DataSources are complete it is time to generate the document :

• Open the data editor and select the class Document.

• Fill the class attribute template by selecting the reference to the created DocumentTemplate of the first step.

• Now you can add the "dataSource" and the "subDataSources" you created. If you are using refDataSources, just link the higher dataSource (the lower ones will be added automatically).

• Set a name for your generated file in attribute "name" and select the file type (pdf, docx, csv, txt, xls, xml or rtf) which will be generate under "fileType" attribute.

• There is also the possibility to nationalize the Document in two different ways:

1. the "language" attribute
   Just give this this attribute an official country code like "en" and location specific formats will be adopted automaticall (e.g. for dates).

2. the "langProperties" attribute
   To use this attribute, your template file has to contain a resource bundle and fields with the right syntax to be filled with different values depending on the nationalization.
   Post a file with the following structure: <filename>_<country code>.properties.
   There can only be one properties file per Document object.
   If the "langProperties" attribute is set, the cobntent of the "language" attribute does not matter anymore.
   Attention: if the jasper template requires a properties file, the properties file must be uploaded first.

• After setting these attributes, set "generate" value to 1 and the module will generate the document automatically. The generated document will be stored in the attribute "resultFile", ready to be downloaded.