Installation Guide

AVEVA Bocad 2.2

www.aveva.com document version: 24-04-1

Installation Guide

Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free from virus-
es.
1.2 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 user,
including any loss suffered by the user 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.
1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the perfor-
mance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the user's claim is
brought.
1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.
1.5 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
Copyright and all other intellectual property rights in this manual and the associated software, and every part of it
(including source code, object code, any data contained in it, the manual and any other documentation supplied with it)
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
copyright notice, and the above disclaimer, 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 not reverse engineer, decompile,
copy, or adapt the software. Neither the whole, nor part of the software described in this publication may be incorpo-
rated into any third-party software, product, machine, or system without the prior written permission of AVEVA Solu-
tions 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 software described in this guide is to be installed and operated strictly in accordance with the terms and
conditions of the respective software licences, and in accordance with the relevant User Documentation. Unauthorised
or unlicensed use of the software is strictly prohibited.
Copyright 1990 to current year. AVEVA Solutions Limited and its subsidiaries. All rights reserved. AVEVA shall not
be liable for any breach or infringement of a third party's intellectual property rights where such breach results from a
user's modification of the AVEVA software or associated documentation.
Incorporates Qt Commercial, 2011 Nokia Corporation or its subsidiaries.
AVEVA Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.

Trademarks
AVEVA and bocad are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised use of the
AVEVA or bocad trademarks is strictly forbidden.
AVEVA product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or its subsidiar-
ies, registered in the UK, Europe and other countries (worldwide).
The copyright, trademark rights, or other intellectual property rights in any other product or software, its name or logo
belongs to its respective owner.

2
 Content

Content
Introduction ................................................................................................................ 5
Prerequisites............................................................................................................................................ 5
Information for users of previous versions of AVEVA Bocad .................................................... 6
Installing License server and licenses ........................................................................ 7
License Server Installation ................................................................................................................... 7
Installing or updating license files ....................................................................................................... 8
Bocad Client installation .......................................................................................... 10
Installation of the ALS Client Configuration Tool ....................................................................... 10
AVEVA Bocad installation .................................................................................................................. 11
Change, Repair or Remove Bocad installation ....................................................... 16
Uninstall .................................................................................................................................................. 16
Modify ..................................................................................................................................................... 16
Repairing................................................................................................................................................. 17
Index .......................................................................................................................... 19

3
 Introduction

Introduction
The AVEVA Bocad 2.2 installation guide explains how to install and set up
AVEVA Bocad on a PC running Microsoft Windows.

For completely up-to-date information, refer to the AVEVA Website at

http://www.aveva.com/products/support/support.html.

The complete installation is carried out from one installation package, comprising
all available AVEVA Bocad products.
Additionally, an ALS server (hosting the license information) has to be set-up,
and any client machine (hosting an AVEVA Bocad installation) has to be config-
ured to see the ALS server. This installation guide covers also the basic setup
and configuration of the required license system ALS (AVEVA licensing system).

AVEVA Bocad 2.2 Software Installation

AVEVA Bocad software is supplied on a DVD (downloadable as an .ISO disk-
image from the AVEVA Support site). The DVD contains
AVEVA Bocad multi product installer (comprising all available AVEVA Bocad
products).
Release Notes
AVEVA Licensing System
Basic documentation
Insert the DVD in the PC DVD-drive, and then follow the instructions.
If the disk does not start, open its content with the Windows-Explorer and dou-
ble-click the Start.html file.

Prerequisites
AVEVA Bocad supports officially: Microsoft Windows 7 with 32-bit or 64-bit.
At least 8 GB free on a drive to have sufficient space for AVEVA Bocad (pro-
gram data, client data and project data).
Some components of AVEVA Bocad 2.2 require at least version 4.0 of Mi-
crosofts .NET Framework.

AVEVA License File

