AVEVA Bocad Admin 2.

Reference

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

AVEVA Bocad Admin 2.2

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
Overview ..................................................................................................................... 5
Explanation of the general buttons ........................................................................... 6
Functions of the Standard tab ................................................................................... 7
info ............................................................................................................................................................. 7
envir_bocad ............................................................................................................................................. 8
activate ...................................................................................................................................................... 8
init_login ................................................................................................................................................. 11
Online help ............................................................................................................................................ 11
initiconrows ........................................................................................................................................... 11
transferclientdata ................................................................................................................................. 12
Functions of the Advanced tab ................................................................................ 14
upgproject .............................................................................................................................................. 14
upgdb ....................................................................................................................................................... 16
import_new ........................................................................................................................................... 16
kor ........................................................................................................................................................... 17
bocad_reg_exp/bocad_reg_imp ...................................................................................................... 19
Functions of the Shared work tab ........................................................................... 21
Index .......................................................................................................................... 23

3
 Overview

Overview
The AVEVA Bocad Admin tool allows an easier way to manage your existing
AVEVA Bocad installations.
It contains miscellaneous functions, e.g. to initialise or change the programme
language, to define and debug the environment variables during runtime or to
change the version and/or the customer data.
The AVEVA Bocad Admin is installed together with AVEVA Bocad and can be
started via double-click on its own desktop icon:

You can open the AVEVA Bocad Admin either by double-click on the icon or via
the explorer [DRIVE]: \bocad\[VERSION NUMBER]\ bo-
cad3d_admin.bat (DRIVE will be abbreviated by DRV and VERSION
NUMBER by VNO in the following).

The explanations of this reference shall help you to understand the purpose of
the functions. Especially enhanced functions should only be handled by experi-
enced users and/or under guidance of the AVEVA Bocad support.

5
AVEVA Bocad Admin 2.2

Explanation of the general buttons

Apply button
The currently highlighted function is started with the Apply button. Depending
on the function further entries might be necessary (compare the following de-
tailed descriptions).

Close AVEVA Bocad before clicking the Apply button.

Exit button
Exit will close AVEVA Bocad Admin.
Log file button
Via the Log file button you can get information about the administrative activi-
ties of the AVEVA Bocad Admin since the last installation.

6
 Functions of the Standard tab

Functions of the Standard tab

This tab contains basic functions for administration of AVEVA Bocad.

info
Via info you can see informations about your currently installed release. Below
you will find variables descriptions:
Value Description
Bocad_dir Bocad PS path
KRYMSG Language of the Bocad PS user interface
Path System variables, e.g. for executable programme files
TEMP temporary directory
TMP temporary directory
BO_PATH Path to the current version of bocrun
BocadRootDir AVEVA Bocad home directory
Version Current release number
KU_SRC Path to customer data
BocadJobData Path to projects
Languages Available languages for the AVEVA Bocad user interface

7
AVEVA Bocad Admin 2.2

envir_bocad
The envir_bocad function shows your complete AVEVA Bocad environment
variables as defined in mainlocations.xml and privateloca-
tions.xml files:

A warning is given if the environment variables are not initialised for current
user. In such case please use the function init_login.

activate

Description
This function combines the following administrative options:
 Activating a different version of AVEVA Bocad installed on your PC.
 Creating or changing desktop icons for your AVEVA Bocad products.
 Changing the language of the user interface (if installed).
 Changing the active folders for client data and projects.

8
 Functions of the Standard tab

