EnvironmentName - System Parameter
EnvironmentName holds the name of this Nodinite environment, such as PROD or Test. The Web Client shows it in the header on every page (see Menu - Environment), and it becomes part of the Log Database names (see LogDatabaseName).
At a Glance
| Property | Value |
|---|---|
| Key | EnvironmentName |
| Data type | string |
| Default | Set by the installer |
| Read by | Web Client (header); also part of the Log Database names, see LogDatabaseName |
| Takes effect | Within about 15 seconds; no restart needed. Don't change it after installation (see How It Works) |
| Status | ✅ Active |
The environment name and the customer name of the licensee, as shown at the top of the Web Client.
How It Works
You define the environment name when you create the environment in the Nodinite Portal, as the first step of Install Nodinite v7 (see Step 1: Basics). The installer stores it as the EnvironmentName System Parameter.
Each Nodinite instance has its own environment name, so several instances on the same host are easy to tell apart. All users of an instance see the same name; it is not configurable per user or per Role.
The environment name is more than a label:
- It becomes part of the names of the Log Databases the Logging Service creates, because the installer writes it into the LogDatabaseName pattern.
- The installation uses it in folder names, for example
C:\Program Files\Nodinite\<EnvironmentName>\(see Managing Monitoring Service).
Caution
Set the EnvironmentName during installation and don't change it afterwards. Existing Log Databases and installation folders keep the old name, so a later change leaves them out of step. Contact Nodinite Support if you need to rename an environment.
Choosing a Value
- Nodinite does not validate the value. It becomes part of SQL Server database names, so SQL Server naming rules are the limit.
- Use letters, digits, and hyphens only, for example
PROD,Test,QA,Demo, orPROD-Finance. Avoid spaces and other special characters. - Keep it short and easy to read at a glance; users see it in the header on every page.
- Add a header colour per environment with EnvironmentColor (for example red for
PROD).
Frequently Asked Questions
Does the EnvironmentName affect the Logging or Monitoring Service?
It doesn't change how they process data. The Web Client shows it in the header, and it is part of the Log Database names (see LogDatabaseName), which is why you shouldn't change it after installation.
How is EnvironmentName different from EnvironmentColor?
EnvironmentName is the text in the header and part of database names; set it once. EnvironmentColor only sets the header colour, and you can change it at any time.
Note
Nodinite v6 and its Install and Update Tool are no longer supported.
Next Steps
- Menu - Environment – How the environment name appears in the Web Client
- Install Nodinite v7 – Define the environment name in the Portal
- Manage System Parameters