Installation User Guide
Installation User Guide
Installation
User Guide
AVEVA Solutions Limited
Disclaimer
AVEVA Instrumentation provides instrument sizing calculations for estimation purposes only, end users of the
software should not rely on the calculations produced by the software for design purposes. End users should seek
the advice of certified equipment suppliers prior to specifying or purchasing equipment.
a) AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free from viruses;
b) AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses; loss of
anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or information; any
special, indirect, consequential or pure economic loss, costs, damages, charges or expenses which may be
suffered by the customer, including any loss suffered by the customer resulting from the inaccuracy or invalidity of
any data created by the AVEVA software, irrespective of whether such losses are suffered directly or indirectly, or
arise in contract, tort (including negligence) or otherwise;
c) AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the
performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the
customer's claim is brought.
In the event of any conflict between the above clauses and the analogous clauses in the software licence under
which the AVEVA software was purchased, the clauses in the software licence shall take precedence.
Copyright
All intellectual property rights, including but not limited to, copyright in this manual and the associated software,
(including source code, object code, and any data) belongs to or is validly licensed by AVEVA Solutions Limited or
its subsidiaries.
All rights are reserved to AVEVA Solutions Limited and its subsidiaries. The information contained in this document
is commercially sensitive, and shall not be copied, reproduced, stored in a retrieval system, or transmitted without
the prior written permission of AVEVA Solutions Limited. Where such permission is granted, it expressly requires
that this Disclaimer and Copyright notice is prominently displayed at the beginning of every copy that is made.
The manual and associated documentation may not be adapted, reproduced, or copied, in any material or
electronic form, without the prior written permission of AVEVA Solutions Limited. The user may also not reverse
engineer, decompile, copy, or adapt the associated software. Neither the whole, nor part of the product described in
this publication may be incorporated into any third-party software, product, machine, or system without the prior
written permission of AVEVA Solutions Limited, save as permitted by law. Any such unauthorised action is strictly
prohibited, and may give rise to civil liabilities and criminal prosecution.
The AVEVA products described in this guide are to be installed and operated strictly in accordance with the terms
and conditions of the respective licence agreements, and in accordance with the relevant User Documentation.
Unauthorised or unlicensed use of the product is strictly prohibited.
Copyright 2000 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved.
The AVEVA Instrumentation user interface is based on the Microsoft® Office Fluent™ user interface.
Trademarks
AVEVA and Tribon are registered trademarks of AVEVA Group plc or its subsidiaries. AVEVA product names are
trademarks or registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use of
trademarks belonging to AVEVA Group plc or its subsidiaries is strictly forbidden.
Microsoft® Office Fluent™ user interface. Fluent is a trademark of Microsoft Corporation and the Fluent user
interface is licensed from Microsoft Corporation. The Microsoft Office User Interface is subject to protection under
U.S. and international intellectual property laws and is used by AVEVA Solutions Limited under license from
Microsoft.
DevExpress® redistributables are used by AVEVA under license from Developer Express Inc. Copyright © 2000-
2014 Developer Express Inc.
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.
Installation User Guide
Revision Sheet
Contents Page
Installation
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Database Systems Supported . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Project Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Client Computer Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Microsoft .NET Framework 4.8 Runtime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Project Packager and Microsoft’s Shared Management Objects (SMO). . . . . . 2:1
AVEVA Instrumentation Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Installing a Full Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Installing a Partial Release (Fix Release) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
Unattended Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
Unattended Installation of a Package. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
Unattended installation of a Fix Release . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
Licensing Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:3
Using Licensing as a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4
Using the Client-based AVEVA Licensing System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4
1 Introduction
SQL Server 2016 SP1 and 2017: SQL Server 2016 and later requirements
The Express version of SQL Server 2019 is available as a free download from the Microsoft
website.
2 Installation
2.2 Compatibility
For the latest compatibility information please refer to the Release Letter.
By clicking the links, in the order indicated, users will be able to download the required msi
files and install the assemblies. Once installed, the Project Packager will run without any
problems.
Note: Refer to the Security Manager documentation for the procedure for packaging
projects.
Note: If you are not an Administrator on the client PC, right-click on the .exe file and click
Run as Administrator.
Continue at:
• Installing a Full Release
• Installing a Partial Release (Fix Release)
If installing a partial (Fix) release, the following steps will upgrade the current installation to
the new version:
• Start the installation wizard as described above. On the welcome screen click Next to
proceed.
• Click Install to install the product.
• Click Finish to complete the installation.
Name Value
AVEVA_CONNECT_AUTHORITY_URL https://identity.capdev-connect.aveva.com/
identity
AVEVA_LICENSE_SERVER_LIST https://test-license.capdev-connect.aveva.com/
;4545@licsrvhyd1;4545@licsrvhyd2
Note: Versions 2.0, 3.0, 4.0, and 4.1 of the ALS are supported. Be aware that a new
license file will be required after upgrading to a later version.
To operate, AVEVA software must be able to access the correct ALS license file, which
should be installed on either the Server, on the workstation, or on a networked workstation.
ALS is a network license service which hands out floating licenses to clients, meaning that
licenses are not tied to a certain workstation but can be used from any workstation where
the software is installed, as long as the total number of licenses in use does not exceed the
number of licenses purchased.
The ALS guide is available on the AVEVA support site.
AVEVA Instrumentation is supported for use with Citrix for multi-site working.
3 Project Setup
After installation, either a new AVEVA Instrumentation project (and database) must be
setup, or an existing project Workgroup file must be selected. The Workgroup file is a data
file that holds the details of all AVEVA Instrumentation projects located on the system.
Run an AVEVA Instrumentation module. If this is the first time an AVEVA Instrumentation
application (or module) has been run on the workstation, the Browse For Folder window
will be displayed.
To select an existing project, use the dialog to select the folder in which the project
Workgroup file is located and click OK.
Note: If multiple AVEVA Instrumentation users are to work on the project then this
Workgroup file folder should be located on a common network drive accessible to all
these users.
The AVEVA Instrumentation Workgroup file is a Microsoft Access database that contains a
single table that holds the names and locations of the AVEVA Instrumentation projects.
Note: To reset a workstation’s Workgroup file (e.g. if the wrong folder was selected), simply
delete the file ‘Inst.ini’. This file will located in:
Users\<user name of installer>\AppData\Roaming
If this does not exist, AVEVA Instrumentation will ask for the Workgroup file once
again.
Continue at:
• Create a New Project
• SQL Server Setup
• SQL Server Security
• AVEVA Instrumentation User Security
• AutoCAD Setup
The Create a New AVEVA Instrumentation Project window is displayed either after a
Workgroup file has been selected as described previously, or when New is clicked on the
Select an AVEVA Instrumentation Project window (accessed from the Open Project
option in the Setup tab of Engineering modules).
SQL Server: Click the [...] button to display the SQL Server login window, used to create
the new project database on a selected SQL Server. Refer to SQL Server Setup for details.
Copy: Select one of the following options as required:
Empty Project: The default option. A new blank project with no project data and the
default security settings will be created if this option is selected.
Demo Project: AVEVA Instrumentation includes a ‘Demo Project’ database which can
be copied for the purposes of evaluating or testing AVEVA Instrumentation. Select this
option if the new project is to be a copy of the AVEVA Instrumentation Demo Project.
Packaged Project: Projects can be “packaged”, that is saved to a single package
(.pkg) file. When new projects are created, a packaged project can be selected.
Project setting and data are copied from the packaged project.
Note: Refer to the Security Manager documentation for the procedure for packaging
projects.
When the Packaged Project option is selected, the Package File field and ... button
become active. Click the ... button to browse for and select the required package file.
The location and file name of the selected file is the displayed in the Package File
field.
Project Folder: This is the ‘root’ project folder. By default, once entered (or browsed to), the
other project folder names are automatically completed using this root. These can
subsequently be edited if required (see below).
If the project is a copy of the demo or of a packaged project, most of these fields will be
automatically completed. They may be amended if required.
Note: AVEVA Instrumentation will create all the project folders if they do not already exist
when Save is clicked.
File Locations/Folders:
Design Database: The SQL Server Database Name.
Note: If multiple AVEVA Instrumentation users are to work on the project then these folders
should be located on a common network drive accessible to all these users and the
mapped drive letter must be the same for all these users.
Other Folders: All other folder names are user definable but (logically) should reside
under the same root folder for ease of management. Although in theory everything
could be located in the same folder, this would be difficult to manage as the number of
files grows. Therefore it is recommended that each group of files is located in a
different sub-folder.
When the project details have been entered, click Save.
AVEVA Instrumentation will then create the new project database on the nominated Server.
AVEVA Instrumentation will also create all the project folders if they do not already exist.
If a packaged project was selected to copy from, a window displaying the progress of the
extraction of data from the package file is displayed:
Once created AVEVA Instrumentation will show the new project in the Select an AVEVA
Instrumentation Project window.
When an AVEVA Instrumentation module is started, if only a single project has been created
(i.e. is listed in the Workgroup file), this project will be automatically selected and opened.
If more than one project has been created, then the Select an AVEVA Instrumentation
Project window is displayed, from which the required project can be selected:
To create further projects, select the New button on the Select an AVEVA Instrumentation
Project window. The Create a New AVEVA Instrumentation Project window is then
displayed, and should be completed as described above.
The Select an AVEVA Instrumentation Project window can also be opened by selecting
the Open Project option from the Project tab of AVEVA Instrumentation modules.
Note: To remove a project from the list in the Select an AVEVA Instrumentation Project
window, open the Projects.Mdb Access database located in the Workgroup folder
and delete the appropriate record. The SQL server database on the database server
will not be affected.
The project details, including project folders, may be edited after a project has been created
by selecting the Edit Project option from the Project tab of AVEVA Instrumentation
modules (once a user has logged on to the project). However, AVEVA Instrumentation will
not move any existing files to any new folders. After folder creation, this must be done
manually.
The SQL Server Login window is displayed when the button next to the SQL Server Name
field on the Create a New AVEVA Instrumentation Project window is pressed (see Create
a New Project). This is used to create the new project database on a selected SQL Server.
Test that the entered details are valid by clicking Test Connection.
Clicking OK will run a script to create the new AVEVA Instrumentation database.
Note: Once security is switched on, by default users will have no access until they are
added to a Security group.
Index
A S
ALS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4 SMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
AutoCAD Setup . . . . . . . . . . . . . . . . . . . . 3:8 SQL Server
AVEVA Connect . . . . . . . . . . . . . . . . . . . 2:4 Security . . . . . . . . . . . . . . . . . . . . . . 3:6
AVEVA Licensing System . . . . . . . . . . . . 2:4 Setup . . . . . . . . . . . . . . . . . . . . . . . . 3:5
C U
Compatibility . . . . . . . . . . . . . . . . . . . . . . 2:1 Unattended Installation . . . . . . . . . . . . . 2:3
Computer Requirements . . . . . . . . . . . . . 2:1 User Security . . . . . . . . . . . . . . . . . . . . . 3:8
D
Database Systems
Supported . . . . . . . . . . . . . . . . . . . . . 1:1
I
Instrumentation Setup . . . . . . . . . . . . . . . 2:2
L
LaaS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:4
Licensing as a Service . . . . . . . . . . . . . . 2:4
Licensing Setup . . . . . . . . . . . . . . . . . . . 2:3
P
Project Folders . . . . . . . . . . . . . . . . . . . . 1:1
Project Packager and Microsoft’s Shared Man-
agement Objects (SMO) . . . . . . 2:1
Project Security . . . . . . . . . . . . . . . . . . . . 3:7
Project Setup . . . . . . . . . . . . . . . . . . . . . 3:1
© Copyright 2000 to current year. Index page 1 12.2 and above only
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Instrumentation Installation User Guide
© Copyright 2000 to current year. Index page 2 12.2 and above only
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.