Skip to main content
Version: 12.0

Configure the ADONIS Web Client

In order to configure the ADONIS web client, settings for the login process and general settings have to be adapted.

Settings for the Login Process#

In order to adapt the settings for the login process:

  • Open the folder “<ADONIS installation>/conf” and edit the file adoxx_web_conf.js.

The following section lists the parameters that have an impact on the login process in the web client and their meaning:

  • ADOXX_JS_LOGLEVEL:

    The log level used in ADONIS. By default, only errors are logged, but other log levels can be set. Possible values are AIT_LOGLEVEL_ERROR, AIT_LOGLEVEL_WARN, AIT_LOGLEVEL_INFO, AIT_LOGLEVEL_DEBUG and AIT_LOGLEVEL_PROFILE.

  • ADOXX_WEB_CLIENT_SHOW_LANG_SELECTION:

    Specifies whether the user should be able to switch the language for the web client on the login page. If this is set to true, a drop-down menu containing the available languages is displayed on the login page of the web client. Possible values are true or false.

  • ADOXX_WEB_CLIENT_LANGUAGE:

    The language id of the standard language the web client should be started with. Depending on the product configuration, possible values are e.g. “en” for English or “de” for German.

  • ADOXX_WEB_RESTRICT_WEB_SERVER_SESSIONS:

    If this is set to true, every user can be logged in only once to the web client. When a user logs in again, any old web sessions are closed. This has the effect that artefacts (objects, models, groups) that were locked in the old session are unlocked again without saving. Possible values are true or false.

  • ADOXX_WEB_FILE_POINTER_PROTOCOLS:

    This setting lists the protocols that should be recognised by the ADONIS web client. By default, the protocols HTTP, FTP and HTTPS are recognised. To add a protocol, the protocol name has to be added to the field. Files that are referenced by protocols not listed here are assumed to be using the protocol “file:///”.

  • ADOXX_WEB_LOGIN_PAGE_IDM:

    This is only relevant if an identity manager is used to login to the web client. This setting specifies the login page for this working mode. The value entered in this setting is the URL of the page, to which the web client forwards in case of session timeouts or when the logout button in the web client is clicked.

  • ADOXX_WEB_TRACK_LOGINS:

    This property is used to control the behaviour of logging in the ADONIS web client. By default this is set to true, which means that the web client will log the login name for each user that logs in to the web client. If this is set to false, the logins will still be tracked, but the users’ names will not be contained in the logs.

  • ADOXX_WEB_CHUNK_LIMIT:

    This setting defines the maximum package size when calling web methods from the application server. The default value is "0" which means the size of packages is not limited.

  • ADOXX_WEB_USE_JSM:

    This setting specifies how the application server handles the internal JavaScript resources. The value should only be changed for debugging.

General Settings#

Within the ADONIS web client there is a configuration file which has an impact on general settings on the web server side. In order to adapt this file:

  • Open the folder “<Tomcat installation>/webapps“ and open the file ADONIS12_0.war with a file archiver. Edit the file adoxx_web.properties which can be found inside. Save the changes afterwards.

The most important configuration parameters are listed below. Usually, it should not be necessary to change the other parameters:

  • aservers

    The URL at which the ADONIS application server can be reached. The URL consists of the name of the application server (can be freely defined) and the domain name or IP address (a port should NOT be included). You only need to change this parameter if the application server and the web server are running on different machines.

Example

If you are running the application server locally, and the name of the application server is "AS1", the parameter should look like this:

aservers = AS1:localhost

  • aworkers

    aworker process started by the application server. The parameter consists of the name of the application server (as defined in the parameter aservers) and the port (as specified in the file server.conf). You only need to change this parameter if the port is already used by other services in your environment, or to set up a load balancing configuration.

Example

If the application server name is "AS1" and you are using the default port, the parameter should look like this:

aworkers = AS1:41200

  • copy_db_files

    When starting the web server it tries to connect to the application server and copies some plugin data and icons of the ADONIS database into the "webapps" directory of the web server. In some scenarios this may not work because there is no write permissions to that directory. Therefore this behaviour can be switched off by setting this parameter to false and copying the required data manually into the webapps folder (by default it is set to true).

  • search.result.max.size

    This parameter specifies the maximum search result limit in the web client.

  • translation.maximum.artefacts

    This parameter specifies the number of models and objects that can be translated at once in the web client.

  • report.parallel.execution

    This parameter specifies the number of reports that can be created in parallel in the web client.

  • security.allowframedisplay

    Specifies whether embedding ADONIS as an iFrame is allowed. Possible values are "true" or "false".

  • supportinformation.disable

    Specifies whether the support package is available for download within the ADONIS web client (see "Appendix B: Troubleshooting"). Possible values are "true" or "false".