3 Replies Latest reply on Sep 30, 2021 10:37 AM by 1010496

    Faster report generation

    1010496 New User

      When building report Freemarker (FTL) templates to extract information from IUCLID using the Report Generator, the time-consuming part is often testing the FTLs and re-uploading these to the IUCLID Report Manager. Now there is a faster way you can generate reports.

       

      The IUCLID team has now published an example Bash script to rapidly generate a report from multiple datasets or dossiers for IUCLID's main entities: (Substances, Mixtures, Categories, Articles).

       

      Automatic report generation - IUCLID (europa.eu)

       

      This saves a lot of time if you are building and testing reports, as with the example Bash script, you can make your FTL changes and quickly generate your updated report FTL templates without repeatedly uploading the templates to the Report Manager.

       

      On the webpage, we show you how to clone a github repository on your local machine, which gives you A) the bash script and B) the folder structure and files needed to run the script.

       

      Moreover, we provide line-by-line guidance on how to configure the all-important '.env' file so that your own IUCLID and datasets/dossiers can be used in the automatic generation of reports.

        • Re: Faster report generation
          1316871 New User

          Dear Mark,

           

          Thanks a lot for developing this script! It does indeed speed up a lot the process of refreshing templates and generating reports for lists of dossiers, which is very useful when developing new templates or modifying existing ones

           

          I have couple of questions:
          1) Would it be possible to use this script for reports in the Cloud, and not only for local IUCLID installations? That would avoid the need of downloading dossiers locally.
          2) I noticed that when reports crash (e.g. because there is a mistake in the ftl templates), empty pdf/rtf files are created and no explicit error is raised by the bash script. The only way to identify the reports that crashed is either by trying to open them manually or doing some other operations in the command line e.g. checking the size of all generated reports. I was wondering, would it be possible to make the bash script output some text messages about the success of the report update/creation process e.g. a final text summary indicating those reports that crashed or were not updated successfully?

           

          Thanks a lot, and congrats for the nice work!

           

          Adrian

            • Re: Faster report generation
              1010496 New User

              Thanks for the extra information, Adrian.

               

              Regarding your question:

              1) Would it be possible to use this script for reports in the Cloud, and not only for local IUCLID installations? That would avoid the need of downloading dossiers locally.

              Currently, the IUCLID API is not supported with Cloud instances: https://iuclid6.echa.europa.eu/public-api

               

              Unfortunately, for the time being, you will need to continue to use a local instance of IUCLID to use the Bash script.

               

              Regarding your question:

              I was wondering, would it be possible to make the bash script output some text messages about the success of the report update/creation process e.g. a final text summary indicating those reports that crashed or were not updated successfully?

              Currently, this is not supported using the bash script, and we would recommend using the server/error logs found in the IUCLID installation directory (only for local installations). If you are using Cloud, then the primary log event for reporting is found in the classic interface's background jobs.

               

              We have taken note of this request, and will look into it as part of our updates to the bash script.

               

              Apologies that we cannot give more positive answers at this stage.

            • Re: Faster report generation
              1010496 New User

              Currently, the ECHA IUCLID webpage is not available.

               

              If you wish to use the bash script, you should clone the repository from github:

               

              https://github.com/echa-ecm/automatic_report_generation_scripts

               

              and follow the instructions from the READme file.

              1 of 1 people found this helpful