The pre-computed RLIN (Result LINks) module provides an XML file containing the latest forecast results. It makes the new data available into a file named computed-rlin-result.xml
The RLIN module requires several configurations, based on two main files:
- rlin-exporter-service-0.0.1-SNAPSHOT.conf
- application.properties
All these files are stored in the same folder of the Apache proxy (→ Installing pre-computed RLIN module).
Configuring the file rlin-exporter-service-0.0.1-SNAPSHOT.conf
JAVA_OPTS='-Xmx4G -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath="heap.dump" -verbose:gc -Xloggc:gc.log'
RUN_ARGS=--spring.config.additional-location="application-custom.properties"Generally you don't need to update it.
You could want to change the JAVA_OPTS row in case you want to run the JVM with different options, for example in case you have a huge network and need more memory.
You can change the parameter spring.config.additional-location in case you want to use a different property file.
For additional details, see the Spring Boot documentation.
Configuring the application
It is possible to configure the application through the parameters contained in the application.properties file, packaged in the application JAR.
Each line of the application.properties file, and of the external application-custom.properties file, must have a format based on a pair key=value.
Example line:
spring.datasource.url=jdbc:postgresql://127.0.0.1:5432/optima
| Element | Description |
|---|---|
|
ptv.rlin.filestore.provider |
Provider name. Values:
Default value: filesystem. |
|
ptv.rlin.filestore.storage_account_credentials.name |
Storage account name. Mandatory if the provider is azureblob |
|
ptv.rlin.filestore.storage_account_credentials.key |
Storage primary key. Mandatory if the provider is azureblob |
|
ptv.rlin.filestore.basedirectory |
Path of the directory where are stored the results, grouped for tenant. For each tenant is created a subfolder. Example value: /var/www/html/tenant_subfolder Default value: /var/www/html |
|
ptv.rlin.filestore.age_ms |
Time period, measured in milliseconds. Files are deleted if older than this time period . Default value: 14400000 |
|
ptv.rlin.filestore.startup.max_age_ms |
Time period, measured in milliseconds. At startup, last link is deleted if older than this time period. Default: 180000 |
|
ptv.rlin.filestore.link_name |
Name of the hard link to the file containing the latest simulation data. Default value: computed-rlin-result.xml |
|
ptv.rlin.filestore.basedirectory_cleaning_schedule |
Cron expression to schedule the cleaning of historical data. Default value: * */15 * * * ? |
|
spring.datasource.url |
JDBC connection URL. The format is: jdbc:postgresql://<server>:<port>/<database> Default value: ${PG_JDBC_URL} ${PG_JDBC_URL} indicates that the value is read from the PG_JDBC_URL environment variable. |
|
artemis.remote.broker-url |
Usually, the instances of Optima are associated to the broker included in Optima AS. The format is: tcp://<ARTEMIS_HOST>:<ARTEMIS_PORT> Where:
Default value: tcp://${ARTEMIS_HOST}:${ARTEMIS_PORT:5445} |
Caution: You MUST NOT modify the application.properties file inside the application JAR.
If you need to update some parameters, you must create a custom properties file:
application-custom.properties
It contains the parameters to be changed.
The external file application-custom.properties MUST contain at least the following parameters:
| Element | Description |
|---|---|
|
spring.datasource.url |
JDBC connection URL. The format is: jdbc:postgresql://<server>:<port>:<database> Default value: ${PG_JDBC_URL} |
|
artemis.remote.broker-url |
Usually, the instances of Optima are associated to the broker included in Optima AS. The format is: tcp://<ARTEMIS_HOST>:<ARTEMIS_PORT> Where:
Default value: tcp://${ARTEMIS_HOST}:${ARTEMIS_PORT:5445} |
The properties specified overwrite the properties indicated into application.properties file.
The file application-custom.properties MUST BE stored in the same folder where is stored the file rlin-exporter-service-0.0.1-SNAPSHOT.jar (→ Installing RLIN module as system service).