Compatibility notes
Activating a version prior Due to changes of the internal installation handling, the AVEVA
AVEVA Bocad 2.1 Bocad Admin does not allow activation of any version prior to
AVEVA Bocad 2.1.
To activate a previous version, please run the AVEVA Bocad-3D
Admin tool from the according installation folder; e.g. [drv]:\
bocad\ 23_12466\ bocrun\ bocad3d_admin.exe.
To re-activate any version above AVEVA Bocad-3D 23 later, use
also the compatible version of the AVEVA Bocad Admin (for
AVEVA Bocad 2.2 e.g. [drv]:\ bocad\2_2\ bo-
cad3d_admin.bat).
Activating client data of Client data of AVEVA Bocad-3D 23 require a migration before
previous versions for they are compatible with AVEVA Bocad 2.1 and above. This
AVEVA Bocad 2.2 should be carried out before old client data are activated for a
newer version.
See section Functions of the Standard tab: transferclientdata for
further information.
Activating a projects Projects created with a newer version (e.g. AVEVA Bocad 2.2),
folder of previous ver- or projects from a previous version opened once in a newer
sions for AVEVA Bocad version, cannot be opened with any previous version (e.g.
2.2 AVEVA Bocad-3D 23).

If you have to work with different releases of AVEVA Bocad, you should
take care to work on a particular project exclusively with one certain ver-
sion of AVEVA Bocad and one certain client data folder.

Handling
To set or change the active version of AVEVA Bocad, the desktop icons, user
interface language or the active folders for client data and projects, follow the-
se steps:
 Select the Activate function and click the Apply button.
 In the first dialogue for release selection, the selection list is pre-set with
the currently active installation of AVEVA Bocad. You can change this to ac-
tivate another available installation.
 Confirm the setting with the Apply button.
 In the next dialogue, select a client data folder or keep the currently active
one. Use Browse to change the folder or to create a new one.
 Confirm the setting with the Apply button.
 In the next dialogue, select a projects folder or keep the currently active
one. Use Browse to change the folder or to create a new one.
 Confirm the setting with the Apply button.

9
AVEVA Bocad Admin 2.2

 Confirm the summarised settings

shown in the next dialogue with the
Yes button, otherwise click the No
button to change this settings.

In the following AVEVA Bocad Personal Setup dialogue, configure desktop

icons and user interface language for your products:
 Activate check
boxes for the
product(s) you
have licensed.
 Select to use
AVEVA Bocad as
32 Bit pro-
gramme or as 64
Bit programme.
 Select your pre-
ferred language
for the user in-
terface.

The desktop icon setup is not checking any license information. This means
you can also configure desktop icons for a product which is included in the
AVEVA Bocad installation package, but not (yet) licensed to you.

Subsequently, environment
variables and registry values
are updated and summarised.

10
 Functions of the Standard tab

init_login
With init-login you can set up an AVEVA Bocad installation for another user
(more precisely: for the use on the same PC with another user account). A new
installation is not necessary for this. The init-login function establishes the new
user account in AVEVA Bocad, including start icons for both AVEVA Bocad and
the AVEVA Bocad Admin.

Starting icons are only created for those languages, which were chosen at the
installation and set up properly.

 Open the Windows Explorer.

 Change to the directory [DRV]:\bocad\[VNO]\bocrun\.
 Double-click on the file bocad3D-admin.exe to open the AVEVA Bocad
Admin.
 Select the init-login function and click the Apply button.
 Select the release of AVEVA Bocad that shall be initialized.
 Select a client data and project folder.
 Confirm the selection with Yes.
 Wait a moment and then confirm the final protocol with OK.
Start icons for both AVEVA Bocad and AVEVA Bocad Admin are created on the
desktop.

To improve performance of AVEVA Bocad exclude the complete directory

[drv]:\bocad\ from your virus scanner. You can find the appropriated
procedure in the documentation of your anti-virus programme.

Online help
The Online help function allows changing the language of your AVEVA Bocad
online help manually. Currently, English and German online help are available.

initiconrows
With this function you can reset the configuration of the Bocad icon bars to the
AVEVA Bocad defaults.
Compared to loading the defaults via the Extras > Icon bars function in AVEVA
Bocad, not only the icon bar selection itself will be reset, but also their arrange-
ment on the AVEVA Bocad-surface. In addition existing custom settings (file
icons_*.cfg in directory documents and settings\[your pro-
file name]) will be saved as icons_*.cfg_[active version num-
ber], so that you can reset it afterwards by renaming if needed.

