X-Force Historian

Installation Guide
Rev1

SSM InfoTech Solutions Pvt. Ltd.

 Table of Contents
Tracking Info .................................................................................................................................................. 4
Introduction ..................................................................................................................................................... 5
About X-Force Historian ............................................................................................................................ 5
Components of X-Force Historian ............................................................................................................ 5
Deployment Options ....................................................................................................................................... 6
Single Node System .................................................................................................................................. 6
Single Node Multiple Source ...................................................................................................................... 7
Single Server and Single Collector Node ................................................................................................... 8
Single Server and Multiple Collector Nodes ............................................................................................ 9
Redundant Servers .................................................................................................................................. 10
Tired Historian Architecture .................................................................................................................... 11
System Requirement ..................................................................................................................................... 12
Hardware .................................................................................................................................................. 12
Networking and Firewall ......................................................................................................................... 12
Flow of Installation ....................................................................................................................................... 13
Windows and Additional software Installation......................................................................................... 13
Historian Installation ................................................................................................................................. 13
Pre-Requisite ................................................................................................................................................. 14
Windows Server Configurations ............................................................................................................... 14
Steps For Enabling IIS & .NET Features in Server OS :- .................................................................... 14
Additional Supportive software ................................................................................................................ 22
1. Installation of Microsoft ASP.NET Core 5.0.17 ........................................................................ 22
2. Installation of Microsoft .NET 7.0.5 Window Server Hosting ................................................. 24
3. Installation of Microsoft .NET SDK 5.0.408 ............................................................................ 25
Database Server ........................................................................................................................................ 27
1. Microsoft SQL Server Installation Guide ................................................................................... 27
2. Install SQL Server Management Studio (SSMS) ............................................................................. 37
Installation Procedure of Historian ........................................................................................................... 39
Steps for Creating Database of XForce Historian................................................................................. 39
Web Portal Installation ............................................................................................................................. 47
 Publication of Application in IIS .......................................................................................................... 48
Configure X Force Historian ................................................................................................................ 72
Historian Storage Engine Installation ....................................................................................................... 79
Collector Installation ................................................................................................................................. 81
Installation Checklist .................................................................................................................................... 87
TRACKING INFO
Rev Description Created Reviewed Approved
Rev0 Release for Milind Kansara
V.22.24.1.101
Tejas Panchal
Ravindra Desai
INTRODUCTION
About X-Force Historian
X-Force Historian is a Time-Series process historian to capture, store, process,
analyze and retrieve data.
X-Force Historian can store huge volumes of data generated from modern industrial
plants with thousands of tags.
Help you to:
• Store all the data in a single place.
• Provides real-time trend and historical plant data.
• Asset structure and process definition to create analytics.
• Provides responsive dashboard.
• Reporting system with user customizable, free form reports in web, excel, pdf etc.
• Access from anywhere, on any device
• In case of any plant upset it will help user to analyze the tag value movement of which
has started upset.

Components of X-Force Historian

• Storage Service
• Collectors
• Configuration Console
• Client Web Application
• Excel Add-in
• Scheduler Service
• Data Synch Service
DEPLOYMENT OPTIONS
In this section the deployment options of different architecture is described.

Single Node System

In this type of deployment the single system is used for Storage and collector. The data can
be read from OPC DA Server through Firewall.
Single Node Multiple Source
In this type of deployment the single system is used for Storage and collector. The data can
be read from multiple OPC DA Server through Firewall.
Single Server and Single Collector Node
In this type of deployment two different system used for Storage and collector. The data can
be read from multiple OPC DA Server through Firewall.
Single Server and Multiple Collector Nodes
In this type of deployment one system is used for Storage and multiple systems are used for
collectors. The data can be read from multiple OPC DA Server through Firewall.
Redundant Servers
In this type of deployment one or more systems are used for Storage (the other storage system
can configured as a redundant storage) and multiple systems are used for collectors. The data
can be read from multiple OPC DA Server through Firewall.
Tired Historian Architecture
In this type of deployment one or more systems are used for Storage (the other storage
systems can configured as a Tier-2) and multiple systems are used for collectors. The data
can be read from multiple OPC DA Server through Firewall.
SYSTEM REQUIREMENT
Hardware
Can handle 100K / per second with 8 core, 128 GB RAM Server

Networking and Firewall

X-Force Historian comply with cyber security terms and by using CISCO ASA1010
FirePower, it shall be complied
Firewall - A device or application that analyzes packet headers and enforces policy based on
protocol type, source address, destination address, source port, and/or destination port.
Packets that do not match policy are rejected.
We providing CISCO ASA 1010 X Firewall for standard Historian commissioning, and
its supported IPS/IDS policy.
(Policy) Intrusion Detection System - A device or application that analyzes whole packets,
both header and payload, looking for known events. When a known event is detected a log
message is generated detailing the event.
(Policy) Intrusion Prevention System - A device or application that analyzes whole packets,
both header and payload, looking for known events. When a known event is detected the
packet is rejected.
FLOW OF INSTALLATION
Windows and Additional software Installation

