- 4 minutes to read

Manage System Parameters

This guide shows how an administrator changes a System Parameter value in Nodinite — in the Web Client or through the Web API — and what happens after you save. Each environment has its own set of values, stored in its Configuration Database.

Before You Change a Value

  • Read the parameter's page first. Each page in the System Parameters list states the data type, the default, which service reads the value, and when a change takes effect.
  • No restart needed. Every Nodinite process caches each value for about 15 seconds. A few parameters wait for the next cleanup or processing run, or use a longer cache; the parameter page says so.
  • Note the old value. A wrong value can stop logging or monitoring. Write down the current value so you can put it back.
  • Administrator role required. You must be a member of the built-in Administrator Role to change a value, both in the Web Client and through the Web API.

Data Types

The edit dialog shows each parameter's data type below the value.

Data type Enter Example
boolean true or false true
integer / double A number, in the unit the parameter page states (days, GB, MB, milliseconds, …) 90
string Text; some parameters use a semicolon-separated list or a pattern Administrators;Operators
json A valid JSON value, following the structure on the parameter page {"MaxRetries":3,"TimeoutSeconds":120}

Change a Value in the Web Client

Step 1: Open System Parameters

In the Web Client, go to Administration › Settings › System Parameters. The list shows every key with its current value.

System Parameters list in the Web Client (7.1)
The System Parameters list in the Web Client Administration area.

Step 2: Edit the Value

  1. Select the key you want to change. The edit dialog shows the Key, the product's Description, the Value, and the Data type.
  2. Enter the new value in Value.
  3. For json parameters that have a validator, the dialog checks the JSON as you type and shows Json model is valid or the error.
  4. Click Save.

Edit dialog for the AlarmQueueSettings System Parameter with JSON validation (7.11)
The edit dialog: key, description, value, the JSON validation result, and the data type.

Important

"Json model is valid" means the JSON matches the expected structure. It does not prove that every value is sensible — check the parameter page.

Step 3: Verify the Change

Wait until the change takes effect (see the parameter page), then check the behaviour it controls: for example a new retention value on the next cleanup run, or the header colour after a page refresh for EnvironmentColor.

Read-Only and Special Keys

Key How to change it
ProductKey, CustomerName 🔒 Read-only here, and their values are never shown. Change them in Manage License.
Version 🔒 Read-only; the installer sets it.
EnvironmentName, SqlServer, ProductArtifactsPath Set during installation. Change them only when Support asks you to.
AllowExport ❌ Obsolete; changing it has no effect.
MessageProcessingTimerInterval ⚠️ No effect in v7.

Change a Value Through the Web API

Automation and deployment scripts can change values through the Web API. Explore the operations in Scalar at the root of the Web API site (https://{host}:{port}/scalar).

Operation What it does
PUT api/SystemParameters/{key} Changes the value of {key}. Requires the Administrator role. Changes only the value; the description and data type stay as they are.
POST api/SystemParameters/{key}/ValidateJson Validates a JSON value for {key} without saving it. Works for the json parameters that have a validator; other keys return not implemented.

Warning

The PUT operation doesn't run the JSON validation. Call ValidateJson first, or test the value in the Web Client, before you script a change to a json parameter.

Frequently Asked Questions

Do I need to restart any service after a change?

No. In Nodinite v7 no System Parameter needs a restart. Each parameter page states how soon its change takes effect.

Where are the values stored?

In the SystemParameters table of the Configuration Database, one row per key. Change values through the Web Client or the Web API, not directly in SQL Server, so that the Administrator role is checked and JSON can be validated first.

I use Nodinite v6. Do these steps apply?

No. Nodinite v6 used the Install and Update Tool, which is no longer supported. Upgrade to Nodinite v7 to manage System Parameters in the Web Client.

Next Steps