Installation of Relay Server

Prerequisites

# Procedure Expected Result

1

Confirm hostnames for this deployment, and note hostnames in “Actual Result” columns are as specified in the installation preparation section General Installation Preparation:

Relay Server

D-SITE-Relay-1

Master Core Server

D-GXPC-Core

2

Confirm site short code for this deployment and the deployment Role (e.g. D/Q/P)

SITE

D, Q or P

3

Open RDP session to Relay machine (Relay Server)

Successful login on machine

4

Open File Explorer

Copy installation deliverables into the installation directory D:\Installation

Installation Files

The following files exist in the installation directory D:\Installation

  • AspenTechInmationNodeSetup.exe

  • install.ps1

  • NodeSetup.xml

  • pre-install.lua

5

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

6

Ensure that the AspenTechInmationNodeSetup.xml contains the right settings for the following static parameters. These parameters define the requirements for the instance type being installed (in this case a Relay) and will not change between installs on any deployment. Edit and save if necessary.

Settings are as below:

ConnectorActiveComponent

"TRUE"

HasConnector

"FALSE"

HasRelay

"TRUE"

HasServer

"FALSE"

RelayActiveComponent

"TRUE"

InstallConnector32Bits

"FALSE"

InstallRelay32Bits

"FALSE"

InstallServer32Bits

"FALSE"

Install

"TRUE"

Update

"FALSE"

Delete

"FALSE"

7

Ensure that the AspenTechInmationNodeSetup.xml contains the right settings for the following dynamic parameters. 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 your Design Specification/Configuration Specification and check that the following parameters match in the xml file.

Name

ConnectorCoreServerHost

ConnectorCoreServerPort

ConnectorListenerPort

ConnectorPassphrase

ConnectorSecurityMode

ServerCoreServerHost

ServerCoreServerPort

RelayListenerPort

RelayCoreServerHost

RelayCoreServerPort

Initialize Relay Object

# Procedure Expected Result

1

Open RDP session to Master Core and log in as an appropriate AspenTech Inmation Windows user

Successful login on machine

2

Open start menu and type DataStudio

Open “AspenTech Inmation DataStudio” by pressing Enter

DataStudio window opens with “Connect to dialog”

3

Use Windows Authentication

Click Ok

Connect to dialog closes. No error message is shown in connection dialog.

4

Optional: When using DataStudio the first time, the “Create new workspace…” dialog appears

Leave proposed name and click Ok

Create new workspace dialog closes

5

In the Menu Bar, click Open  Console

New Console opens in AspenTech Inmation DataStudio

6

Copy the following mass command (or the content of the pre-install.lua script which is part of the deployment files) to the Console, ensuring shortCode and relayHost are as per Prerequisites section above:

(require "esi-deploy"):INIT_RELAY({
    shortCode = "SITE",
    relayHost = "D-SITE-Relay-1",
})

shortCode and relayHost match requirements of Prerequisites section.

7

Press F5 to run the command

A new Relay Object with the name defined as per Prerequisites section is created in the I/O Model Navigation Tree.

All Lua scripts during installation are run on the DataStudio console. DataStudio is connected to the Master-Core.

Install Relay Service

# Procedure Expected Result

1

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

2

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

Start PowerShell

PowerShell with administrative priviledges is available

3

Execute the command to run the installation script by typing

 .\install.ps1
Start Install

The script starts, executes without user intervention, and ends successfully

4

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 - Scroll down to find the created AspenTech Inmation rule as shown below. Check the highlighted items for consistency with the setup XML file.

Inbound Firewall Rules
  • Relay Service rule reflects the "Name" set in the settings XML file (e.g. AspenTech Inmation Relay 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 RelayListenerPort set in the XML file (e.g. 6511)

3

Outbound Rules - 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.

  • Relay Service rule reflects the "Name" set in the settings XML file (e.g. AspenTech Inmation Relay 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 service has been installed and configured

# 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 Relay Service is present and running by verifying the item highlighted as below

AspenTech Inmation Services

Close the Services application when verification is completed

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

3

Go back to the Master Core machine and use DataStudio to check the Relay Object

relay Status

The status of the Relay Object is good

4

While using the Master Core machine DataStudio, check the Object Properties. The settings should be as highlighted below:

relay Properties
  • In the Common section, the Object Name reflects the OverrideObjectName setting of the XML file

  • In the Communication section:

    • the Host Name or IP reflects the relayHost of the pre-install.lua script

    • Component Identification shows the Component Type as Relay Service Component