11
AVEVA Bocad Admin 2.2

transferclientdata

Description
Since the structure of client data has been changed with AVEVA Bocad 2.1, a mi-
gration of existing client data coming from a previous version is necessary before
usage with AVEVA Bocad 2.2.
This migration can be carried out with the transferclientdata function of the
AVEVA Bocad Admin:
 It will take an existing client data folder coming from AVEVA Bocad-3D 23.
 Create a re-structured new client data folder useable with AVEVA Bocad 2.2.
 No additional update steps are required for the migrated client data.
The migration is possible into a new, empty folder if you want to bypass the
AVEVA Bocad defaults for any reason.
Nevertheless, the recommended procedure is the migration of existing client data
into the default client data, as created during the installation of AVEVA Bocad 2.2.

The source client data is not affected by the migration process, but the
target client data folder will be changed (if the transfer is not done into a
new, empty folder).
Although it is possible to re-install a default client data folder with the
AVEVA Bocad installer package at a later date, a backup of the original de-
fault client data folder before the migration can be helpful; especially if you
have to maintain several client data folders for different customers.

Handling
To create a new client data folder from an existing client data folder, suitable
for AVEVA Bocad 2.2, follow these steps:
 Select the transferclientdata function and click the Apply button.
 In the first dialogue, select
the source client data folder
for the migration from the
selection list.
 Confirm the setting with the
Apply button.
 In the next dialogue, select a
target client data folder for
the migration from the se-
lection list. By using the
Browse button, it is also
possible to create a new,
empty folder or to select a
folder outside the current
\bocad folder.

12
 Functions of the Standard tab

 Confirm the setting with the Apply button.

 Confirm the final settings
summary with the Apply
button to start the migra-
tion process.

The newly created client data folder is automatically activated so it used for
any new project when starting AVEVA Bocad the next time.

The migration process is logged inside the target client data folder into the file
transfer.log. This file can also be used for a comparison of the changed
structure and the modified locations of any customised files.

13
AVEVA Bocad Admin 2.2

Functions of the Advanced tab

This tab contains specific functions which should only be used by experienced
users and/or with the help of the AVEVA Bocad support.

upgproject

Description
With this function you can update projects created with earlier AVEVA Bocad
versions or earlier updates.
Projects are updated automatically when opened with a newer AVEVA Bocad
version. Compared to this, upgproject is suitable especially:
 For a quick update of a project without the need to open AVEVA Bocad.
 For an update of projects outside the active project directory.
 For updating several projects below a project directory.

Please consider that updated projects should not be opened with earlier ver-
sions of AVEVA Bocad. For safety reasons use the backup option of this func-
tion to have a way back to the initial data if needed.

14
 Functions of the Advanced tab

The selected project will always be updated to the state of the currently ac-
tive version of AVEVA Bocad. Therefore check the currently active version
before the update. You can change the active version using the Activate func-
tion.

Explanation

Select project
This button allows selecting projects to be upgraded. You can select a complete
projects directory or the directory of a single project.
The default is the active projects directory, but you can also change to an inac-
tive projects directory, respectively a single project.
Verify project directory
After selection of a projects directory a list of projects to be upgraded will be
created by this button. The list is shown in an editor and can be edited, e.g. to
exclude single projects from it from the upgrade process.
zip boc3db before upgrade
With activated option, a backup of the project is created before the upgrade.
Therewith, if needed afterwards you can also open the project with the version
with what the project was initially created with.
Show protocol
With activated option, a report of all done steps will be shown after the up-
grade.
Execute upgrade now
After selection and confirmation of the projects directory the upgrade of the se-
lected projects can be started via this button according to your settings.

15
AVEVA Bocad Admin 2.2

