Top-Level Node Setup with Windows Installer
In this section, step-by-step instructions are provided to guide you through the installation of a Top-Level Node using the AspenTech Inmation OT Data Fabric Windows Installer.
System Requirements
Please review the System Requirements for the minimum hardware and operating system setup of the host machine where the Top-Level Node will be installed.
Simple Installation
To begin the installation of the Node, right-click on the AspenTech-Inmation-OT-DataFabric-Setup executable file and select 'Run as administrator' to open the Setup wizard.
In this simple setup, make sure all checkboxes on this page are selected. This will install OPC Core Components (If an existing installation is detected, this will be indicated in the Setup and will be upgraded if required)
To proceed with the installation, click the checkbox to agree with the license terms and conditions. Now, click the Install button to begin the installation.
| If you have an existing MongoDB installation, uncheck the MongoDB Integration checkbox. |
| The path to the AspenTech Inmation OT DataFabric executable, config file, startup script, data folder etc. must only contain ASCII characters. Non-ASCII characters in these paths can cause installation issues. |
It is recommended to use the Program Files directory of the Windows host for installation location. This limits access to Administrators only and allows for proper IT access control. For the same reasons, the Program Data directory is used by default for the data folder when using the Windows Setup installer as the image contains sensitive data.
|
MongoDB Installation
The next step in the installer is used to install MongoDB and MongoDB Shell.
| Before installation, download MongoDB here and MongDB Shell here. AspenTech Inmation is compatible with MongoDB 7.0.x versions. |
Ensure that the 'Install MongoDB 7' and 'Install MongoDB Shell' checkboxes are selected. Set the MongoDB installer location and MongoDB Shell installer to the folder where the corresponding .msi file can be located.
The MongoDB location and MongoDB Shell location are used to define the location for the installed MongoDB files. By default, these fields are set as 'C:\Program Files\MongoDB\Server\7.0' and 'C:\Program Files\mongosh' respectively and can be left as the default values for this simple setup.
Click Next to proceed.
| Control | Text | Default | Description |
|---|---|---|---|
Checkbox |
Install MongoDB 7 |
Enabled |
Enable this to install MongoDB as part of the installation |
Field |
MongoDB installer location |
- |
Define the location of the MongoDB .msi file |
Field |
MongoDB location |
C:\Program Files\MongoDB\Server\7.0 |
Location where the MongoDB files will be installed. |
Checkbox |
Install MongoDB Shell |
Enabled |
Enable this to install MongoDB Shell as part of the installation |
Field |
MongoDB Shell installer location |
- |
Define the location of the MongoDB Shell .msi file |
Field |
MongoDB Shell location |
C:\Program Files\mongosh |
Location where the MongoDB Shell files will be installed. |
MongoDB Integration
The next step of the installer is used to integrate MongoDB and MongoDB Shell.
MongoDB is integrated as a Windows service. The bin directory, data storage directory, log directory and shell bin directory must be configured individually.
-
For the data storage directory and log directory, the locations should be configured to a folder where the MongoDB data and logs will be stored. If these folders do not exist, they will automatically created during the installation.
-
For the bin and shell directories, the respective paths should be configured to the location of the respective folders where MongoDB and MongoDB Shell are installed. If MongoDB and MongoDB Shell are installed using the installer, then these fields will be pre-configured.
To change the locations, either manually enter a value in the text field or click Change… to open a directory selection window.
Finally, configure a Windows service name and TCP port for the MongoDB client to listen on. The default port is 27017.
Click Next to proceed to the next step of the installation.
| Control | Text | Default | Description |
|---|---|---|---|
Field |
MongoDB bin directory: |
C:\Program Files\MongoDb\Server\7.0\bin |
Configure the MongoDB bin directory. This folder should contain all MongoDB binaries. |
Button |
Change… |
N/A |
Opens an advanced directory selection window for the MongoDB bin directory path |
Field |
MongoDB data storage directory: |
C:\Program Files\MongoDB\Server\7.0\data |
Configure the MongoDB data storage directory. All database files are stored in this folder. |
Button |
Change… |
N/A |
Opens an advanced directory selection window for the MongoDB data storage directory path |
Field |
MongoDB log directory: |
C:\Program Files\MongoDB\Server\7.0\log |
Configure the MongoDB log directory. All log files are stored in this folder. |
Button |
Change… |
N/A |
Opens an advanced directory selection window for the MongoDB log directory path |
Field |
MongoDB shell bin directory: |
C:Program Files\mongosh |
Configure the MongoDB shell bin directory. This folder should contain all MongoDB Shell binaries. |
Field |
Service Name: |
MongoDB |
Configure the name of the MongoDB Windows service |
Field |
Port: |
27017 |
Configure the TCP port that MongoDB listens on. |
MongoDB Security
In this step, the security options for MongoDB will be configured.
MongoDB has the following security modes:
-
None (no security configured)
-
SCRAM-SHA-1 Authentication
-
SCRAM-SHA-256 Authentication (default)
Configure the MongoDB Security as required for your system.
Click Next to proceed to the next step in the installation.
| Control | Text | Default | Description |
|---|---|---|---|
Drop Down List |
Authentication Mode: |
6 - SCRAM-SHA-256 Authentication |
Choose the MongoDB authentication mode |
Radio |
IP Binding: |
Local Host |
Allow connections to MongoDB database from only the local machine (Local Host) or all machines (All) |
Field |
User |
Empty |
Assign a user name that will be allowed to connect to the MongoDB database server |
Field |
Password |
Empty |
Assign a password to the MongoDB user account |
Field |
Repeat Password |
Empty |
Repeat the password for verification purposes |
Communication Options
In this Communication Options page, the Node type can be defined. Set the Connection Mode to Top-Level Node.
For this simple setup, we will create a default instance. Ensure that the "Create default instance" checkbox is selected. Selecting this checkbox will also assign default values for the Instance Location and the Data Location.
| For non-default instances, the Instance Name should also be defined. This will also automatically assign values to the Instance Location and the Data Location, which can be overridden if required. |
The Override Object Name option can be used to define the name of the corresponding Node object created by the installation. If this field is left blank, the Object Name of the Node object will be the machine where the Node is installed. For this example, set the Override Object Name field to Home.
Click Next to proceed to the next step of the installation.
| Control | Text | Default | Description |
|---|---|---|---|
Radio |
Connection Mode: |
Top-Level Node |
Install the Node as a Top-Level Node or a Child Node |
Field |
Instance Name |
Empty |
Assigns a name for the new instance. |
Checkbox |
Create default instance |
Disabled |
Enable to create a default instance |
Field |
Override Object Name |
Empty |
Assigns a custom initial name to the Node object created in the System Model during installation of the Node service. |
Field |
Instance location |
Empty |
Configure the Instance location. All directories related to this instance are stored here. |
Button |
Browse |
N/A |
Opens an advanced directory selection window for the Instance location path. |
Field |
Data location |
Empty |
Configure the Data location. All data directories are stored here. |
Button |
Browse |
N/A |
Opens an advanced directory selection window for the Data location path |
Field |
Listener Port: |
6512 |
Configure the TCP port of the Node |
Checkbox |
Configure Windows Firewall |
Enabled |
Enables automatic Windows Firewall configuration. |
Node Options: System Owner
Enter a Profile Name for the System Owner profile; this profile will be created during installation. By default, it will not be possible to login with the System owner profile. If you want to be able to login using the System Owner profile, you need to check the Enable Profile Login checkbox and assign a password to the System Owner profile.
| The password needs to have a minimum length of 6 characters and must contain at least one lower case character, one upper case character and one number. |
The Profile assigned to the Top-Level Node can be found in the Access Model after installation and will have full administrative rights. All users assigned to this profile are also granted full administrative rights.
Click OK to proceed to the next step.
| Control | Text | Default | Description |
|---|---|---|---|
Field |
Profile Name: |
Empty |
The name of the Profile created during installation. |
Checkbox |
Enable Profile Login |
Enabled |
Enables/disables the ability to access the system using the profile |
Field |
Password: |
Empty |
Assign a password to the profile |
Field |
Repeat Password: |
Empty |
Confirm the password for the profile |
Radio |
Account or Group |
Account |
Choose whether to assign a Windows user account or a Windows user group to the system owner profile |
Field |
Microsoft account or group |
Domain and user account being used to install the system |
Assigns a Windows user account to the System owner profile |
Node Options: Web Server
The Web Server can use secure (https) and insecure (http) listener ports (8009 and 8008 are the respective defaults). It is recommended to only use secure connections in production environments.
Set the Insecure Binding to NONE, preventing insecure connections to the Web Server. To enable secure connection to the Web Server, set the Secure Binding to LOCAL or ALL. This will allow secure connections to the Web Server from the local machine or from all machines respectively.
| When a WebServer object is created, a self-signed certificate and private key are generated and stored in WebServer object properties. The self-signed certificate can be used to establish an initial secure connection to the WebServer but is not recommended for production environments. If a new valid certificate is available, it can be imported into the WebServer object after installation. |
Click Finish to proceed.
| Control | Text | Default | Description |
|---|---|---|---|
Checkbox |
Enable WebServer |
Enabled |
Enables/disables the Web Server |
Radio |
Secure Binding |
NONE |
Defines which machines (none, local, all) can connect to the Web Server using a secure connection. |
Field |
Secure Listener Port |
8009 |
Port used for secure connections to Web Server |
Radio |
Insecure Binding |
LOCAL |
Defines which machines (none, local, all) can connect to the Web Server using an insecure connection. |
Field |
Insecure Listener Port |
8008 |
Port used for insecure connections to Web Server |
Node Options: MongoDB
In this step, the Node is configured regarding the MongoDB client connection.
| If a pre-existing MongoDB installation is used, then the hostname and TCP port of the MongoDB client must be set. If MongoDB is running on the same machine as the installer, set the MongoDB Host as localhost, otherwise the FQDN of the machine where MongoDB is installed should be used. The default TCP port of MongoDB is 27017. |
| When installing AspenTech Inmation without MongoDB (meaning that the MongoDB integration checkbox is unchecked on the first page of the installer), an existing MongoDB installation can be configured as a standalone database or using replica sets. See the Advanced Node Options: MongoDB section below. |
| Control | Text | Default | Description |
|---|---|---|---|
Checkbox |
Create Datastores |
Enabled |
When enabled, an Initial Data Store is created in the System Model. |
Finishing the Top-Level Node Setup
After the configuration of these options, the installation process will now begin. This may take some time.
When the setup is complete, the dialog will show that the installation has been successful. This window will also provide links to WebStudio and the System Config App.
Before you can use the functionality of the Node, the machine where the Node was installed must be restarted. Click Restart to restart the machine immediately; alternatively, click Close to close the setup installer.
Configuration in WebStudio
After the machine hosting the Node is restarted, load WebStudio using the following URL:
https://localhost:8009/apps/webstudio
Connect using the profile created during installation. This will open the index page where you can access the System Config App. This compilation is primarily used for configuration.
Alternatively, load this compilation directly using the following URL:
https://localhost:8009/apps/webstudio/?name=config
| With the above installation configuration, the self signed WebServer certificate will be be used to establish a secure connection to the WebServer. The browser may display a warning that the certificate is not trusted. For initial configuration you can continue with the self-signed certificate but a valid certificate should be used in production environments. |
In the System Config App, the Node object corresponding to the newly installed Node is found in the System Model in the Object Model Panel. By default, the name of the Node will be assigned the value of the Instance Name.
In addition to the Node object, the Web Server object, Built-In Authentication Provider and IWA Provider objects and the Initial Data Store object are created by the installation.
| If the Instance Name or Override Object Name was not defined during installation, the name of the Node object will be the hostname of the machine where the Node was installed. To change the name of the Node object, right-click on the object in the System Model and select . |
Advanced Options
Advanced Node Options: MongoDB
In the Node Options: MongoDB section of the setup, there are advanced options that can be configured in regards to Replica sets.
Replica sets can be configured in the Node Options: MongoDB section of the setup. This will only be available when installing without MongoDB integration (meaning that the MongoDB integration box is unchecked on the first page of the installer).
Enter the hostname and port of any replica set location and they will be configured automatically by the setup.