Installation of Local Core

Prerequisites

These pre-requisites are necessary for the successful deployment of the AspenTech Inmation solution on a Local Core connecting to the Master Core through a Relay.

# Procedure Expected Result

1

The Master Core must have been installed and operational as per the Master Core installation instructions in this document set. Refer to Installation of Master Core for more details.

Note the Core Listener port, the KPI Root object name and the ISA95 Root object name in the Master deployment using Data Studio as appropriate. Note the machine name (DNS) on which the Master Core is installed.

  • Master Core is installed and operational.

  • Core Listener port: 6512

  • KPI Root Object Name: "GXPC KPI"

  • ISA95 Root Object Name: "GXPC Assets"

  • Machine Name: "D-GXPC-CORE"

2

The Relay must be installed and operational as per the Active Relay installation instructions in this document set. Refer to Installation of Relay Server for more details.

Note the machine name (DNS) and port of the machine hosting the Relay server, and the Relay Object name in the Master Core using Data Studio as appropriate.

  • Machine Name: D-Site-Relay

  • Port: 6511

  • Relay Object Name: SITE-Relay

3

Confirm hostname for this deployment:

D-Site-Core

4

Log into the VM, where the Local Core is to be installed with an administrative account (domain user) using Remote Desktop console session.

In CMD Shell, type:

MSTSC /v:D-SITE-Core

Execute this command by pressing ENTER/RETURN.

Successful login on machine with administrative account.

5

Open Start Menu and type Explorer

Open File Explorer by pressing ENTER/RETURN.

Check file contents in the folder D:\installation.

Installation Files

The following files exist in D:\installation (or your selected installation folder)

  • AspenTechInmationSetup.exe

  • AspenTechInmationNodeSetup.exe

  • install.ps1

  • mongodb-windows-x86_64-5.0.x-signed.msi

  • pre-install.lua

  • Setup.xml

6

Ensure the security on the files is "Unblocked" by right-clicking on each file, selecting properties and checking the status of security as shown below. (Unblocking, where required, will ensure the setup can run without manual intervention)

Unblock File

Files are unblocked and run without intervention.

7

Ensure that the Setup.xml contains the right settings for the following parameters. Edit and save if necessary.

These parameters define the requirements for the instance type being installed (in this case, a Local Core) and will not change between installations on any deployment.

xml file settings are as below:

InstallWebApi

0

InstallServer

0

InstallDataStudio

1

OfflineInstallMongoDb

1

IntegrateMongoDB

1

LocationMongoDb

D:\installation

InstallOpcComponents

0

InstallCore

1

InstallRelay

0

InstallConnector

0

IsLocalCore

1

ConfigureFirewall

1

8

Depending on the server environment (D\Q\P) and its configuration specification the parameters below might be different from one server to another.

If required, consult the Design Specification/Configuration Specification (DS/CS) document then check the settings for the following parameters from the Setup.xml file.

InstanceName

InstallationFolder

CorePort

OverrideObjectName

ProductKey

MasterCoreOrRelayPort

MasterCoreOrRelayHost

MongoDbUserName

ISA95ObjectParent

ISA95ID

ISA95Description

ISA95ObjectType

KPIObjectParent

KPIObjectName

KPIObjectDescription

KPIObjectType

MsiVersion

MsiSystemId

AdName

AdPrefix

Install Local Core

The Local Core solution installation should be simple using a dedicated script that installs the software with the settings as defined in the Setup.xml. The script execution should not require any user interaction (aside from that to execute the script).

Some user interaction is necessary prior to the installation to "create" the Local Core from the Master Core; steps are included below.

# Procedure Expected Result

1

On the Master Core machine start Data Studio and open a "Console" (using either the top menu bar, Open, Console or the key-press combination Ctrl+Shift+U). Copy the content of the pre-install.lua file (example below) into the Console window, and verify again that the settings in the script are correct.

(require "esi-deploy"):INIT_LOCALCORE({
    shortCode = "SITE",
    coreHost = "D-SITE-Core",
    hasCoreRelay1 = 1
})

When satisfied the settings are correct, execute the script using "Run the code…​" from the console top menu bar (Play button) and ensure that the "Local Core" object is created in the I/O model pane.

Preinstall Script Result

On completion, exit the Data Studio on the Master Core, and return to the Local Core machine for installation.

The Local Core object will be created in the I/O Model tree underneath the Relay Object.

The Local Core will only show one "red" light at this stage since the actual Local Core object is yet to be installed.

2

On the Local Core machine, open File Explorer and browse to the installation directory set in Prerequisites step #5 (e.g. D:\installation)

Folder contains 4 files as shown in pre-requisites.

3

In File Explorer, go to the File Menu, select Open Windows PowerShell, and select "Open Windows PowerShell as administrator"

Start PowerShell

PowerShell with administrative priviledges is available.

4

Execute the command to run the installation script by typing

.\install.ps1
Start Install

The script starts, executes without user intervention, and ends successfully with the message "Installation Complete". No errors are shown.