To operate, AVEVA software must be able to access the correct license file,
which should be installed on either the server, on your PC, or on a networked
PC. Refer to the AVEVA Licensing System guide. News and update information is
also available on the AVEVA support web-site.

5
Installation Guide

Although the AVEVA Bocad multi product installer contains several AVEVA
Bocad products, a user is only able to use the items that are licensed to him.
An on-screen notification will warn when the license is due for renewal.

Information for users of previous versions of AVEVA Bocad

1. The ALS license system is not compatible with the dongle-based license sys-
tem of prior versions of AVEVA Bocad:
It is not possible to use AVEVA Bocad 2.2 or above with a Hardlock or
HASP dongle.
It is not possible to use any version before AVEVA Bocad 2.1 (AVEVA Bo-
cad 23 or below) with the ALS license system.
In general both license systems can be used in parallel to work with different
versions of AVEVA Bocad.

Please contact the AVEVA Support for additional information regarding the li-
censing.

2. Existing client data from AVEVA Bocad Version 23 has to be transferred be-
fore it is used in AVEVA Bocad 2.2. This can be done with the Bocad admin
tool (Icon on the desktop) by the TransferClientData function from the
Standard tab.
3. Projects from AVEVA Bocad Version 23 are updated when opened first-time
in AVEVA Bocad 2.2. Updated projects are no longer compatible with prior
versions of AVEVA Bocad.

6
 Installing License server and licenses

Installing License server and licenses

AVEVA Bocad 2.1 and above is using the license system ALS (AVEVA licensing
system). Licenses itself are provided as license files; to be imported into the ALS
license server.
All information about licensed products is managed through the ALS server and
provided to any requesting AVEVA Bocad installation from within the network.

License Server Installation

The ALS license server can be installed on any PC inside a network to provide
its licenses to several client PCs. It is not necessary to install AVEVA Bocad on
the serving PC but possible (e.g. to run AVEVA Bocad on a Laptop without per-
manent network connection).
The ALS licensing system is provided on the AVEVA Bocad DVD or from the
AVEVA support site.
Unzip it if required.
Install using the setup.exe file.
Run the AVEVA License System Console (from Start > All programs >
AVEVA > Licensing system).
Check on the Que-
ry/Configure tab if the
server is running by click-
ing the Query Servers
button. For AVEVA Bo-
cad, only the RMS Server
Status is relevant.
If the server is not run-
ning, start it on the
Start/Stop tab by clicking
the Start licensing sys-
tem button.
In case of problems check inside the server log file for any reasons why it has
not started (View Log File button on the Query/Configure tab).

Additional information about setup and configuration is provided in the in-

cluded Product release letter. Once installed, full details of configuration are giv-
en in the AVEVA Licensing System User Guide, which can be found using Start >
All programs > AVEVA > Licensing system.

7
Installation Guide

Installing or updating license files

