How to download, install and run

Installation options

There are two installation options:

  • Server installation (for version 1.1.0 and later) – recommended
    This installation is done once for a company on a server (similar to IUCLID itself, if not the Desktop version is used) and then can be accessed by all users. Maintenance and updates are done by local IT staff. It is strongly recommended to install own company SSL certificates, see section below
  • Local PC / desktop installation – not recommended, but technically possible

Server installation

The IIP is a Java application based on the WildFly application server and is usable on any platform that supports Java. It was developed and tested on Windows 10.

Installation as a Windows service

We recommend that you use the scripts that Wildfly provides to install the IIP as a service on Windows.

You will need the following steps:

  • Firstly, move to the folder “wildfly-*\docs\contrib\scripts\”.
  • Next, copy the “service” directory to wildfly-*\bin
  • Then, open an Admin Shell and navigate into the “service” folder
  • Run “service.bat install“

See http://www.mastertheboss.com/jbossas/jboss-configuration/installing-wildfly-on-windows/ for additional info.

Before running the service.bat you may adjust settings in the script, e.g. the display name of the service.

The service will be installed in a way that wildfly-*\bin\standalone.bat is used for the server process execution. You may influence the runtime settings, e.g. max memory, by changing the JAVA_OPTS environment setting in wildfly-*\bin\standalone.conf.bat

Local PC installation

The process of downloading, installation and running the IUCLID Integration Platform on your local PC is nearly identical to the one of the CropLife Europe eSubmission builder, as the technical architecture is identical. Also, the installation and runtime requirements are identical (e.g. supported browser types).

Therefore, please read the respective information for the eSubmission builder first. You can then apply those instructions one by one, by modifying the information respectively (e.g. the path name, the name of the startup scripts etc.). Please note that the version of the application server WildFly can differ between the two programs, which is not relevant to the installation procedure.

After starting the IIP with the startup script in the root directory, a successful startup looks like this:

Please minimize this window and pay attention that you do not click inside of it. Do not close this window, as this will stop the application.

After the IIP being successful started as in the example above, you can click on the shortcut supplied in the root installation folder to open the application in the standard browser.

Installation configuration

Most configurations are to be made in the Wildfly file “standalone.xml” which can be found in “wildfly-23.0.0.Final\standalone\configuration\standalone.xml” below the root installation directory.

IUCLID connection