5

Copy the autogenerated password to the clipboard.

Default is N. If needed, enter Y to copy the MongoDB password to the clipboard, and then paste to a text editor like Notepad.

6

Check the output for errors; successful installation will be error free. This can be done both on the console output, and the "install.log" file which will be created in the installation directory from which the install.ps1 script was executed.

Install Complete

The installation completes with the message "Installation completed successfully". No errors are shown.

Detailed Testing

The following sections are intended for use only during the initial deployment (first use) of the installer script (install.ps1) following which successful deployment of the script (step 8 in the previous section) will be assumed to have deployed as per the detailed sections below. Therefore it is only necessary to check deployment with the sections below once (although any user may decide to implement the detailed tests on an ad-hoc basis).

Installation Testing - Firewall

Ensure Windows Firewall settings reflect requirements as defined in the Setup.xml file.

# Procedure Expected Result

1

From the Windows Start Menu, type "Firewall" and select the "Windows Firewall with Advanced Security" application.

Start Windows Firewall

Windows Firewall application is opened.

2

Inbound Rules - order rules using "Name" by clicking the Name column header. Scroll down to find the single created AspenTech Inmation rule as shown below. Check the highlighted items for consistency with the setup XML file.

Inbound Firewall Rules
  • Core Service rule reflects the "Name" set in the settings XML file (e.g. AspenTech Inmation Core Service (D))

  • Program locations reflect the "InstallationFolder" set in the XML file (e.g. d:\AspenTech\inmation.root\)

  • The Local Port for the Core Service reflects the CoreListener set in the XML file (e.g. 6512)

3

Outbound Rules - order rules using "Name" by clicking the Name column header. Scroll down to find the single created AspenTech Inmation rule as shown below. Check the highlighted items below for consistency with the setup XML file.

Outbound Firewall Rules

Close the Windows Firewall application when checks are completed.

  • Core Service rule reflects the "Name" set in the settings XML file (e.g. AspenTech Inmation Core Service (D))

  • Program locations reflect the "InstallationFolder" set in the XML file (e.g. d:\AspenTech\inmation.root\)

Installation Testing - Services

Ensure the correct Windows services have been installed.

# Procedure Expected Result

1

From the Windows Start Menu, type "Services" and select the "Services" desktop application.

Start Windows Services

Windows Services application is opened.

2

Check the two (2) expected AspenTech Inmation installed services are present and running by verifying the items highlighted as below.

AspenTech Inmation Services
MongoDB Service

Close the Services application when verification is complete.

  • AspenTech Inmation Core Service is present and running; the Name as set in the XML file is reflected in the service name.

  • MongoDB is present and running.

Installation Testing - Data Studio

Check the detailed installation of the AspenTech Inmation software using the Data Studio interface application from the Master Core server.

# Procedure Expected Result

1

In the I/O Model panel, expand the System and show the installed Master Core, and the Local Core underneath the Relay Object. The Master Core will only show one green status indicator, but as seen during the installation step the Local Core should now show two green indicators lights.

Data Studio Local Core

Select the Local Core Object Properties and check the settings as highlighted below. Note: All screen shots in the IaC are examples and do not reflect the parameter values expected in an actual Local Core System installation, the parameter values are determined by the settings in the Setup.xml file and the machine host names in the network.

Data Studio Local Core Object Properties
  • In the Common properties:

    • the Object Name reflects OverrideObjectName setting of the XML file

    • Host Name or IP reflects the Object Name (as above in step #3 of the prerequisites)

    • Server Port reflects the CoreListener setting of the XML file

  • In the Component Identification:

    • the Component Role shows this is a Primary Component (i.e. Local Core)

    • Instance shows the Name setting of the XML file

3

Still in the I/O Model panel, check the creation of the default I/O Model objects to ensure they are present and operating correctly (one or two green lights).

  • Core Logic (Security Perimeter) is created and shows green operating light.

  • Message Broker (MSI) is created and shows green status indicators.

4

In the KPI Model pane, check the creation of the default "Site" KPI object to ensure it is present and operating correctly.

Data Studio KPI Model
  • SITE object is created and shows green operating light. The name reflects the OverrideObjectName setting of the XML file.

  • Object Description reflects the SiteLongName setting of the XML file.

5

Select the Access Model panel and check the Local (Site) MES and Site group Profiles users have been created. View the MES user password using the "eye" icon to show a random password selection (created during install). Note, there will also be profiles created from the Master Core installation (and possibly others).

Data Studio Access Model
  • The MU-Site-MES user has been created

  • The local user profile groups for Administrators, Auditors, Engineers, Readers and Writers have been created and are prefixed with the local ShortCode (e.g. SITE)

  • The MES user password is set random and different to other passwords

6

In the ISA-95 Model panel, check the creation of the default "Site" object to ensure it is present and operating correctly.

Data Studio ISA-95 Model
  • SITE object is created and shows green status light. The name reflects the OverrideObjectName setting of the XML file.

  • Description reflects the SiteLongName setting of the XML file.