Reports

Reports are created in the tooljaspersoft and incorporated into the system using the fields and options available on the senior X Platform. For correct operation, they must be created following the guidelines:

• The parameters used must be standard Java types: Number, String, Boolean, java.sql.Date, java.sql.Timestamp, java.util.List, java.util.Map (in the case of MAP, it will only be used to create reports via parameters);
• Parameters that have the "Is for prompting" option are mandatory and must always be informed during their generation;
• The default data source for presenting service data is JDBC, it is also possible to create a report without a data source, just passing parameters and generating the report based on this information, however this is necessaryconfigure Jaspersoft;
• The file must have the .jrxml or .zip extension, when there are images and/or java scripts.

After the model is created in Jaspersoft Studio and the senior X Platform, remember to define access permissions for it, indicating which users will be able to run/view the report.

After creating the report in Jaspersoft Studio, publish it to the senior X Platform.

Before uploading a report to the platform, create the report using JasperReport in advance and define parameters for this report:

1. Access Technology > Customization > Reports > New Report;
2. Fill in the parameters to create a report normally;
3. Upload the previously created report file. A list of parameters defined within the report file will be displayed in the File Information > Parameters section;
4. Choose any of the existing parameters, go to the columnSearch Service and clickAdd/+;
5. Choose the target domain or service that will be responsible for returning the list of values for the parameter in question (any existing domain/service can be used);
6. Choose the primitive that will be used to return the values. Only primitives that return values in the correct format will be displayed. Therefore, all of them are syntactically valid, and it is necessary to choose the one that has the correct semantics, for example, one that actually returns the list of companies, and not the list of products;
7. click inTo save.

Create reports using custom fields, applying filters and using the fields as parameters:

1. Download It isconfigure the senior-jasperreports-functions-XXXjar library;
2. Create the report as needed:
   1. Access Jas
   2. persoft Studio, in File > New > Jasper report;;Select Blank A4 Landscape and click
   Next
   3. and again in
   Next
   4. ; Select
   Tei
   5. id - Database JDBC Connection and click
   Next
   6. ;Go to Table
   , select the desired table and click Next ;In Fields, select all fields and click theAdd;click in Next and then inFinish.

3. Extract the custom field using the function available in CustomFields. These methods receive as parameters the value of the custom field (XML) and the name of the column that you want to extract;
4. Use the report variable and the expression field to extract the information and display it in the report;
   
   Example:

   CustomFields.getInteger("<xml><ext><CodigoNcm>123</CodigoNcm></ext>", "CodigoNcm") == 123

5. Include the variable in the document and save the Jaspersoft Studio project;

6. Finally, publish the report for execution on the platform.

Create a menu to access the report screen:

1. Access Technology > Customization > New Report;
2. Under Report Menus, clickNew;
3. Determine where it will be displayed:
   • In
   • the main menu: allows you to select only grouping menus;In the context of a screen: It is not possible to select menus that are submenu groups.
   

   Exam
   In the main menu: Technology > Customization > Main reportIn the context of a screen: Technology > Customization > Modules > Main report
4. Report atLabel the name of this menu;
5. Select a menu and it will be displayed. When it is not possible to select one of the menus from the previously determined location, an access denied icon will be displayed;
6. click inTo add.

Some resources are of great help in handling reports, such as, for example, the creation of tags to facilitate searching when there are a large number of reports in the environment. Another option is to make the report available for only a pre-determined period of days and choose a good location for it to be viewed, remembering that the name entered when creating it is what will be displayed, and not the name of the file itself.

1. Access Technology > Customization > Reports > New Report;
2. click inCreate Report, enter the name and attach the report template. Other fields are optional;
3. click inTo save.

If the report is made up of several files, these files must be added to a compressed file (.zip). It is important that the name of the compressed file (.zip) is the same as the name of the report file (.jrxml). When the report consists of just one file, it can be added normally, just the file with the .jrxml extension.

To schedule a report, you first need edit and view permissions for the res://senior.com.br/platform/scheduler/job resource. After securing permission, proceed with scheduling:

1. Access Technology > Customization > Report > Reports;
2. Select a report and clickActions >Details;
3. Click on the buttonSchedule report;
4. If the report has parameters, they must be filled in. Enter the format and who to send it to. The user will be redirected to the scheduling screen, where all the fields required for the report will already be filled in;
5. Complete the sectionExecution, choosing the start date, frequency, time, among others.

1. Access the report through the menu where it was made available or through Technology > Customization > Reports;
2. Select the report you want to print or search for the created report;
3. click inTo view. The report parameters will be displayed;
4. Check the Lookup parameters and, if desired, edit them. The Lookup list follows the scope of the user in question. Therefore, only values for which the user has permission will be displayed;
5. Choose whether the report will be sent to someone;
6. click inView Report and wait for notification that the report is ready.

1. Access Technology > Customization > Reports;
2. View a list of all reports already created for existing domains and services;
3. click inActions, in the optionDetails , of the report you want to edit;
4. As per your permission, edit the information.