JasperSoft integration
  • 29 Feb 2024
  • 4 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

JasperSoft integration

  • Dark
    Light
  • PDF

Article summary

1. Manage printables (JasperSoft)

Managing printables with JasperSoft Studio software allows the creation of several types of reports. It allows you to create metadata report templates in PDF format, based on types of archival and project management entities such as metadata reports of documents, folders, and tasks. JasperSoft also allows you to assign a metadata report based on a general or specific metadata schema. JasperSoft allows you to create labels to your liking for use on Constellio containers, folders and documents. It also allows you to manage slips.

Important
The version of Jaspersoft Studio to use for Constellio 10+ is6.16.0.

Jaspersoft Studio is a third-party software owned by Jaspersoft (Tibco Software).
https://www.jaspersoft.com/

Jaspersoft Studio v6.16.0 download link: https://constellio.cloud.constellio.com/constellio/dl?id=00000961331

Namely
This section will be useful to the user who will create the metadata reports in the Constellio software and who will also have the mandate to create the labels, PDF reports and slips. However, it should be noted that the user will be required to master certain computer concepts (e.g. unite two metadata using a syntax in Java language, recognize a metadata field within a generated XML, summarily recognize error messages pointing to the source of a problem, etc.) in order to acquire a certain autonomy and to be able to allow it to import, modify or build a model so that it can then be integrated into Constellio. 

2. Limitation of functionality

Some limitations are known of the feature.

  • It is not possible to generate a report that contains records of several different schema types.
  • It is not possible to generate a report that contains both records of different metadata schemas unless you select a report that is defined for the default schema.
  • The "Generate Report" button is not available in simple search, only in advanced search, since the mechanics related to simple search do not distinguish between archival entities, even if a search facet is selected to define a type of archival entity.
  • The new report control screen will be visible only when the user has global read access permission on the collection.
  • The data export (savestate) will not contain the report templates.
  • The user is responsible for saving report templates that have been integrated into Constellio.
  • Metadata reports must be imported manually for each collection.

3. Label management

Label management mainly allows you to add labels for folders and containers.

  1. Click on " Administration " in the navigation menu";
  2. Then click on " Manage Printables ";
  3. In the " Printable Management " window, click on " Label Management ". 

The actions available in the " Label Management " window are the same for either folder labels or container labels. 

How to create these labels with JasperSoft Studio?
See the Labels article. 

3.1 Add a label template

  1. In the " Label Management " window, click on " Add Label ";
  2. In the " Add Label Template " window, complete the metadata and click " Save ".
Field Name
DescriptionImage
TitleObligatoryClear and concise title that makes it easier to identify the label model.
Jasper fileObligatoryAdd the Jasper file to the label template.
ColumnFacultativeSpecify the number of columns in the label template.
LineFacultativeSpecify the number of rows in the label template.
TypeFacultativeIndicate whether the label template is for folder or container.

3.2 Consult a label

In the " Label Management " window, click on the magnifying glass to the right of the label template you want to view.


3.3 Edit a label

In the "Label Management " window, click on the notebook to the right of the label template you want to edit.


3.4 Delete a label

In the " Label Management " window, click on the red X to the right of the label template you want to delete.


3.5 Get a test XML

  1. In the " Label Management " window, go to the tab for which you want to obtain a test XML and click on " Get a test XML";
  2. In the " Get Test XML " window, enter the number of folders or containers and click " Save ";
  3. Download the test XML file. 

3.6 Obtain templates

This option allows you to obtain container labels, folder labels, and empty label templates.

In the " Label Management " window, click on " Get label templates ".


4. Management of printable reports

This option allows you to create printable reports for folders, documents, and tasks. In Constellio, this type of report is called metadata report.

  1. Click on " Administration " in the navigation menu;
  2. Then click on " Manage Printables ";
  3. In the " Manage Printables " window, click on " Printable report management ";
  4. In the " Printable report management" window, click on " Add a new report template ";
  5. In the add report model window, complete the metadata and click " Save ". 
Add a report template
Field Name
Description
TitleObligatoryClear and concise title that makes it easier to identify the report.
Jasper fileObligatoryAdd the Jasper file to the report template.
Report TypeObligatorySelect the type of report corresponding to the report (Folder, Document, Tasks).
Schema related to the reportObligatorySelect the metadata schema related to the report.

4.1 Consult a report template

In the " Manage printable reports " window, click on the magnifying glass to the right of the report you want to view.


4.2 Edit a report template

In the " Manage printable reports " window, click on the notebook to the right of the report you want to edit. 


4.3 Delete a report template

In the " Manage printable reports" window, click on the notebook to the right of the report you want to edit.


4.4 Get a test XML

  1. In the " Manage printable reports " window, go to the tab for which you want to obtain a test XML and click on " Get a test XML ";
  2. In the " Get Test XML " window, select items (folders, documents, or tasks) and click " Save ";
  3. Download the test XML file.

4.5 Obtain templates

This option allows you to get the templates for all your reports. In the " Manage printable reports " window, click on " Get templates ". 


4.6 Generate a metadata report

It is possible to generate a metadata report for folders, documents, and tasks via the cards for these items, the selection action window, and the advanced search.





Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.