Historian Installation
PRE-REQUISITE
Windows Server Configurations
Steps For Enabling IIS & .NET Features in Server OS :-
Just Little bit difference between the process of enabling IIS in normal windows OS and
server OS that has been described below as follows.

Step-1: Open Start Menu and Click on Server Manager.

Step-2: Click on “Add role and Features”.

Step-3: Click on “Next”

Step-4: Select Role based or feature based installation.

Step-5: click on “server selection” and then select “select a server from the server pool” option.

Step-6: As per this below Image we have to continue by check marking the features as per
our requirement.
Step-7: Click on Add Features

Step-8: As per this below Image check marking the features of IIS.
 Step-9: Click on Add features.

Step-10: Select .Net framework 3.5 and .Net framework 4.7 all features.
Step-11: Select IIS Hostable Web Core feature. And click on Next button.
Step-12: Click on Next

Step-13: Select all features of Web Server Role Services and click on Next button.
Step-14: Click on yes if its asked for restart.

Step-15: Installation Succeeded then click on close.

 Additional Supportive software
1. Installation of Microsoft ASP.NET Core 5.0.17

ASP.NET Core is a cross-platform, high-performance, open-source framework for building

modern, cloud-enabled, Internet-connected apps.
For downloading the Microsoft ASP.NET Core 5.0.17
https://dotnet.microsoft.com/en-us/download/dotnet/5.0

Step-1:Double click on aspnetcore-runtime-5.0.17-win-x64 for Installation.

Step-2:Tick mark on checkbox for License terms & condition & click on Install.

Step-3:Your Installation of Microsoft ASP.NET Core 5.0.17 successfully completed.

 2. Installation of Microsoft .NET 7.0.5 Window Server Hosting

Step-1: Double click on dotnet-hosting-7.0.5-win for Installation.

Tick mark on checkbox for License terms & condition & click on Install.
Step-2: Your Installation of Microsoft .NET 7.0.5 Window Server Hosting successfully
completed.

3. Installation of Microsoft .NET SDK 5.0.408

Step-1: Double click on Installation of Microsoft .NET SDK 5.0.408
click on Install.
Step-2: Your Installation of Installation of Microsoft .NET SDK 5.0.408 successfully
completed.
Database Server
1. Microsoft SQL Server Installation Guide
SQL Server Overview
SQL Server supports many of the ANSI/ISO SQL standards, so when you learn SQL Server
you are mainly close to the portable standards. SQL Server, developed by Microsoft, runs on
Windows platforms, and on Linux as well. SQL Server is scalable, and supports both
clustering and cloud computing through Azure to surpass the performance and reliability of
any single platform. SQL Server is an in-demand, capable database system.
SQL Server Editions

SQL Server is released in several editions. To simplify your selection, we will focus on the
Developer and the Express editions. For both CS 669, the express edition will work just fine,
however for CS 779 we recommend that you use the Developer Edition. The Developer
Edition has the same full feature set as the Enterprise Edition with the exception of the license.
Production environments cannot be implemented using the Developer Edition. Please refer
to the SQL Server Web site for comparison of editions.
https://www.microsoft.com/en-us/cloud-platform/sql-server-editions
The Developer Edition is especially useful for those students who plan investigate advanced
SQL Server topics as part of their CS 779 term project. Our installation instructions explain
which features you may find useful for either course.
The Express Edition can be used for all the CS 669 and CS 779 assignments. The Express
Edition is a free version of SQL Server which is a smaller version that places limits on the
size of the database, computing capacity and feature set. For some of the MET courses, we
have found that the Express Edition is suitable on the most part, and has advantages of a much
smaller load on the computer and simpler installation.
 Installing SQL Server Express Edition
Step-1: Double click on SQL Server Express Edition Setup file.

Step-2: Once the installation starts, click on the Basic install.

Step-3: Clicking the Accept button for Microsoft SQL Server License Terms.

Step-4: Choose the installation path. Note the minimum free space and download size and
press Install.
Step-5: Choose installation path & click on Customize.

Step-6: Choose Installation type and click on Next.

Step-7: On the License Terms page, check the box next to “I accept the license terms” and
click Next.

Step-8: Remove tick mark on Azure Extension for SQL Server and click on Next.
Step-9: Select the components of SQL server to install on your computer.
Select Database Engine Services, this is the minimum requirement to use SQL Server.
Step-10: Keep Default Instance and click on Next.
Step-11: In Server Configuration, keep Service Accounts tab as it is.