upgdb
With upgdb you can update the library folders (boc3db) a previous version to
the current version. This function is especially suitable for libraries that have
been structured into sub-folders. With help of upgdb you can update all sub-
folders in one step.

By contrast to this, AVEVA Bocad itself only updates the selected folder at
first usage.

Generally, you can also use upgdb to upgrade several AVEVA Bocad projects in
one step to the current version. However, this involves the following restriction:

With this update the boc3db is cleared up, so the model data base is re-
duced. Thereby the setting files (.rsc, .inp etc.) of the boc3db related to
the project are deleted. This is not relevant for library folders, but when using
upgdb for project folders, only the pre-settings of your client data or the ver-
sion are available afterwards!

Procedure: Update of a library

 Select the upgdb function and click the Apply button to open the dialogue.
 Click onto the Select directory of libraries button.
 Select the folder of your libraries in the next dialogue.
 Click onto the Search all libraries button.
 Now you can get in an editor a list of library folders. You can edit these, if
necessary expand or reduce them. Finally save your changes and close the ed-
itor.
 Click onto the Execute update now button in the dialogue.
 Now the first library folder of the list is being updated. When the Show pro-
tocol option is activated a report of the update is shown thereafter.
 On closing the protocol, the next folder will be updated.
After upgrading all the folders you will get back into the dialogue of the function.
With Exit you will return to the main dialogue of AVEVA Bocad Admin.

import_new
You can decrease the database size by importing an existing project with im-
port_new into a new boc3db. By this all elements receive a new ident number.
Already existing evaluation documents such as drawings can only be modified as
2D drawings in such minimised projects. The parts on these drawings do not
have any link to the model anymore.

16
 Functions of the Advanced tab

Therefore please use import_new only:

 If there are no completed drawings which have to stay linked to the
model.
 If all partial projects have been synchronised and are disconnected from
the master project when applying shared work.

Procedure: Minimising a boc3db

 Select the import_new function on the Advanced tab.
 Click the Apply button.
 Confirm the safety query with Yes.
 Click on the Select project button on the opening dialogue.
 Select the project folder.
 Confirm your selection with OK.
 Click onto the Import button.
The project size will be minimised. All project elements receive new ident numbers.

kor
Description
The bocad profile and bolt data base in the format .inp can be converted
from and to the format .csv by kor. Files in .csv-format can be opened for
modification with for example MS Excel. This way new profiles and bolts can be
managed and added easily.

17
AVEVA Bocad Admin 2.2

Basic files that can be used:

File name Description
prfadr.adr_ prfinf.inf_ Binary files (unmodified) containing all the profiles and
scradr.adr_ scrinf.inf_ bolts
alle_prof.inp Image of profile database
alle_sc.inp Image of bolt database
cli_pr.inp Data of customised profiles
cli_sc.inp Data of customised bolts

Read the according documentation for more information about profile and bolt
databases.

Dump of currently used data to K_PROFIL

The Dump of currently used data to K_PROFIL option writes the contents of
the binary database to k_Profil. The files alle_prof.inp and al-
le_scr.inp are generated from the existing binary data.
This output uses the client data ($KU...) or the data of the current release
(e.g. [DRV]:\ [VNO] \bocad\ bocdat\ profil).
Convert alle_prof.inp  alle_prof.csv / alle_sc.inp  alle_sc.csv
Converts the file format .inp to .csv. The profile and bolt data in .csv-format
can be opened with MS Excel for editing.
Convert alle_prof.csv  alle_prof.inp / alle_sc.csv  alle_sc.inp
Converts the profile and bolt data with its modifications back into the AVEVA Bocad
format .inp.

Init of profile and bolt data using alle_prof.inp and alle_sc.inp

