Installing pre-computed RLIN module

The pre-computed RLIN (Result LINks) module provides an XML file containing the latest forecast results. It makes the new data available in a file named computed-rlin-result.xml (→ Getting traffic forecast > RLIN module: a workflow for API consumers).

For installation prerequisites, please see → System requirements.

As a prerequisite, set the configuration template 001-apache-rlin-api.conf:

<VirtualHost *:80>
        ServerAdmin webmaster@localhost
        DocumentRoot /var/www/html/optima
		
        AddEncoding gzip .gz
        FilterDeclare gzip CONTENT_SET
        FilterProvider gzip INFLATE "! req('Accept-Encoding') =~ /gzip/"
        FilterChain gzip

        ErrorDocument 404 "OPTIMA is recomputing the forecast results"
        ProxyRequests Off

        RewriteEngine On

        # redirect if (1) the request URI is for strt and
        #             (2) there are no request parameters, or only the sessionid and
        #             (3) there is no content-type header, that is, no parameters in the body and
        #             (4) the file computed-rlin-result.xml exists
        RewriteCond %{REQUEST_URI} ^/datex-interface/orca2/rlin/strt$
        RewriteCond %{QUERY_STRING} ^(session=[a-zA-Z0-9]+)?$
        RewriteCond %{HTTP:Content-Type} ^$
        RewriteRule (.*) %{DOCUMENT_ROOT}/computed-rlin-result.xml.gz

        LogLevel alert rewrite:trace1

        SSLProxyEngine On
        SSLProxyCheckPeerCN off
        SSLProxyCheckPeerName off
        ProxyPass / https://<Optima AS hostname>:<Optima AS port>/

</VirtualHost>
  1. On a separate server than the server hosting the Optima AS, install an Apache web server.

  2. Set up Apache with the provided file 001-apache-rlin-api.conf.

    The configuration file, for Oracle Linux 8 distribution, must be placed in /etc/httpd/conf.d.

  3. The module mod_ssl for Apache is required. You must enable it, if necessary.

    For Oracle Linux 8 distribution, run the command: yum install mod_ssl && systemctl restart httpd

  4. Insert the information to reach Optima AS:

    ProxyPass / https://<Optima AS hostname>:<Optima AS port>/

  5. Set the listening port used by the configuration you just installed.

    Tip:  If the configuration contains the line <VirtualHost *:80>, a Listen 80 directive must be present in one of the main configuration files of Apache, usually in /etc/apache2/ports.conf or in /etc/httpd/conf/httpd.conf.

  6. The RLIN extractor, by default, stores its data inside the Apache default folder /var/www/html/optima.

    Important:  This parameter is linked to the value of the property ptv.rlin.filestore.basedirectory, set in the file application.properties packaged in the application JAR (→ Configuring the application). Generally you don't need to change it. If you change it, you must update the property ptv.rlin.filestore.basedirectory accordingly.

  7. Install the RLIN service (see → Installing RLIN module as system service).
  8. Run the RLIN service (see → Starting the RLIN service).

The files necessary to install the RLIN service:

  • Must be provided by Optima support.
  • Must all be stored in the same directory.

  1. On the Apache proxy, store in the same directory the files:

    • install-service.sh
    • update-config.sh
    • rlin-exporter-service.service
    • rlin-exporter-service-0.0.1-SNAPSHOT.jar

    • rlin-exporter-service-0.0.1-SNAPSHOT.conf

      The name of this last configuration file must match the name of the JAR file (except for the extension name).

      Important:   The owner of the directory and files is the same user that runs the installation scripts and the associated service.

  2. Set the parameters in the file:

    rlin-exporter-service-0.0.1-SNAPSHOT.conf (→ RLIN module configuration).

  3. Run the command:

    chmod +x install-service.sh update-config.sh

  4. Run the command:

    ./install-service.sh

    Important:  In case of errors during the execution of the script, file permissions and attributes can be changed. To revert the starting permissions, please run: sudo chattr -i rlin-exporter-service-*.jar

    As a result, the service is installed and automatically starts at the next boot.

After the installation (see → Installing pre-computed RLIN module), the service starts at the next boot. If you want to start it manually:

  1. Run the command:

    sudo service rlin-exporter-service start

  2. If you want to check the service logs:

    journalctl -u rlin-exporter-service.service

RLIN is a Java standalone application, requiring a JVM installed that supports the version Java 17.

You can avoid using RLIN as a service by running the command:

java -jar rlin-application.jar --spring.config.additional-location=application-custom.properties