Professional Documents
Culture Documents
Aveva Unified
Aveva Unified
7 Installation Guide
aveva.com
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved.
No part of this documentation shall be reproduced, stored in a retrieval system, or transmitted by any means,
electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of AVEVA.
No liability is assumed with respect to the use of the information contained herein.
Although precaution has been taken in the preparation of this documentation, AVEVA assumes no responsibility
for errors or omissions. The information in this documentation is subject to change without notice and does not
represent a commitment on the part of AVEVA. The software described in this documentation is furnished under
a license agreement. This software may be used or copied only in accordance with the terms of such license
agreement.
ArchestrA, Avantis, Citect, DYNSIM, eDNA, EYESIM, InBatch, InduSoft, InStep, IntelaTrac, InTouch, OASyS,
PIPEPHASE, PRiSM, PRO/II, PROVISION, ROMeo, SIM4ME, SimCentral, SimSci, Skelta, SmartGlance, Spiral
Software, WindowMaker, WindowViewer, and Wonderware are trademarks of AVEVA and/or its subsidiaries. An
extensive listing of AVEVA trademarks can be found at: https://sw.aveva.com/legal. All other brands may be
trademarks of their respective owners.
Publication date: Thursday, September 22, 2022
Publication ID: 1007559
Contact Information
AVEVA Group plc
High Cross
Madingley Road
Cambridge
CB3 0HB. UK
https://sw.aveva.com/
For information on how to contact sales and customer training, see https://sw.aveva.com/contact.
For information on how to contact technical support, see https://sw.aveva.com/support.
To access the AVEVA Knowledge and Support center, visit https://softwaresupport.aveva.com.
Contents
Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Assumptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Guide Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
AVEVA Licensing System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
AVEVA Flex Licensing. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Font Size. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 3
AVEVA™ Engineering 15.7 Installation Guide
Contents
Language Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Setting AVEVA Engineering Default Text Format. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Prepare AVEVA Engineering For Legacy PDMS Databases. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 4
1 Introduction
The AVEVA Engineering Installation Guide explains how to install and set up AVEVA Engineering on a workstation
running Microsoft Windows. For completely up-to-date information, refer to the AVEVA Website at and the
Customer Support Hardware pages.
Assumptions
The AVEVA Engineering Installation Guide assumes that:
• Users are familiar with the concepts of folder/file hierarchies for storing data on disks and with basic
Windows terminology and commands. If not, the user can also refer to the operating system documentation
while carrying out the installation.
• Users have already gained access to the installation files for AVEVA Engineering via the AVEVA Download site.
• Users have Local Administrator rights.
• Adobe PDF Reader is installed.
Guide Structure
The AVEVA Engineering Installation Guide is divided into the following sections:
Requirements lists the hardware and software requirements.
AVEVA Engineering Installation describes how to install and license the software.
Set Up the Windows Environment explains how to configure the Windows operating system
before running AVEVA Engineering.
Language Support describes how to set up the Windows Environment to use
AVEVA Engineering with different Language options.
Run AVEVA Engineering Under Windows gives some advice on using AVEVA Engineering in a
Windows environment.
Structure of AVEVA Engineering on .NET outlines the way in which AVEVA Engineering is installed
and configured in a Microsoft NET environment.
Tag Management Register Installation describes how to install and configure the Tag
Management Register software.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 5
2 Requirements
AVEVA Engineering operates on Windows 10 and Windows Server 2019. AVEVA Engineering will operate with
less but system performance will be compromised.
AVEVA Engineering uses Microsoft .NET Framework version 4.8 (supplied with AVEVA Engineering and installed if
necessary). Refer to AVEVA Engineering Installation for installation instructions.
Note: Serialized settings of the user interface configuration are saved in the following location on Windows 10:
C:\Users\<username>\AppData\Local\Aveva\Engineering\15.7
Note: Microsoft .Net Framework 4.8 can only be installed on Windows 10 versions 1607 and above.For Windows
10 Versions 1903 and above, .NET Framework 4.8 is preinstalled.
To check the windows 10 Version for the PC, type winver in the Start menu search box and then press enter to
display the About Windows window.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 6
AVEVA™ Engineering 15.7 Installation Guide
Requirements
A minimum screen resolution of 1280x1024 is recommended, although most users use either two such screens
or a wide-screen (1920x1200) display.
Internet Explorer 8 or later is also required.
If AVEVA Engineering is installed with AVEVA Database Cache Service the user must activate Microsoft Message
Queuing (MSMQ) as a prerequisite of the installation. Refer to the Database Cache Service Installation Guide for
further information.
The user interface requires the use of the Arial Unicode MS font, which is supplied with Microsoft Office (version
2000 onwards) and is usually installed automatically. If this font is not installed, some of the text in the user
interface may become illegible.
The layout of some GUI forms may also be adversely affected if the screen font size is not set to the smallest size,
which is usually default. Refer to Font Size for further information.
Graphics cards
AVEVA Engineering requires 3D graphics hardware, capable of running DirectX 11, to ensure optimum
performance for both design and drafting. DirectX 11 is included as an integral part of the Windows 10 operating
systems.
AVEVA strongly recommends that appropriate hardware is used for AVEVA Engineering.
If appropriate graphics hardware is not detected on entry, AVEVA Engineering may still be used but the displayed
warning is given and certain graphical effects, including use of laser data is limited.
Following extensive testing of current market Graphics Cards and AVEVA Engineering, a recommended
configuration is summarised in the table below.
Desktop Laptop
Graphics Card
nVIDIA® Quadro® K600. nVIDIA® Quadro® K1000M.
"AMD FirePro™ V3800 or V3900. "AMD FirePro™ M2000.
AVEVA strongly recommends that clients should test their chosen card or laptop in their own environment before
purchase.
Availability and support of graphics cards changes frequently; a full updated list of graphics cards that have been
verified with AVEVA Engineering is available via the IT Configuration area of the AVEVA Support Site ().
PC Configuration
OS Windows 10
CPU Intel x64 compatible - CPU with high performance in each processor core.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 7
AVEVA™ Engineering 15.7 Installation Guide
Requirements
Display High resolution widescreen display recommended (1920 x 1200); dual screens also
supported. Minimum resolution 1280x1024.
File System NTFS.
Network Gigabit Ethernet (GbE) LAN.
Firewall Microsoft ICF disabled.
Other Mouse - three button with a scroll wheel.
Server Configuration
OS Windows Server 2019.
CPU Modern architecture multiple core processors recommended.
RAM 32 GB RAM. Additional RAM increases the caching capability and thereby the performance.
HDD The amount of disk space should be configured according to the customer's requirement
based on the number and size of projects. To secure data and improve performance, the use
of RAID 0+1 or 5 storage is recommended; 15k rpm drives are preferred.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 8
AVEVA™ Engineering 15.7 Installation Guide
Requirements
• There is a large degree of change between AVEVA Engineering 14 and 15 series. This means it might not be
appropriate to simply point AVEVA Engineering 15 software at projects that have ENGI databases created
with AVEVA Engineering 14.2 or earlier. If this is done, it is possible that database corruption could occur.
This would show up in DICE reports as Fatal Errors. Repair will require a Reconfigure process, which could be
significant and encompass all project databases. The steps required to avoid corruption vary depending on
project structure/content, please discuss your exact needs with AVEVA Technical Support.
• The Mandatory/Optional Upgrade process does not transform database content. It sets a flag on the
database that stops earlier software versions being used. It is optional so that you keep the option to be able
to switch back to an earlier version of software if you see any risk in using new software versions.
Note: If you do use the Mandatory/Optional Upgrade on a database, you cannot Undo that transaction.
AVEVA strongly recommends having a full back-up available should you want to secure the ability to return to
the database using previous software versions.
The AVEVA Engineering group is reviewing documentation relating to data and project upgrade processes.
However, AVEVA strongly recommends to contact your local AVEVA Technical Support when considering a project
or database upgrade, particularly if you are moving to the AVEVA Engineering 15 series.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 9
AVEVA™ Engineering 15.7 Installation Guide
Requirements
Font Size
During the installation of Windows 10, the install process decides what it believes to be the best setting for the
font size and sets this as the Default. AVEVA recommends to keep the default, that is 100% display size.
To change the default setting, right-click on the desktop, then from the displayed menu select Display Settings.
The Display window is displayed, modify the display settings to those displayed. If any changes are made, click
Keep Changes.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 10
AVEVA™ Engineering 15.7 Installation Guide
Requirements
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 11
3 AVEVA Engineering Installation
AVEVA Engineering is supplied via the AVEVA Download site. It is recommended that the user carefully read all of
the Installation instructions before installing the software.
It is recommended that the default settings are used for folder paths etc., unless the user has good reasons for
doing otherwise.
Manual installations can be easier if run from the Setup.exe program. Each Setup.exe checks and installs the
dependencies of its primary installation (like the .NET framework), before running its primary (MSI) installation.
Users should never see missing dependency errors if installations are started from the Setup.exe program.
Setup.exe also tells the primary installation to target the C:\ drive/volume, which is the preferred default in most
manual installations. However, if a more customised installation is required then running the primary MSI
directly becomes the better approach. In such cases, run time dependencies (like the .NET framework) must be
deployed beforehand.
AVEVA Engineering will not work if it is installed on a drive other than the C:\ drive with spaces in the installation
path.
.ETAP Import/Export
Initially during the installation of Engineering 15.x, only the export related files, 'ETAPExportTrans.xslt' and
'ValueValidation.xml' were placed in the installation directory, for example "C:\Program Files
(x86)\AVEVA\Engineering15.x".
Now the Export and Import related files (ETAPExportTrans.xslt, ValueValidation.xml; ETAPImportTrans.xslt,
ETAPAttribute.xml. ETAPImportTrans.xslt and ValueValidation.xml files) are placed in the following locations.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 12
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
Export
ETAPExportTrans.xslt A translation file which converts the AVEVA Engineering data into a
format ETAP can interpret.
Import
ETAPAttribute.xml Contains all the ETAP attributes which are used to map to their
corresponding AVEVA Engineering attributes.
ETAPImportTrans.xslt A translation file which converts the ETAP data into a format AVEVA
Engineering can interpret.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 13
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
Open the ndp48-x86-x64-allos-enu.exe file to display the User Account Control window.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 14
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
After the download has been completed, the Microsoft .Net logo is displayed followed by the Microsoft .Net
Framework window.
The user must read the License Terms and then select the I have read and accept the license terms check box to
continue the installation.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 15
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
After clicking Install, the Microsoft .Net Framework window displays task bars showing the status of the
installation.
Once the installation has completed, the Microsoft .Net Framework window displays a message confirming the
user has finished the installation of Microsoft .Net Framework.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 16
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
The computer must be restarted to complete the Microsoft .Net Framework installation.
Note: For the purposes of this section of the installation guide the windows displayed during the installation
have the version number obscured. However the information and functionality available from the windows are
applicable to this version.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 17
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
The AVEVA Engineering Setup Wizard activates at this point and guides the user through the installation of the
product.
Click Back to step back a stage, Cancel to terminate the Setup Wizard or Next to display the Client Cache Service
screen.
If Microsoft Message Queuing Service (MSMQ) is enabled the Client Cache Service screen confirms this.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 18
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
If MSMQ is not enabled the Client Cache Service screen displays a warning that the service is not enabled.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 19
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
To enable MSMQ, click Programs and Features to display the Control Panel.
In the left hand pane, click Turn Windows features on or off to display the Windows Features.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 20
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
Select all of the Microsoft Message Queue (MSMQ) Server check boxes to enable the Microsoft Message Queue
(MSMQ) Server Core component.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 21
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
The user must read the End-User License Agreement and then select the I accept check box to activate Next.
Note: If the user does not select the check box, Next will not activate and the installation cannot continue.
After clicking Next the Custom Setup screen is displayed.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 22
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
The default installation and its location is displayed in the Custom Setup screen.
To change the installation click the icons in the tree, to change the location of the installation, click Browse to
navigate to the required location.
Click Reset to return to the defaults.
Click Disk Usage to display the use of the hard drive.
Click Back to step back a stage, Cancel to terminate the Setup Wizard or Next to display the Initial Configuration
screen and continue the installation.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 23
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
The Initial Configuration screen allows the user with existing projects and infrastructures to customise the
installation.
De-selecting the Install setup files and: check box deactivates the Start Menu Shortcuts and the Desktop
Shortcuts options. Both options are dependent on the setup files being installed.
De-selecting the Start Menu Shortcuts check box deactivates the Desktop Shortcuts option. The option is
dependent on the Start Menu Shortcuts being installed.
Clicking Browse displays the Change Destination Folder window which allows the user to select a different folder
name and location path.
Click Back to step back a stage, Cancel to terminate the Setup Wizard or Next to display the Additional Software
screen.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 24
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
Check the box to install the SEE Electrical 3D Panel+ v2r2 SP2 software.
Note: Choosing this installation option will automatically install SEE Electrical 3D Panel+ v2r2 SP2 software at the
end of the AVEVA Engineering installation.
Click Back to step back a stage, Cancel to terminate the Setup Wizard or Next to display the License
Configuration screen.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 25
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
Click Back to step back a stage, Cancel to terminate the Setup Wizard or Install to display the Installing AVEVA
Engineering screen.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 26
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
The Installing AVEVA Engineering screen displays a taskbar showing the status of the installation.
During the installation process the screen displays Cancel, which can be clicked to stop the installation. When
selected a window is displayed asking for confirmation that the installation is to be cancelled.
Selecting Yes displays a screen showing the AVEVA Engineering Setup Wizard was interrupted.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 27
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 28
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
The user has the option to download the latest projects which are compatible with AVEVA Engineering. To do
this the user must select the Download the latest Projects check box and click Finish.
A web browser window is displayed, select Save then Run.
The Windows Installer Installation Wrapper window is displayed, showing the progress of the download, which
the user can stop by clicking Cancel.
After the download has been completed, the Windows Installer Download Bootstrap Security Warning window
is displayed.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 29
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
Click Run to install the latest projects, the Windows Installer window is displayed showing the progress of the
installation, which the user can stop by clicking Cancel or click Don’t Run to cancel the installation.
After the installation has completed the AVEVA™ Projects Setup screen is displayed.
Click Cancel to terminate the Setup Wizard or Next to display the Custom Setup screen.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 30
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
The Custom Setup screen displays every configurable aspect of the installation. Configurable Features are
displayed on the left hand side of the window, in a control called the SelectionTree. Refer to for further
information. Each feature is depicted as a box with a description of the feature displayed in the right hand pane.
The boxes representing each feature are depicted as follows:
- Feature will be installed (Locally)
Will be installed on local hard drive Selecting this option will install the feature locally.
Entire feature will be installed on local hard drive Selecting this option will install the feature and all its sub-
features locally.
Entire feature will be unavailable Selecting this option prevents the current feature and all
its sub-features from installing.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 31
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
Click Back to step back a stage, Cancel to terminate the Setup Wizard or Install to display the Installing AVEVA™
Projects screen.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 32
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
The Installing AVEVA™ Projects screen displays a taskbar showing the status of the installation.
During the installation process the window displays Cancel, which can be clicked to stop the installation. When
selected, a window is displayed asking for confirmation that the installation is to be cancelled.
Selecting No on the confirmation window returns the user back to the Installing AVEVA™ Projects screen and
continues the installation.
Selecting Yes displays a window showing the AVEVA™ Projects Setup Wizard was interrupted.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 33
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 34
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
The user should refer to the APS_Project_description.pdf and ACP_Projects_description.pdf for further
information. These files are installed during the installation of the projects in the location selected by the user.
AVEVA LaaS/Flex licensing is available for the SEE Electrical 3D Panel+ application.
Log File
During the installation, setup.exe creates a log file of the installation in the users TEMP directory named
Engineeringxx.x.log. To locate the log file, type %TEMP% in the Windows search text field.
Uninstall
Complete removal of an installation can be accomplished by several methods.
• Removing it from the Control Panel via the Add or Remove Programs option in the usual way. To open the
Control Panel, type Control Panel in the Start menu search box and then press enter.
• Right clicking on the MSI file that installed it, and selecting Uninstall
• Running the command MSIEXEC /X [Path to Original MSI]
• Running the command MSIEXEC /X {ProductCode of MSI}. Refer to for further information.
Removal of individual Features is also possible from the command Line, using the REMOVE property or by
changing the installation state via the Add/Remove Programs options.
Note: Uninstalling the AVEVA Engineering installation will not uninstall Microsoft's .NET Framework or
downgrade the Windows Installer Service. The .NET Framework must be removed separately if required.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 35
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
Click Cancel to display a Confirmation window. Click Yes to cancel or No to return to the setup screen.
Click Next to display the Change, Repair, or Remove Installation screen.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 36
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
Change Displays the Custom Setup screen, which allows the user to change which features that are
installed.
Repair Displays the Reinstall or Repair AVEVA Engineering screen, which allows the user to repair any
errors in the most recent installation by fixing missing and corrupt files, shorts and registry
entries.
Remove Displays the Ready to remove AVEVA Engineering screen which allows the user to remove the
installation.
Note: Never move files by other means, as this may trigger healing, however Copying files to other locations will
not cause problems.
Change
There are several ways to change an installation. For example:
• Change it from Control Panel via the Add or Remove Programs option in the usual way. To open the Control
Panel, type Control Panel in the Start menu search box and then press enter.
• Right clicking on the MSI file that installed it, and selecting Install, then selecting Change at the subsequent
window.
• Running the command MSIEXEC /I [Path to Original MSI], then selecting Change at the subsequent window.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 37
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
• Running the command MSIEXEC /I {ProductCode of MSI}, then selecting Change at the subsequent window.
Refer to for further information.
Once the Change option is selected, the Custom Setup screen is displayed, allowing the user to change which
features that are installed. The functionality of the Custom Setup screen is described at the beginning of the
AVEVA Engineering Installation section of this Installation Guide.
Repair
Repair of an installation can be accomplished by several methods:
• Repair it from Control Panel via the Add or Remove Programs option in the usual way. To open the Control
Panel, type Control Panel in the Start menu search box and then press enter.
• Right clicking on the MSI file that installed it, and selecting Repair.
• Running the command MSIEXEC /I [Path to Original MSI], then selecting Repair at the subsequent window.
• Running the command MSIEXEC /I {ProductCode of MSI}, then selecting Repair at the subsequent window.
Refer to for further information.
Once the Repair option is selected the Reinstall or Repair AVEVA Engineering screen is displayed, allowing the
user to repair any errors in the most recent installation by fixing missing and corrupt files, shorts and registry
entries.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 38
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
The functionality allows the user to reinstall the application, detect and repair any errors in the most recent
installation and repair shortcuts.
Note: The default is the detect and repair option.
Click Next to display the Ready to repair AVEVA Engineering screen.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 39
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
Click Repair to repair the installation, the Repairing AVEVA Engineering progress window is displayed.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 40
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
When prompted click Next, once the repairs have been completed, click Finish.
Remove
Displays the Ready to remove AVEVA Engineering window which allows the user to remove the installation.
Note: Never move files by other means, as this may trigger healing, however copying files to other locations will
not cause problems.
Healing
MSI technology has in built self repairing mechanisms. As such it is generally unwise to alter file and folder
names, shortcuts or registry manually, as this may trigger the MSI which deployed the files to redeploy them.
However, it is expected that some users will want to alter Appware, Sample Data, shortcuts and .bat file
variables. As such, AVEVA installations have been designed to minimise the ability of the MSI to heal itself in such
cases.
Sample Data, Models, example projects and shortcuts, should not trigger healing if they are deleted or altered.
The consequence of making shortcuts editable/deletable is that MSI Advertising will not function.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 41
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 42
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 43
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
The installation’s media (deployable files) is unpacked into a subfolder beneath the regenerated .msi file, rather
than stored in external .cab files or in .cab files embedded within the .msi file itself. The resultant folder structure
created resembles that which a (Typical) local deployment would create by default.
Administrative installations do not become installed onto the computer which spawned it. They only transform
the source installation into an uncompressed variant of itself during this process.
Create an Administrative Installation Point
To create an admin installation from an installation, start the installation from the Command Window as follows
to display the AVEVA Engineering Administration Point Setup screen:
MSIEXEC /A [Path to MSI File]
Click Next to display the AVEVA Engineering Administration Point Distribution screen.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 44
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
Enter the location where the Admin Installation is to be created. Clicking Browse displays a window allowing the
user to navigate to the required location.
Click Install to start the installation.
Conversely, the following Command Line will achieve the same result quietly:
MSIEXEC /A [Path to MSI File] /QN TARGETDIR=[Path to Admin Installation]
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 45
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
disable the digital signature validation. To enable digital signature validation the command line option
CERTIFICATECHECK=1 should be set.
Using Files within the Source Installation
MSI databases can be authored to allow Features to be installed in the "Will be installed to run from network"
state. AVEVA Installations do not currently support this mode; however it may be made available if requested.
The "Will be installed to run from network" option is otherwise known as run-from-network. In this mode, files
are not copied onto the target computer, but registry, shortcuts and file edits do occur on the target computer,
and they address the programs which reside inside the source installation.
Network Throughput
Admin installations often cross networks more efficiently than large compressed installations. However AVEVA
installations are highly compressed and comply with the recommended file size limits. So Admin Installations are
not recommended purely for deployment purposes. Unless there is a requirement to run programs over a
network, Admin Installations are discouraged.
Advantages of a Network Installation
Once computers address files across a network, it becomes crucial that the files are accessible
whenever required. This then begs questions regarding:
• Network Reliability
• Network Performance
• File Server Reliability
• File Server Performance
• Change Synchronisation
• Change Granularity
Common reasons for storing programs on file Servers are:
• To avoid the network loading of large and un-staggered rollouts.
• To guarantee the user base is working with the same files.
• To prevent tampering with programs and settings.
• To maintain a tradition.
All of these issues are of course resolvable with locally deployed applications
Note: Direct editing of .msi's is discouraged in favour of Transforms (.mst files) because it will invalidate the
installation certificates.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 46
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 47
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 48
AVEVA™ Engineering 15.7 Installation Guide
AVEVA Engineering Installation
A most definitive reference to MSI Command Line arguments can be found, refer to for further information. The
following examples have been tested, but are only intended to demonstrate general Command Line principles.
In Windows 10 and Windows Server 2019 make sure that the command line has been opened using the option
Run as administrator so that the silent install application has the correct User Access Control (UAC).
Example 1: Installing AVEVA Engineering with a custom installation directory and Projects
directory setting an All Users License Server
msiexec /i "Full Path to .MSI file" PRODUCTDIR=D:\ENG141 PROJECT=D:\Projects LICENSETYPE=0
LICENSESERVER=744@LicenseServer /qb!-
Example 2: Installing the product & projects to different locations, setting users writeable areas
to a separate drive, configuring a License Server and not creating Desktop Shortcuts
The installation will run without user intervention and generate a log file in the Users Temp directory.
Installs all Features to the C:\
msiexec /i "Full Path to .MSI file" PRODUCTDIR= "%ProgramFiles%\AVEVA\Engineeringxxxx"
PROJECT=D:\Projects AVEVA_DESIGN_DFLTS=D:\DFLTS AVEVA_DESIGN_USER=D:\USERDATA LICENSETYPE=0
LICENSESERVER=744@LicenseServer DESKTOPSHORTCUTS=0 /qb!- /l %temp%\Engineering.log
Example 3: Removing an Installation
msiexec /x "Full Path to .MSI file" /qb!-
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 49
4 Set Up the Windows Environment
Setting up the Windows Environment section describes how to configure the Windows operating
system before running AVEVA Engineering. Following the installation of AVEVA Engineering, the user
should perform the following steps:
• Check the settings for the graphics board: Refer to Windows Control Panel.
• Check the license environment. Refer to Set the License File Location.
• Configure Windows parameters for AVEVA Engineering: Refer to Environment Variables.
• The user can then run AVEVA Engineering by clicking on the AVEVA Engineering shortcut or icon, which will
set up the remaining environment variables required.
Note: In the following instructions it is assumed that AVEVA Engineering has been installed in folder
C:\Program Files (x86)\AVEVA\Engineeringxxx. If it has been installed elsewhere, substitute C:\Program
Files (x86)\AVEVA\Engineeringxxxx with the name of the installation folder.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 50
AVEVA™ Engineering 15.7 Installation Guide
Set Up the Windows Environment
Once the Path variable includes the folder, the user can run AVEVA Engineering by typing Engineering at a
command prompt.
Environment Variables
AVEVA Engineering uses Windows Environment variables to locate folders containing AVEVA Engineering system
files and users project data. This allows the user to locate these folders anywhere on the file system. The default
location for AVEVA Engineering system files is C:\Program Files (x86)\AVEVA\Engineeringxxxx, unless the default
location was changed during the installation.
AVEVA Engineering is supplied with a file evars.bat which sets default values for the environment variables so
that they point to the folder structure as installed. It also sets the PATH variable to include the
AVEVA_DESIGN_EXE folder containing AVEVA Engineering executables.
The user may need to modify this file to reflect the folder structure of their own installation. The following is a
list of the variables the user may need to reset, with a brief description of each one and the default setting.
Note: all environment variables must be entered in UPPERCASE.
Search Paths of Folders Containing Spaces
Search paths of folders can contain spaces, by using a semicolon as the separator between folders, for
example:
set PMLUI=C:\Local AVEVA Engineering\Appware;M:\Project AVEVA Engineering\Appware;
a:\Company AVEVA Engineering\Appware
Note: that in order to define an environment variable that contains just one item including spaces, it must
explicitly include a final semicolon. For example:
set PMLUI=C:\Local AVEVA Engineering\Appware;
Length of Search Path Environment Variable
The lengths of AVEVA Engineering search path environment variables can be up to a maximum of 5120
characters.
Recursive Expansion of Environment Variables
An environment variable defining a search path can itself contain references to other environment
variables. For example:
set MPATH=%ROOT%\Standard Version;%ROOT%\Update Version
set ROOT=C:\Program Files (x86)\AVEVA; (note final semicolon)
Then on AVEVA Engineering:
*$m%MYPATH%\mac
Will check in turn for:
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 51
AVEVA™ Engineering 15.7 Installation Guide
Set Up the Windows Environment
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 52
AVEVA™ Engineering 15.7 Installation Guide
Set Up the Windows Environment
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 53
AVEVA™ Engineering 15.7 Installation Guide
Set Up the Windows Environment
This will start AVEVA Engineering, then wait until it has finished before resuming the script.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 54
5 Language Support
AVEVA Engineering uses Unicode for character storage throughout, with the exception of data migrated from
older versions of PDMS. This simplifies its installation so that, in general, no special settings are required, other
than making sure that the appropriate language support is installed in Windows.
There are aspects of the Unicode standard that are not yet implemented. AVEVA Engineering currently
handles the following correctly:
• Left to Right languages; and therefore not, for example, Arabic and Hebrew
• Pre-composed characters; for example, the single character á but not the combiners a + ' => á
• Upper and lower casing of characters, where both cases have the same number of bytes
CADC_LANG_NEW Specifies the file encoding for new files written. If the variable is unset, the default
is Unicode UTF-8 format with a BOM present.
These variables may be set to a variety of values:
UTF8 Unicode UTF-8 (the default)
UTF16LE UTF-16 little-endian
UTF16BE UTF-16 big-endian
UTF32LE UTF-32 little-endian
UTF32BE UTF-32 big-endian
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 55
AVEVA™ Engineering 15.7 Installation Guide
Language Support
LATIN1 ISO8859-1
LATIN2 ISO8859-2
LATIN3 ISO8859-5 Cyrillic
JAPANESE Japanese Shift-JIS
CHINESE Simplified Chinese (EUC)
KOREAN Korean (EUC)
TCHINESE Traditional Chinese (used in Taiwan for example) (EUC)
CP932 Japanese Shift-JIS
CP936 Simplified Chinese GBK
CP949 Korean
CP950 Traditional Chinese Big5
CP1250 Central European
CP1251 Cyrillic
CP1252 LATIN-1 + some extras (beware)
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 56
Run AVEVA Engineering Under Windows
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 57
6 Structure of AVEVA Engineering on .NET
The AVEVA Engineering UI uses the Microsoft .NET Framework environment including the latest WinForms/
Infragistics based user interface components. Using the state-of-the-art Infragistics technology enables docking
windows and provides a robust foundation for the future provision of standard application programming
interfaces.
Overview
Overview describes the overall structure and components of the AVEVA Engineering .NET installation, and the
environment necessary to run it. Each AVEVA Engineering GUI module now consists of a .NET module, .NET
interface and addin assemblies and native dlls plus some other shared components including 3rd party controls
from Infragistics. The .NET components are private assemblies installed under the root directory
%AVEVA_DESIGN_EXE%.
AVEVA_DESIGN_EXE
As before the environment variable %AVEVA_DESIGN_EXE% is used to locate the executable on module switch. It
is also used to locate attlib.dat (attribute and noun definitions), message.dat (message definitions), desvir.dat
(schema definition) etc. Normally AVEVA Engineering is started from engineering.bat which is located in the
user’s %PATH%. Both %AVEVA_DESIGN_EXE% and %PATH% should include the install directory.
UI Module Structure
Each UI module is now structured in the same way. The basic structure for each module looks like this.
where all components are installed in the %AVEVA_DESIGN_EXE%. directory. So, when running a AVEVA
Engineering GUI module %AVEVA_DESIGN_EXE% is used to locate the executable, .NET loading rules are used to
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 58
AVEVA™ Engineering 15.7 Installation Guide
Structure of AVEVA Engineering on .NET
load the interface assemblies and Win32 DLL loading rules are used to load the native components (and other
Win32 DLLs on which Aveva.Core.dll depends).
Native DLLs
Native dlls are loaded using Win32 DLL loading rules. These are:
• The directory from which the importing component loaded.
• The (application's) current directory (where it’s run from)
• The Windows directory (default: C:\Windows) (we don’t install anything here)
• The directories that are listed in the PATH environment variable
Therefore normally the %PATH% is used to locate native dlls. This is normally set in evars.bat located in the
installation directory. Having different versions of AVEVA_DESIGN_EXE in the %PATH% may cause
System.IO.FileLoad exceptions where components are loaded from different directories.
These rules apply to pdms.dll and all dependencies.
Components
All components are installed in the %AVEVA_DESIGN_EXE% directory including .NET interfaces and addins,
Infragistics assemblies and native components.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 59
7 Tag Management Register Installation
The Tag Management Register must be installed and configured before the TMR service can be used. If installing
an new engineering build then a matching TMR installation is required.
Launch TMRSetup.msi, the AVEVA Tag Management Register Setup Wizard activates at this point and guides the
user through the installation of the service. Click Cancel to terminate the setup or Next to display the End-User
License Agreement window.
The user must read the End-User License Agreement and then click to select the I accept the terms in the
License Agreement check box to activate Next.
Note:
If the user does not select the check box, Next will not activate and the installation cannot continue.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 60
AVEVA™ Engineering 15.7 Installation Guide
Tag Management Register Installation
After click Next the Destination Folder window is displayed, the default installation and its location is displayed.
Click Change to navigate to another location, click Back to return to the End-User License Agreement window or
click Next to display the Ready to install AVEVA Tag Management Register window.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 61
AVEVA™ Engineering 15.7 Installation Guide
Tag Management Register Installation
Click Install to proceed with the installation, click Back to return to the previous window or click Cancel to
terminate the installation.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 62
AVEVA™ Engineering 15.7 Installation Guide
Tag Management Register Installation
The Status taskbar shows the progress of the installation, if required the installation can be terminated click
Cancel and then click Yes to cancel the installation. Once the TMR service has been successful installed, a
window is displayed confirming the installation of the TMR Service.
Click the TMR shortcut, the TMR service manager window is displayed, use the functionality to install and
manage TMR service.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 63
AVEVA™ Engineering 15.7 Installation Guide
Tag Management Register Installation
Click Install, the Install/Configure window is displayed, use the functionality to configure the TMR service (To
install the TMR service with https, refer to TMR Service - HTTPS Configuration).
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 64
AVEVA™ Engineering 15.7 Installation Guide
Tag Management Register Installation
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 65
AVEVA™ Engineering 15.7 Installation Guide
Tag Management Register Installation
Db type: Select the datasource for the TMR service, in the production environment a Sql Server should be
selected, SQL lite can be selected for test and development environment as recommended in the Install/
Configure window.
Sql server - If Sql server is selected as the datasource for TMR service then some connection parameters are
required (refer to SQL Server Configuration) to configure the pre-requisites for this section.
Name/Address - the name/address of the SQL server for example - AUMELLCU0750\SQLEXPRESS17.
Admin username - enter the login name of a SQL server login that has privilege's to create a database.
Admin password - enter the SQL server authentication password of the admin user.
Note:
The admin username and password is not stored it is only used once to create the service database.
Connection username - enter the Login name of a SQL server login that will be used to read/write to service
database.
Note:
This user is created in SQL Server if it does not already exist. It is strongly recommended that an existing
username is provided as per the policy of this interface. If an existing user is used then an extra step needs to be
executed in SQL Server Management studio to associate the user with service database, this step should be
executed after an successful install and before starting the service, refer to Granting Access to an Existing SQL
Server User.
Connection password - enter the SQL server authentication password of the connection user. If an existing
username is used then the entered password must be exactly the same as it is in the SQL Server for the existing
username.
Note:
The Connection username and password is stored as encrypted string in the appsettings.json config file
Connection encrypt - Only check this check box if TLS Encryption between Service and SQL Server is required.
For this option to work some configuration for SQL Server is required, refer to Enable TLS Encryption between
Service and SQL Server.
Upon successful installation, the service is available for selection in the TMR service manager window.
Select the TMR service in the TMR service manager window, click Start to start the selected TMR service, if
successful the status of the TMR service is displayed as 'Running'
If the service does not start, click Event Log to troubleshoot any issues.
To refresh the TMR service, the TMR service manager window, click Refresh.
To uninstall the TMR service select the service in the TMR service manager window, click Uninstall.
To stop the TMR service select the service in the TMR service manager window, click Stop.
To test a connection select the TMR service in the TMR service manager window , click Test connection
(Swagger page for the URL).
To edit the logon details, select the TMR service in the TMR service manager window then click Edit logon
details to display the Edit Login Details window use to edit the login details.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 66
AVEVA™ Engineering 15.7 Installation Guide
Tag Management Register Installation
Note:
If the project name needs to modified log in into the Lexicon module navigate to Home > Standards
modify
the existing TMR ProjectNameKey and save the change.
Once the modification has been done copy both 9100 and 9101 files from the databases folder in the AVEVA
Administration installation location and replace them in the AVEVA Engineering installation's databases folder,
so that the url and project name can be given under the settings.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 67
AVEVA™ Engineering 15.7 Installation Guide
Tag Management Register Installation
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 68
8 SQL Server Configuration
In the production mode, the TMR service must use the SQL server as its data source.
1. Download SQL server express from . The SQL Server 2019 window is displayed.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 69
AVEVA™ Engineering 15.7 Installation Guide
SQL Server Configuration
4. Install SQL Server Management Studio (SSMS) (that is compatible with SQL server 2019, if not already
installed).
Note:
Installing SSMS is optional but it can be helpful when troubleshooting any connectivity issues for the SQL
server and also aids the creation of logins required by the TMR service.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 70
AVEVA™ Engineering 15.7 Installation Guide
SQL Server Configuration
5. Download the SSMS installer and install, upon successful installation the setup completed window is
displayed.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 71
AVEVA™ Engineering 15.7 Installation Guide
SQL Server Configuration
6. Run SQL Server management studio, the Connect to Server window is displayed
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 72
AVEVA™ Engineering 15.7 Installation Guide
SQL Server Configuration
7. Enter the server name (which is made up of two parts – the instance name – step three and the machine
name for example machine name: INHYZD311and the SQL Server Instance Name SQLEXPRESS01).
8. Click Connect.
9. From the Object Explorer of the Microsoft SQL Server Management Studio window, select the server name.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 73
AVEVA™ Engineering 15.7 Installation Guide
SQL Server Configuration
10. Right click and select Properties to display the Server Properties window.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 74
AVEVA™ Engineering 15.7 Installation Guide
SQL Server Configuration
11. From the Select a Page pane of the Server Properties window, select Security.
12. Select the SQL Server and Windows Authentication mode radio button.
13. Click OK.
14. A restart message is displayed, click OK.
15. From the Object Explorer, right click on the server name, select Restart.
16. Once the server has restarted, from the Object Explorer expand Security > Logins folder.
17. Right click sa login and select Properties to display the Login Properties.
Note:
Inbuilt 'sa' user has elevated privileges, hence is should be used with caution. In the production environment
the 'sa' user should not be used, database admin should setup a different user that has privileges to create a
database and can provide other users access to this database.
18. From the Select a page pane of the Login Properties window, select the Status page.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 75
AVEVA™ Engineering 15.7 Installation Guide
SQL Server Configuration
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 76
AVEVA™ Engineering 15.7 Installation Guide
SQL Server Configuration
21. Set the password and confirm the password (this login can be used as the Admin login for TMR service by
entering sa in the Admin username and the password).
22. From the Objects Explorer pane of the Microsoft SQL Server Management Studio window, right click Logins.
23. Select New Logins.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 77
AVEVA™ Engineering 15.7 Installation Guide
SQL Server Configuration
24. From the Select a page pane of the Login New window, select General.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 78
AVEVA™ Engineering 15.7 Installation Guide
SQL Server Configuration
26. In the Login name field enter a login name for example: UserForTMR.
27. Set a password and confirm the password (this login can be used as the Connection login for TMR service by
entering the chosen username for example: UserForTMR in the Connection username and the Connection
password).
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 79
9 Enable TLS Encryption between Service
and SQL Server
Note:
This configuration is for a production environment where a customer requires Transport Layer Security (TLS)
encryption for service to SQL Server communication.
The connection between the TMR SQL Server and TMR Service can be configured to use TLS to encrypt data that
is transmitted across a network. TLS can be used for server validation when a client connection requests
encryption.
To vouch for the identity of the server machine and the SQL Server instance a certificate from a public
certification authority is to be used. Such server validation requires that the certificate to be installed in the
trusted root certificate store of the computer on which the client application is running. Encryption with a self-
signed certificate is possible , but a self-signed certificate offers only limited protection.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 80
AVEVA™ Engineering 15.7 Installation Guide
Enable TLS Encryption between Service and SQL Server
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 81
AVEVA™ Engineering 15.7 Installation Guide
Enable TLS Encryption between Service and SQL Server
3. From the Flags tab, in the ForceEncryption field, select Yes then click OK.
4. Restart the SQL Server service.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 82
AVEVA™ Engineering 15.7 Installation Guide
Enable TLS Encryption between Service and SQL Server
2. Install the certificate in the trusted root certificate of the machine in the client machine
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 83
10 TMR Service - HTTPS Configuration
Note:
This configuration is for production environment where a customer might want to expose the TMR API on a
HTTPS endpoint.
The following describes the steps required to configure SSL for the TMR Service while hosting on http.sys. A valid
X.509 certificate must be obtained (for testing a self signed certificate is required).
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 84
AVEVA™ Engineering 15.7 Installation Guide
TMR Service - HTTPS Configuration
6. Click Next.
7. Click Automatically Select the certificate store.
8. Click Next then Finish.
9. Click OK.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 85
AVEVA™ Engineering 15.7 Installation Guide
TMR Service - HTTPS Configuration
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 86
AVEVA™ Engineering 15.7 Installation Guide
TMR Service - HTTPS Configuration
Note:
If the certificate is not added to the trusted root certification authorities in client machine the service page is
displayed as shown below.For the purposes of this guide a self signed certificate is used, hence the page is
displayed with a certificate error "ERR_CERT_AUTHORITY_INVALID".
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 87
AVEVA™ Engineering 15.7 Installation Guide
TMR Service - HTTPS Configuration
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 88
AVEVA™ Engineering 15.7 Installation Guide
TMR Service - HTTPS Configuration
TLS configuration for multiple TMS service on the same machine using same
certificate
Repeat the steps as above, change the port number during the service installation and use that port while
binding the ssl certificate to the port step.
Alternatively generate self signed certificate using OpenSSL
1. Download openssl : http://code.google.com/p/openssl-for-windows/downloads/detail?
name=openssl-0.9.8k_X64.zipF.
2. Follow the steps detailed on https://www.ibm.com/docs/en/api-connect/2018.x?topic=overview-
generating-self-signed-certificate-using-openssl to create a self signed certificate.
a. Run openssl req -newkey rsa:2048 -nodes -keyout key.pem -x509 -days 365 -out certificate.pem
b. For openssl cnf error change command:openssl req -newkey rsa:2048 -nodes -keyout key.pem
-x509 -days 365 -out certificate.pem -config "C:\openssl\ssl\openssl.cnf".
3. Install the certificates to localsystem/personal store.
Alternatively, follow the steps detailed on https://docs.microsoft.com/en-us/powershell/module/pki/new-
selfsignedcertificate to generate a self signed certificate.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 89
11 Exposing an instance of SQL server to be
used by networks users
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 90
AVEVA™ Engineering 15.7 Installation Guide
Exposing an instance of SQL server to be used by networks users
7. Change the start mode to Manual and start the service (ensure the state is running).
8. Navigate to SQL Server Services, right click the SQL Server <instance name>, click Restart.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 91
12 Granting Access to an Existing SQL
Server User
1. From the Microsoft SQL Server Management Studio window, open the Object Explorer.
2. Expand Security then Logins
3. Right click UserForTMR, then select Properties the Login Properties – UserFor TMR window is displayed.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 92
AVEVA™ Engineering 15.7 Installation Guide
Granting Access to an Existing SQL Server User
4. From the Select a page pane of the Login Properties – UserForTMR window, select User Mapping.
5. Click to check the check box in the Map column for the database to which access has to be granted.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 93
AVEVA™ Engineering 15.7 Installation Guide
Granting Access to an Existing SQL Server User
6. Click to check the db owner check box to give the user full access.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 94
13 TMS Project Upgrade to TMR
By default, a new project starts as a non-Tag Management project, the administrator must set the TMR URL to
make it Tag Management enabled and restart the Configuration module.
Use the following procedure to upgrade an existing Tag Management System project to be compatible with TMR.
Step one is optional but recommended.
1. Remove the working and consumer extracts for the Tag management master database, for example – the
working and consumer extracts in the ATP project are displayed below.
Note:
Before making any modifications to the project ensure that a DICE check has been run and there are no
issues reported.
2. Modify the team membership of all users that need to create tags in AVEVA Engineering (this provides the
tag creating users write access to the Tag management system master database. (For example: in the ATP
project INST.ENG user's team membership needs to be modified so that INST.ENG user is member of
TMSRLSD team. In the ATP project the TMSRLSD team is the owner of UDE_TMS_RLSD database which in
Engineering 15.7 is set as the Tag management system master database).
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 95
AVEVA™ Engineering 15.7 Installation Guide
TMS Project Upgrade to TMR
3. Modify the MDBs that are used to login into AVEVA Engineering for purpose of tag creation. These MDBs
need to have Tag management system master database as the first Engineering database in the MDBs. This
change is required to ensure that all new tags are created in the Tag management system master database,
as TMR management business logic will create any new tags in first writable Engineering database. Taking
the ATP project as an example, UDE-ENG MDB will need to be modified so that UDE_TMS_RLSD is the first
database in the MDB.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 96
AVEVA™ Engineering 15.7 Installation Guide
TMS Project Upgrade to TMR
4. Install the TMR service and connect to project, refer to the Tag Management Register Installation for further
information.
5. Run the upgrade utility from configuration module to synchronize the DABACON project tags with the TMR.
6. Carry out an optional cleanup:
a. Remove MDBs specific to the TMS for example: in ATP project "UDE_TMS_RLSD" and "UDE_TMS_WKK"
MDBs can be deleted.
b. Remove users specific to the TMS for example: in ATP project "TAGS.ADMIN" user can be deleted.
Note:
An upgrade of non Tag Management Service enabled project to be TMR enabled is not supported at this
time.
© 2022 AVEVA Group plc and its subsidiaries. All rights reserved. Page 97