Please configure the connection to IUCLID in the “Administration” perspective of the running IIP web interface: Take the URL you use to open the IUCLID dashboard and remove the last part ““/iuclid6-web/dashboard” and then enter this resulting URL value (starting with “https://:” into the URL field, so usually this looks like “https://<servername>/”, with eventually an additional port.

Demo mode (default:off)

The IIP supports a demo mode for CSV upload. This means that a specific field in the target entity is filled with a fixed string “Created by IUCLID Integration Platform”, eventually overwriting the data provided in the CSV.

The demo mode allows to

  • quickly see the instances created / updated by the IIP (eventually use the Advanced Search in the IUCLID web interface)
  • delete all instances created in demo mode – to repeatedly test the functionality of the IIP (see the Administration perspective). Please note that the deletion will only affect the instances with the respective fixed string, not any other instances.

The demo mode can be turned on / off using the property “iuclid.demoMode” with values true/false:

    <system-properties>
        <property name="iuclid.demoMode" value="${iuclid.demoMode:false}"/>
        ...
    </system-properties>

CSV import directory

For the CSV import functionality, the respective CSV files have to be put below a CSV import directory that is both accessible for the user and the IIP. The user first puts CSV files to be processed below this directory by normal file system operations (e.g. in the Windows Explorer), which subsequently can be picked up via the IIP browser interface in the import operation. The IIP cannot upload files to this directory or for direct processing via the web browser.

For a server installation this directory has to have the following characteristics and has to be set up by IT admins:

  • accessible from the local PCs for all intended users (e.g. via the Windows Explorer)
  • directory considered local for the IIP server, either as local directory or drive letter (windows) / mounted drive (Linux)
  • access rights to create, modify and delete files for all intended users

For the IIP this directory needs to be configured in “standalone.xml”. The default setting for this “import.dir” is the directory “import” below the default data directory “wildfly-26.0.0.Final\standalone\data”:

   <property name="import.dir" value="${jboss.server.data.dir}\import"/>

This property can be changed to any other directory accessible for the machine (server or local PC) where the IIP is installed. If the shared directory is a network directory, it needs to be accessible locally to the IIP server, e.g. for Windows by mapping it to a drive letter; or for Linux mounting it. During testing on Windows mounted drives with letters (e.g. “Z:\import”) have worked, but not UNC paths (e.g. \\DataServer\import).

This directory expects a subfolder for each importable IUCLID entity type.

  • LITERATURE
  • REFERENCE_SUBSTANCE

The folders are created upon startup, when not available. The further directory structure is customizable and needs to be managed manually. Users may chose a further structure to their liking.

All “*.csv” file in the directory structure are then selectable for import by users via the IIP browser interface.

The administration can use a specific property “import.help” in the standalone.xml to have a specific help text displayed in the import mask of the IIP, to support the user to find this directory. The default is:

   <property name="import.help" value="Please copy your CSV data into the shared import directory ${import.dir} for selection."/>

This help text should ideally name the import directory as it is accessible for all users from their local PCs.

SSL certificates

For server installation, it is strongly recommended to install own company SSL certificates on the Wildfly application server, as the IUCLID connection settings including username and password are transferred to the IIP. This task is not specific to the IIP. Please check the Wildfly documentation or a tutorial like this one.

The SSL configuration structure is already prepared in the standalone.xml, but uses a generated self-signed certificate by default for the host “localhost”.

To change the self-signed certificate, the “tls.generate.host” can be changed:

        <property name="tls.generate.host" value="localhost"/>

To properly configure a SSL certificate to use, a JKS Keystore needs to be prepared in the standalone/configuration directory, with the keystore password and the private key password of the certificate:

        <property name="tls.keystore.path" value="iip.keystore"/>

        <property name="tls.keystore.password" value="iip"/>

        <property name="tls.key.password" value="changeit"/>

As soon as a valid keystore is configured, the attribute “generate-self-signed-certificate-host” needs to be removed to prevent automatic self-signed certificate creation.

       <key-manager name="applicationKM" key-store="applicationKS" generate-self-signed-certificate-host="${tls.generate.host}">

Ports

By default the port 8100 is used for HTTP and port 8463 is used for HTTPS.

To change the default ports, the environment variables “jboss.http.port” and “jboss.https.port” in the standalone.xml can be changed:

<socket-binding-group name="standard-sockets" default-interface="public" port-offset="${jboss.socket.binding.port-offset:0}">
    ...
    <socket-binding name="http" port="${jboss.http.port:8100}"/>
    <socket-binding name="https" port="${jboss.https.port:8463}"/>
    ...
</socket-binding-group>

HTTP Proxy server configuration

If the IIP and the IUCLID instance are in different networks separated by a proxy server, the IUCLID connection may fail. In this case, the proxy information for an HTTP proxy has to be supplied in the “standalone.xml” configuration file: Example settings are:

<system-properties>
   <property name="http.proxyHost" value="10.0.0.1"/>
   <property name="http.proxyPort" value="8800"/>
...
</system-properties>

The configuration proxy setting is shown as part of the IUCLID connection settings as a readonly information.

Please note, that the IIP only support HTTP proxies, not HTTPS proxies. The connection to IUCLID may still be HTTPS.

Accept all certificates

In case you enter the IUCLID connection information and you receive an error of type

Iuclid request failed: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target

then this means, that the certificate of IUCLID is not trusted and not part of the local Java certificate cache “cacerts”. Please ask your admin to add the IUCLID certificate to the Java trust store of the machine, where the IIP is installed.

For testing purposes only:

You can configure the IIP to accept all incoming certificates by setting the configuration parameter “security.trustall” in the standalone.xml to “true”. It is set to “false” by default.

    <system-properties>
        <property name="security.trustall" value="true"/>
        ...
    </system-properties>