Skip to main content

FieldLogs

Using ReportingNG

ReportingNG is an advanced report generation facility available in FieldLogs.

It is used to generate reports pertaining to FieldLogs Objects. You can configure the reports by either specifying the id of the object whose report is to be printed or by defining a search query. When a search query is defined, it prints the reports of all the Objects that match the search criteria.

Configuration Files:

The ReportingNG interface accepts two files:

  1. A .zip file that has both the components configuration .json file(componentsConfiguration.json) and the .ftl model file. This is a mandatory input.

  2. A User Input .json file userInputFile.json. This is optional and only required if a user input is required.

ReportingNGCONFIGFINAL.png

In the example below, the QA_Report_V50.zip contains the .ftl model and the componentsConfiguration.json. The data defined in the componentsConfiguration.json is used by the .ftl model to print the report.

ReportingNG-UI1.png

The report configuration in ReportingNG is contained in a .ftl model file and a componentsConfiguration.json file. Together they can be compressed in a single .zip file. This is the Model file.

Users can customize reports. If a user input is required, an optional userInputFile.json is uploaded. As soon as this file is uploaded, the user is prompted to enter the required data.

Note

The variable configuration in the componentsConfiguration.json must have variableDataType:"userInput" in order for the userInputFile.json to be considered.

Otherwise, the userInputFile.json will be ignored and the user will not be prompted to enter any input.

It has several advantages compared to the traditional FieldLogs report generation. They are described in the table below:

Traditional FieldLogs Reporting

ReportingNG

Each report can only be a separate .pdf file

One of the following options can be selected, as defined in the config.json file.

  • Multiple reports in separate .pdf files.

  • Several reports can be combined into one single .pdf file

The following reports can be generated:

  • Template

  • Job

  • Dataset

  • Screening

  • Operation Plans

The following reports can be generated:

  • Template

  • Job

  • Dataset

  • Screening

  • Operation Plans

  • Tasks

  • Projects

  • User Sets

  • Enterprise Information

  • Roles

Mass Printing and the multi-report option from the search page can be used to print multiple reports.

Multiple report types can be printed in one PDF file.

Report generation of all Templates/Jobs matching a search criterion is not available.

Reports can be generated from Templates/Jobs that match certain search citeria.

The .ftl model need to be uploaded while printing the reports.

The componentsconfig.json is embedded in the .ftl model. They are both in the executable report.