Installation and change control documentation requirements
- Last UpdatedFeb 25, 2025
- 2 minute read
During the installation procedure and as changes and patches or hotfixes are added to the system, it is important that you keep good records.
The spreadsheet shown on the following page is an example of an installation and change control record. Note how it identifies all major software components and identifies where they are installed.
It is also important to document any AVEVA hotfixes or patches that are installed. These typically do not appear in the Windows Add/Remove Programs Control Panel dialog box.
Note: Having complete installation records will help ensure that the components that are installed on your system are communicated to support engineers when troubleshooting problems or when determining whether a new hotfix that is being requested is compatible. For MES, most hotfixes as well as the current version information is stored in the db_status table.
This spreadsheet is intended to be used with the system topology diagram to provide a complete picture of the system. For an example of a system topology diagram, see Typical Medium-Size Plant.
Any one of these servers can be duplicated to scale out the solution. For example, there are often two database servers with one dedicated to the production databases and one for reporting databases. Other examples include a second Work Task Server for load balancing or multiple servers of the same type for load balancing.
The key to the servers listed in the columns is shown below.
-
DB: Database Server
-
AS: Application Server for System Platform-related software
-
TS: Terminal Server for client applications
-
WT: Work Tasks Server
-
WEB: Web Server
-
DEV: Development machine
|
Software |
Version |
DB01 |
AS01 |
TS01 |
WT01 |
WEB01 |
DEV01 |
|---|---|---|---|---|---|---|---|
|
Windows Components |
|||||||
|
Windows Server |
<insert version number> |
X |
X |
X |
X |
X |
|
|
Windows |
X |
||||||
|
Terminal Server/Licensing Server |
X |
X |
|||||
|
Activate Windows Licensing |
X |
X |
X |
X |
X |
X |
|
|
IIS (Internet Information Services) |
X |
||||||
|
.NET Framework |
X |
X |
X |
X |
X |
X |
|
|
Microsoft Message Queuing |
X |
X |
|||||
|
Additional Microsoft Software |
|||||||
|
Microsoft Office |
X |
||||||
|
Microsoft SQL Server |
X |
X |
|||||
|
Microsoft SQL Server - Reporting Services Standard |
X |
||||||
|
SharePoint |
X |
||||||
|
AVEVA Software |
|||||||
|
System Platform IDE |
X |
||||||
|
Application Server Galaxy Repository (GR) |
X |
||||||
|
Application Server Boot strap |
X |
X |
X |
||||
|
System Management Server [supports AVEVA Identity Manager (AIM)] |
X |
||||||
|
OMI (Operations Management Interfaces) and InTouch TSE |
X |
||||||
|
OMI and InTouch Failover System TSE |
X |
||||||
|
Historian and its Runtime database |
X |
X |
|||||
|
MES Database |
X |
X |
|||||
|
MES Middleware |
X |
X |
X |
X |
X |
||
|
MES Middleware Proxy |
X |
X |
X |
X |
X |
X |
|
|
MES Curation services |
X |
||||||
|
MES Reports |
X |
|
X |
||||
|
MES Client and applications |
X |
X |
|||||
|
MES Web Portal |
X |
||||||
|
Work Tasks Engine |
X |
||||||
|
Work Tasks Enterprise Console |
X |
||||||
|
Work Tasks Farm and repository databases |
X |
||||||
|
Work Tasks Extension and Connector for MES |
X |
||||||
|
MES model-driven application content |
X |
X |
|||||
|
Rabbit MQ and AMQP (Advanced Message Queuing Protocol) |
X |
||||||
|
BI Gateway |
X |
||||||
|
BI Gateway Database |
X |
||||||
|
Enterprise Integration |
X |
X |
|||||
|
Operation Integration (OI) Server for communication with Programmable Logic Controllers (PLCs) |
X |
||||||
|
License Server (can be located on any node except DEV01) |
NO |
||||||
|
License Manager (can be located any node, except DEV01, that has external Internet access to the AVEVA Activation Server) |
NO |
||||||