Install Nodinite Core Services

This document will guide you through the steps required to install the Core Services for Nodinite. Installation is easily being performed by an administrator using the Nodinite Update Application. The install process usually takes less than 15 minutes.

During the installation you must click inside every single text box to verify/validate the content. When valid, a (green) check appears on the left side of the label and you can move on to the next input field.

Make sure to download, install and use the latest version of the Nodinite Update Application before installing or updating the Core Services of Nodinite.

Installation Checklist

The following prerequisites must be met before installing the core services for Nodinite:

Windows

SQL Server

    Note: If you are using High Availability SQL Servers, accounts and rights must be applied on all instances since this information is not being synchronized

The Database reports may require additional assigned rights, if you can't open the report, add the following grant:

USE MASTER
GO
GRANT VIEW SERVER STATE TO [DOMAIN\user];
GO

Nodinite

IIS

  • IIS Application Pools

    • Web API - App Pool (should run as AppPoolIdentity (low degree of access rights) to enforce security policies and avoid breaches to security policies) - Uses Impersonation from Install configuration (encrypted in web.config)
      • The configured account used in installation (Installation account name) must have the following SQL Rights for the impersonation to properly work:
        • Configuration Database
          • dbo
          • db_datareader
          • db_datawriter
          • db_ddladmin
        • IMLog databases
          • db_datareader
          • db_datawriter
          • db_ddladmin
    • Web Client - App Pool (should run as AppPoolIdentity (low degree of access rights) to enforce security policies and avoid breaches to security policies)
    • Log API - App Pool (should run as a named domain account)
      • The account used must have the following SQL Rights:
        • IMConfig
          • dbo
          • db_datareader
          • db_datawriter
          • db_ddladmin
        • IMLog databases
          • db_datareader
          • db_datawriter
          • db_ddladmin

    Example for the application pools for a prod or test environment

    png_IISAppPools

Note: The named AppPool accounts must be either local administrator or part of the IIS_IUSRS group

png_AppPoolRights


Step 1 Prerequisites

Using the Nodinite Update Web Application from a modern browser. You must first have:

Click on the Install button to open the installation dialogue.
png_Menu_Install_Button

General: The first step of installing Nodinite involves the configuration of the unique specific instance. This step includes among other things setting up details for the Licensee.

The following configuration steps must be followed in order:
Install

  1. Customer Name, Enter the company/customer name (Associated with the Product Key for Licensee)
  2. Enter key, Enter the Product Key (Associated with the Customer Name for Licensee)
  3. Environment Name, Enter the mandatory custom name of the target environment (QA/DEV/PROD)
  4. Update Service Address, AutoPopulated to localhost

Nodinite supports the use of a multiple Update Services, installed on many different servers useful for hardened environments.

  1. Installation account name, Enter credentials for the Service Account running the Monitoring Service, Logging Service and the WebAPI (can be overridden individually later on in the installation)
    4.1 Set User Name for Service Account
  2. Installation account password Enter the password
  3. Click on Validate Account to validate that user and password information is correct

When every (green) is shown for every field the setup will automatically continue to the next installation step.

Step 2 Install the Configuration database

The second step of installing Nodinite involves the setup of the configuration database called Configuration Database.

The Install and Update Tool detects if the SQL Server is either:

  • Stand alone (including fail over cluster) or
  • Always On in which case you need to read About Always On user guide first

The following configuration steps must be followed in order:
Install

  1. Use default Update Service, When checked, the installation will use the Update Service information provided in the General section. For additional information about advanced configurations see Nodinite Installing Nodinite Install and Update Tool for more information. Common values are http://localhost:8000/Nodinite/Service/Update or http://localhost:8000/IM/Service/Update
    CustomInstallationUpdateService
  2. Use default installation account, When checked, the installation will use the Service credentials provided in the General section
    CustomInstallationAccount
  3. Use previously installed configuration database, When checked, an existing configuration database will be used. This is typically chosen when performing in place updates (for example v3.x -> v4.x)
    Enter the SQL server where the database will be placed, if every parts of Nodinite including the SQL is running och the same server you could use localhost, else you must enter the server name/address

CustomInstallationOldConfigDB *The user account running the installation application

  1. Database Server, Enter the Name of the SQL Server database server
  2. Database Name, Enter the name of the configuration database.. To avoid mixups the provided naming scheme like IMConfig_<environment> should be honored.
  3. Install, Click Install to install (or for advanced setups upgrade) the configuration database

Always on

If you use the SQL Always On Listener name then the Install and Update Tool automatically detects the current configuration and you must specify a valid accessible path for SQL Server backup files (The account running the SQL Service on all nodes must have access to this highly available share).

AlwaysOnConfiguration
Configuration page for Always On SQL Server target environments

Nodinite will automatically perform the required backup to the backup folder and then set the Configuration Database in the Synchronization state.

Step 3 Install the Logging Service

Install

  1. Folder, Set the root path where the Logging Service will be installed
  2. Name of the Logging Service, to make mix-ups less possible now and in the future the name is Nodinite <environment> Logging Service so it is recommended to use this naming scheme.
  3. Click Install to install the Logging Service.

Step 4 Install the Monitoring Service

Install the Monitoring Service.

Install

  1. Folder, Set the root path where the Monitoring Service will be installed
  2. Service Name, Set the name of the Monitoring Service, to make mixups less possible now and in the future the name is Nodinite <environment> Monitoring Service so its recommended to use this naming scheme.
  3. Click Install to install the Monitoring Service.

