Step 1: Register Environment
Register the Nodinite Environment in the Portal before you download anything. This step defines the names, ports, Microsoft SQL Server settings, authentication defaults, and optional SQL DB Lookup entries that the PowerShell 7 installer will consume later.
Prerequisites
- Valid Nodinite 7 product key
- Portal access to the target customer
- Planned Environment name, SQL Server name, and service account names
- Decision on whether you will use SQL DB Lookup with the sqllookup Formula plugin
What You Configure in This Step
| Area | Why it matters |
|---|---|
| Environment settings | Controls naming for IIS sites, folders, and databases |
| Configuration Database and Log Database settings | Tells the installer where SQL Server resources will be created |
| Authentication defaults | Determines whether Windows Authentication or OAuth 2.0 / OIDC is the primary sign-in path |
| SQL DB Lookup | Creates named connection strings that the sqllookup Formula plugin can reuse in Search Field Expressions |
Register the Environment in the Portal
- Open the Portal and navigate to your customer.
Example of the customer entry you open before registering a new Environment.
- Verify that a Nodinite 7 product key exists. If it does not, create one before continuing.
Example of a Nodinite 7 product key entry in the Portal.
- Open the Environment tab and click Add Environment.
Example of the Add Environment action that starts the installation wizard.
- In the wizard, select Install Fresh Nodinite 7.
Example of the Install Fresh Nodinite 7 option in the Portal wizard.
- Enter the base Environment values that the PowerShell 7 script will later use.
Example of the initial 'Add Environment' modal where the installation parameters are entered.
Configure Basic Environment Settings
Use values that you intend to keep. The Environment name becomes part of folders, IIS application pools, and database names, so changing it later is disruptive.
| Mandatory | Variable | Default | Description |
|---|---|---|---|
| Environment Name | Name of the target Environment | ||
| Description | Business or operational purpose | ||
| Destination Root Path | C:\Program Files\Nodinite |
Root installation directory | |
| App Server Name | localhost |
Application server hosting the web applications and services | |
| Admin Account Email | Administrator contact used in the Portal | ||
| Web Client Port | 40000 or 443 |
IIS port for the Web Client | |
| Web API Port | 40001 |
IIS port for the Web API | |
| Log API Port | 40002 |
IIS port for the Log API | |
| Logging Service Port | 40003 |
IIS port for the Logging Service | |
| Monitoring Service Port | 40004 |
IIS port for the Monitoring Service | |
| MCP Endpoint Port | 40005 |
IIS Port for the MCP Endpoint |
Tip
If you are uncertain about an account value, you can continue with a placeholder and override it when you run the PowerShell 7 script. Do not edit the generated script file directly.
Configure Database Settings
Choose the SQL Server model that matches your target deployment.
| Option | When to use |
|---|---|
| Standalone | Single SQL Server instance for the Configuration Database and Log Database workload |
| Always on | SQL Server Always On Availability Group for high availability |
| Azure - Managed Instance | Managed SQL platform in Azure |
| Edit Connection String Manually | Advanced scenarios where you need direct control over the SQL Server connection string |
| Mandatory | Setting | Default | Description |
|---|---|---|---|
| Database Type | Standalone |
SQL Server deployment pattern | |
| Database Server Name | localhost |
SQL Server host or ServerName\InstanceName |
|
| Availability Group Name | Required only for Always on | ||
| Availability Group Backup Path | Required only for Always on | ||
| Edit Connection String Manually | No |
Enables manual SQL Server connection details | |
| Connect without encrypt | No |
Disables SQL encryption if required by your Environment | |
| Encrypt Connection | Checked |
Recommended for most installations | |
| Trust Server Certificate | Checked |
Recommended when your SQL Server certificate chain requires it | |
| Sql Package Path | C:\Program Files\Microsoft SQL Server\170\DAC\bin\SqlPackage.exe |
Path to SqlPackage.exe from DacFX |
Important
If you select Always on, you must also provide Availability Group Name and Availability Group Backup Path. The backup path must be reachable from every replica and writable by the Logging Service account.
Configure SQL DB Lookup
Use the SQL DB Lookup section when you want Search Field Expressions to query reference tables from SQL Server with the sqllookup Formula plugin.
Example of the SQL DB Lookup section with named connection string entries for Formula expressions.
Add a SQL DB Lookup entry
- Click + Add in the SQL DB Lookup section.
Example of the Add button that inserts a new SQL DB Lookup row in the Portal.
- Enter a Name value. This becomes the
CSTRIDor first parameter in the sqllookup expression. - Enter the Connection String value for the reference database.
- Save the Environment after the entry is added.
SQL DB Lookup rules
- Use a stable name such as
SqlDbLookupLocalorCustomerReferenceData. - Keep the connection string read-only from the perspective of the target database.
- Do not rename an existing SQL DB Lookup entry after Search Field Expressions start using it.
- Reuse the same name in the sqllookup Formula page and in your Search Field Expressions.
Example mapping
If you add a SQL DB Lookup entry named mylookup, you can later use that name in a Search Field Expression with the sqllookup Formula plugin.
sqllookup('mylookup', 'MyLookupDB', 'AreaCodes', 'Name', 'AreaCode', body)
For the full syntax, configuration notes, and examples, continue with the dedicated sqllookup documentation.
Completion Checklist
- Product key verified
- Environment values entered
- SQL Server settings reviewed
- Configuration Database and Log Database strategy selected
- SQL DB Lookup entries added if your Search Field Expressions need them