A3. PostgreSQL is not supported for use with IUCLID 6. The only databases supported are JavaDB/Derby (free, as in no charge) and Oracle (commercial). For more information about software requirements please refer to the documentation section of this website.
A4. Tomcat is not supported for use with IUCLID 6. This is one of the major technical changes between IUCLID 5 and IUCLID 6. The Tomcat application server is replaced by GlassFish (version 3.1.2 or 4).
A5. Details of the operating systems tested and supported by ECHA are available on the system requirements page of the IUCLID website.
A6. Yes. IUCLID 6 Desktop is available for macOS from the download page of the IUCLID website.
Installation, update, and system configuration
A76. Before installing IUCLID 6, check the following.
- If you have a relatively small amount of data (< 1 GB) you may not have to install IUCLID 6 at all, because you may be able to use an instance of IUCLID 6 hosted in the ECHA Cloud Services. Please check the associated Terms and Conditions to see whether your are eligible for the service. This solution is also particularly useful if you want to give a consultant remote access to your data.
- If you do not want to, or cannot use the IUCLID Cloud Services, you can install IUCLID 6 Desktop on a local computer running MS Windows, macOS, or Linux. This is a desktop application where all your data is stored locally, and is accessible by one user at a time. The resources required are such that for a few hundred datasets or dossiers, any fairly recent computer or laptop should work, but ensure that there is enough memory available when actually running IUCLID. If you need to provide remote access to multiple users of data, you will need to download and run IUCLID 6 Server. More precise requirements are given on this website under System Requirements. More information about the differences between the Cloud, Desktop, and Server versions of IUCLID are given at the top of the download page.
- The user installing IUCLID must have appropriate permissions to create the IUCLID 6 installation folder. For MS Windows it is recommended that IUCLID 6 is installed in a directory like C:\iuclid6, D:\iuclid or similar. To avoid problems with access rights, we do not recommend installation in the Windows folder Program Files.
- The installer for IUCLID 6 Desktop is documented in its user interface, and in the video here. Instructions for IUCLID 6 Server are provided in its installation manual.
A77. Before upgrading IUCLID 6, check the following.
- Download the appropriate IUCLID Updater Tool for the system to be upgraded.
- Make a backup of your data. For IUCLID 6 Desktop this can be done by running the tool iuclid6-backup-restore.exe that comes with the application. It is located in the installation directory.
- Ensure that the user under which the updater is run has write permissions to the installation folder and all the files under it. In windows this can be checked for a file by right-clicking on the file, selecting Properties, and then viewing the settings under the tab Security.
- If the database is very large, consider the configuration of memory that is described in Q48.
- The IUCLID Updater Tool is documented in its user interface, and in the video here. The IUCLID Updater Tool works for both the Server and Desktop versions of IUCLID 6. Additional instructions that apply only for IUCLID 6 Server are provided in its installation manual.
- Before upgrading or restoring IUCLID 6 Server without running a gui, ensure that the values for the installation to be upgraded have been entered in to the configuration file indicated below:
<IUCLID Updater Tool>\config\updaterConfig.properties
A22. This depends on whether the password of the user SuperUser was changed via the Windows installation wizard, and whether users have been migrated from IUCLID 5. If neither of these were done, after an installation, use the following credentials to log in to IUCLID:
All credentials are case sensitive. For non-administrative use of IUCLID 6 it is recommended to use a user other than SuperUser. You can create new users whilst logged in to the classic user interface as SuperUser.
The IUCLID 6 Desktop version offers the option to work without user management. In that case the log in step is by-passed.
For IUCLID 5 Portable, the credentials to log in are admin / admin.
A46. In case you do not remember which version of IUCLID is installed, you can download a small executable file to find out. Here is how to check your IUCLID 6 version:
- Download the IUCLID 6 version checker
- Extract the file to your IUCLID 6 installation folder, as below
- Execute the file by double-clicking it
- For a 32-bit version you should obtain the following result
- For a 64-bit version you should obtain the following result
Please note that there is only one updater provided for IUCLID 6 that will update your existing IUCLID 6 Desktop installation to the latest one, whether it is a 32-bit or a 64-bit installation.
A48. The following problems can be caused by insufficient system memory (RAM) being available to IUCLID 6 or its associated software tools:
- IUCLID 6 or a tool does not start;
- Unusually slow performance, especially when large files are handled;
- The error “Out of Memory exception” is output either to log files or the command line.
To avoid these problems, and to use resources most efficiently, consider the total RAM available to the computer, and how it is allocated to IUCLID 6 and each of its software tools. The recommended system resources for IUCLID 6 are stated here. Many problems like those given above can be solved simply by changing the values of certain system parameters in settings files. A detailed guide to memory management for IUCLID 6 and its tools, aimed at non-IT specialists, is provided in the document Java and Memory in IUCLID 6. What follows below is aimed at users with sufficient IT skills that they need to know only where to find the parameters.
IUCLID 6 and its tools are Java applications. Many problems relating to memory can be solved simply by increasing the maximum limit of allocation of RAM by increasing the value of the parameter Xmx for the relevant Java virtual machine (JVM). Where Xmx is set, Xms may also be set. The locations and default values are:
|Application||Default value||Settings file|
|IUCLID 6 Desktop||2 GB (-Xmx2048m)||<installation directory>\glassfish4\glassfish\domains\domain1\config\domain.xml|
|IUCLID 6 Server (Server)||4 GB (-Xmx4096m)||<installation directory>\glassfish4\glassfish\domains\domain1\config\domain.xml|
|IUCLID 6 Server (Client)||1 GB (-Xmx1024m)||<installation directory>\glassfish4\glassfish\domains\domain1\iuclid6\iuclid6-war-<version>.war\launch.jnlp|
|Updater tool||2 GB (-Xmx2048m)||<IULCID updater tool>\bin\updater.cmd|
A57. The Updater tool can be used to upgrade to IUCLID 6.4 from IUCLID 5.6 or later. The Updater tool migrates the data to the latest format. Migration of data can also be done by exporting from IUCLID 5.6 or later, and then importing in to IUCLID 6.4.
A61. When you migrate data between major versions of IUCLID, there will be no data loss. Most data is migrated to other structured fields. When structured fields are not available, the data is put into an attachment and can be opened from the relevant IUCLID document. When using the updater tool to update from v6.1 to v6.4, or importing IUCLID files from 6.1 to 6.4, your data will be migrated step-wise up the major versions, that is: 6.2, 6.3, 6.4.
A62. There is no 32-bit version available from the website anymore because the vast majority of computers are now 64-bit compatible. Using a 32-bit version presents some limitations in terms of performance of the application and memory allocation. If you used a 32-bit version earlier, the 64-bit updater can upgrade your installation to 64-bit. Before continuing to use a 32-bit version of IUCLID, please check whether the computer you are using can run the 64-bit version and if it can, consider using it. 32-bit installers and updaters are available on request from the Helpdesk.
A74. In the classic interface, you can check the IUCLID version by going in the menu, under 'Help', 'About'.
In the web interface, you can access the IUCLID version information under 'About' in the main IUCLID menu.
A78. This problem can be caused by the following:
- Ignored failure messages during migration processes from the past.
- The update process did not complete successfully. Check the logs of the IUCLID Updater Tool for detailed information on the cause of the unsuccessful update. Restore the instance of IUCLID from a backup, try to fix any reported problems, and then run the update again. Instructions on backup, restore, and update are given in the installation manual for IUCLID 6 Server.
- Check and confirm that the IUCLID Updater Tool is being run on the correct IUCLID instance, and that it has access to the correct database. Details of what will be done are shown in the interface of the IUCLID Updater Tool before the actions are carried out. For example check the values stated under Database connections details.
A79. If the versions of IUCLID 6 differ, or the database is of a different type; for example Oracle as opposed to Derby, use the export/import functionality of IUCLID to transfer the data via i6z files. If the versions of IUCLID are identical, and the database is the default type, embedded Derby, then the whole database can be copied as a folder from one instance of IUCLID to another. In IUCLID 6 the embedded Derby database is wholly contained within the following folder:
<IUCLID 6 installation folder>\glassfish4\glassfish\domains\domain1\databases\iuclid6
If you are in position to move a whole database, you can follow the steps below:
- Stop both instances of IUCLID 6, source and destination. Take a backup of the IUCLID data, and store it safely. Rename the database folder of the IUCLID 6 destination instance, e.g. from:
<IUCLID 6 destination>\glassfish4\glassfish\domains\domain1\databases\iuclid6
<IUCLID 6 destination>\glassfish4\glassfish\domains\domain1\databases\iuclid6_old
- Copy the database from the IUCLID 6 source to the IUCLID 6 destination. To do that, copy the following folder:
<IUCLID 6 source>\glassfish4\glassfish\domains\domain1\databases\iuclid6
into the following folder:
<IUCLID 6 destination>\glassfish4\glassfish\domains\domain1\databases
- Start IUCLID 6 destination. Ensure it runs, and that the data is accessible as expected. Remember that a database must never be copied across different versions of IUCLID 6, e.g. from v4.1.2 to v4.16.1.
A80. The 404 error means that the browser is not getting a response from IUCLID at the address supplied. Check the server address and port, and that IUCLID 6 Server is running. Clear the browser cache and try again. If there is no clear reason why the 404 error occurs, carry out the following procedure.
- Shutdown IUCLID.
- Take a backup of the files in the installation.
- Make sure that all files and folders where IUCLID is installed are fully accessible (R/W/D) by the user which is used to run IUCLID.
- To get out of any erroneous state, clear caches by deleting the following folders under:
- Optionally, you can either delete logs or move it to a separate archive.
- Start IUCLID
Migration from IUCLID 5 to IUCLID 6
A10. Data can be migrated from any supported IUCLID 5.6 database to IUCLID 6 using the installer for IUCLID 6. In addition, IUCLID 5.6 files with extension i5z can be imported into IUCLID 6. For more information see the following page on this website https://iuclid6.echa.europa.eu/archive-iuclid-5..nnn..
A16. Yes, IUCLID 6 accepts the import of IUCLID 5.6 files. During import, the data is automatically migrated to the IUCLID 6 format. However, IUCLID 6 is not able to export data in the IUCLID 5 format.
A17. Yes. The IUCLID 6 installer migrates data from PostgreSQL to Derby databases. It connects to both IUCLID 5 and IUCLID 6 databases at the same time, and executes the migration from any supported IUCLID 5.6 database to the latest version of any supported IUCLID 6 database.
A18. The migration of data from a IUCLID 5 database to a IUCLID 6 database performed by the IUCLID 6 installer works independently of whether either database were used in a desktop or a server configuration. There is no separate tool for the desktop and server configurations.
It is not always essential to migrate data using the IUCLID 6 installer, because i5z files created in IUCLID 5.6 can be imported into IUCLID 6. The use of the IUCLID 6 installer is recommended for large amounts of data, for example, thousands of dossiers.
A19. Yes. Use the IUCLID 6 installer to migrate the data from a IUCLID 5.6 database, to a fresh IUCLID 6 database. The IUCLID 6 database can then be used with either a desktop or server version of IUCLID 6.
A33. The introduction of Instance Based Security (IBS) in IUCLID 6 allows data to be migrated and/or imported from different IUCLID 5 databases into one merged IUCLID 6 database in which access to the data is partitioned between Users and groups of Users.
Before attempting to merge IUCLID 5 databases, familiarise yourself thoroughly with the IBS functionality and consider what action to take (Cf. IUCLID 6 User Manual).
Some common scenarios are described here.
A34. When the IUCLID 6 installer is closed after a migration, it writes a report on the migration to the following file:
<iuclid 6 installation directory>/logs/installer-report.log
The file contains a report in structured text, that for further analysis, can be imported in to a spreadsheet application such as Excel.
IUCLID functions and integration with other systems
A20. Web services are designed for using IUCLID 6 with external systems, but the integration with specific systems; such as IHS Intelligent Authoring, and SAP EHS, will have to be implemented by the users. ECHA will develop the integration of IUCLID 6 with, for example, Chesar 3 and the QSAR Toolbox. In addition, ECHA will provide guidelines on how to achieve integration with other systems.
A26. This problem can be caused by an antivirus program; or by a firewall or a proxy between the client and the server. There could be an intermediate proxy that rewrites requests or responses. Try to run the IUCLID 6 client locally on the server. If the client can run locally without this problem, you will have to configure your network so that the IUCLID 6 clients make direct connections to the server.
A30. A user with 'Access All' can view and update the accessibility of all sections in Role - Data access.
A user with 'Read/Write/Delete' rights to roles but with 'No access 'on a section in 'Data Access' cannot see or update the accessibility of that section for any role.
A user with 'Read/Write/Delete' rights to roles but with 'No access' to an entity in 'Permissions' can see and update the accessibility of that section for any role.
The visibility of data sections should be the same as for entities.
The work-round is that a user must have at least 'Read Access' to any section in order to be able to see and grant rights to it in 'Roles - Data Access'.
A39. The log files generated by IUCLID can be found in different locations according to your installation type:
IUCLID 6 Desktop: <IUCLID6 installation folder>\glassfish4\glassfish\domains\domain1\logs
- IUCLID 6 Desktop installer wizard: <IUCLID6 installation folder>\logs or i6inst\logs (in case the installation is not successful)
- IUCLID 6 Server
- Server side logs - from the IUCLID 6 server: <IUCLID6 installation folder>\glassfish4\glassfish\domains\domain1\logs
- Client side logs - from the computer where IUCLID 6 was used: C:\Users\<username>\iuclid6\<URL>\logs
- IUCLID 6 migration tool: folder “logs” in a folder where the migration tool was launched, or one level above. If the migration was executed with the IUCLID 6 Desktop installer wizard then the migrator logs will be in: <IUCLID6 installation folder>\logs
A54. The error message, "The file you are importing is not supported by your Iuclid instance." is given when an attempt is made to import data into that was exported from a more recent version of IUCLID, using the default options. For example, to import data from IUCLID 6.4 in to IUCLID 6.3.x it must have been exported with the option 'Export to previous major version' turned on, as shown below.
There are two ways to proceed:
1) Upgrade the instance of IUCLID to the version from which the data was exported, and then retry the import.
2) Re-export the data from the more recent version with 'Export to previous major version' turned on, and then retry the import.
Bear in mind that the data might have been exported with 'Export to previous major version' turned off to preserve a particular data format. Therefore, before re-exporting with 'Export to previous major version' turned on, ensure that it will not cause any unwanted effects. For an example, see section 17.4.4 of the manual Functionalities of IUCLID 6.
A55. Dynamic tables of contents can be created within a CSR by edting the document in MS Word, in accordance with instructions given here.
A56. Yes, in general compatibility is ensured between the latest version of IUCLID and the latest version of Chesar. For more information on the compatibility of different versions of IUCLID and Chesar, please see the related FAQ on the Chesar website.
A58. An installation of the IUCLID 6 Desktop application can have multiple web interfaces open at the same time, but only one client interface. The single client interface can be run in parallel with one or more web interfaces. In that case both types of interface point to the same database, so for example, data saved in the client becomes visible in the web interface as soon as the web page is refreshed.
IUCLID 6 Server provides a multi-user environment, in which users have their own accounts, and log in via their own instances of the interface. It is possible to have more than one IUCLID client running on the same machine at the same time, that connect to the same user account on the same instance of IUCLID 6 Server.
To run more than one instance of IUCLID 6 Desktop on the same machine at the same time, see FAQ 59.
A59. Yes, that is possible, so long as the different versions of IUCLID use different ports in the computer. This can be set up automatically by installing IUCLID 6 Desktop whilst a different version is running.
Alternatively, the ports can be reconfigured manually in the following two files:
1) <installation directory>\glassfish4\glassfish\config\asenv.bat
Examples of the differences in configuration are given below:
IUCLID 6 Desktop v6.3 installed with no other IUCLID 6 Desktop running
IUCLID 6 Desktop v6.4 installed whilst IUCLID 6 Desktop v6.3 is running
2) <installation directory>\glassfish4\glassfish\domains\domain1\config\client.settings.properties
Set the value of the parameter networkSettings.root.url to be the value of HTTP_LISTENER_PORT used in the file asenv.bat.
Examples of the differences in configuration are given below:
IUCLID 6 Desktop v6.3
IUCLID 6 Desktop v6.4
A60. The Updater tool migrates data step-wise automatically across the different versions of IUCLID, up until the most recent one. Changes to the data format mean that there may not be an exactly equivalent field to which the data can be migrated. In such cases, the data is placed in a text file that is attached to the affected document. Thus, no data is completely lost during migration. Where migration results in the creation of an attachment, the particular step in which it was created is identified in the attachment. An example is given in the manual Functionalities of IUCLID in section 17.4.4 Export to previous major version.
A63. The exchange of data between these two versions is not fully supported. IUCLID 6.1 data can be imported in to IUCLID 6.4, but not the other way around. We recommend upgrading the older instance of IUCLID. Using a Cloud instance should be investigated, because this would not require an update to the older version of IUCLID. We recommend updating IUCLID at least every two years.
A75. The practical limit to the number of dossiers that can be imported at once via the web interface is a few hundred dossiers. To import more, use the classic interface. The upper limit to the number of dossiers that can be imported at once is set in the classic interface via the administration panel.
The default value is 1000. It can be increased up to 5000. To be able to set a value above 5000, edit the file below:
Add the following line, and then replace N with your own upper limit.
Remember to set the actual limit in the administration panel shown above. For the change to take effect, IUCLID must be restarted.
Be aware that importing such large numbers of dossiers at once can lead to long delays in the response of the IUCLID interface.
It is possible to import dossiers in large batches using the IUCLID Public REST API. This requires programming skills. The API comes with documentation that describes the import process. If the number of dossiers to be imported is in the tens of thousands, such as when importing all of REACH Study Results, care should be taken to build code that does not overload IUCLID with too many simultaneous requests, and has adequate logging. Also, it is recommended to delete background jobs after they have finished.
A64. The classic interface is based on technology that is becoming obsolete. In addition, the classic interface is not easily accessible to the users of the Server or the Cloud distributions of IUCLID, because it requires Java software to be available locally.
A65. We aim to decommission the classic interface by October 2020 and retain only the web user interface thereafter. The decision will depend on the feedback from IUCLID users as to whether the web interface can support their data management work flows and regulatory obligations. We have dedicated user groups established to provide a channel for this communication.
A66. Yes, the web and the classic interfaces access the same database.
A67. Yes. Using the web user interface does not necessarily mean that you are using the ECHA Cloud Services. When you are using the Desktop version, and select the new web user interface, it means that you are accessing your own local database from your own browser.
For more information about the forms in which IUCLID is available, see the description at the top of the Downloads page under the heading Cloud, Desktop or Server - which version of IUCLID is best for me?.
A68. The IUCLID web interface offers basic searches for entities on their list pages. You can search by entity name, and where applicable, by chemical identifiers. In addition, dossiers can be searched by submission type. You can search for lower level entities, for example literature references, when creating a link in a dataset. The search options have been extended in the April 2020 release for the substance, mixture and article datasets. The advanced search for other entities and for dossiers will be available in the October 2020 release.
A69. A high-level list of remaining features to be implemented in the web interface was presented during the webinar for the release of IUCLID 6.4 in October 2019. An update is given in the webinar for the April 2020 release that is available on the 12th of May 2020. As of IUCLID 6, version 4.14.1, these are the features not currently available in the web interface:
- (additional) basic search options for dossiers and for inventories (advanced searches are available for substance, mixture and article datasets)
- Bulk operations (delete, export)
- Display links between IUCLID forms in an information pane
- PNEC calculator
- Import (advanced options)
- Paste a record as a reference
- Report management
- Users, roles and groups (for Instance Based Security - IBS) management
A73. The problem appears (Linux server distribution) because the permissions are not correct and thus some files are not executables under glassfish4\glassfish\bin\
Workaround: Go to the iuclid installation folder and give the appropriate permissions: chmod -R 755 glassfish4\glassfish\bin\
A41. This means that IUCLID 6 tried to reserve the port 4848 (Glassfish Admin Console port) but it could not because something else is already listening on this port. Because of this IUCLID 6 could not start. In most cases this is caused by an instance of IUCLID 6 that is hanging, i.e. this instance was run but could not start and is stuck in some state still holding the port 4848 reserved.
The two most common causes for this are:
- Proxy issue.
- Lock file issue.
A proxy issue occurs when the proxy server is not bypassed for the local addresses. The lock file issue can occur after a collapse of the application. In that case a so-called lock file can remain on the filesystem preventing IUCLID 6 from starting. Please see below for further information on these causes.
1. Proxy issue
Sometimes users installing IUCLID 6 Desktop experience the following situation:
- Installation seems to be going OK until it reaches 99%.
- Then it stops.
When users try to start IUCLID 6 a warning appears saying “the required port 4848 is currently in use”.
The technical explanation of the issue: IUCLID 6 Desktop installs a server on the client computer. When the client runs IUCLID 6 then the client application attempts to connect to the (locally installed) server using URL “localhost”. However because of some configuration issue the client’s request for “localhost” is redirected to your proxy instead of connecting locally.
This issue can be fixed by applying one of the solutions below. We recommend you to try to address this with the first solution under the title “Probable solution for the proxy issue”. If this solution for some reason does not work then you can try to apply the workaround described below. The workaround should always work but will cause automatic update notification of IUCLID 6 not to work.
If you have started with IUCLID 6 v1.0.2 or later then the configuration part described under “1) Probable solution for the proxy issue” is already there and you only need to bypass proxy for the local addresses. However if you have IUCLID 6 v1.0.0 or have started with this version and upgraded it later then you will have to enter all configuration as described below.
Probable solution for the proxy issue
Please check the proxy settings via IE or Chrome. Specifically in the LAN Settings check if the “Use a proxy server for your LAN...” is selected or not.
If the “Use a proxy server for your LAN...” options is checked, then please apply the following options:
a) Check the Bypass proxy server for local addresses
b) In the Exceptions panel set the following addresses 127.0.0.1;localhost;0.0.0.0
After that adapt the domain.xml from <glassfish_installation>\glassfish\domains\domain1\config:
a) Stop IUCLID 6
b) Open the folder <IUCLID6>\glassfish4\glassfish\domains\domain1\config
c) Make a backup copy of the configuration file domain.xml for backup. You can copy it to a temporary folder.
d) Edit the configuration file <IUCLID6>\glassfish4\glassfish\domains\domain1\config\domain.xml with an editor like Notepad++
e) Make sure the java.net.useSystemProxies is set to true (this is so by default but in work-round below it would be changed to false)
f) Set the address of jmx-connector to localhost instead of 0.0.0.0
g) Set the address of jms-host to localhost instead of 0.0.0.0
h) Add the following jvm parameter:
i) Save the configuration file.
j) Start IUCLID 6.
See the snippets from domain.xml below.
<admin-service system-jmx-connector-name="system" type="das-and-server">
<java-config classpath-suffix="" system-classpath="">
Workaround for the proxy issue
In order to have your instance of IUCLID 6 working regardless of the above steps, you can change the value of the property java.net.useSystemProxies to false. However this is not the best solution since as a consequence in the future you will not be informed by IUCLID 6 about available updates for the program.
a) Stop IUCLID 6.
b) Open the folder <IUCLID6>\glassfish4\glassfish\domains\domain1\config
c) Make a backup copy of domain.xml for backup. You can copy it to a temporary folder.
d) Edit <IUCLID6>\glassfish4\glassfish\domains\domain1\config\domain.xml with an editor like Notepad++
e) Find a line like this:
Change it to:
f) Save the configuration file <IUCLID6>\glassfish4\glassfish\domains\domain1\config\domain.xml
g) Start IUCLID 6.
2. Lock file issue
This issue can occur on the systems which were successfully installed. Users that had been using IUCLID 6 Desktop successfully suddenly discover that it would not start. After each subsequent attempt to start the program the following window opens.
Restart of the computer does not help. In the log file server.log there is the entry like this:
Caused by: java.lang.Exception: [B3087] : The broker has detected an active lock file:
This file indicates that there is another copy of the broker running
The lock file prevents IUCLID 6 to fully start but it leaves a running Java process hanging that keeps the port 4848 reserved.
To address this perform the following actions:
a) Make sure that you have backups of your IUCLID data stored in a safe location;
b) Terminate IUCLID 6 by opening the Task manager and killing the corresponding Java process. To make sure that the proper Java process is killed you can:
i) Expand Java (in Windows 10)
ii) Display the Command Line column (pre-Win 10: View -> Select Columns -> Command Line). In the Command line, the value should be
JAVA_HOME/java.exe -cp C:\iuclid6\glassfish4\glassfish\modules\glassfish.jar ...
Alternatively you can re-start your computer;
c) After IUCLID 6 is stopped, open the folder
and then delete the lock file;
- Warning: <IUCLID6> above stands for the IUCLID 6 installation folder, e.g. c:\iuclid6
d) Launch IUCLID 6.
A52. The message “java.lang.OutOfMemoryError: Java heap space” means that the Updater tool did not have enough memory allocated to it. This can be fixed by running the Updater tool again, with more memory allocated to it, as described below.
There are two sets of instructions, the first for use with the graphical wizard, and the second where only the command line is used. You need to follow only the set of instructions that applies in your case.
1) Increasing the memory for the Updater tool when run with its graphical interface
Before proceeding, make sure that you have valid backups of your IUCLID data stored safely.
If the error message was shown whilst the Updater tool was creating a backup, the existing installation of IUCLID 6 has not yet been touched, so the Updater tool can just be run again, this time with more memory. If the error message was shown after the Updater tool had created a backup and whilst it was updating IUCLID 6, the installation must first be restored, before running the Updater tool with more memory. The restoration process is built in to the Updater tool wizard. Select restore on the first page.
The Updater tool can be run with more memory allocated to it by editing a script that is supplied with the Updater tool. The script for Windows is named updater.cmd, and for Linux it is updater.sh. The scripts are located in the directory bin, as shown below.
Increase the value of the parameter Xmx. It can be found on a line that begins with "%JAVA_PATH%\bin\java". For the default value of 2 GB, the format of the parameter is -Xmx2048m.
In the example shown below, the maximum memory allocation is being changed from 2 GB to 4 GB.
Save the change, by saving the script file. To start the Updater tool, run the script iuclid6-update-gui.cmd.
If even more memory is required, increase the value of Xmx further still, but consider the total amount of memory available. A detailed guide to memory management for IUCLID 6 and its tools, aimed at non-IT specialists, is provided in the document Java and Memory in IUCLID 6.
2) Increasing the memory for the Updater tool when run without its graphical interface
Before proceding, make sure that you have valid backups of your IUCLID data stored safely.
If the error message was shown whilst the Updater tool was creating a backup, the existing installation of IUCLID 6 has not yet been touched, so the Updater tool can just be run again, this time with more memory. If the error message was shown after the Updater tool had created a backup and whilst it was updating IUCLID 6, the installation must first be restored, before running the Updater tool with more memory. The restoration process is carried out by running either the script iuclid6-restore.cmd in Windows, or iuclid6-restore.sh in Linux/macOS. Before running the script, ensure that the name and path of the archive from which data will be restored has been entered in to the file updaterConfig.properties in the directory, config.
Configure the maximum amount of memory that the Updater tool may use by editing the value of the parameter Xmx in either the script updater.cmd or updater.sh, in the directory bin.
If even more memory is required, increase the value of Xmx further still, but consider the total amount of memory available. A detailed guide to memory management for IUCLID 6 and its tools, aimed at non-IT specialists, is provided in the document Java and Memory in IUCLID 6.
A53. When you print or generate a report from IUCLID and you receive an error message, for example mentioning the 'java heap stack', this could be because you need to allocate more memory to your IUCLID 6 application. To prevent this error, allocate more memory as described in the following steps:
1. Check whether your IUCLID 6 application is 32 bit or 64 bit. For instructions, see FAQ entry Q46.
2. Shutdown your IUCLID 6 application.
3. Create a backup of the configuration file named domain.xml, which is located in the folder:
4. Edit the file domain.xml, as described below for a IUCLID installation that is either (a) 64 bit, or (b) 32 bit:
(a) 64 bit - set the value of the parameter Xmx to be at least 2 GB, as shown in the example below:
Underneath that line, add the following line:
(b) 32 bit - set the value of the parameter Xmx using the line below:
Underneath that line, add the following line:
5. Start your IUCLID 6 application.
6. Retry printing or generating the report.
7. If you still cannot print or generate the report, please contact the ECHA Helpdesk.
A70. When generating a IUCLID CSV report from the web interface, it contains hyperlinks to the relevant IUCLID document in the IUCLID instance from which you generated the CSV report.
To do this, the report makes use of the Excel formula "=HYPERLINK". In some locales, the ‘;’ may not be interpreted correctly.
In such cases the Excel formula “=HYPERLINK …” will be displayed instead of the hyperlinked text. The formula can be corrected with the following steps.
- Highlight the affected column
- Press 'Ctrl + F'
- Enter into 'Find what' the following "; "
- Enter into 'Replace with' the following ", "
- Click on 'Replace all'
After the steps above, the text intended to be wrapped with the URL hyperlink will be displayed correctly and made into a hyperlink to the relevant IUCLID document.
A71. This behaviour can be caused by an error in the configuration was that was delivered with IUCLID Server v3.16.1. If so, it can be fixed as follows. First, check the log file server.log for the error message shown below. The path to the log file is:
If the error message is not present in the file server.log, contact the ECHA Helpdesk. If the error message is present, carry out the following steps.
1) Stop IUCLID Server v3.16.1
2) Delete the lines indicated below from the configuration file domain.xml, which is at the following path:
Lines to delete:
<http max-connections="250" default-virtual-server="__asadmin">
3) Start IUCLID Server v3.16.1
Note that upgrading IUCLID does not fix this problem.
A72. To get IUCLID to run faster, try the following:
1) Check whether anti-virus software is slowing down either IUCLID or the whole computer. If it is, then takes steps to prevent this from happening.
2) Consider increasing the memory that is available to IUCLID, as described in FAQ 48.
Fixed in IUCLID 6 1.3.0 (28th April 2017)
A43. This bug was introduced since IUCLID 6 version 1.1.0. We have now updated the installation packages on the IUCLID 6 website to prevent this error from hapenning.
The solution we found can also be applied by the IUCLID server administrator on existing IUCLID 6 installation where the error is detected:
- On the IUCLID server, update the file ‘client.settings.properties’ under ‘<IUCLID server installation folder>\ glassfish4\glassfish\domains\domain1\config’. Add the following new lines:
- After the update the content of the file should be similar to the one below:
- Save the file and close it.
- If you start the IUCLID 6 client again and you log in, the issue should not appear anymore. There is no need to restart the IUCLID server.
The issue was only a user interface issue and has been fixed in the IUCLID installation packages with a configuration change. There is no need to download and reinstall IUCLID 6, applying the fix above is enough.
A47. The issue 'Failed to update document. The document is missing.' occurs in IUCLID6 v1.2.0 Server version if Instance Based Security (IBS) is disabled and a standard user tries to update a document created by another user. You will find more detailed instructions on how to solve this issue in this file (1 MB).
In case you would have the same issue with a Desktop version, please contact the Helpdesk.
Fixed in IUCLID 6 1.2.0 (31st January 2017)
A38. The issue can occur in some cases when formatted text is copied from programs such as word processing tools, to rich text fields in IUCLID 6.
The workaround currently available is the following:
- Prepare the text directly in IUCLID 6 or copy non-formatted text (e.g. from programs like Notepad or Notepad++).
- Format the text in IUCLID 6.
A fix has been included in the September service release of IUCLID 6 (version 1.1.0). The fix will address the copying of formatted text from the most used text formatting software. For less standard programs the issue might still occur and should be reported to the ECHA Helpdesk.
A42. This issue is caused by a glitch in the template file generating CSR chapter 8 “PBT AND vPvB ASSESSMENT” (more specifically: “126.96.36.199.3. Toxicity assessment”). A fix for this issue will be available in the next IUCLID release planned for end of January 2016.
In the meantime, you can apply the following workaround in IUCLID:
- Go to section “2.3 PBT assessment” and edit the available record(s) (the summaries do not need to be modified)
- In the record(s), go to the following text field: “Results of detailed PBT /vPvB assessment” -> “Toxicity” -> “Evidence on non-T properties” -> “EC10 or NOEC>=0.01 mg/L for marine / freshwater organisms (long-term toxicity)”
- Enter relevant text in this field. Or, in case this is not applicable, insert n/a for example.
- Save the record and try to generate the CSR again.
Fixed in IUCLID 6 1.1.0 (30th September 2016)
A36. Certain operations in IUCLID 5, particularly the import of endpoint study records via the clipboard, may have created corrupted references in the IUCLID 5 database. The corrupted references should be fixed before migration to IUCLID 6 in order for the application to work correctly. This is described in detail in the Migration manual.
If your IUCLID 5 database contains corrupted references but you still executed the migration to IUCLID 6, you will experience issues related to the datasets that contain corrupted references. This will not be immediately visible, but the following occurrences are indicative of such an issue:
- Running the Validation Assistant gives a generic error (with NullPointer exception).
- Creation of a dossier and export fails (with a NullPointer exception).
- If you try to open an endpoint study record that contains corrupted references, IUCLID 6 will freeze with an “Operation in Progress” message and you need to restart the application.
The following approaches can be adopted to be able to continue working with datasets containing corrupted references, depending on your situation.
This approach resolves the issue of corrupted references prior to migration and no later fix is therefore expected to be needed for the IUCLID 6 database. It is the recommended option whenever the IUCLID 6 database has not yet been taken into use.
1. Fix all the corrupted references in the IUCLID 5.6 database with the help of the Attachment references corrector tool, included in the IUCLID 6 migration tool.
- Execute the tool in SCAN_MODE.
- Check the reports (auto_corrected_raw_data…txt and user_action_required_raw_data…txt).
- Fix manually all that you can fix (e.g. you will not be able to fix corrupted references inside dossiers because they are read-only).
- Execute the tool in FIX_MODE.
For further information on how to do this, see chapter 1.1.2 of the Migration manual.
2. Re-execute the migration to an empty IUCLID 6 database.
This approach addresses a situation where the IUCLID 6 database contains data that was entered/edited after the migration from IUCLID 5, and thereby a fresh migration from IUCLID 5 is not a feasible option. The approach is designed to resolve the issue where a registrant needs to edit a limited number of datasets and create new dossiers for submission. For a full IUCLID 6 database correction, including correction of corrupted references inside existing dossiers, it is recommended to apply approach 3 below.
- Make sure that you have valid backups of your IUCLID 5.6 and IUCLID 6 data stored in a safe location
- In IUCLID 5.6, manually fix the corrupted references in the dataset you have problems with in IUCLID 6. Detailed step-by-step instructions on how to locate and manually fix the corrupted references are provided in an annex: Finding and fixing corrupted references in IUCLID 5. Note that if you use the IUCLID 5 Attachment references corrector tool to locate the corrupted references, it is essential that you only run it in SCAN_MODE. Running it in FIX_MODE will not update the modification history of the amended endpoint study records, and they will not be imported during step d) of these instructions.
- After all the corrupted references have been fixed in the dataset, export the dataset from IUCLID 5.6.
- Import the dataset in the IUCLID 6 database that you are working with. Select “If newer than existing” for the “Overwrite mode” (see screenshot below). This will ensure that all changes that you had later made to the corresponding IUCLID 6 dataset are kept, while the fixed endpoint study records that previously contained corrupted references will be imported and replaced in your dataset.
- Check that the data has been correctly imported in IUCLID 6, in particular that you can open the documents where you corrected corrupted references in IUCLID 5.
A IUCLID 6 database patch tool has been developed to resolve the issue in those cases where the user has already migrated data containing corrupt references to the IUCLID 6 database. This tool can be downloaded here.
A37. An issue has been identified in IUCLID 6 when a user tries to edit a rich text in a dataset that has been migrated from IUCLID 5. The issue affects fields which were plain text fields in IUCLID 5, but in IUCLID 6 were changed to store rich (formatted) text. A fix has been included in the September service release of IUCLID 6 (version 1.1.0). The fix addresses the problem of the text not displaying correctly, and will not require a re-migration of the data.
More concretely, the issue is related to the handling of rich text format tags in IUCLID 6 by the user interface. The information is correctly stored in the database, but it is not properly displayed in the user interface.
The problem manifests itself in that the entered information does not appear to be saved, copy-paste into the field does not seem to work, the formatting options of the field do not produce the expected result, or that even if the text seems to have disappeared from the field in the user interface, it appears during printing. As explained above, the information is in fact stored, but does not display correctly in the IUCLID 6 user interface.
Affected IUCLID 6 fields include:
- Section 6 – Ecotoxicological information (endpoint summary), fields ‘Explanations on the hazard conclusion’
- Section 7 – Toxicological information (endpoint summary), fields ‘Explanation for hazard conclusion’
- Section 4-7 endpoint summaries, field ‘Description of key information’
If, in the meantime, you need to edit a rich text field which was migrated from IUCLID 5 and encounter the above-described problems, the following work-around can be applied:
- First, make sure you have a back-up of the dataset by exporting it and storing it in a safe location.
- In the field where you observe a problem (or you expect to observe a problem, based on the above description of the issue), click inside the field and select all the field content using the key combination CTRL+A. To ensure that all content is selected it is important to do the selection using this key combination and not try to do it using the mouse.
- Using the key combination CTRL+C, copy the contents of the field and paste into a program such as Notepad, which converts it to non-formatted text.
- Delete the contents of the field. Save. This removes the additional tags in the field that confuse the user interface display.
- Copy and paste (CTRL+V) the text back to the field, and continue editing as needed. The content should be properly displayed from now on.
If you follow the above instructions in detail, and it does not resolve your problem, we would very much appreciate if you could provide us with more information to identify the source of your issue. More concretely, we would be interested in obtaining the dataset and, in the case your problem results after copy-paste of formatted information into the migrated field, a file of the data you were trying to paste into the field.
We would kindly ask you to re-create this issue and send us the following information:
- Which of the following did you observe:
- Copy-paste of formatted text did not work (field empty)
- Copy-paste of formatted text worked, but upon saving the field was empty
- Manual entry of text did not work (field empty)
- Manual entry of text worked, but upon saving the field was empty
- Other than above (please explain)
- What type of data did you use:
- Was the issue observed in a migrated dataset, i.e. a dataset that you had created in IUCLID 5 and migrated or imported into IUCLID 6?
- If yes, was the document (record, summary) where you observed the issue newly created in IUCLID 6, or were you editing a document that had been migrated from IUCLID 5?
- Which were the IUCLID 6 fields where the problem was observed?
- Further information:
- For copy-paste: What type of data was copied when the paste failed? If you could send us the source data of the failed copy-paste operation as a file it would be very helpful.
- For manual text entry: Did the inability to save typed text occur after you had attempted to first paste information into the field? Or was the field completely unused (no information had previously been stored there) when you typed the text?
- Finally, please send us a dataset where the problem happened, i.e. where copy-paste did not work and later saving emptied the type text (please indicate the section, name of record/summary and field where you experienced the problem). To avoid sharing large files, and potentially sections with confidential information, you can choose to export only a particular section of IUCLID or you can contact the ECHA Helpdesk for further instructions on sharing confidential information.