Step 5 Install the Web API

Install the Web API.
png_Installation_WebApi

  1. Use Default Update Service, to use the local update service (default) make sure to have this checkbox checked. If the Web API is installed on some other IIS Server then the Nodinite Update Service on that server must be used when updating Nodinite.

Note: Only un-check this checkbox for advanced setups (preferably in dialogue with our technical support)

  1. Use default account for installation, When checked, the installation will use the Service credentials provided in the General section. If not checked, enter account and password to use when installing the Web API.

  2. Local Installation, Check to install on localhost (default and recommended)

  3. Folder, the physical file path location to where to install the Web API

  4. User default account as Impersonation Account, When checked, the installation will use the Service credentials provided in the General section to configure impersonation for the Web API

  5. IIS Web Site, Enter the name of the web site where to install the Web API

  6. IIS Application Pool, Enter the name of the IIS App Pool (should run as AppPoolIdentity as also described in the Installation Checklist)

  7. IIS Virtual Path, Enter the name of the IIS Virtual Path. Default is Nodinite or IM-%Environment%

  8. Install, click on the Install button to start the installation of the Web API

Step 6 Install the Web Client

NOTE: You may need to review the applied SQL rights before continuing, check SQL prerequisites for the Web API

Install the Web Client.
png_Installation_WebClient

  1. Use Default Update Service, to use the local update service (default) make sure to have this checkbox checked. If the Web Client is installed on some other IIS Server then the Nodinite Update Service on that server must be used when updating Nodinite.

Note: Only un-check this checkbox for advanced setups (preferably in dialogue with our technical support)

  1. Use default account for installation, When checked, the installation will use the Service credentials provided in the General section. If not checked, enter account and password to use when installing the Web Client.

  2. Local Installation, Check to install on localhost (default and recommended)

  3. Folder, the physical file path location to where to install the Web Client

  4. IIS Web Site, Enter the name of the web site where to install the Web Client

  5. IIS Application Pool, Enter the name of the IIS App Pool (should run as AppPoolIdentity as also described in the Installation Checklist)

  6. IIS Virtual Path, Enter the name of the IIS Virtual Path. Default is Nodinite or IM-%Environment%

  7. Install, click on the Install button to start the installation of the Web Client

Step 7 Install the Log API

Install the Log API.

png_Installation_LogAPI

  1. Use Default Update Service, to use the local update service (default) make sure to have this checkbox checked. If the Web Client is installed on some other IIS Server then the Nodinite Update Service on that server must be used when updating Nodinite.

Note: Only un-check this checkbox for advanced setups (preferably in dialogue with our technical support)

  1. Use default account for installation, When checked, the installation will use the Service credentials provided in the General section. If not checked, enter account and password to use when installing the Log API.

  2. Local Installation, Check to install on localhost (default and recommended)

  3. Folder, the physical file path location to where to install the Log API

  4. IIS Web Site, Enter the name of the web site where to install the Log API

  5. IIS Application Pool, Enter the name of the IIS App Pool (should run as domain account with specific rights in the Log Databases as also described in the Installation Checklist)

png_Installation_LogApiAppPool

Note: You should use an IIS AppPool with a named domain account with specific rights in the databases, as also described in the Installation Checklist.

  1. IIS Virtual Path, Enter the name of the IIS Virtual Path. Default is Nodinite or IM-%Environment%

  2. Install, click on the Install button to start the installation of the Log API

Step 8 Set default behaviour

Click next after installing all the core services. The next step involves setting up the default behavior for Nodinite

Configuration

png_Installation_Configure

Step 9 Configuration

General

png_Installation_Configure_General

Step 10 Configure Logging

png_Installation_Configure_Logging

Step 11 Configure Monitoring

png_Installation_Configure_Monitoring

Step 12 Configure Active Directory Support

png_Installation_Configure_AD

Step 13 Review Configuration

Review configuration and click the Next button

png_Installation_Configure_General_Next

Step 14 Start Services

png_Installation_StartServices

Step 15 Start Logging Service

png_Installation_StartLoggingService png_Installation_StartLoggingServiceStarted

After successful start, information about the newly created IMLog database will be shown:
png_Installation_IMLogDatabaseInformation

Step 16 Start Monitoring Service

png_Installation_StartMonitoringService png_Installation_StartMonitoringServiceStarted

Step 17 Finish

png_Finish

Step 18 Assign Access rights

After installation make sure to assign who has the right to update Nodinite, see more in the Assign Access Rights user guide.

Also make sure the appropriate SQL rights are set for new Nodinite Log Databases, see more about the following 2 System Parameters:

  1. ImLogAccessRoles
  2. ImLogServiceUsers

Additional tuning can be performed altering System Parameters

Common errors

Each text box must be clicked to validate content. If you do not click on each text box, the validation process will not be performed and the installation can not continue.

#1: Missing SQL package

The file SqlPackage.exe was not found on the server 'localhost'
Missing SQL package

Solution Download and install the following file from here

  • DACFramework.msi (18.0 or later)

Data tier

#2 Unauthorized

If end users can't login to either the Web Client or the Web API although they are registered as either Users or Windows AD Groups, make sure the end users have the local policy: "Access this computer from the network" set
png_accessthiscomputerpolicy
default settings example for Windows 2016

#3. IIS Authentication settings

Please read the IIS Authentication settings troubleshooting guide.


Next Step

Administer Nodinite
Configure BizTalk LogAgent

Download
Update
Web Client
Release Notes
Logging Service
Monitoring Service
Log Databases