Skip to content

Platform Config

The Platform Config provides a transparent view of all exposed backend configuration variables and allows administrators to adjust them in real-time. This ensures that essential system settings can be reviewed and managed without requiring backend access.

Configuration changes are applied after saving, and take effect immediately without restarting the backend service.

Example:
The SparQL timeout flag previously available only as a backend configuration. Now is visible and adjustable within the Platform Config page.

Accessing the Platform Config

To manage Platform Config:

  1. Open the Admin page by clicking the gear icon in the sidebar.
  2. Select the Platform Config tab.

This section is accessible only to users with ADMIN role.

Tree View Structure

All configuration options are displayed in a tree view for clear navigation and modular grouping.
The tree view organizes configuration items by module, allowing administrators to quickly locate related settings and understand their context.

Each node in the tree view can represent one of two types of entries:

  1. Informational Module – displays only the module's title and its description.
    This type provides context or documentation about a configuration area without any editable inputs.
    It helps users understand the purpose of a group of related settings.

  2. Configurable Module – shows the module's title, and displays each input field along with its own title and description for editable parameters.
    Each input corresponds to a backend-exposed property that can be modified through the UI.

Dynamic Rendering

Each configurable property is defined with metadata that specifies how it should be displayed and validated. This metadata includes field type, validations, and value options. The frontend uses this schema to automatically generate the corresponding input components.

Validators

These validators are defined by the backend and automatically enforced in the user interface.

Validator Description
emptyValue Indicates whether empty string values ("") are allowed.
maxValue Specifies the maximum allowed value for numeric types.
minValue Specifies the minimum allowed value for numeric types.
options Defines the set of possible options for ENUM types.
regex Regular expression pattern used for string validation.

Default Values, Trash Icon, and Save Behavior

When managing environment variables in the Platform Config interface, each property includes visual indicators and controls that clarify its current state and available actions.

Default Badge

If a property currently uses a default value (i.e., a value defined by the system and not modified by the user), a Default chip is displayed next to the input label field.
This badge helps administrators easily distinguish between system-provided defaults and user-overridden configurations.

  • Default chip visible: The property value is inherited from the system default.
  • Default chip hidden: The property value has been modified by a user and now overrides the default.

Trash Icon

Each property row includes a trash icon that allows users to restore the property to its default value.

When the trash icon is clicked:

  1. The current user-defined value is marked for reset.
  2. The input field becomes blocked (read-only) to indicate the pending reset state.
  3. The Default chip will appear after saving, once the reset is confirmed.

This action is not applied immediately — the property is only reverted to its default value after clicking the Save button.

If the user decides not to proceed with the reset before saving, a revert icon appears beside the input.
Clicking the revert icon cancels the pending reset, restoring the previous editable value.

Save Behavior

All configuration changes made within a tab are stored only after clicking the Save button.
Saving is handled per tab, meaning changes in one tab (e.g., Pending Changes Workflow or Matching) are independent of changes in another.

Import and Export Configuration

Administrators can also export the current platform configuration or import a saved configuration file to replicate settings across environments.

  • Export Icon – clicking this icon downloads the current platform configuration as a CSV file.
    This allows administrators to back up the current settings or share them across environments.

  • Import Icon – clicking this icon opens a file selector that lets you upload a previously saved configuration file.
    The uploaded file must be in the .csv format and contain 2 columns: "id" and "value". Each value should be kept in quotation marks.

Important: Imported settings are applied immediately.