Standalone or Server configuration file

In this page, the configuration file, which is in .json format, is required for both standalone and Server installations, is explained.

This file can be generated and saved in the following paths:

  • $env:LOCALAPPDATA\Local\Programs\Rulex Platform\resources for the Windows Standalone installation.

  • /opt/rulexplatform/resources for the Ubuntu Standalone installation.

  • /Applications/Rulex Platform.app/Contents/Resources for the Darwin Standalone installation.

  • <SERVER_INSTALLATION_DIR>\resources for the Server installation.

{
  "general": {
      "log": {
          "level": "info",
          "tags": {
              "broker": false,
              "apiwatcher": false,
              "metrics": false,
              "connectors": false,
              "sensitive": false
              "webserver": false,
              "parserAlive": false,
              "tasks_verbose": [],
        }
      },
      "batch": {
          "healthz_polling": true,
          "be_healthz_timeout_s": 600
      },
      "addgroups": true
  },
  "api": {
      "license_login_retry": {
          "enable": False,
          "max_attempts": 5,
          "retry_delay": 15,
          "timeout": 3600
      }
  },
  "bridge": {},
  "compute": {
      "sensitivity":"BusinessUse",
      "sensitivity_list":[]
  },
  "studio": {},
  "designer": {},
  "notify": {},
  "resman": {},
  "session": {}

Warning

When the license_login_retry parameter is inserted in the configuration.json file, the retry mechanism activates when the maximum number of sessions is reached. Subsequently, if the API request performed is asynchronous, the 202 response is delayed until the retry operation has been performed successfully.

Custom entries

In the table below, all the custom entries in the configuration file are listed.

Name

Description

Type

general.log.level

The default log level of the application. Possible values are:

  • error

  • warning

  • info

  • debug

string

general.log.tags

An internal object where extra debug logs can be defined. Only effective if loglevel is debug. Possible log tags are:

  • broker: enables broker messaging logs.

  • apiwatcher: enables extra logs for API/batch monitoring.

  • metrics: enables recurrent logs for CPU and RAM metrics through computations.

  • sensitive: enables sensitive logs containing information on flow computation (data source name, options stored, etc). All these logs contain the Message ID SENSITIVE.

  • connectors: enables extra debug logs connected to the failing external connection.

  • webserver: enables extra debug logs for NGINX.

  • parserAlive: enables extra debug logs for parser management.

  • tasks_verbose: list of tasks where the verbose mode is enabled (supported on sourcedb, sinkdb, conditionalimport tasks).

JSON

general.addgroups

Forces the system to ask the host machine for the user groups at the startup.

boolean

compute.sensitivity

The sensitivity label to apply as a default to the installation. All exported files from the current installation will have the sensitivity label added as a prefix, followed by an underscore.

string

compute.sensitivity_list

The possible sensitive labels which will be available in the Sensitivity Label drop-down menu in the Export File tasks.

list

api.license_login_retry.enable

Whether to retry the license login only for the API/Batch requests when the max active session limit of the license is reached.

boolean

api.license_login_retry.max_attempts

Maximum number of login attempts before giving up.

integer

api.license_login_retry.retry_delay

Seconds to wait between consecutive login attempts.

integer

api.license_login_retry.timeout

Maximum total seconds to spend retrying on the login before aborting, regardless of attempts remaining.

integer