Installation of Interface Server To Master Core

Prerequisites

These pre-requisites are necessary for the successful deployment of the AspenTech Inmation solution interface server on a Master Core system.

# Procedure Expected Result

1

Confirm hostnames for this deployment:

Interface Server

D-GXPC-Interface

Core Server

D-GXPC-Core

2

Log into the server, where the webAPI and OPC server instances are to be installed with an administrative account using Remote Desktop console session.

In CMD Shell, type:

MSTSC /v:D-GXPC-Interface-1

Successful login on machine with administrative account.

3

Open Start Menu and type Explorer

Open File Explorer by pressing ENTER/RETURN.

Check the file contents of the installation folder (D:\installation).

Installation Files

The following files exist in the installation directory (D:\installation)

  • AspenTechInmationSetup.exe

  • AspenTechInmationNodeSetup.exe

  • install.ps1

  • post-install.lua

  • Setup.xml

4

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

5

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 WebAPI and OPC services) and will not change between installs on any deployment.

InstallWebApi

1

InstallServer

1

InstallDataStudio

0

OfflineInstallMongoDb

0

InstallOpcComponents

0

InstallCore

0

InstallRelay

0

InstallConnector

0

ConfigureFirewall

1

6

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

CoreHost

CorePort

OverrideObjectName

WebApiInstanceName

WebApiProfileName

WebApiProfilePassword

Install Interface Services

# Procedure Expected Result

1

Open File Explorer and browse to the installation directory (D:\installation)

Folder contains 5 files as shown in pre-requisites.

2

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

Start PowerShell

PowerShell with administrative privileges is available

3

Execute the command to run the installation script by typing

.\install.ps1
Start Install

The script starts execution.

4

Enter web API profile’s password and hit enter.

WebAPI Profile Password

To get the profile password: Open RDP session to Master-Core > Open DataStudio > in "Access Model" select the Web API profile "MU-Global-WebAPI" > Copy password from the "Profile Credential" in Object property.

(If the clipboard is not shared between servers, use a secondary method to transfer the password between machines - such as temporarily visualizing in a document and typing manually with care.)

Powershell script completes without errors.

5

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.

6

Using DataStudio connected to the Master Core, open a Console window (Open, Console or Ctrl+Shift+U) and copy the content of the post-install.lua to the console window. Check the contents are correct and match the setup installation XML (shortCode and extension1). The script should look similar to the example below:

(require "esi-deploy"):INIT_INTSERVER({
	shortCode = "Global",
	extension1 = "Interface01",
})

Press the console "run" button or F5 to execute the script

The OPC Server becomes active, and a UA server and endpoint are created.

The WebAPI Server should remain active.

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. Tests are conducted on the Interface Server machine.

# 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 two created inmation rules as shown below. Check the highlighted items for consistency with the setup XML file.

Inbound Firewall Rules - Server
Inbound Firewall Rules - WebAPI
  • Program locations, where appropriate, reflect the "InstallationFolder" set in the XML file (e.g. D:\AspenTech\inmation.root\)

  • The Local Port for the Web API Service reflects the WebAPIPort set in the XML file (e.g. 8002)

3

Outbound Rules - Scroll down to find the single created 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.

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

Installation Testing - Services

Ensure the correct windows service has been installed on the Interface Server machine.

# 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 installed AspenTech Inmation Interface services are present and running by verifying the items highlighted as below

AspenTech Inmation Services

Close the Services application when verification is completed

AspenTech Inmation Web API and Server Services are present and running; the Name as set in the XML file is reflected in the service names

Installation Testing - Server Objects

In this section check the configuration of the Server objects using DataStudio on the Master-Core instance.

# Procedure Expected Result

1

In the Master Core machine check the WebAPI Server Object status.

WebAPI and Server Object enabled

WebAPI Object is in a good status with two green lights

2

Select the WebAPI Server Object in the Server Model then check the Object Name and Context Path properties configurations in Common section.

WebAPI Properties Check

Settings are as the following:

  • Object Name: Follows naming convention

  • Context Path: /System/Core

3

Select the Server Object in the Server Model then check the Object Name property in Common section.

Server Object Properties Check

Object Name was set according to the naming convention.

4

Select the OPC UA TCP Server object below the Server Object in the Server Model hierarchy then check the Object Name property in its Common section.

Server Object Properties Check

Object Name is following the naming convention.

5

Select the OPC UA TCP Server Endpoint object below the OPC UA TCP Server in the Server Model hierarchy and check the following properties:

  • Object Name in Common section

  • Security Mode in Communication section

  • Security Policy in Communication section

  • User Name Policy in User Token Policies

Server Object Properties Check

Settings are as below:

  • Object Name : is following the naming convention

  • Security Mode : Sign and Encrypt

  • Security Policy : Basic256Sha256

  • User Name Policy : Enabled