Step-12: Check the collation tab at the top. For our purposes this can be left at default,
SQL_Latin1_General_CI_AI, which is Latin1-General case insensitive accent
insensitive. Collation defines the sorting rules, case and accent sensitivity for
character data, for example you can choose a different language or set it to be case
sensitive. Some applications require for you to choose a specific collation. You can
click Customize to change it. Click Next when done.
Step-13: Select Mixed mode configuration, write password for the SQL and click on Next.
Step-14: Click close button, when set up is installed successfully.

Step-15: Installation has completed successfully, click on close button.

Page | 36
2. Install SQL Server Management Studio (SSMS)
Step-1: Run the SSMS installer. The first screen that appear is shown below.

Step-2: Click the “Install” button to begin. A progress screen will appear similar to the
following.

Page | 37
Step-3: Let it progress through until completion, then you will see a screen indicating successful
setup, click close.

Page | 38
 Installation Procedure of Historian
Steps for Creating Database of XForce Historian
Step-1: Open Historian. Database Folder

Step-2: Execute XStudio_Configuration scripts from given setup Historian Database folder and
execute at SQL query window.

Step-3: Enter Login and Password and Click on Connect

Page | 39
Step-4: Click on Execute.

Page | 40
Step-5: Execute XStudio_Configuration_Historian scripts from given setup Historian Database
folder and execute at SQL query window.

Page | 41
Step-6: Click on Execute

Step-7: Execute XStudio_Historian_Schema scripts from given setup Historian Database folder
and execute at SQL query window.

Page | 42
Step-8: Click on Execute

Step-9: Execute XStudio_Historian_Data scripts from given setup Historian Database folder
and execute at SQL query window.

Page | 43
Step-10: Click on Execute

Page | 44
Step-11: Execute XStudio_Historian_SP scripts from given setup Historian Database folder and
execute at SQL query window.

Step-12: Click on Execute

Page | 45
Step-13: Open Historian.Registry set up folder.

Step-14: Click On X-Force Historian Data Retrieval API and Click on Yes.

Step-15: Click on Ok

Page | 46
 Web Portal Installation
Step-1: Copy 3 Folders
03 Historian.Retrival.Api
04 Historian.Api
05 Historian.Client

Step-2: Paste these Copied 3 folders in given Path C:\inetpub\wwwroot

Step-3: Rename the folder as Historian.Retrival.Api , Historian.Api , Historian.Client and Click

on Close button.

Page | 47
Publication of Application in IIS
Step-4: In Server manager click on “Tools” and in Tools Click on “Internet Information
Services (IIS) Manager”

Step-5: This screen visible after Click on “Internet Information Services (IIS) Manager”

Page | 48
Step-6: In IIS Manager select the Default Web Sites under Sites, and click on Bindings to
change the default port.

Step-7: Click on http port no. 80 to change it. (Because 80 port going to assign to the Historian
Client, so any other port no. e.g. 90 is assigned to default website)

Page | 49
Step-8: Change port no. to 90, and click on ok.

Step-9: Port no. changed, click on close button.

Page | 50
 Step-10: Right click on Sites after extending the PC name and select the Add Website option.

Step-11: Write the site name Historian.Client and select physical path
c:\inetpub\wwroot\Historian.Client.
Click on Test Settings… to test the connection.

Page | 51
Step-12: Authentication pass through message appear than Click the close button to close the
Test Connection window.

Step-13: Click ok to close Add website window.

Page | 52
Step-14: New website Historian.Client created, and visible under Sites.

Step-15: Right click on Application pool and select the Add Application pool.

Page | 53
Step-16: Write down the name of application pool as “Historian.Api”, and in .Net CLR version
select “No Managed Code”. Click “OK” to Add Application Pool.

Step-17: In IIS Manager, expand PC name and click on Application Pools, then Right click on
Historian.Client in Application Pools, and select Basic Setting.

Page | 54
Step-18: Change the .Net CLR version to “No Managed Code” and click “OK”.

Step-19: Right click on Historian.Api under the Default Web Site and select Convert to
Application.

Page | 55
Step-20: Click on “Select” button.

Step-21: Select the Historian.Api as Application Pool and click OK.

Page | 56
Step-22: Click OK to close the Add Application window.

Step-23: Right click on Historian.Retrival.Api and select Convert to Application

Page | 57
Step-24: Keep everything as it is, click OK to Add (Publish) Application.

Step-25: Go to the c:\inetub\wwroot folder and right click on Historian.Api folder.

Select Properties of Historian.Api folder.

Step-26: Go to Security tab and click on Edit button.

Page | 58
Step-27: Select the Add option (to add application as a user for providing rights of the folder)

Step-28: Write “IIS AppPool\Historian.Api as a user and click on Check Names.

Page | 59
Step-29: Historian.Api name will appear and click OK.

Step-30: Give the Full control to Historian.Api user by selecting it and click OK.

