Configuration

Configuration files of ARender Web-UI

ARender configuration files are located in the configurations/ folder of ARender Web-UI package.

File name Details
arender-custom-client.properties Custom ARender client properties file. Available properties are listed inside. Uncomment and modify the properties value to use. More information here: Profile
arender-custom-server.properties Custom ARender server properties file. Available properties are listed inside. Uncomment and modify the properties value to use.
arender-custom-integration.xml Custom Spring Bean XML file. Add your custom XML client configuration in this file.
arender-custom-server-integration.xml Custom Spring Bean XML file. Add your custom XML server configuration in this file.
application.properties Custom Spring Boot properties file. Add your custom Spring Boot configuration in this file. The various properties available are listed in Spring’s online documentation. (File to create if needed).

Rendition server definition

In order to define one or several rendition servers, edit the arender-custom-server.properties configuration file as follows:

configurations/arender-custom-server.properties
arender.server.rendition.hosts={rendition_server_1:8761/},{rendition_server_2:8761/},{rendition_server_n:8761/}
Note

The value of "{rendition_server_x}" here has to be changed by the right rendition server address.

(Don’t forget to reboot your Web-UI)

Custom resource files of ARender Web-UI

ARender custom resources files have to be put in the public/ folder at the root of ARender Web-UI package.

Example of externalization in public

To add a .css file named test.css, place it in the public folder:

/configurations/arender-custom-client.properties
style.sheet=css/arender-style.css,test.css

XFDF annotation folder configuration

A default folder is configured in ARender to saved annotations as XML files. The user that launch the application server has to have read and write rights on this folder.

By default, XFDF annotations are saved in a folder named ARenderAnnotations/ created in the home folder of the user that launch the application server.

Warning
On Windows, if the application server is launched as a service (without any user configured), the folder will be created in C:\Windows\System32\config\systemprofile.

To configure a specific folder,

  • Either modify server properties in arender-custom-server.properties and modify the property arender.server.annotations.xfdf.localstorage.default.path with the wanted value.
  • Either create a system property named arender.annotation.xfdf.localstorage.default.path and set its value with the needed folder path.

Style sheet: ARender-mat.css

Most of the ARender graphical components can be configured in the style sheet. Consult the file for more details.

Note
This stylesheet is related to default user profile. See the Configuration guide for more information.

Configure cache sharing between ARender Web-UIs

It is possible to configure the cache sharing between all Web-UIs by configuring HazelCast. It provides better support for the scalability of the Web-UIs thanks to its shared and distributed cache system.

Warning

This configuration should only be used if the environment is like below:

  • No sticky session on the load-balancer on top of ARender Web-UIs
  • The cache is shared between all Rendition servers using Hazelcast
  • The Rendition tmp folder is shared between all Rendition server (Using NFS or Lustre FSx)

To activate the cache feature you need to modify the arender-custom-server.properties like below:

arender-custom-server.properties
# Defines the cache strategy to use. Valid values : ehCacheStrategy, hazelCastStrategy
arender.server.cache.strategy=hazelCastStrategy
# Path of the hazelCast configuration file, if the value is empty then the default one in the classpath will be used. 
arender.server.cache.hazelCast.config.path=

See below the default Hazelcast configuration for ARender :

Default file: hazelcast.yaml
hazelcast:
  map:
    documentAccessorsHMI:
      max-idle-seconds: 3600
      eviction:
        eviction-policy: NONE
        max-size-policy: PER_NODE
        size: 5
  network:
    port:
      port: 5702
    join:
      auto-detection:
        enabled: true
    rest-api:
      enabled: true
      endpoint-groups:
        CLUSTER_READ:
          enabled: true
        HEALTH_CHECK:
          enabled: true
        WAN:
          enabled: true
        DATA:
          enabled: true

Warning

For now the connectors supported by ARender have not yet undergone the necessary changes to support HazelCast.

If you have implemented your own connector, then you will need to make your DocumentAccessor properly serializable/deserializable.