When using the Init of profile and bolt data using option, all profile and bolt
databases from the modified .inp files are initiated, which were generated by
using the function described above. This produces new binary files.
When .csv-files have been changed, it is necessary to generate first the files
alle_prof.inp and/or alle_sc.inp (see above).
Convert cli_pr.inp  cli_pr.csv / cli_sc.inp  cli_sc.csv
Converts the file format .inp to .csv. The profile and bolt data in .csv-format
can be edited in this tabular form.
Convert cli_pr.csv  cli_pr.inp / cli_sc.csv  cli_sc.inp
Converts the profile and bolt data with its modifications from .csv-format back
into the AVEVA Bocad format .inp.

18
 Functions of the Advanced tab

Add client profiles and bolts data .../ Client profiles and bolts data ... replace
When the Add client profiles option is activated, binary files of profiles and
bolts are added from cli_pr.inp and cli_sc.inp.
With the activated Add client profiles and bolts data cli_pr.inp and cli_sc.inp
replace bocad data option the binary files are only created from the files
cli_pr.inp and cli_sc.inp.
The files alle_prof.inp and alle_sc.inp are initialised from these new
binary files. This only works correctly if you can see new elements in al-
le_prof.inp and alle_sc.inp.

Example

Adjust client profile data with current release

1. Activate the Dump option and Apply this function: Copies from current re-
lease [DRV]:\client_data and there create miscellaneous files such as
alle_*.inp.
2. Activate the Convert alle_prof.inp  alle_prof.csv option and Apply the
function. This will convert the previously extracted .inp to .csv.
3. Activate the Convert cli_pr.inp  cli_pr.csv option and use the function:
Copy existing cli_*.inp to cli_*.csv (when no cli_*.inp is availa-
ble an empty file is created).
4. Change or complete cli_*.csv: Open the file for example with MS Excel,
modify the contents and save the changes.
5. Activate the Convert cli_pr.csv  cli_pr.inp option and execute the func-
tion: This will convert cli_*.csv to cli_*.inp.
6. Activate the Add option and Apply the function: Binary files will be created
(*.adr_ and *.inf_). When starting AVEVA Bocad next time, you can use
the updated profiles.

bocad_reg_exp/bocad_reg_imp
With bocad_reg_exp/bocad_reg_imp you can export the adapted colour set-
tings (bocad_colors) and the position of the dialogues (bocad_boxpos) of
the active user. You can import these onto another computer or for another
user on the same PC.

Procedure: Export settings

 Select the bocad_reg_exp function and click the Apply button.
 Activate the settings you want to export and click onto Apply.

19
AVEVA Bocad Admin 2.2

 Enter the target directory for the file export, e.g. [DRV]:\bocad, when a
second user wants to use the settings, or [USB stick]:\ when the im-
port shall take place on another PC.

If you do not have sufficient write permission in the target drive, a dialogue
will advise you of this. In this case the files bocad_colors.reg and/or
bocad_boxpos will automatically be added to [DRV]:\bocad\.

Procedure: Import settings

 Start AVEVA Bocad Admin on the target PC or on another user account.
 Select the bocad_reg_imp function and click onto Apply.
 Activate the settings you want to import and click onto Apply.
 Change to the directory (e.g. to the USB stick) on which the exported files
are located.
 Confirm the following queries with Yes.
The settings are written into the registry and become effective the next time you
start AVEVA Bocad.

20
 Functions of the Shared work tab

Functions of the Shared work tab

The functions of the Shared Work tab are supposed to help the new user and
especially the administrator to supervise projects which are processed by multi-
ple users.
With the AVEVA Bocad Admin tool, this supervision can be done independent
of AVEVA Bocad and provides - besides known functions of AVEVA Bocad -
functions exclusively for administrative purposes.

This tab contains specific Shared work functions which should only be used by
trained users and/or under guidance of the AVEVA Bocad support!

21

Index
bocad environment variables .........................8
Functions overview
Advanced functions ..............................................14
Shared work ...........................................................21
Index
Standard functions..................................................7
mainlocations.xml ............................................. 8
privatelocations.xml ......................................... 8
23