Obtain a License File (locking Criteria)
To ensure to have correct license server locking criteria, run the echoid applica-
tion via the AVEVA-locking.bat file found in the folder
C:\AVEVA\AVEVA Licensing System\RMS\Tools.
Alternatively, it can be downloaded from the AVEVA Support site: download the
ServerInfo.zip file (http://support.aveva.com/services/products/alic/serverinfo.zip), ex-
tract the program and .bat file from the .zip file, and run it on your server.
echoid will create a file (AVEVA-Server-computername-info.txt) with
your machines locking data for your license server. Please attach that file into
the license request email. By return you will be sent a license file configured for
your system for your applications.
Please save this file in C:\AVEVA\download\myARMSlicense.xml.

License files returned to you are bound to a specific machine. To move li-
censes to a different machine it is necessary to revoke them in the AVEVA
License System Console, and to request a new license file.
Please contact the AVEVA Support if you plan any movement of license
files.

Install or update a license file

Run the AVEVA License System Console, this is found under START > All
Programs > AVEVA > Licensing System > AVEVA License System Console.
To install your license file, on the tab Licenses, Browse to your saved li-
cense.xml file.

8
 Installing License server and licenses

If the license locking criteria is

OK and the licenses have been
extracted, start now the installa-
tion of the license files, you will
get a checking panel as below, an-
swering Yes will start to install.

With successful
license installa-
tion, this is re-
ported to the log
window as shown
on the right:

Finish the license installation by clicking the Close button.

9
Installation Guide

Bocad Client installation

The AVEVA Bocad Products Installation is supplied on a DVD in an installation
called Bocad. Also on the disk is a folder containing the Installation instructions
and basic user documentation, and it is recommended that the user carefully
read all of the Installation instructions before installing the software.
You may install as many clients as you wish. However, the maximum of simulta-
neously useable installations is limited by the number of available licenses.

Be sure all intended client PCs will have network access to the serving PC
(e.g. correct router settings). Ask the local administrator for assistance if
required.

Installation of the ALS Client Configuration Tool

The client machine has to be configured to see the license server. This is also
necessary if license server and AVEVA Bocad installation are on the same ma-
chine (e.g. laptop installation).

The AVEVA Bocad installation itself does not require any license information,
so you can carry out this configuration step before or after the client installa-
tion.

The ALS Client configuration tool is included in the ALS licensing system; pro-
vided on DVD or from the AVEVA support site (see section 'License Server Instal-
lation').
Unzip it if required.
Install using the setup.exe file.
Run the AVEVA Licensing Client Configuration Tool (from Start > All
programs > AVEVA > Licensing system).

10
 Bocad Client installation

Configure either for indi-

vidual users or for the cli-
ent in general the address
parameters of the license
server:
The default Port number
of the ALS server is 4545.
Set the Hostname corre-
sponding to the server host
name that was in the file
AVEVA-Server-
info.txt (see section
'Installing or updating license
files').

It is also possible to configure the client without installation of the AVEVA

Licensing Client Configuration Tool:
Add AVEVA_LICENSE_SERVER_LIST with the value
4545@[LicenseServerName] to the user environment or system
environment variables.

AVEVA Bocad installation

It is not necessary to remove any previous installation of AVEVA Bocad (e.g.
AVEVA Bocad 23). AVEVA Bocad 2.2 can be installed in parallel, thereby switch-
ing between different versions is possible using the Bocad admin tool.

For a detailed description of switching between different versions of AVEVA

Bocad refer to the AVEVA Bocad Admin 2.2 Reference.

Although there is no need to un-install a previous installation before a new in-

stallation, you can remove any version before AVEVA Bocad 2.2 by simply de-
leting the appropriate folder [drive]:\bocad\[build_number]. To
un-install AVEVA Bocad 2.2 itself refer to chapterUninstall.

Using the disk to install AVEVA Bocad products

Insert the disk and on the Welcome screen click Click for contents.
If the disk does not start, open its content with the Windows-Explorer
and double-click the Start.html file.
A screen showing the available products is displayed. Click AVEVA Bocad
2.2 to display the Release Documents screen.

11
Installation Guide

Click INSTALL to dis-

play the AVEVA Bocad
Setup Wizard.
Click Next to display
the End-User License
Agreement window.

Read the End-User Li-

cense Agreement and
then select the I ac-
cept the terms in the
License Agreement
check box to activate
Next.
Note: Without select-
ed check box, Next will
not activate and the in-
stallation cannot con-
tinue.

After clicking Next the

Custom Setup screen
is displayed.

12
 Bocad Client installation

The Custom Setup window displays every configurable aspect of the installation:
Folder for the program files
Additional language packs
Folder for the projects and default Client data
Packages for profile systems
Configurable features are displayed on the left hand side of the window, in a
control called the SelectionTree. Each feature is depicted as a box with a de-
scription of the feature displayed in the right hand pane. The boxes representing
each feature are depicted as follows:
Feature will be installed (Locally)

Feature will be installed (Locally), but not all sub-features will.

Feature will be unavailable (not installed), as well all descendants.

Clicking a box displays a drop-down menu.

Will be installed on local hard drive
Entire feature will be installed on
local hard drive
Entire feature will be unavailable
Selecting this option will install the feature locally.
Selecting this option will install the feature and all its
sub-features locally.
Selecting this option prevents the current feature
and all its sub-features from installing.

Clicking Reset in the Custom Setup screen will de-select all currently select-
ed features.

Clicking Browse, when ac-

tive, displays the Change
Destination Folder win-
dow which allows selecting
a different folder name and
location path.

13
Installation Guide

It is possible to specify different locations for the AVEVA Bocad program

files, Client data and the Projects directory.
It is strongly recommended to install the main program into a root folder
[drive]:\bocad!

To check if enough disk space is available click Disk Usage to display the
Disk Space Requirement screen. Highlighted volumes indicate that there is
not enough disk space available for the selected features. You can remove
some of the files from the highlighted volumes, install fewer features or select
a different destination volume. Click OK to return to the Custom Setup
window.
Click Back to step back a stage, Cancel to terminate the Setup Wizard or
Next to display the Ready to Install AVEVA Bocad screen.

Now you can click Back

to step back a stage and
change their installation
option, Cancel to termi-
nate the Setup Wizard or
Install to display the In-
stalling AVEVA Bocad
screen.

The Installing AVEVA Bo-

cad 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 installa-
tion.

14
 Bocad Client installation

When the installation has

been completed, click Fin-
ish to exit the Setup Wiz-
ard.

Complete installation process

At the end of installation the AVEVA Bocad Personal Setup window is
shown; here you can configure desktop icons for your products:
Activate check
boxes for the
product(s) you
have licensed
Select to use
AVEVA Bocad as
32 Bit program
or as 64 Bit
program
Select your pre-
ferred language
for the user in-
terface

The setup is not checking any license information. This means configuration of
desktop icons is also possible for products included in the AVEVA Bocad in-
stallation package, but not (yet) licensed.

Finish the installation with the Exit button in the main setup window.
To change the desktop icons for your licensed products at a later time, start
the Bocad admin tool (Icon on the desktop) and use the Activate function
from the Standard tab.

For performance reasons, it is recommended to exclude the installation folder

(usually [drive]:\bocad) and all its sub-folders (including \projects
and \client2_1) from the virus scanner.

15
Installation Guide

Change, Repair or Remove Bocad installation

Maintenance operations for the AVEVA Bocad installation can be accom-
plished by two methods:
From the Start > Set-
tings > Control Panel
> Add/Remove Pro-
grams applet
Right clicking on the
Bocad.msi file that in-
stalled it.

Uninstall
Open the AVEVA Bocad Setup window as described above.
Start the uninstall procedure by selecting the Remove button.

Uninstalling the Bocad 2.2 Products installation will not uninstall

Folders containing Client data
Folders containing Project data
Any previous installation of AVEVA Bocad (e.g. AVEVA Bocad 23).

Modify
Open the AVEVA Bocad Setup window as described above.
Start the modify procedure by selecting the Change button.

16
 Change, Repair or Remove Bocad installation

Once the Change option

is selected the Custom
Setup window is displayed
allowing the user to
change which features are
installed.

The Change option cannot be used to change the location path. To change
the location path, the current installation must be removed and then re-
installed using the new location path.

Repairing
If any programs stop working, or the installation has knowingly been damaged,
then Repair may fix the problem.
Open the AVEVA Bocad Setup window as described above.
Start the modify pro-
cedure by selecting the
Change button.

Repairing an installation causes it to heal itself.

17

Index
AVEVA licencing system
Client configuration tool .....................................10
General ...................................................................... 7
License server .......................................................... 7
DVD content......................................................5
Index
Installation
Modify ...................................................................... 16
Repair ...................................................................... 17
Uninstall .................................................................. 16
license server locking criteria ....................... 8
19