- 8 minutes to read

EnvironmentName – System Parameter

Clearly identify your Nodinite environment with the EnvironmentName system parameter. This critical setting ensures you always know which environment you're working in—Production, Test, QA, or Demo.

What you'll achieve with this parameter:

  • Instantly identify which environment you're using (PROD, Test, QA, Demo)
  • Prevent accidental changes to production systems
  • Always-visible environment name in the Web Client header
  • Consistent identification across all Core Services
  • Combine with EnvironmentColor for visual distinction

The EnvironmentName System Parameter defines the environment type displayed at the top of the Nodinite Web Client. This value is set once during installation and applies to all Core Services for the Nodinite instance.

System Parameter Name Data Type Values/Example Comment
EnvironmentName string PROD, Test, QA, Demo Set during installation. DO NOT change after initial setup. Contact Support if modification is required.

Environment Name in Web Client
The environment name and customer details are always visible at the top of the Web Client for clarity and compliance.

Caution

Critical: The EnvironmentName should NEVER be changed once set during installation. Changing this value can cause licensing issues, configuration mismatches, and audit trail inconsistencies. Contact Nodinite Support if you absolutely must change the environment name.

How It Works

Set During Installation

The EnvironmentName is configured during the initial installation of Nodinite Core Services using the web-based Installation tool. This ensures the environment is properly identified from day one.

Installation Process:

  1. Run the Nodinite PowerShell 7 installation script
  2. Access the web-based installation wizard
  3. Enter the EnvironmentName (e.g., "PROD", "Test", "QA", "Demo")
  4. Complete installation—the environment name is permanently set
  5. The environment name appears in the Web Client header for all users

Note

The environment name applies to all Core Services for each Nodinite instance. This makes it easy to manage multiple installations on the same host—each instance can have its own environment name.

Common Environment Names

Real-world examples of environment names include:

Environment Purpose Typical Users
PROD Production environment with live business transactions Business users, support teams, administrators
Test Testing environment for validating changes before production QA teams, testers, developers
QA Quality assurance environment for acceptance testing QA teams, business analysts
Demo Demonstration environment for training and sales Sales teams, trainers, prospects
Dev Development environment for building and testing features Developers, architects
UAT User acceptance testing environment Business users, stakeholders
Staging Pre-production environment mirroring production DevOps, release managers

Always Visible

The environment name is always visible at the top of the Web Client, ensuring users can instantly identify which environment they're working in. This prevents accidental changes to production systems and provides clarity for compliance and auditing.

Visibility Features:

  • Displayed in the Web Client header on every page
  • Shows alongside the CustomerName for licensing compliance
  • Combined with EnvironmentColor for visual distinction
  • Visible to all users regardless of Role or permissions

Integration with EnvironmentColor

For additional visual distinction, combine the EnvironmentName with the EnvironmentColor system parameter. This allows you to assign unique color schemes to each environment, making it even easier to identify which system you're using at a glance.

Example Configuration:

  • PROD - Red color scheme (caution for live data)
  • Test - Blue color scheme (calm for testing)
  • QA - Green color scheme (go for quality checks)
  • Demo - Orange color scheme (attention for demonstrations)

Learn more: EnvironmentColor System Parameter

Licensing Integration

The EnvironmentName is tied to the Nodinite licensing system along with the CustomerName and ProductKey system parameters. During installation:

  1. CustomerName - Identifies the licensee organization
  2. ProductKey - Validates the license
  3. EnvironmentName - Identifies the specific environment instance

This combination ensures proper licensing, compliance tracking, and environment identification.