Step-31: Select Properties of Historian.Client folder.

Page | 60
Step-32: Go to Security tab and click on Edit button.

Step-33: Select the Add option (to add application as a user for the folder)

Step-34: Write IIS AppPool\Historian.Client as a user and click on Check Names.

Page | 61
Step-35: Historian.Client name will appear and click OK.

Step-36: Select the Add option again (to add application as a user for the folder)
Write IIS AppPool\Historian.Api as a user and click on Check Names.

Page | 62
Step-37: Historian.Api name will appear and click OK.

Step-38: Give the Full control to Historian.Client user by selecting them and click OK.

Step-39: Give the Full control to Historian.Api user by selecting them and click OK.

Page | 63
Step-40: Select Properties of HistorianRetrieval.Api folder.

Step-41: Go to Security tab and click on Edit button.

Step-42: Select the Add option (to add application as a user for the folder)

Page | 64
Step-43: Write IIS AppPool\DefaultAppPool as a user and click on Check Names.

Step-44: DefaultAppPool name will appear, and click OK.

Step-45: Give the Full control to DefaultAppPool user by selecting it, and click OK.

Page | 65
Step-46: Go to IIS Manager, select the Historian.Client website, and click on Browse to open the
Historian in Web.

Step-47: In default browser this screen appears.

Page | 66
Step-48: Go to SSMS.

Step-49: Copy your Server Name from SQL server.

Page | 67
Step-50: Paste the Server Name in XStudio Website.
Write the Server Username as “sa”
And Server password.

Step-51: Go to IIS Manager, select the Historian.Api website, and click on Browse.

Page | 68
Step-52: Copy the website link of the Historian.Api website.

Step-53: Paste the link of Historian.Api website to API End Point box in Historian.Client website,
remove http:// as it already there.
Click Next.

Page | 69
Step-54: Click on Choose File button and select the license file of Historian.

Page | 70
Step-55: Click on Save button.

Step-56: The screen of XStudio Historian appears.

Page | 71
Configure X Force Historian
Step-1: Open IIS manager, and select Historian.Client.
Click on Browser.

Step-2: Select X-studio from the drop down

Page | 72
 Step-3: Enter User Name and Password. (the default username is admin)

Step-4: Click on Configurator.

Page | 73
Step-5: Select the Master>Global Parameters from navigation tree.

Step-6: Add the Historian.Retrieval.Api website link in value.

Click on Save.

Page | 74
Step-7: Click on System Selection drawer and select Historian 3.0.

Step-8: Click on Configurator.

Click on the Master>Data Source Configuration.

Page | 75
 Step-9: Click on Edit button of Historian Retrieval row.

Step-10: Add the Historian.Retrieval.Api website link in Base url.

Check connection by clicking on Test connection.
Click on Save.

Page | 76
Step-11: Sign out from the X-Studio system.

Step-12: Go to the C: \ ProgramData \ SSM InfoTech Solutions Pvt. Ltd. \ X-Studio 5.0
Copy the ssmxforce.lic file.

Page | 77
Step-13: Go to the C: \ ProgramData \ SSM InfoTech Solutions Pvt. Ltd. \ Historian 3.0
Paste the License file in this folder.

Page | 78
 Historian Storage Engine Installation
Step-1: Open Historian.Server folder

Step-2: Click on Setup file (X-Force Historian Storage) and click on Next.

Step-3: Click on Next (Select Installation Folder)

Page | 79
Step-4: Click on Next (Confirm Installation)

Step-5: Click on Close button (Installation Complete)

Page | 80
 Collector Installation
Step-1: Open Folder Historian Collector

Step-2: Setup X-Force Historian Collector

Step-3: Click on Next

Page | 81
Step-4: Click on Next

Step-5: Click on Next (Confirm Installation)

Step-6: Click on Close (Installation Complete)

Page | 82
Step-7: Go to the services of the System.
Find out and start X-Studio Historian Collector Service.

Page | 83
Step-8: Go to the C: \ ProgramData \ SSM InfoTech Solutions Pvt. Ltd. \ Historian 3.0
Open the Collector_Config file in notepad.

Step-9: Copy the PC name (Server name) from SSMS.

Page | 84
Step-10: Paste the Computer name instead of Collector name in Collector_Config file.

Step-11: Go to system services.

Find out and start X-Force Historian Storage Service.

Page | 85
Step-12: Also start X-Force Historian Collector service.

Step-13: Check the status of X-Force Historian Collector service and X-Force Historian
Collector service both are Running.

Page | 86
INSTALLATION CHECKLIST
.Net Framework & IIS Installation
.Net SDK
.Net Hosting Bundle
.Net Runtime
SQL Sever
SSMS
Creating Database of X Force Historian
Publication of Application in IIS
Configure X Force Historian
Historian Storage Engine Installation
Historian Collector Installation

Page | 87