graph LR subgraph "Installation" Install[" Install Tool"] end subgraph "System Parameters" Customer[" CustomerName"] Product[" ProductKey"] Env[" EnvironmentName"] end subgraph "Web Client" Header[" Always Visible
Header Display"] end Install -->|Sets during install| Customer Install -->|Sets during install| Product Install -->|Sets during install| Env Customer --> Header Env --> Header

The environment name is set during installation and displayed prominently in the Web Client.

Use Cases

Scenario 1: Multi-Environment Setup

Requirement: Organization maintains separate PROD, Test, and QA environments

Configuration:

  • Server 1 (Production): EnvironmentName = PROD, EnvironmentColor = Red
  • Server 2 (Testing): EnvironmentName = Test, EnvironmentColor = Blue
  • Server 3 (QA): EnvironmentName = QA, EnvironmentColor = Green

Result:

Users instantly know which environment they're in
Visual color coding prevents accidental production changes
Clear audit trail for compliance and governance
Each environment properly licensed and identified

Scenario 2: Single Server, Multiple Instances

Requirement: Run multiple Nodinite instances on the same server for different departments

Configuration:

  • Instance 1 (Sales): EnvironmentName = PROD-Sales, Database = Nodinite_Sales
  • Instance 2 (Finance): EnvironmentName = PROD-Finance, Database = Nodinite_Finance
  • Instance 3 (IT): EnvironmentName = PROD-IT, Database = Nodinite_IT

Result:

Each department has isolated Nodinite instance
Clear identification of which instance users are accessing
Separate licensing and audit trails per department
Efficient resource utilization on single server

Why EnvironmentName Cannot Be Changed

The EnvironmentName is deeply integrated into multiple Nodinite systems and should never be changed after installation:

Technical Reasons

Database References - Environment name may be referenced in:

  • Log Events and audit records
  • Historical reporting data
  • Configuration backups and exports
  • Integration monitoring records

Licensing - Tied to ProductKey and CustomerName validation:

  • License validation checks
  • Support ticket associations
  • Customer portal access
  • Activation and renewal processes

Audit Trail - Critical for compliance:

  • Regulatory audit requirements
  • Change tracking and governance
  • Environment identification in logs
  • Compliance certifications (GDPR, HIPAA, SOX)

Repository Model - May impact:

If You Must Change It

If you absolutely must change the environment name (e.g., organization rename, environment repurpose), contact Nodinite Support:

Email: support@nodinite.com
Support Portal: https://support.nodinite.com

The support team will:

  1. Validate your licensing and configuration
  2. Assess impact on existing data and audit trails
  3. Provide guidance or perform the change with proper backups
  4. Update licensing records if necessary
  5. Ensure no compliance violations occur

Warning

Unsupported Change: Manually changing the EnvironmentName in the database is NOT supported and can cause system instability, licensing failures, and data integrity issues. Always contact support.

Best Practices

Installation Planning

Plan Environment Names - Decide on naming conventions before installation:

  • Use short, clear identifiers (PROD, Test, QA, Demo)
  • Avoid special characters or spaces
  • Consider future environments (don't use "Test1" if you'll need "Test2")
  • Document naming conventions for your organization

Stakeholder Approval - Get sign-off on environment names:

  • IT management approval
  • Compliance team review
  • Licensing team confirmation
  • Documentation team notification

Environment Management

Use EnvironmentColor - Always combine with color coding:

  • Production: Red (danger/caution)
  • Test/QA: Blue/Green (safe zones)
  • Demo: Orange (attention)
  • Development: Gray (neutral)

Document Environment - Maintain clear documentation:

  • Purpose of each environment
  • Data refresh schedules
  • User access policies
  • Backup and retention policies

Security Policies - Different security for different environments:

  • Production: Strictest access controls
  • Test/QA: Moderate access for testing
  • Development: Open access for developers (non-sensitive data only)

Frequently Asked Questions

Find more solutions and answers in the Nodinite System Parameters FAQ, as well as the Troubleshooting user guide.

How do I set the EnvironmentName during installation?

The EnvironmentName is configured during the initial installation using the web-based Installation tool:

  1. Run the PowerShell 7 installation script for Core Services
  2. Access the installation wizard in your browser
  3. Enter the EnvironmentName in the configuration form
  4. Complete the installation—the environment name is saved to the Configuration Database
  5. The name appears immediately in the Web Client header

See the Install Nodinite v7 guide for complete installation instructions.

Can I change the EnvironmentName after installation?

No. The EnvironmentName should NEVER be changed once set during installation. This parameter is deeply integrated with licensing, audit trails, and system configuration.

If you absolutely must change it (e.g., organization rename, environment repurpose), contact Nodinite Support for assistance. Manual changes are NOT supported and can cause system failures.

Do I need to restart anything when changing the EnvironmentName?

You should not be changing the EnvironmentName manually. If Nodinite Support performs this change on your behalf, they will provide specific instructions on any required service restarts or cache clears.

What happens if I manually change the EnvironmentName in the database?

DO NOT DO THIS! Manually changing the EnvironmentName can cause:

  • Licensing validation failures
  • Audit trail inconsistencies
  • Compliance violations
  • Support ticket mismatches
  • Configuration database corruption

Always contact Support if you need to change the environment name.

How is EnvironmentName different from EnvironmentColor?

  • EnvironmentName - Text identifier (PROD, Test, QA, Demo) - Cannot be changed
  • EnvironmentColor - Visual color scheme (red, blue, green) - Can be changed anytime

Use both together for the best user experience. The EnvironmentName provides clear text identification, while the EnvironmentColor provides visual distinction.

Can different users see different environment names?

No. The EnvironmentName is a global system parameter that applies to all users accessing the Nodinite instance. All users see the same environment name in the Web Client header.

If you need different environment names for different teams, you must set up separate Nodinite instances (which can run on the same server with different databases and Core Services configurations).

Does the EnvironmentName affect the Web API or Log API?

No. The EnvironmentName is primarily for display purposes in the Web Client. It does not affect:

However, it does provide important context for audit trails and compliance tracking.

Can I use spaces or special characters in the EnvironmentName?

Technically possible, but NOT recommended. Best practices:

Use: Letters, numbers, hyphens (PROD, Test-01, QA-Sales)
Avoid: Spaces, special characters, long names

Keep it short (5-15 characters), clear, and easy to read at a glance.

Next Step

Install Nodinite v7 - Set EnvironmentName during installation
EnvironmentColor - Add visual distinction with color schemes
CustomerName - Configure customer name for licensing
ProductKey - Validate your license