Beruflich Dokumente
Kultur Dokumente
(14.1)
TRAINING GUIDE
Engineering Administration
TM-3652
www.aveva.com
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 2
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Revision Log
Updates
Suggestion / Problems
If you have a suggestion about this manual or the system to which it refers please report it to AVEVA
Training & Product Support at tps@aveva.com
This manual provides documentation relating to products to which you may not have access or which may
not be licensed to you. For further information on which products are licensed to you please refer to your
licence conditions.
Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free
from viruses.
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 performance 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 www.aveva.com
such permission is
Copyright 1974 to current year. 3
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
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 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 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.
Copyright 1974 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.
AVEVA Solutions Limited, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.
AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge, CB3 0HB, United Kingdom.
The AVEVA Tags user interface is based on the Microsoft Office Fluent TM user interface.
Trademark
AVEVA and Tribon are registered trademarks of AVEVA Solutions Limited or its subsidiaries. Unauthorised
use of the AVEVA or Tribon trademarks is strictly forbidden.
AVEVA product/software names are trademarks or registered trademarks of AVEVA Solutions Limited or its
subsidiaries, 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.
www.aveva.com
Copyright 1974 to current year. 4
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
Contents
1 Introduction .............................................................................................................................................. 9
1.1 Aim..................................................................................................................................................... 9
1.2 Objectives ......................................................................................................................................... 9
1.3 Prerequisites .................................................................................................................................... 9
1.4 Course Structure .............................................................................................................................. 9
1.5 Using this guide ............................................................................................................................... 9
2 AVEVA Engineering Data Model .......................................................................................................... 11
2.1 AVEVA Engineering Project Data Setup ...................................................................................... 14
Standard Project Setup ............................................................................................................ 14
UDETs and UDAs Definition .................................................................................................. 14
Status Configuration .............................................................................................................. 15
Datasheets and Revision Configuration .............................................................................. 15
Flexible Explorer Setup ......................................................................................................... 15
Inter-disciplinary Project Data .................................................................................................. 15
2.2 AVEVA Engineering Data model setup Admin Module ........................................................... 16
2.3 AVEVA Engineering Data model setup LEXICON Module ...................................................... 16
2.4 AVEVA Engineering Data model setup Engineering Tags Application ................................. 17
Exercise 1 Develop a Data Model Definition Using Flow Chart Diagram .............................................. 18
3 Project Setup for AVEVA Engineering (Admin Module) .................................................................... 19
3.1 AVEVA Administration Modules ................................................................................................... 19
Admin ...................................................................................................................................... 19
3.2 Creating a Project .......................................................................................................................... 19
3.3 Setting up a Project (Non Interdisciplinary Project Data) .......................................................... 21
Create Teams, Users and Engineering Databases Worked Example .................................. 22
Exercise 2 Creating Engineering Database and Distributed Hierarchy ................................................ 32
3.4 Setting up a Project (Interdisciplinary Project Data) .................................................................. 33
3.5 Inter-disciplinary Project Setup Workflow .................................................................................. 34
Create Discipline ...................................................................................................................... 34
Create Maturity ......................................................................................................................... 38
Create DB-Sets ........................................................................................................................ 41
Initiate Inter-disciplinary Project Data....................................................................................... 42
Update Inter-disciplinary Project Data...................................................................................... 48
Create Project Baselines .......................................................................................................... 51
Create Users for Inter-disciplinary Project Data ....................................................................... 55
Exercise 3 Inter-disciplinary Project Data ................................................................................................ 58
4 Engineering Element Types and Attributes Definition (LEXICON Module) ..................................... 61
4.1 Engineering Objects (UDETs) definition- A Worked Example .................................................. 63
Creating a UDET world (UDETWL).......................................................................................... 63
Creating a group (UDETGR) .................................................................................................... 64
Creating a UDET ...................................................................................................................... 64
4.2 General Attributes (User Defined Attributes: UDAs) - A Worked Example .............................. 66
Creating a UDA world (UWRL) ................................................................................................ 66
Creating a UDA group (UGRO) ................................................................................................ 66
Creating a UDA ........................................................................................................................ 67
Creating a referenced UDA ...................................................................................................... 68
Graphical views of elements and attributes ............................................................................. 69
4.3 Distributed Attributes- A Worked Example ................................................................................. 70
Creating a Distributed UDET .................................................................................................... 71
4.4 Distributed Attributes Definition .................................................................................................. 73
Creating a Distributed Attributed Definition World (DSXWRL) ................................................ 75
Creating a Distributed Attribute Definition Group (DSXGRP) .................................................. 75
Creating a Default Home Definition (DSXHOM) ...................................................................... 76
Creating a Default Home Destination Definition (DSXDST) .................................................... 77
Creating a Distributed Attributes Schema (DSXSCH) ............................................................. 78
Creating a Binding Elements Definition (DSXOWN) ................................................................ 78
Creating a Bound Elements Definition (DSXMBR) .................................................................. 79
Viewing the Distributed attributes definition ............................................................................. 80
Exercise 4 Create Distributed Attribute Group UDETs and UDAs ........................................................ 80
www.aveva.com
Copyright 1974 to current year. 5
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 7
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 8
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 1
1 Introduction
This training guide has been developed for the engineering project administrative user who will be
responsible for the creation, configurations and maintenance of a defined project data infrastructure (data
model). The sections covered within, attempts to detail and describe all relevant steps required for
structuring an engineering data model.
1.1 Aim
This guide aims to be a source of the administrative knowledge necessary for the administration of an AVEVA
Engineering project. This includes the complete definition, setup and configuration of an appropriate
engineering data structure which will be run within the AVEVA Engineering Tags module. The contents of
this guide can also be referenced during maintenance activities.
1.2 Objectives
1.3 Prerequisites
Trainees should be familiar with the use of LEXICON and Admin modules of AVEVA PDMS / Outfitting /
E3D or AVEVA Administration products. Knowledge on the use and manipulation of the AVEVA
Engineering Tags application is essential.
Training will consist of oral and visual presentations, demonstrations and set exercises. Each trainees
workstation will have a supplied training project in which the sections in this guide are based upon, and will
be populated with model objects. This will be used by the trainees to practice their methods, and complete
the set exercises.
Certain text styles are used to indicate special situations throughout this document, here is a summary;
Menu pull downs and button press actions are indicated by bold dark turquoise text.
Information the user has to key-in will be red and in bold Italics.
Annotation for trainees benefit:
Additional information
Refer to other documentation
System prompts should be bold and italic in inverted commas i.e. 'Choose function'
Example files or inputs will be in the courier new font, colours and styles used as before. www.aveva.com
Copyright 1974 to current year. 9
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 10
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 2
AVEVA Engineering is a data model management and visualisation application with which tagged items
can be created, managed and stored, whilst maintaining a firm integration with corresponding or referenced
3D, Schematic and/or Engineering items.
An AVEVA Engineering data model could be structured to cater to a wide variety of engineering workflows
and scenarios as required by the users or the engineering tasks being run. Typical AVEVA Engineering data
models could be for (but not limited to):
The creation and/or management of tagged or engineering items (Data source)
Data integration center between several sources (data hub)
Data visualisation
Multi user and Multi discipline working environment
Inter discipline project data
Generation of standard engineering data deliverables
Engineering data models are dependent on a project requirement, and are defined by the project
applications implementation stakeholders.
An AVEVA Engineering data model is setup and configured by an Administrator, using the modules of the
AVEVA Administration product as well as configuration tools within the AVEVA Engineering application.
This training guide covers the administrative requirements for a standard AVEVA Engineering data model
setup and configuration for a multi user and multi discipline project. It details the steps required for the
creation, configuration and allocation of databases, engineering elements, attributes, datasheet templates
and object revisioning.
A standard AVEVA Engineering data model could be based around the sample figure shown:
In the case shown, an Engineering object (which could be a tagged item) could have a collection(s) of its
attributes assigned and grouped according to a nominated discipline. These attributes are known as
Distributed Attributes.
www.aveva.com
Copyright 1974 to current year. 11
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The standard engineering data model could further be represented by the figure shown:
Engineering objects, along with their generic attributes and nominated distributed attributes can be displayed
on a configured engineering list complete with attribute or expression columns. The acess rights of certain
attributes can be restricted for specific project discipline users, but also allowing for concurrent independent
creation / modification of permitted attribute values.
Each configured list is based on a Database View, which could also be utilized for the generation of
Reports, Datasheet configurations and data subscriptions.
A schematic breakdown of a standard data model definition with its required procedures is displayed
below:
www.aveva.com
Copyright 1974 to current year. 12
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
For the definition of a more complex engineering data model (Setup for an Interdisciplinary Project data/
Controlled Object Revisioning (COR) ), the required procedures could be structured as shown:
The procedures are contained within recommended steps during a project configuration as shown:
www.aveva.com
Copyright 1974 to current year. 13
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The procedures shown are implemented within the Admin and LEXICON modules of the AVEVA
Administration product.
These procedures also allows for the setup of more complex AVEVA Engineering data models, which could
be structured to provide a controlled revisioning of engineering objects across multiple database layers. This
can also support the data subscription and notification mechanism, in which information is shared and
consumed across disciplines.
Further setup and configuration carried out within the Engineering Tags application itself and utilise
embedded controls and functions which are reserved for an Administrative user only. These are summarized
below, and will be covered in details later in this guide.
The AVEVA Administration 1.2 (or later) product will need to have been separately installed prior
to commencing this training course
Project set-up for use of AVEVA Engineering can be carried out in two main ways. The selection of a
project creation method by the System Administrator is usually dependent on the project requirements.
These methods are:
Both project data setup methods can be deployed on the same project
The Standard Project Setup is used to for setting up new project, defining users access to a selection of
existing or newly created databases for use of the AVEVA Engineering- Tags application.
The Standard Project Setup allows an administrator to create/modify various administrative elements such
as Teams, Users, Databases, and MDBs etc. The element to be created/ modified via the Elements option
gadget as shown below:
To set up a data model definition for use in the AVEVA Engineering Tags Module,
involves a number of procedures.
The LEXICON Module enables the definition of User Definable Attributes (UDA) that
may be assigned to Engineering elements or objects.
User Defined Element Types (UDET) defined and configured as to represent the main
engineering objects in project.
www.aveva.com
Copyright 1974 to current year. 14
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Status Configuration
Status Control provides the ability to control and report on the status of individual model
objects (e.g. Engineering UDETs) as they progress their lifecycles. It can be applied to any
model objects, for example engineering tagged items, Diagrams etc. This section describes
how to assign status definitions to engineering elements UDETs.
This section will give a basic overview on the definition of Objects Revision and Datasheet
templates in AVEVA LEXICON Module to the deliver data entry and modification
functionalities within datasheets in AVEVA Engineering Tags.
Flexible Explorer provides the capability to present database content depending on user
needs. This section is an overview on how flexible/Project Explorers are defined using
sample scenarios, within the AVEVA LEXICON module.
Inter-disciplinary Project Data Setup is an added feature to the Admin Module to support the creation and
configuration of Teams, complex Extract hierarchies, and MDBs for AVEVA Engineering projects utilising the
Engineering Controlled Object Revisioning features and Notification mechanism with which data changes
are sent as notifications to subscribing users
The Project Setup workflow for Inter-disciplinary Project has been designed allowing users to configure key
Administration objects that are used to automate project setup, creating Teams, Databases (which includes
only Engineering databases) and MDBs.
New Administration Data objects, Discipline and Maturity, have been introduced alongside the existing
objects to configure Inter-disciplinary Project Setup.
Project setup automation is also implemented in PML which allows companies to tailor the process if they
wish. Inter-disciplinary Project Setup Workflow is defined as:
www.aveva.com
Copyright 1974 to current year. 15
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
AVEVA Engineering 14.1 is administered with the Admin and LEXICON Modules of the
AVEVA Administration product.
Within the Admin module for a standard project, the following entities can be created and
configured as required:
- Users
- Teams
- Databases (ENGI DB)
- Multiple Databases (MDBs)
This also incorporates the setup and application of the usual Admin
controls for Data Access Controls (DACs), Global etc...
The LEXICON module reads and writes to a dictionary database. The framework and
usability of an engineering data model is setup within the LEXICON module.
For a standard project, the following entities can be created and configured as required:
- User Defined Element Types (UDETs)
- User Defined Attributes (UDAs)
- Definition of Distributed attributes and their owners
- Status Definitions
- Database Views
- Datasheet templates
- Revision configurations for both datasheets and controlled objects
- Flexible Explorer Definitions
This also incorporates the setup and application of Unit Sets and interdisciplinary data subscriptions.
www.aveva.com
Copyright 1974 to current year. 16
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
In order for the users to begin any actual work or data visualisations, the administrator will
have to setup required database item locations, lists, integration configurations, default
datasheet templates etc. This activity is dependent on the project / user tasks requirements.
www.aveva.com
Copyright 1974 to current year. 17
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Within the AVEVA Engineering Tags application, certain configuration functions are required for the
configuration of the user environment and work space. These functions are made available only for an
administrative user, and include the configurations for:
- Database Views Editor
- Categories and Lists
- AutoNaming
- Compare/Update
- Datasheets
- Database locations for engineering items
Ideally a clean (new) project will be required in order to follow the demonstration described in the guide.
Although any existing project can be utilised as appropriate
A copy of the demo project (ACE) containing a pre-configured and setup engineering elements will be
supplied to act as a reference material and aid the trainee with working through the chapters in the
guide
Macro files which could be used to create pre-configured dictionary elements will also be supplied
Develop the layout for a standard engineering data model for Lines, Equipment, Nozzles and Valves. List
generic attributes for each of the engineering objects (tagged items). Also list and group list distributed
attributes according to an appropriate discipline.
www.aveva.com
Copyright 1974 to current year. 18
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 3
As described previously, the AVEVA Administration product consists of 2 modules, Admin and LEXICON,
which are explained in subsequent sections of this guide.
AVEVA Administration
LEXICON Creation of User Defined Attributes, User Defined Element Types, Status Definitions,
Revision Definition, Flexible Explorer Definition and Database Views.
Admin
The Admin module of the AVEVA Administration product administers the AVEVA Engineering and
Everything3D products. Its main features include:
Set up new projects, controlling which users have access to which databases.
Administer projects, including change management and setting AVEVA fonts.
Control user access to modules.
Check data integrity.
Reconfigure databases when necessary.
Create a new project using the Project Creation Wizard 1.2.0 from the start menu select:
Start > All Programs > AVEVA > Manage > Project Creation Wizard 1.2.0
Project Training
Code TRA
Location: C:\Users\Public\Documents\AVEVA\Administration\Projects1.2.0\Training
Login to the Admin module (AVEVA Administration) of the newly created project using the details
provided
by the trainer. They will typically be similar to this:
www.aveva.com
Copyright 1974 to current year. 19
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Project Training
Username SYSTEM
Password XXXXXX
It is not necessary
to specify an MDB to enter
Admin. Free Users, like
SYSTEM, are not
displayed on the
Username pull down.
The Admin default screen layout will be displayed comprising of the main pull down menus, the Admin
Explorer and the Admin functions form.
www.aveva.com
Copyright 1974 to current year. 20
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
In the data model definition example displayed below, an engineering item Pump (with associated Motor)
consists of Mechanical, Electrical and Process attributes groups, whose data will be distributed across
three (3) separate engineering databases.
Using team access control, each discipline will have full control of their own data whilst working with data
issued from all the other disciplines.
This section will utilise an example scenario (which consists of engineering elements (Pump & associated
Motor), and its Mechanical attributes data attached directly onto the engineering items. These attributes data
will be stored within the Mechanical Engineering database.The Process and Electrical attribute data are
distributed across two (2) separate Process and Electrical databases respectively. This will allow three (3)
different teams to modify data on the engineering element concurrently.
The creation of teams, databases and MDBs will be demonstrated using this sample engineering structure
displayed below:
The following example demonstration will be conducted on the newly created ACE project, or could
also be accomplished on any existing project of choice www.aveva.com
Copyright 1974 to current year. 21
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
To control who can modify or update engineering items (Pump & Motor) attribute data and distributed data,
the following elements must be created in the AVEVA Admin Module according to the data model definition
diagram shown previously.
Start > All Programs > AVEVA >Manage > AVEVA Administration 1.2.0
Project ACE
Username SYSTEM
Password XXXXXX
Teams
- AMECHENG
- AELECENG
- APROCENG
www.aveva.com
Copyright 1974 to current year. 22
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 23
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
USERS PASSWORD
ELEC.ENGINEER A
MECH. ENGINEER A
PROC. ENGINEER A
Make the Users members of the following teams:
TEAM AELECENG
TEAM MEMBER ELEC.ENGINEER
TEAMAMECHENG
TEAM MEMBER MECH.ENGINEER
www.aveva.com
Copyright 1974 to current year. 24
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
TEAM ..APROCHENG
TEAM MEMBER PROC.ENGINEER
For further details, on creation of Teams and Users, please refer to AVEVA Plant System Administration
User Guide (TM1300) www.aveva.com
Copyright 1974 to current year. 25
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
1. Create Mechanical Engineering Database To store Engineering Attribute Data that is directly
attached to engineering Item in this case Pump & associated Motor.
To create Engineering database, select Databases & Extracts from the Elements options list. Click the
Create button to display the Databases & Extracts form
Click the Master DB radio button and click the OK button to display the Create Database form.
Select <Team> AMECHENG from the Owning Team grid Name column.
Name TAGSMATER.
www.aveva.com
Copyright 1974 to current year. 26
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
To create an Engineering World for Mechanical Attributes data in AVEVA Tags database Explorer,
Select Engineering Data World from Element Type pull-down.
The Create ENGWLD (Engineering World) field is then displayed. Enter the required value in this case
MECH-Items-and-AttData.
To create Engineering database for Distributed Electrical Attributes Data, select Databases & Extracts from
the Elements options list. Click the Create button to display the Databases & Extracts form.
Click the Master DB radio button and click the OK button to display the Create Database form.
Select <Team> AELECENG from the Owning Team grid Name column.
Name ENGIELECTDIST
www.aveva.com
Copyright 1974 to current year. 28
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
To create Distributed attribute data World (top-level administrative element) for Electrical Attribute data in
AVEVA Tags database Explorer, select Extended Properties World from Element Type pull-down list.
The Create XPIWLD (Distributed World) field is then displayed. Enter the required value e.g.
ELECTAttData as highlighted.
Distributed attributes World (XPIWLD) is a toplevel administrative container for distributed attribute
data.
www.aveva.com
Copyright 1974 to current year. 29
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Repeat the procedure as described in step 2 (Electrical Engineering Database) to create Engineering
database for Distributed Process Attributes Data.
To create Distributed attribute data World (top-level administrative element) for Process Attribute Data in
AVEVA Tags database Explorer, select Extended Properties World from Element Type pull-down list.
The Create XPIWLD (Distributed World) field is then displayed, enter the desired value in this case
PROCAttData as highlighted.
The newly created Engineering databases must be added to the current project Multiple Database (MDB), in
this case A-Tags MDB.
For further configuration and definition of an engineering project within the LEXICON Module, a writable
Dictionary (DICT) Database must be created. This will store all the elements set up within the
LEXICON Module
Created a new Dictionary (DICT) Database named: ENGDICT-B, owned by the team PPROJECT
created. This will store all the elements set up within the LEXICON Module www.aveva.com
Copyright 1974 to current year. 30
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
To view the newly created Engineering Data World (ENGWLD) and Distributed World (XPIWLD) in
AVEVA Engineering Tags database Explorer:
Project ACE
Username SYSTEM
Password XXXXXX
MDB -----A-Tags
Select the Explore tab from AVEVA Tags main toolbar to view the created database worlds as shown.
www.aveva.com
Copyright 1974 to current year. 31
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Using the data model definition developed in exercise 1, Login into AVEVA Admin Module using the details
provided by the Trainer.
- Process Team.
- Piping Material Team.
- Piping Stress Team.
- Process Users.
- Piping Material Users.
- Piping Stress Users.
- Piping Material Engineering Database - Storage for Distributed Piping Material Attribute
Data.
- Piping Stress Engineering Database - Storage for Distributed Piping Stress Attribute
Data.
Modify project MDB ( A-Tags) to include newly created Databases. Place the databases in the following
order, Process Engineering Database (as the first Engineering DB in the Current Database grid),
followed by Piping Material Engineering DB and Piping Stress Engineering DB.
3 (d). Login into AVEVA Engineering Tags Module using the details provided by the Trainer, to view the
newly created Engineering Data World (ENGWLD) and Distributed World (XPIWLD) in AVEVA Tags
database Explorer.
Project ACE
Username SYSTEM
Password XXXXXX
MDB -----A-Tags
www.aveva.com
Copyright 1974 to current year. 32
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Inter-disciplinary Project Setup allows engineering projects to be configured to support Controlled Object
Revisioning functions in AVEVA Engineering.
An extract hierarchy is used to support the general Working -> Approval ->
Issue mechanism for the data being modified. Extract databases called
consumer extracts allow users to pull changes from other disciplines into
their view
In the example diagram below the User is a Junior Piper working in the Piping Discipline. The Junior Piper
has an Equipment list with their own discipline attributes (E, F, G), but also wants to see attributes from
Instrumentation, Electrical and Mechanical disciplines. The Junior Piper can change the (EFG) data, but
only has read access to other data via consumer extracts. The Junior Piper MDB has read-only access to
consumer extracts for Instrumentation, Electrical and Mechanical disciplines.
Status Management functions are used to promote data from Working to Approval, and finally from 'Approval
to Issued in the items normal lifecycle. Upon reaching the Issued level the system sends a notification to
Users in other disciplines to indicate that changes are available once changes to data from one of the
Instrumentation, Electrical or Mechanical disciplines has been made available in the Issued level.
www.aveva.com
Copyright 1974 to current year. 33
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
To simplify Inter-disciplinary Project Setup a workflow has been designed allowing users to configure key
Administrative objects that are used to automate project setup, creating Teams, Databases and MDBs.
As part of the Inter-disciplinary Project Setup Workflow, Baseline Project Data can also be created.
Baselines allow a view of all disciplines data to be saved in a particular state. Each discipline can continue to
change data and create new revisions of data without changing the view of a project saved in a baseline.
Baselines may be created at any time in a project after the initial project configuration has been defined, and
in practice they are likely to be created at key project milestones.
Discipline data is not changed in a Baseline view, so Baselines do not have their own database hierarchy.
Baselines have consumer extracts which are added to each disciplines released (master) database.
Through these consumer extracts System Engineers can control what version of released data will be saved
to a baseline. Each Baseline has an MDB which contains all consumer extracts related to that Baseline.
System Engineers use this MDB to view a Baseline.
Create Discipline
Discipline objects have been introduced alongside the existing objects to configure Inter-disciplinary Project
Setup. The object represents a Discipline as defined by the Engineering requirement.
In the Admin module, click Disciplines (ENG) on the Administration Elements form element type selector to
display the Discipline elements form.
www.aveva.com
Copyright 1974 to current year. 34
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 35
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Name: ELECTRICAL
The Name. Text field is used to define Element Name
and can be modified any time before or after a project definition
has been created
Description: Electrical
The Description Text field is the description of the discipline and can be modified any time before or
after a project definition has been created
The DB Range Start Numeric field is used to set the lowest database number that will be applied to
databases created for this discipline. The system finds the first unused DB number greater than or
equal to the given number for databases created for this discipline
www.aveva.com
Copyright 1974 to current year. 36
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Click the OK button to create the discipline and close the form.
The Discipline elements can only be deleted if they have not been used in a Project Definition.
Discipline elements cannot be deleted at a satellite end of a globalised project
Repeat the procedure as described in Section 3.5.1 to create the following disciplines using the
information in the table below:
www.aveva.com
Copyright 1974 to current year. 37
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Create Maturity
Maturity defines the Approval process that items should go through in their lifecycle. A standard three level
approval mechanism for example of Release-> Approve -> Work requires 3 levels of extracts:
Released = Master
Approve = Level 1 Extract
Work = Level 2 Extract.
Items can be created and modified in the Work 2nd level extract. Once they require Approval they are
dynamically issued into the Approve 1st level extract after a status change. Then finally when they are
APPROVED, they are dynamically issued into the Released Master database.
A Maturity hierarchy can have two or more extract levels, and the names used for each level can be defined
during the creation of the Maturity objects.
To define a Maturity, click Maturity (ENGI) on the Administration Elements form type selector to display the
Maturity elements form.
www.aveva.com
Copyright 1974 to current year. 38
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Create and Modify functions display the same form which allows for new Maturity elements to be
created and existing Maturity element attributes to be modified.
In the Maturity form, clicking the New button adds a row to the end of the table for that element.
www.aveva.com
Copyright 1974 to current year. 39
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The arrows on the right side of the form is used to re-order the Maturity Objects. It is possible to create
Maturity objects in any order, and then re-order the levels to a preferred order. Maturity elements
cannot be re-ordered once a project definition is created and they cannot be modified at a satellite of a
Globalised project
Name: RELEASED
The Name. Text field is used to define Element Name and can be modified any time before or after a
project definition has been created.
The Name can be entered with or without the preceding /. Spaces are removed from names before
submitting changes to the database.
The Display Name. Text field is a descriptive text for discipline and can be modified at any time before
or after a project definition has been created.
The Code.is an alphanumeric Text field. The Code can be used in automatically generated teams,
databases and MDB names.
www.aveva.com
Copyright 1974 to current year. 40
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Maturity Code must be unique for each maturity levels. Once an Inter-disciplinary project setup has
been created
The Maturity Code cannot be modified. The Code can be modified until it has been referenced by a
project definition
Repeat the same procedure as described in Section 3.5.2 to create the following Maturity levels using the
information in the table below:
Create DB-Sets
The automated Inter-disciplinary Project Setup mechanism creates Engineering databases and extracts.
Relevant databases (e.g. Dictionary, Design etc.) which are not created during this process will need to be
included in utilised MDBs in order for the users to gain access to relevant data from other applications.
It is possible to create a DB Set to hold these relevant databases which will be referenced during Inter-
disciplinary Project Setup creation using existing Administration DB Set functions as shown:
www.aveva.com
Copyright 1974 to current year. 41
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The created Dictionary (DICT) Database (ENGDICT-B) must be included in the created DBSET as this
will store all the elements set up within the LEXICON Module as well as grant access to the elements to
engineering users who have the DICT DB included in their MDBs
To simplify the Inter-disciplinary Project Setup workflow an automation process has been designed allowing
users to, create Teams, Databases and MDBs. When the automation process is run, an extract hierarchy is
created for each discipline according to the specified maturity levels, along with consumer extracts for each
Discipline extract hierarchy other than itself.
The Consumer extracts all belong to a single consumer extract team named <base-name>CX. No
users need to be assigned to this team, they allow for the reference of other disciplines data
Before running the automation process for Inter-disciplinary Project Setup workflow. It is very important
to review the Maturity levels definitions and other relevant setup necessary for the Inter-disciplinary
Project Setup automation process to run
www.aveva.com
Copyright 1974 to current year. 42
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Inter-disciplinary Project Data form is then displayed with pre-populated Disciplines and Maturity
definitions.
The Base name is used to identify the project definition. It is used in naming conventions for databases
and MDBs linked to this project definition. The Base name cannot be changed after project data has
been created
www.aveva.com
Copyright 1974 to current year. 43
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 44
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Naming Convention section of the Inter-disciplinary Project Data form is for information only. This
shows how team, database and MDB names are formed.
Click the Create Project Data button to create teams and databases.
After Inter-disciplinary Project Data has created all the required database elements. The discipline list shows
a green tick for each discipline that has been defined.
The Date and Time highlighted below is the date that the session in which the project definition was created
is saved to the database.
www.aveva.com
Copyright 1974 to current year. 45
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
A Project Definition can be deleted if no data has been stored in any of the databases. In a Globalised
project databases can only be deleted at the hub, and only if these databases are not allocated to
another location.
If project data is created some messages appear in the Summary panel along with a Details button which is
a link to a log file that records the objects created, along with any warning messages. www.aveva.com
When the Inter-disciplinary Project Data definition is run, a team is created for each combination of discipline
and maturity. And a Team is created for all the consumer extracts.
www.aveva.com
Copyright 1974 to current year. 47
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Also when Inter-disciplinary Project Data project definition is run Master Engineering Databases are created
for each Discipline and Database extracts for the main Maturity workflow and for the read only consumer
extracts.
In the Databases & Extracts form apply a filter on the TYPE column to display the newly created ENGI
database as shown above.
A new discipline can be added after a project definition has been initialised.
To do this, repeat the same procedure as described in Section 3.5.1 to create a Mechanical discipline
using the information in the table below:
Select Utilities>Inter-disciplinary Project Data>Manage to display the Inter-disciplinary Project Data form.
www.aveva.com
Copyright 1974 to current year. 49
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The form shows the new discipline in the discipline table but it is unmarked because databases for that
discipline have not been created.
Click the Update Project Data button to confirm the addition of the new discipline to the existing project
data.
Click the Yes button to add the new discipline to existing project
data.
The discipline list shows a green tick for the new discipline that has
been defined.
www.aveva.com
Copyright 1974 to current year. 50
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The system adds new master database and maturity extract databases for the new discipline, along with
consumer extracts to share other disciplines data with the new discipline and vice-versa. New teams are
created with MDBs for the new discipline. Other disciplines MDBs are modified to add consumer extracts for
the new discipline.
To simplify Inter-disciplinary Project Baseline Setup an automation process has been implemented to allow
users to, create BaselineTeam Databases and MDBs. When the automation process is run, consumer
extract databases for each discipline are created and included in the MDB for that baseline. The MDB
contains the baseline consumer extracts and loads databases from the common database set used in
discipline MDBs.
To run the Inter-disciplinary Project Baseline Setup, select menu command Utilities>Inter-disciplinary
Project Data>Baseline to configure project data baselines.
www.aveva.com
Copyright 1974 to current year. 51
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Name: ACE
The element Name can be defined and modified at any time before or after a project definition has
been created. Name can be entered with or without the preceding /. Spaces are removed from names
before submitting changes to the database
ID (Required): ACE
The ID alphanumeric Text field can be used in automatically generated database and MDB names.
Baseline ID must be unique and must not contain symbols or spaces
The after Baseline databases have been created the Baseline ID cannot be modified
Click the Create Database button to create the Project Baseline Database. One or more rows in the table
must be selected for the Create Databases function to become enabled.
The selected baselines must have a valid ID and must not have databases associated with them
The Project Baseline Name column in the table shows a green tick for the newly defined Baseline.
www.aveva.com
Copyright 1974 to current year. 52
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Project Baseline setup creates a team with a name convention <base name>BL. This team is used by
all baselines, so it is only created when the first baseline is created.
A Consumer extract database is created for each discipline and included in the MDB for that baseline.
www.aveva.com
Copyright 1974 to current year. 53
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Project Baseline setup creates an MDB for the baseline, MDB names are <Base name>_<Baseline
ID>_BL. The MDB contains the baseline extracts and loads databases from the common database set used
in the discipline MDBs.
Immediately after the baseline extract databases have been created the Summary panel contains
messages generated by the system along with a Details button which links to a log file that records the
objects created, along with any warning messages.
www.aveva.com
Copyright 1974 to current year. 54
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Inter-disciplinary Project setup automation process has not been configured to create Users. The Users
are created separately by the Administrator after the creation of the Inter-disciplinary Project Data.
Create Users for Mechanical, Instrument and Electrical disciplines using the information in the table below:
www.aveva.com
Copyright 1974 to current year. 56
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Using the procedure described above, make the following Users members of the relevant teams as shown:
www.aveva.com
Copyright 1974 to current year. 57
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
1. Using existing ACE Inter-disciplinary Project Data definitions create the following Disciplines:
Display
Discipline Code Description DB Rang Start
Name
PIPING Piping PIPE Piping 250605
PROCESS Process PROC Process 250601
www.aveva.com
Copyright 1974 to current year. 58
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
3. Create a new Project Data Baseline using the information in the table below:
4. Create the Users for Piping, and Process discipline using the information in the table below:
www.aveva.com
Copyright 1974 to current year. 59
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 60
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 4
This chapter will extensively cover the creation and setup of the basic but fundamental elements required for
defining a standard engineering data model.
These will be structured as engineering objects owning their generic attributes, and also owning distributed
attributes which are collected within disciplines. Macros will be supplied to support the exercises.
The created element will then be appended to Database Views, which are setup with attribute and
expression columns. The Database Views will serve as the basis for the creation of Engineering Lists etc.
www.aveva.com
Copyright 1974 to current year. 61
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Using the AVEVA Administration 1.3.0 product, log into the supplied project with the details as shown:
PROJECT: ACE
USER: SYSTEM
PASSWORD: XXXXXX
MDB: ADMIN-LEXICON
Click on the LEXICON tile, to launch and display the LEXICON module.
www.aveva.com
Copyright 1974 to current year. 62
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Engineering objects are created as User Defined Element Types (UDETs), and assigned generic attributes.
As the LEXICON module reads and writes to the Dictionary database, the administrator should
ensure that all required dictionary databases are available as appropriate. This also includes all
team memberships and user access rights as covered in the preceding chapters
Within the Current Element Editor, fill in the attribute details of the created UDETWL world as shown.
Dictionary items can be created from the Create button on the menu bar, or creation commands
can also be entered as command line syntax in the command window
www.aveva.com
Copyright 1974 to current year. 63
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Within the Current Element Editor, fill in the attribute details of the created UDET group as shown.
Creating a UDET
Within the Current Element Editor, fill in the attribute details of the created UDET as shown.
This creates an engineering element type with user defined name: EQUIPMENT with basetype ENGITE,
from which objects / equipment tagged items can be based. The Equipment object can also own other
equipment objects if :EQUIPMENT is selected as its Member type. Selecting ENGGRP indicates that
engineering objects can only be created within an ENGGRP db element within the Tags Application.
Using the methods demonstrated, more user defined element types are created and named as shown:
- Instrument - Line
- Valve - InstLoop
- HVAC - Nozzle
www.aveva.com
Copyright 1974 to current year. 64
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 65
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Existing User Defined attributes can be appended to any created Engineering element type, but new
attributes can be created as required:
Within the Current Element Editor, fill in the attribute details of the created UWRL world as shown.
The creation commands can also be entered as command line syntax in the command window
Within the Current Element Editor, fill in the attribute details of the created UDA group as shown.
www.aveva.com
Copyright 1974 to current year. 66
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Creating a UDA
Within the Current Element Editor, fill in the attribute details of the created UDA as shown.
Name: TagLetter
Description: Tag Letter
Abbreviation Length: 9
UDA type: Text
Abbreviation Length: 5
Element type: :EQUIPMENT :INSTRUMENT : NOZZLE :VALVE
User defined name: TAGLETTER
Reporter Text: Tag Letter
UDA Category: TagDefinition
www.aveva.com
Copyright 1974 to current year. 67
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
A referenced UDA is one which references an existing element type. It could be used to obtain specific
information from an object based on the referenced type.
Just as accomplished earlier, select the newly created UDA group, display the context menu and click Create
> UDA: User defined element to create a User defined element group
Within the Current Element Editor, fill in the attribute details of the created UDA as shown.
Name: NozzleConnection
Description: Nozzle Connection
Abbreviation Length: 8
UDA type: reference
Abbreviation Length: 120
Element type: : NOZZLE
Referred type: :EQUIPMENT
Indexed UDA: True
User defined name: NOZZCONN
Reporter Text: Tag Letter
UDA Category: TagDefinition
www.aveva.com
Copyright 1974 to current year. 68
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
To gain an overall layout view of the attributes assigned to all available engineering objects click Graphical
View to display a schematic representation:
www.aveva.com
Copyright 1974 to current year. 69
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Distributed attributes could simply be defined as a cluster or collection of attributes of an element. Each
collection could be based on any criteria, and could be managed independently by different appropriate
users concurrently without laying claim to the main engineering object.
This training course assumes the collections of distributed attributes to be by discipline. Users of each
defined discipline will be able to create, modify and manage the attribute values assigned to their discipline.
For the created engineering object (:EQUIPMENT) element type, the nominated disciplines are:
- Electrical
- Mechanical
- Process
Each distributed element is tied to a nominated Owner (Owning engineering object). The
nomination of these elements will be described in subsequent sections
Although the Engineering object is stored in an engineering (ENGI) Database, its distributed
attributes can be stored in separated engineering databases. The ability to read, create or modify
an attribute is dependent on the read/write access to the database which holds www.aveva.com
the attribute values
Using the procedures described earlier, create a new UDET to group distributed elements, then a User
Defined Element Type with basetype XPITEM as shown:
Name: MECHANICAL-ATTRIBUTES
Description: Mechanical Attributes
User defined name: MECHANICAL-DATA
Base type: XPITEM
Owner Types: XPIFLD
This creates a distributed element UDET, with basetype XPITEM, whose attributes will be discipline
specific.
Using the methods demonstrated, 4 more user defined element types (XPITEMs) are created with user
defined names as shown:
- INSTRUMENT-DATA
- VALVE-DATA
- INSTLOOP-DATA
- ELECTRICAL DATA www.aveva.com
Copyright 1974 to current year. 71
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
From groups of attributes (UDAs) created earlier, the appropriate discipline attributes are assigned to the
created distributed elements (XPITEMs) as demonstrated earlier (Similar with the assignment of UDAs to
UDETs).
www.aveva.com
Copyright 1974 to current year. 72
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Using the graphical view functionality, all existing distributed elements can be viewed, with the attributes
assigned to them:
Having created all required User Defined Element Types (ENGITEs) / Engineering object types, User
Defined Attributes (UDAs) (as required by the relevant disciplines), and the Distributed UDETs (XPITEMs)
the distributed attribute definitions can now be setup.
A distributed attribute definition could be setup according to the schematic diagram shown:
www.aveva.com
Copyright 1974 to current year. 73
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
For a multi discipline project setup, the distributed attribute definition helps performs the following functions:
- Specifies a main engineering object which holds attributes for various disciplines(Binding Element)
- Assigns discipline objects (Distributed udets) to a main engineering object
- Specifies the location where discipline attributes will be stored.
Within the Current Element Editor, fill in the attribute details of the created DSXWLD as shown.
www.aveva.com
Copyright 1974 to current year. 75
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Within the Current Element Editor, fill in the attribute details of the created DSXGRP as shown.
Within the Current Element Editor, fill in the attribute details of the created DSXHOM as shown.
www.aveva.com
Copyright 1974 to current year. 76
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Within the Current Element Editor, fill in the attribute details of the created DSXDST as shown.
The entry for Home Location is a PML 1 expression which references the name of the XPIWLD hierarchy
level (in the Engineering database explorer) where distributed elements (disciplines) and their attributes
are to be created and stored.
www.aveva.com
Copyright 1974 to current year. 77
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Within the Current Element Editor, fill in the attribute details of the created DSXSCH as shown.
Within the Current Element Editor, fill in the attribute details of the created DSXOWN as shown.
www.aveva.com
Copyright 1974 to current year. 78
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Within the Current Element Editor, fill in the attribute details of the created DSXMBR as shown.
Name: LINE-PROCESS-DATA
Default home: LINE-PROCESS-ATTRIBUTES-HOME
Auto Creation: True
Cardinality: 0, 1
Element types: :PROCESS-DATA
The Default home entry displays a pick list which contains any existing Default home definitions
(DSXHOM).
Selecting a default home means that a referenced distributed element type (DSXMBR) can be created and
stored at the database location (DSXDST) specified by the default home (DSXHOM)
Cardinality helps specify the minimum and maximum number of each of the assigned attributes which may
be created. For Example, a cardinality of (0, 2) means that the distributed element :PROCESS-DATA will
have 2 instances of the attribute :MAXFLOWRATE (:maxflowrate1, :maxflowrate2)
Setting the Auto Creation entry to True ensures that the distributed element will be automatically created
when a distributed attribute value is filled in at the first instance.
www.aveva.com
Copyright 1974 to current year. 79
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The nominated Element Types specifies the XPITEM based UDET, which will be considered as a
distributed element, and whose attributes will be referenced by an ENGITE (DSXOWN)
www.aveva.com
Copyright 1974 to current year. 80
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
A Status definition is the implementation and structuring of the Status Control mechanism.
Status reasons is a configurable function with which allows for the definition of mandatory reasons to be
selected during status transitions.
This means that when a status change is being made, the user can select a reason from a pick list of
configured reasons.
The status reason is defined with a new dictionary element (UDLOV) which is used to manage a new text
attribute Reason. The reason will be assigned to a Status value (STAVAL), and can be visible as a pick list
within the Status edit form in the Tags module.
www.aveva.com
Copyright 1974 to current year. 81
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Name: ApproveReasons
Valid Values: For Calculation check
For safety check
For general check
Value Type: Text
Create and enter the attributes for the second UDLOV (ReleaseReasons) as shown:
Name: ReleaseReasons
Valid Values: For Construction
For tender
For review
For Design
Value Type: Text
The status reasons created will be utilised during the definition of both the Approved and
Released status values (STAVAL) www.aveva.com
Copyright 1974 to current year. 82
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Within the Current Element Editor, fill in the attribute details of the created STAWLD as shown.
Within the Current Element Editor, fill in the attribute details of the created STADEF as shown.
www.aveva.com
Copyright 1974 to current year. 83
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Name: ENGR-STATUS-DEFINITION
Description: Status definition for Engineering items
Initial Status: Identified
Within the Current Element Editor, fill in the attribute details of the created STAVAL as shown.
Name: IDENTIFIED
Description: Identified
Select the created Status definition STADEF, display the context menu and click Create > STAVAL:
Status Value to create further Status Values.
Within the Current Element Editor, fill in the attribute details of the created STAVAL as shown.
Name: WORKING
Description: Working
Valid Trainsitions: IDENTIFIED
Demote: IDENTIFIED
www.aveva.com
Copyright 1974 to current year. 85
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the created Status definition STADEF, display the context menu and click Create > STAVAL:
Status Value to create further Status Values.
Within the Current Element Editor, fill in the attribute details of the created STAVAL as shown.
Name: PENDING-APPROVAL
Description: Pending Approval
Reason Values: ApproveReasons
Valid Trainsitions: WORKING
Demote: WORKING
This status level is defined so that status level WORKING transitions to the PENDING-APPROVAL status
value after a promotion.
The Reason values is defined for this status value (STAVAL), as it is required for this status. This means
that when the user promotes the status of the engineering object from the WORKING state to the
PENDING APPROVAL the dialogue form will carry a pick list with the specified reason values. The
selection of a reason value in this case is mandatory.
www.aveva.com
Copyright 1974 to current year. 86
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Following the predefined Status Definition in the supplied training project, a completely configured project
status definition could be structured to look as shown:
Status values (STAVAL) Promotion transitions are marked with the GREEN arrows, while the
Demotion transitions are marked with RED arrows. BLACK arrows mark natural transitions
www.aveva.com
Copyright 1974 to current year. 87
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 88
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
A Database View is a Dabacon based functionality with which attribute data of elements can be collectively
configured to map into the cells of a table. These tables can be generated as lists, indexes and reports.
A Database View definition is based on any available element type, with column references to a selection of
its attributes or expressions defined beneath.
The Database View definition will allow a table to create and list instances of the element type (database
items) in rows with the columns controlled by their selected attributes or expressions (PML 1 or XPath 1.0
expressions).
In other words, as a Database View it supports a list view table, where each row of that table will be an
instance of an element type(s), and the cells of each column will either be a value of an attribute or expression
based on the corresponding row element.
It is possible for each row to represent data from multiple element types and also multiple database
elements may be modified if a row of data is edited in a grid or via an import
A generated engineering list consists of rows and columns, and is based on a Database View. Row entities
are controlled by the applicable element types, as each row is an instance of that element type, hence a
database item. Columns are controlled by element attributes or expressions, hence referred to as Attribute
Columns (ATTCOLS) and Expression Columns (EXPCOLs)
Defined Database Views will consist of a base element type, and configurations for Attribute columns. Other
configurations might include Expression columns, attribute filters and item Creation rules.
www.aveva.com
Copyright 1974 to current year. 89
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Database View can also be defined for additional element types, making it possible to include their
attribute and expression data onto the same list / table. These additional element types can be configured as
Source Elements
For an engineering project setup, the Database Views definition helps performs the following functions:
- Specifies the major element (UDET) which a list is based on
- Specifies properties which are available as list attribute columns and expression columns
- Defines the required contents and behaviour of an engineering list
- Defines the creation requirements and criteria for list items
- Defines the presentation structure of list items
www.aveva.com
Copyright 1974 to current year. 90
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Database View
DBVW A table definition that defines the display name, element criteria and
columns
Attribute Filter:
An attribute filter is a test executed against the selected element
ATTFIL based on the value of a specified attribute such as DESC Equals
Vessel. A database element must match all filters present in the
Database View to be present in the resulting table
Expression Filter:
An expression that must evaluate to TRUE or FALSE to determine
EXPFIL whether a database element is part of the database view. A
database element must match all filters present in the Database
View to be present in the resulting table
Attribute Column:
This is an element which defines columns based on a single
attribute. Attributes may be system attributes or UDAs. Qualifiers
ATTCOL can be specified where required such as when accessing the status
of a particular element. Columns based on attributes are by default
editable but can be made to be read only to help with workflow
management
Expression Column:
This is an element which defines columns based on a PML or XPATH
EXPCOL
expression. Expression columns are read only unless software is
written to make them editable.
Source Element:
This is an element which defines a navigational step from the current
context element to another database element. All columns defined in
SRCELE the Source Element are then based on the element that results from
the navigation. Such columns are editable so rows in Database Views
allow editing of more than one database element.
www.aveva.com
Copyright 1974 to current year. 91
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Creation Rule:
This defines the rules for element creation. If within a DBVW element
then the rules permit row creation for the Database View provided that
CRERUL
the AUTCRE attribute is set to TRUE. Information such as where to
create the new item or what type of element to create can be fixed or
specified using expressions
Set Parameter:
This is an element used to define parameters for expressions in
SETPAR other create rules. A parameter can be used in expressions on the
CRERUL, SETATT or TESTEX elements. Parameters provide the
ability to prompt a user for a single piece of information and then
use it in multiple expressions
Set Attribute:
This defines a rule to set a database attribute when the element is
SETATT created. This allows attributes to be defaulted at the point of creation
and forces a user/application to provide a mandatory attribute value
at the time of element creation.
Test Expression:
TESTEX if this evaluates to true then the owning rule will be carried out,
otherwise the owning rule is ignored
Column Relation:
This element defines a Parent/Child relationship between columns for
COLREL
application use. These relationships are currently not supported in the
standard applications
Typical Database Views setup will have most of the hierarchical elements configured, but this depends on
the purpose and use of resulting lists and tables based on the Database Views.
The following sections will describe the definition steps of a Database View, and the configuration of its
hierarchical elements.
www.aveva.com
Copyright 1974 to current year. 92
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Database Views are defined via the Database Views Editor within the LEXICON and Tags modules, or with
the Current Element Editor within the LEXICON module as was originally default.
The Database Views Editor is a General user interface for the creation and definition of Database Views in
a quick and user friendly manner.
The following example will demonstrate the definition of a Database View for a mechanical equipment. Like
previous examples, this utilises the supplied demo project.
With the Current Element Editor, fill in the attribute details of the created DBVW world as shown.
www.aveva.com
Copyright 1974 to current year. 93
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
With the Current Element Editor, fill in the attribute details of the created DBVW world as shown.
The Current Element Editor form of the Database View includes entries for a User Defined Name, as this
will be the identifier for the Database View. Required Element Type(s) can be selected, as list data will be
based on this.
Auto Creation is set to True as this will allow the creation of new rows (new instances of the selected
element type) on any generated list/table which is based on this Database View.
www.aveva.com
Copyright 1974 to current year. 94
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Setting the Allow Deletion to Falsewould make it impossible to delete an item from a list which is
based on this Database view
The utilized element type :EQUIPMENT is an engineering UDET which has been pre-defined for this
exercise
The section Basic definition, of the Current Element Editor form of the Attribute Column includes entries
for a User Defined Name, as any entered value will be displayed as the default caption (Column header) of
the column on a list/table. Required and applicable attributes which have been appended to the utilized
element type can be filled in, as the column will be based on this attribute.
The Read only entry is set to False as this will allow the values within the list/table columns to be editable.
The utilized Attribute :TAGNUMBER entry is an engineering UDA which has been pre-defined for this
exercise. Utilized attributes must already have been predefined and exist
www.aveva.com
Copyright 1974 to current year. 95
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The section Basic definition, of the Current Element Editor form of the Expression Column includes entries
for a User Defined Name, as any entered value will be displayed as the default caption (Column header) of
the column on a list/table. Required and applicable expressions and the expression type are filled in, as the
column will be based on this expression.
Generated expression columns will be marked as Read only by default, as their cell values are derived, and
not directly entered nor modifiable.
www.aveva.com
Copyright 1974 to current year. 96
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The section Basic definition, of the Current Element Editor form of the Attribute filter includes entries for
an attribute with which the filter will be based on. The Filter operator defines the condition/criteria for the
selected attribute. The Filter value is a value which applies to the condition/criteria defined.
In this case, any generated list/table based on this Database View will only display a :TAGNUMBER column
which contains values starting with the characters 16. Every other Tag number will be filtered out.
The section Basic definition, of the Current Element Editor form of the Expression filter includes entries
for an Expression, and Expression type with which the filter will be based on. The expression filter is utilized
if the attribute filter is not sufficient to filter elements, but rather complex conditions are required. A PML type
expression could be (:equiclass eq Pump).
Expressions can be used to define conditions/criteria to filter values displayed in a generated list/table. This
will not be filled in, as it is not required for this exercise. Expression will be left unset.
www.aveva.com
Copyright 1974 to current year. 97
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The section Basic definition, of the Current Element Editor form of the Creation rule includes entries for
an Owner Expression, which is an identifier for the engineering group (ENGGRP) where new :EQUIPMENT
type items / instances will be created and stored. The ENGGRP exists in the engineering database, and can
be accessed via the Tags module. Its name will serve as the Owner of any new EQUIPMENT items.
The Owner Expression type indicates the type of expression used. The Type expression entry requires an
expression which identifies a specific element type which a created item is based on. This is not essential
since the utilized UDET (:EQUIPMENT) can be derived.
Defining the Creation rule ensures that each time a new item is being created on the Database View list /
table, a prompt form appears requesting values for required or optional preconfigured parameters.
Selecting True for the Create ancestors entry makes it possible for new items to be created and stored in
any other existing Owner element (ENGGRP) database hierarchy within the Tags module), if an Owner
Expression is not defined.
The user will be prompted to select from an existing ENGGRP, or create a new one, during the creation of a
new database item.
This means that items created in a list based on this DB view, will
be saved in the ENGGRP Mechanical-Items
www.aveva.com
Copyright 1974 to current year. 98
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The section Basic definition, of the Current Element Editor form of the Set Parameter includes entries
for a User Defined Name, as this value will be the identifier for the parameter.
The value in the Expression entry indicates that whenever this parameter is utilized, any expression value
will be evaluated.
The Creation rule ensures that a prompt form for the entry of parameter is displayed during the creation of
database items in the Tags module, hence the User Prompt entry Tag Number will be displayed on that
form where the user can enter a relevant value. Setting the entry for Required to True ensures that this will
be a mandatory requirement for item creation. If set to False then the parameter entry on the prompt form
will be listed as Optional.
Create 4 further Set Parameter rules and fill in the attribute details as shown.
www.aveva.com
Copyright 1974 to current year. 99
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Tag Number, Tag Prefix and Tag Letter parameters will be displayed as a required (Required:
True) entry on the Creation rule prompt form, and entered values will be utilized in any expression in
which they apply
The Tag Suffix parameter will be displayed as an optional (Required: False) entry on the Creation
rule prompt form, and entry of values is not mandatory
www.aveva.com
Copyright 1974 to current year. 100
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The section Basic definition, of the Current Element Editor form of the Set Parameter includes entries
for Attribute, as this is the selected attribute values will be controlled by the rule.
The Expression entries will extract the values to be utilised for the selected attributes of items to be created.
In this case, the expression points to the defined parameters, as these parameter values are entered in the
Creation rule prompt form.
The entered parameter values will then be evaluated according to the expression, and a final value will be
appended to the attribute of the newly created item.
The Required entry is set to True, ensuring that the application of this rule is mandatory.
Create 2 further Set attribute rules and fill in the attribute details as shown.
www.aveva.com
Copyright 1974 to current year. 101
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 102
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The section Basic definition, of the Current Element Editor form of the Set status includes entries for
Status Definition Ref, as this allows the user to select from a drop down list, a required status definition with
which this rule applies.
The Set status rule appends the Initial status value of the selected status definition to newly created items
on a Database View list / table.
The Required entry is set to True, ensuring that the application of this rule is mandatory.
When a new engineering item is created, it will be appended with the initial status value defined for the
selected status definition
www.aveva.com
Copyright 1974 to current year. 103
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The section Basic definition, of the Current Element Editor form of the source elements includes an entry
for Expression, in which an expression extracts the element type whose attribute data will be defined
beneath.
In this case,selected attribute data of the distributed UDET (:PROCESS-DATA) will be populated and
available on the same Database View list / table together with the attributes of the :EQUIPMENT UDET.
Although the Expression entry can reference the distributed UDET (:PROCESS-DATA), other expressions
can be formulated to extract attribute values from other element types or UDET as a source element.
The Database View list / table will now be able to contain and display attribute data from the source
element, as well as the original selection of attribute data from the original engineering UDET
www.aveva.com
Copyright 1974 to current year. 104
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The UDETs which are referenced as source elements were earlier defined for this exercise
Expression columns (EXPCOL) and Creation rules (CRERULES) can also be created as described
previously
The attributes (e.g. :NORMOPPRESS, :NORMOPTEMP) utilized for the attribute columns, must be
defined for the UDETs of the source elements
Select the created Database View MECH-EQUIPMENT-BASIC, and Create another Source element
(SRCELE) using the context menu.
www.aveva.com
Copyright 1974 to current year. 105
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Within the AVEVA Engineering Tags module, create and display a new list / table from a suitable category,
and based on the previously created Database View.
See AVEVA Engineering 14.1 Basic guide for the creation and display of a list within the Engineering
application
The section Basic definition, of the Current Element Editor form of the Database View includes just an
entry for a User Defined Name, as this is what the Database View Set will be identified with.
www.aveva.com
Copyright 1974 to current year. 106
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Database View Set is simply a collection of created Database Views as required. Database View Sets
can be created to hold a number of Database Views which apply to a specific element type, a discipline, or
tasks.
Click on any existing Database View, drag and drop into the created Database View Set.
The Database View Sets shown was defined using additional Database Views configured for this
demonstration
Database Views and Database View Sets can be managed within Definition sets, although these Definition
sets are not exposed to the user via the Current Element Editor.
A Definition set are areas where the Database Views are created and placed, as well as modified and
updated.
Element View Database Views defined automatically to represent the database hierarchy, and
includes all available element types within the MDB utilized.
Project Views Database Views defined in the dictionary database for a project.
User Views Database Views defined as a file in the users project setting
These Definition sets are visible and manageable from within the Database Views Editor.
Refer to Chapter 8 for more information on the configuration and use of Database Views and
Database Views Sets within the Database Views Editor
www.aveva.com
Copyright 1974 to current year. 107
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Exercise 6
1. Using engineering UDETs and existing Database Views available in the supplied ACE project
define a Database View with the Current Element Editor as described in the examples
2. Create Attribute columns and expression columns beneath the Database View as earlier
described
6. With the engineering UDETs utilized, define another Database View with the Current Element
Editor as described in the examples
7. Create Attribute and expression columns, a Creation rule, and 2 source elements (using either
a predefined distributed discipline (XPITEM), or any element type (As described in the examples))
9. Create a Database View Set, and place the created Database Views within, as described in the
examples
10. Create and display a list / table within the Tags module, and view lists based on the created
Database Views
11. Using the Database Views Editor, copy the created Database Views from their current Definition
set and paste in the User Views Definition set, or any user defined Definition set
www.aveva.com
Copyright 1974 to current year. 108
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 5
It is possible to configure an AVEVA Engineering project for the revisioning of engineering objects. These
objects could be engineering items (ENGITEs), Distributed attributes objects (XPITEMs), and datasheet
instances (DSINST).
The revisioning of items could be implemented within the Controlled Object Revisioning concept. This
concept supports the Interdisciplinary Project Data procedures which allows for data control by the user,
where by data changes can be made, approved and distributed to subscribers. Data changes of other users
can also be received and consumed by the user.
The simplified diagram above describes a possible the Interdisciplinary project data workflow.
In the case above, a user within the Process discipline modifies process data and submits for approval. The
approve piece of work is then transitioned to the Released maturity level where the data is now available
for all subscribers to obtain and consume.
Refer to Chapter 3 for the creation and setup of a project for Interdisciplinary Projectwww.aveva.com
Data
This chapter covers the configuration and setup of dictionary (LEXICON) elements required for the
implementation of object revisioning and interdisciplinary project activities.
Revision configuration for datasheets instances will be covered in chapter 6 (Datasheet configurations)
Within the Current Element Editor, fill in the attribute details of the created REVCWL as shown.
www.aveva.com
Copyright 1974 to current year. 110
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Within the Current Element Editor, fill in the attribute details of the created REVCGP as shown.
The REVNOD element allows for the specification of revision numbering for controlled engineering objects.
Here for example, a working and an issued numbering and number format can be defined for controlled
objects after a status change.
Within the Current Element Editor, fill in the attribute details of the created REVNOD as shown.
www.aveva.com
Copyright 1974 to current year. 111
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the newly created REVNOD, display the context menu and click Edit Revision Number Definition
and within the Revision Number Definition, fill in the entries details as shown.
Working revision text value will be appended to an object which is at a status referenced by this number
definition. Enter an asterix (*) in the field. This will be further explained in the next section.
With the Formatting section of the form, the length of the revision number characters can be increased
from 1 character to 10 characters (per part), with Alphabetic characters being padded with an A or Numeric
characters padded with a 0.
Customised revision numbering texts/format can be utilised, from clicking on the Custom radio button
www.aveva.com
Copyright 1974 to current year. 112
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Working revision text value (*) will now be visible in the entry field.
www.aveva.com
Copyright 1974 to current year. 113
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The revision configuration (REVCON) brings together essential elements required for the revisioning of
objects. It allows for the selection and referencing of appropriate status definition (STADEF), revisioning
numbering and relevant element types.
Select the created Revision configuration ENGR-REVISION-CONFIGURATION, display the context menu
and click Edit Revision configuration fill in the entries details as shown.
Click on the browse button to display the Select Element Types form, and select the required objects
which have their revisioning controlled by this configuration:
www.aveva.com
Copyright 1974 to current year. 114
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
This selection will populate the pick lists of Create working revision at: and Issue revision at: entries
with all available status values of the STADEF.
This means that when the status of an item (based on a selected element type) is changed to working, the
revision number value (*) will be applied to that item.
This is also the case when the status of an item is transitioned to Issued state, then the revision number of
that item will be applied to the object. (For example A1)
The Revision numbers on controlled objects are called from the value of a special attribute: RVCURR
The revision number mechanism will now apply to objects controlled by this revision configuration.
The Revision block definitions are required for the creation and setup of datasheets revision blocks.
This will be demonstrated later in this guide
www.aveva.com
Copyright 1974 to current year. 115
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the created Version control configuration fill in the entries details as shown.
The version Control configuration (VERCON) specifies the behaviour of an engineering object when it
attains a defined status level.
According to the pre setup maturity levels, extract objects will have data changes/modifications dynamically
Issued to the next higher level and revisioned as soon as that object has its status is set to a pre-configured
value.
Please see the AVEVA Engineering User training manual for details on controlling objects
Note: The VERCON element must be named. It has been named Tags in this case.
The required Revision configuration is selected from the pick list as shown:
www.aveva.com
Copyright 1974 to current year. 116
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The States to issue extracts allows for the selection of required status values from a pick form.
Data from the nominated element types are now ready to be transitioned across from an extract level to
another (As configured).
www.aveva.com
Copyright 1974 to current year. 117
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Shared services mechanism will need to be setup and configured before the full functionality of
interdisciplinary workflow can be tested. This is covered in the following Section
Exercise 7
www.aveva.com
Copyright 1974 to current year. 118
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The AVEVA Shared Service Notification is the communications mechanism which firmly supports the
Interdisciplinary project data work flow, as it allows for the exchange of object data between the users of the
AVEVA Engineering Tags application.
Each user will have to subscribe to a notification topic which could be object data from within disciplines of
an AVEVA Engineering project.
Data changes/modifications made within the subscribed data view generates a notification which is stored in
a specified Dabacon database. Subscribing applications can then request (Getwork) a list of notifications
against a subscription from the notification service.
Basically, a notification is raised for an object data change after a status promotion has been initiated. This
could be when the object is promoted to an Approved status level.
The VERCON mechanism will then trigger a dynamic Issue, in which the modified object will be issued
from an extract level to the master databases (Released data).
Users within other disciplines who are subscribed to the source of the change will then be notified (after a
Get Work), and they can chose whether to accept the changes on that object or not (From the Revision
Center form).
The notification service works on a Server Client basis, where the Engineering Tag users can have their
machines setup as clients, and a Notification Server will be nominated. Each user will then have to point
their client dlls to this Server system.
This section covers the configuration and setup for the shared services mechanism according to the diagram
shown:
www.aveva.com
Copyright 1974 to current year. 119
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The AVEVA Shared Services product must be installed on a nominated Server machine, which is made
accessible to required (allowed) client systems.
It could be installed in the system/machine of a client/user. Although one Notification Service server location
must be referenced by all users.
The Shared Services installation comes as a Separate Product Lifecycle (SPL) install, so should have its
custom evars batch file containing a default pointers to sample and catalogue projects (amongst others)
pointing to the correct project. This must be the same project that is accessed by the users. This batch file
may be found in the location shown:
Navigate to the Custom Evars batch file in the Projects 3.2 (for example) folder of the AVEVA Shared
Services installation as shown:
The location of the Custom evars as shown below, assumes a standard product install
www.aveva.com
Copyright 1974 to current year. 120
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Open and display the contents of the Custom Evars batch file in a suitable text application to view the
contents of the file.
Click File > Save to save the changes made to the file.
Open and display the Windows Services application console by navigating to:
Control Panel\All Control Panel Items\Administrative Tools
Select the AVEVA Shared Service Notification Service entry, and click the Start control, to get the
services started.
This essentially starts the Notification Shared Services server started and ready to receive and transmit data
between subscribers and sources.
This services should be started by default normally after the Shared Services 3.1 product has been
installed
www.aveva.com
Copyright 1974 to current year. 121
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Notification Service Client is basically the machine/systems of the users who will be working with the
AVEVA Engineering application, creating/modifying or manipulating data.
AVEVA Shared Services product does not have to be installed on the client users machines. The
installation locations of both the AVEVA Engineering 14.1 and Administration contain an
AVEVA.SharedServices.Client.dll.config file. The contents of these files will have to be manually edited
to point to the Shared Services notification server.
The files can be found in the installation location of the Engineering 14.1 and Administration products
within the clients machine:
The installation location of the products could be different from that displayed above
Navigate to and select the config file contained within the AVEVA Engineering installation as shown, open
and display the contents on this file in a suitable text application. Then modify the contents by including the
machine/system name of the server in which the Notification service has been installed as shown below:
The server names being used in the nodes are purely for example. The administrator must include the
actual server names of their notification service server
www.aveva.com
Copyright 1974 to current year. 122
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Repeat the same actions described for the copy of the AVEVA.SharedServices.Client.dll.config file
contained within the AVEVA Administration product installation location.
This will make it possible for the shared services notification manager to be able to receive information from
the LEXICON module of the AVEVA Administration installation.
The Shared Service Notifications service does not have to be started within the client machine.
These actions carried out will allow the communication links between the Notification Service server, and the
clients to be established.
Having configured and setup the Notification Service server and the clients, it is essential to get the
Notification Proxy Agent up and running as well.
The Notification Proxy Agent is an application which caches notifications raised in the Engineering
application when the Shared Services Notification Service is unavailable.
Data change notification will be cached in a queue system until the resumption of the Shared Services
server availability. This will then release the information held for downstream consumption.
It should be noted that the subscriber might receive the released notifications about 10minutes after the
shared services server is made available.
The AVEVA Notification Proxy agent is silently installed on the clients machine during the installation of
the AVEVA Engineering product, or can be installed on its own via an executable file,
The installation location will also include an AVEVA.SharedServices.Client.dll.config file which will have
to be modified as described earlier.
www.aveva.com
Copyright 1974 to current year. 123
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Display the selected file and make the changes as demonstrated previously:
The Notification Proxy Agent application installs silently during the installation of the AVEVA
Engineering 14.1 product
Finally, ensure that the AVEVA Shared Service Notification Proxy Agent service is started within the
clients machine:
www.aveva.com
Copyright 1974 to current year. 124
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
5.3 Subscriptions
Having run through the steps as described in the previous sections, the administrator can now create data
subscriptions as required.
A data subscriber is essentially a client/user who is interested in receiving notifications when data has been
modified, created or deleted within project view.
Subscriptions are created from within the LEXICON module, and are made up from project Teams and
Database View names.
Subscriptions are initiated via the Team-View Subscription form. This is accessible via the subscription
menu button located on the menu bar of the LEXICON application:
Click the Subscriptions button on the menu bar of the LEXICON module, and click on the Create Team-
View Subscriptions menu item.
www.aveva.com
Copyright 1974 to current year. 125
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The left pane of the form lists Teams available within the project, whilst the right pane of the form lists
available Database Views defined within the current dictionary database.
Select and highlight a team on a left pane, then select a Database View on the right pane. Move the
selected Database View into the Subscribed views pane in the center of the form using the move button
This will initiate a subscription between the team members (Users) and the data contained within the
selected project views.
For example:
The user makes a data change to a Line within the line list in an
AVEVA Engineering list, and then gets the changes on that line
Approved.
Status change form will display the Reason pick list if the
UDLOV has been defined for the current status definition
www.aveva.com
Copyright 1974 to current year. 126
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The changes can only be approved after the approving user receives and reviews the data changes on the
object. If satisfied, the approver can then promote the status of the object to an Approved status.
This issues the object up to the master (Released) databases, as well as triggering a notification to the
subscribers.
Notifications are received by the subscribers after a Getwork has been performed, and in the form of a
counter next to a flag icon on the Engineering application.
Double clicking on the flag icon displays the Revision Center where the items and their data changes are
available. The subscriber can chose what changes they will want to bring into their view.
Double clicking on the notification icon displays the Revision Centre form, where new or modified
engineering items are listed and their changes can be accepted into the users current view
www.aveva.com
Copyright 1974 to current year. 127
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
In order for this to work correctly, the user will need to have the appropriate Consumer extract databases
as part of their current MDB. These databases could be extracts of engineering Master databases which
contains items that the current user has no write access to.
The consumer extract will help feed the client user/subscriber with the data changes which has occurred in
the parent database. The Interdisciplinary Project Data project definition mechanism automatically takes
care of the creation and allocation of consumer extracts.
See chapter 3 for configuration and setup of the Interdisciplinary Project Data
www.aveva.com
Copyright 1974 to current year. 128
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 6
6 Datasheets
This section gives an overview on the definition of datasheets templates within the AVEVA LEXICON
module, required for datasheets creation, data entry and modification functionalities within a datasheet in the
AVEVA Engineering 14.1-Tags application. Before Datasheets template can be configured system
Administrators are advised to complete the following procedures:
Datasheets templates are created in AVEVA LEXICON module and stored in dictionary database. The
instances are created in AVEVA Engineering, Tags Module and stored in engineering database.
To create datasheets templates and datasheet instances as represented above a number of procedures
must be followed such as:
In AVEVA LEXICON
Create datasheets template (DSTMPL).
Define datasheets template presentation.
Define Unit of Measure.
Define and assign revision number control to datasheets template.
Add continuation Area (not mandatory only setup if required).
AVEVA Engineering Tags
Create a datasheets instance based on datasheets template created in LEXICON.
Add /modify data in the Datasheets instance.
www.aveva.com
Copyright 1974 to current year. 129
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Although section 4.6.16 covers the definition of Database Views set, as well as its setup and configuration,
this is further covered in this section for use within datasheet configuration.
The datasheet feature utilises the Database Views sets within its configuration, and this example describes
the creation and configuration of a Database Views set which will be subsequently applied.
Select the created Database View group MECHANICAL-VIEWS, and create a Database View Set
(DBVWSE) using the context menu.
Name PUMP-NOZZLE-
DBVIEW-SET
User-defined name
PUMP_NOZZLE_DBVIEW_SET
Relevant Database Views can be directly created under a Database View Set or indirectly linked to existing
Database Views as illustrated below:
www.aveva.com
Copyright 1974 to current year. 130
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 131
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Navigate to the Dictionary World /*, select Create from right-click menu and click on DSTWLD option from
the right-click submenu.
www.aveva.com
Copyright 1974 to current year. 132
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Name: ENGINEERING-DATASHEETS-TEMPLATES
Description: DATASHEETS WORLD
Navigate to the DSTWLD, select Create from right-click menu and click on DSTGRO option from the right-
click submenu.
www.aveva.com
Copyright 1974 to current year. 133
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Name: ENGINEERING-DATASHEETS-TEMPLATES-GROUP
Description: DATASHEETS-TEMPLATES-GROUP
Name: CENTRI-PUMP-DATASHEET-TEMPLATE
Description: CENTRIFUGAL-PUMP-DATASHEET-
TEMPLATE
www.aveva.com
Copyright 1974 to current year. 134
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Data Source: Select the browse button , next to the Data Source field. The Add Data Source dialog is
then displayed.
Select the preferred Database View Set PUMP-NOZZLE-DBVIEW-SET from the View Sets tab and
click on the Add button.
The Template file field is automatically populated with the location file path of the template when
created
Datasheet Templates are stored by default in .project>dflts\Data\Datasheets\Templates
Click the OK button from the New Datasheet Template dialog to create the datasheet template
(DSTMPL) and close the dialog form.
www.aveva.com
Copyright 1974 to current year. 135
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 136
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Datasheet template is divided into two main areas. The left area shows spread sheet layout, this is
mainly used to define the datasheet layout. The right area contains a list of all the attributes contained in the
selected Database View. After the creation of the datasheets templates (DSTMPL) the presentation or
format can then be defined by Administrator in line with the company template format or user preference
using the Datasheet Template Editor Toolbar functionalities as shown below:
Datasheet Template Editor contains buttons that allow end-users to perform below actions in datasheet
template editor.
User (s) should be able to design their datasheet templates with different styles of borders and various
colours which also reflect in the data sheet instances.
Open the borders window by selecting few cells in the datasheet template and right click, and clicking on the
new menu item Border.
www.aveva.com
Copyright 1974 to current year. 138
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the preferred border styles and colours e.g. ThickLine style and Black colour as shown.
After selecting the line style and colour, click on the Outline, Inside buttons in the Presets section, which
will be used to set the outer/inside borders of the selected cells.
www.aveva.com
Copyright 1974 to current year. 139
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Datasheet Editor also allow user to modify Cell properties such as Height and Width, justification of
text in Template Editor, font etc. which apply to the whole row or column, when this is selected.
Excel files templates from external source can also be referenced and used in existing datasheets template
(DSTMPL) configuration.
Only the XLSX file format from MS Excel 2007 & 2010 are supported
www.aveva.com
Copyright 1974 to current year. 140
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 141
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Check the Edit the template when finished checkbox and click the OK button from the New
Datasheet Template dialog to update the datasheet template (DSTMPL) and open the Edit Datasheet
Template dialog.
Once the datasheet is displayed, Admin users can insert new rows or
columns in the Template Editor if required. This can be achieved by
selecting the preferred row/columns and click the New option to insert
new row /column.
www.aveva.com
Copyright 1974 to current year. 142
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
To map database attribute (Name) to datasheet cells (Name), drag the required database attribute from the
Field List (MECH-EQUIPMENT-FULL) section of the Datasheet Template Editor dialog to the desired
cell and drop the Database attribute onto the cell.
If the mapping is successful, when the mapped cells are selected, the corresponding attribute will be
highlighted in the database source field
If the mapped database attribute datasheet cells have list of values, a pull down list button will be
displayed in the mapped cell
To un-map or un-assign a mapped cell, click on the mapped cell in this case Name cell and select Delete
icon from the Datasheet Template Editor main toolbar or context menu.
www.aveva.com
Copyright 1974 to current year. 143
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Using the same procedure as shown above; map the following database attribute from the Field List
(MECH-EQUIPMENT-FULL) section of the Datasheet Template Editor dialog to the appropriate label text
cell:
Name
Prefix
Tag Letter
Tag Number
Suffix
Description
Area/Unit
Users can also set the Behaviour property of the mapped cell to indicate that the field should be filled in by
a supplier when the datasheet instance is exported as an Excel spreadsheet and sent to a supplier to
complete some of the information.
This can be achieved by selecting the preferred mapped cell in the case Description. Click on the Provide
By Supplier from the context menu accessible via Behaviour option.
www.aveva.com
Copyright 1974 to current year. 144
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Behaviour field in the Properties window is automatically updated for the selected cell.
For cells that have been set with the Behaviour as Provided by Supplier, these cells will remain unlocked by
default, with the rest of the cells in the datasheet instance with the rest cell in datasheet instance being
locked by default, when exported as an Excel spreadsheet.
Auto database attribute mapping allows creation and mapping of attributes to the adjacent cell of the
selected header text cell.
Automap process runs the below algorithm to find the best possible UDA or attribute for selected header
text(s).
Searches the attribute with the same name as of header text in list of data source present in datasheet
template
If no attribute exists then, searches the dictionary database for UDA with same name as of header
text.
If no match is found, the selected header text row is considered as not matched.
www.aveva.com
Copyright 1974 to current year. 145
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
From the displayed datasheet template, select the preferred header text cells e.g. Stages & No.Operating.
In the Datasheet Template it is possible to make multi-selections that include merge cells.
Select the Auto Map icon from the main toolbar to display the Create and Map form.
www.aveva.com
Copyright 1974 to current year. 146
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Matched - Selected header text matches the one of the attribute available in template explorer. User can
check the detail for matched UDA and can accept the row to create mapping for adjacent cell.
User can change the attribute name.
Not Matched -Selected header text does not match any attribute in database. User needs to select and specify
the required properties to create UDA.Complete the required fields as shown below.
Attribute Names must not contain space. If the label text has
equivalent attribute name in the database. Simply modify the
displayed attribute e.g. No.Operating, should be NoOperating
to remove the space between characters.
Data Source Field Select the appropriate Data source (database view)
e.g. MECH-EQUIPMENT-FULL.
Data Type Field: Select the appropriate UDA type from the pull-down list e.g. Text.
Category Field: UDA Category, this is not required in this example.
List of Values: UDA Valid values, this is not required in this example.
Unit of Measure: UDA Units; this is not required in this example. This field is only enabled if the UDA type
real is selected.
Maximum Length: Enter the appropriate UDA Length e.g. 50. Select the Accept or the Accept All to
enable the Create and Map button.Click the Create and Map button to create the label text in the
database as an attribute and map the attribute adjacent cell to the label text.
www.aveva.com
Copyright 1974 to current year. 147
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Create and Map form will display message, if the UDA creation fails, successful or required data is not
specified by user.
The selected label text cells are created in the database and mapped to corresponding label text as shown.
The tool also allows the Admin users to set the unit
of measure presentation and precision
independently from the project units and precision.
www.aveva.com
Copyright 1974 to current year. 148
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Unit Sets Definition for Datasheet and List columns A Worked Example
Compound units based on the available base units e.g. m 3/s2, ft3/hours2 can be defined in LEXICON and
utilised within Datasheet and AVEVA Engineering Tags List columns.
Select Unit Sets from the main toolbar and then click on Configure from the submenu to display the
Unit Sets Configuration form.
Enter or select the following data in the appropriate Unit Sets Configuration form textboxes.
www.aveva.com
Copyright 1974 to current year. 149
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Unit Set Configuration form supports multiple Unit Sets definitions as shown below
The New button is used to create new Unit Sets definitions and Delete button to delete existing unit
Sets definitions that are not required.
Click the OK button from the Unit Sets Configuration window to save the configuration and close the
dialog.
To assign default unit of measure to mapped datasheet template cell with the appropriate unit dimensions.
First map the following database attribute from the Field List (MECH-EQUIPMENT-FULL) section of the
Datasheet Template Editor dialog to the appropriate label text cell.
www.aveva.com
Copyright 1974 to current year. 150
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Datasheet Editor also supports the mapping of Unit of Measure control to multiple cells.
Select the relevant mapped cell in this case Max Design Pressure and assign the appropriate Unit of
Measure (e.g. UoM1-25-8) from the right click menu.
The cell Properties is automatically updated with selected Unit of Measure value.
Use the same procedure as shown above; assign the same Units of measure group (e.g. UoM1-25-8) to
Min Design Pressure mapped cell.
Select the pull-down list button from the mapped Unit of Measure cell to display all the associated unit
derivatives.
www.aveva.com
Copyright 1974 to current year. 151
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the appropriate mapped Unit of Measure cell and enter the desired name, in this case Pressure in
the Properties section of the Datasheet Template Editor dialog.
www.aveva.com
Copyright 1974 to current year. 152
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Users can also assign a user-defined Unit set to datasheet template mapped cells that has the appropriate
unit dimensions, if the user chooses not to use the default unit of measure.
To do this; select the desired Unit Sets with appropriate assigned mapped cell. From the Properties
window select the preferred Unit Sets definitions from the Unit Sets pull-down list as shown.
Select the pull-down list button from the mapped unit cell to display all the associated unit derivatives.
To set preferred presentation precision if required, click on the Unit of Measure pull-down list button.
Click the Set Precision tab. The Set Display Precision dialog is then displayed.
www.aveva.com
Copyright 1974 to current year. 153
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the appropriate Unit Sets definitions from the Unit Sets
pull-down list as shown.
www.aveva.com
Copyright 1974 to current year. 154
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Datasheet Template Editor dialog gives users the capability to use the Standard control options such
as Check Box, Radio Button List, Picture Box and Free Text Cell in datasheets template if required.
Check Box option is often used in datasheet template, if the desired database attribute to be mapped to the
template has database attribute type logical.
To map a Check Box option to the datasheet template, select the preferred datasheet cell e.g.F18.
From the Standard Control menu double click on the Check Box option to assign the Check Box to the
selected cell as shown:
www.aveva.com
Copyright 1974 to current year. 155
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
In the Properties section of the Datasheet Template Editor dialog. Delete the Caption Check Box if is
not required.
Datasheet Editor also supports the mapping of CheckBox control to multiple cells.
Drag the required database attribute in this case Schematic Item Link from the Data Source field to
datasheet cells with the Check Box. If the mapping is successful the cell will become yellow.
www.aveva.com
Copyright 1974 to current year. 156
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Radio Button option is often used in datasheet template, if the required database attribute to be mapped to
the template have defined list of values.
To map a Radio Button option to the datasheet template, select the preferred cell, and then double click on
the Radio Button List option from the Standard Control menu to assign the Radio Button List to the
selected cell as shown:
Drag and drop the preferred database attribute in this case Fluid Phase from the Data Source field to
datasheet cells with the Radio Button List.
www.aveva.com
Copyright 1974 to current year. 157
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Picture Box option is used in datasheet template, if user(s) wants to bind a picture file to the database
template.
To bind picture file to the datasheet template, select the preferred cell. Double click on the Picture Box
option from the Standard Control menu to assign the Picture Box to the selected cell as shown:
www.aveva.com
Copyright 1974 to current year. 158
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
In the Properties section of the Datasheet Template Editor dialog. Click the browse button in the
Image field and select the preferred picture file:
To display the properties fields of the picture box, the mapped picture box cell must selected
Click on the Open tab from the Open File dialog to bind the image to the datasheet template. The bound
image size can be re-sized by selecting the preferred size from the Size Mode field.
The image URL can also be set to the mapped picture box in datasheet template if required
To replicate the mapped image on every page/sheet of the datasheet template, a Repeating Area is added
to the mapped image cell using the Add Area mechanism as described below:
Select the mapped image cell and click on the Add Area button from the context menu / main toolbar to
define the Repeating Area. www.aveva.com
Copyright 1974 to current year. 159
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
In the displayed Properties window, select the appropriate Area Type from the available pull-down list, in
this case Repeating
Click on the AssoiciatedSheets field to select the desired page/sheet. In the example select the Sheet2
checkbox and click the OK button to save the settings.
Repeating Area could also be applied if required to free text, mapped cells, Header and Footer.
www.aveva.com
Copyright 1974 to current year. 160
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 161
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Free Text Cell option is used in datasheet template, if user(s) or Administrator wants the cell value to be
editable, when datasheet instance is created in AVEVA Engineering (Tags).
To map a Free Text Cell to cells in the datasheet template, select the preferred datasheet cell as
highlighted:
Double click on the Free Text Cell option from the Standard Control menu to assign the Free Text to
the selected cell as shown:
www.aveva.com
Copyright 1974 to current year. 162
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The mapped cell color feedback can be modified by the Administrator if required via the Datasheet
Template Setting form accessible via Datasheet menu in Lexicon main toolbar.
The Page Information option provides the capability to map page number to datasheet template. The toolbox
provides the following properties:
CurrentofTotal - Displays the value defined by the Paging Format property, e.g. Paging Format {0}
of {1} where {0} represents the current page number and {1} the total number of pages
To map to the Page info. Select the Page Info control from Standard Controls and then drag and drop onto
the cell. (e.g.O5)
www.aveva.com
Copyright 1974 to current year. 163
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Controlled Cases
Cases in Continuation Area
To use the Case functionality appropriate cardinality must be defined for each distributed attributes that may
be created. The cardinality defines the number cases the attribute has for each tagged item.
Cardinality definitions, defines the minimum and maximum number of each of the distributed attributes
that may be created. A -1 in the maximum definition represent an infinite number
The worked example below illustrates how to map process cases to datasheet template.
www.aveva.com
Copyright 1974 to current year. 164
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Mapping a Case Control to datasheet template allows user(s) to display process case data and as well as
control of the display of governing case data in the datasheet instance if required.
To map Case Control, select the Cases control from Standard Controls as shown below. Drag and Drop the
Cases control onto a cell, in this example drag and drop it on cell F30.
Right-click on the preferred mapped cell and assign the appropriate the Case Group. In this example assign
mapped cell F24-27 and F31-34 to Case Group (Case-Sheet1-31-6).
www.aveva.com
Copyright 1974 to current year. 165
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the Control case cell (e.g. GOV Case) to highlights the entire assigned mapped cell.
The Case control cell will display the number of cases corresponding to the predefined cardinality definition
in the data model once it is assigned to mapped attribute cell with predefined cardinality definition.
The Continuation Area functionality allows the user to specify the number of columns and rows that is
required per sheet and if the number of objects exceeds the expected number of columns and rows in the
datasheet instance the application automatically generates continuation sheets.
The Continuation Area mapping is not a mandatory, but it is necessary if the number of objects expected
in the datasheet instance is unknown. This is mostly applicable to datasheets with Nozzle schedules or
Process Cases.
Continuation area can be defined in datasheet template to hold the information related to sub-object of
datasheet tagged item or Process Cases.
www.aveva.com
Copyright 1974 to current year. 166
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Adding Continuation Area to cases in datasheet template, enables the administrators to control the number
of displayed cases per sheet/page in datasheet instance.
To add continuation area to cases, select the desired numbers of columns and rows
Then select Add Area option from the context menu to assign continuation area to the selected area in the
template.
www.aveva.com
Copyright 1974 to current year. 167
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
When the Continuation Area is added to datasheet cell, an area will be automatically defined in the
datasheet template.
Select the mapped continuation area and set its properties. In this example set the Add Area properties as
shown below:
Area field: From the available pull-down list select Continuous option.
Orientation field: From the available pull-down list select Horizontal option.
Type field: From the available pull-down list select Cases option.
The case continuation area definition in this example will permit the display of one process case data per
sheet in datasheet instance.
www.aveva.com
Copyright 1974 to current year. 168
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Continuation area can be defined in datasheet template to hold the information related to sub-object of
datasheet tag. To map sub-object in continuation area, the datasheet template data source (database view)
should contain the parent object and child-object (Parent Child relation) definition.
To add continuation area to sub list, select the preferred area in the template.
First map the following database attribute from the NOZZLE-VIEW data source section of the
Datasheet Template Editor dialog to the appropriate label text cell as shown:
Select the preferred area in the template and click on the Add Area option from the context menu
to define the continuation area.
www.aveva.com
Copyright 1974 to current year. 169
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
When the Continuation Area is added to datasheet cell, an area will be automatically defined in the
datasheet template.
Select the mapped continuation area and set its properties. In this example set the Add Area properties as
shown below:
The SubItems continuation area definition in this example will only permit the display of SubItems data in
the specified rows e.g. F39-42 and G39 -42.
However, if the Sublist data exceed the specified rows or columns, a continuation sheet will be created
automatically in the datasheet instance to display the remaining SubIltem data.
www.aveva.com
Copyright 1974 to current year. 170
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Mapping Symbols to datasheet template label text are often used to indicate the
information to be completed either by manufacturer or purchaser in the datasheet
instance.
Datasheet Template Editor provides basic four shapes; circle, square, triangle
and hexagon accessible via the Toolbox > Symbols window as shown:
To map a symbol to label text, drag and drop or double the desired symbol to assign the shape to the
preferred label text cells. In this example assign the following shapes (circle, square, and triangle) to the
label texts as shown.
Once the symbol is assigned the preferred label text cells, the properties of the assigned symbols can be
modified using the Properties form as shown.
www.aveva.com
Copyright 1974 to current year. 171
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Alignment:
Appearance:
Fill State: In this example set text field to Filled via the Properties
window.
The Sketch control mechanism provides the capability to mapping process sketches to datasheet template
as well as allowing the end-user to change the process sketches / pictures at the datasheet instance if the
picture is defined as editable in datasheet template.
Create a new page/sheet for the process sketches / pictures by selecting the New sheet at the end of the
datasheet template.
Add the preferred datasheet presentation such as the styles of borders. Modify the cell properties such as
www.aveva.com
Height and Width, justification of text in Template Editor, font and the sheet name if required.
Copyright 1974 to current year. 172
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Then define the area for the process sketches by merging the desired cells if required.
www.aveva.com
Copyright 1974 to current year. 173
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Add a Picture Box control by double clicking on the Picture Box option or Drag the Picture Box option
from the Standard Controls menu to the desired cell.
Select the mapped area and set its properties. Click the browse button in the Image field and select the
preferred picture file.
The image URL can also be used to reference preferred picture file if required.
Set the Is Editable field to TRUE to allow the end users update the sketch/image from the datasheet
instance if required.
www.aveva.com
Copyright 1974 to current year. 174
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the sketch sheet/page in this case Sketch Page to define its properties such as Sheet Type and
Sheet Type Name.
Sheet Type field: Select Additional page from the pull-down list
Sheet Type Name field: Select Sketch Page from the pull-down list
Updating the Sheet Type from Default to additional page automatically display a warning dialog. Click on
the YES button to continue.
Once the sketch control is defined and saved. The application automatically apply the settings to all existing
datasheets templates in the project.
Before exiting Datasheet Editor window do remember to save the template in Datasheet Editor
Form and SaveWork in Lexicon.
www.aveva.com
Copyright 1974 to current year. 175
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Note page control mechanism provides the capability to include Note pages onto the datasheet
instance if required.
Create a new page/sheet for the additional Note page control by selecting the New sheet at the end of the
datasheet template.
Add the preferred datasheet presentation such as the styles of borders. Modify the cell properties such as
Height and Width, justification of text in Template Editor, font and the sheet name if required.
Double click on the Free Text Cell option from the Standard Control menu to assign the Free Text to
the selected cell as shown to make cell value editable, from the datasheet instance.
www.aveva.com
Copyright 1974 to current year. 176
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Then select the Note sheet/page in this case Note Page to define its properties such as Sheet Type and
Sheet Type Name.
Navigate to the REVCGP Group, select Create from right-click menu and click on REVNOD (Revision
Number Definition) option from the right-click submenu to create a REVNOD revision element.
Name: Revision_Number
www.aveva.com
Copyright 1974 to current year. 178
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select Edit Revision Block Definition from right-click menu submenu of the newly created REVNOD
(Revision_Number) to display the Revision Number Definition form.
www.aveva.com
Copyright 1974 to current year. 179
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
If required the Custom Value type can be used to set up custom defined sequence of characters. The
values can contain letters and digits. Click on the Value Set button to display the Custom Value
Editor.
www.aveva.com
Copyright 1974 to current year. 180
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Test Revision Number form is shown with sample values from the sequence for each part and the
combined revision number. If there are duplicate values it will show a message and highlight duplicate
values in red
www.aveva.com
Copyright 1974 to current year. 181
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Name: Revision_Block
Select Edit Revision Block Definition from right-click menu submenu of the newly created REVBLD
(Revision_Block) to display the Revision Block Definition form.
www.aveva.com
Copyright 1974 to current year. 182
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Status definition: Select the appropriate the status definition e.g. (Status Definition for Engineering
items).
The datasheet instance element type DSINST must be added to status definition list of controlled
element type.
Select the Add attribute option to add desired attributes to the attribute column and enter preferred name
in the Header column.
www.aveva.com
Copyright 1974 to current year. 183
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Click the OK button from the Revision Block Definition form to save the settings.
Name: Revision_Configuration
www.aveva.com
Copyright 1974 to current year. 184
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select Edit Revision Block Definition from right-click menu submenu of the newly created REVCON
(Revision Configuration) option.
Element type: Select the datasheets element type DSINST via the ellipsis button.
www.aveva.com
Copyright 1974 to current year. 185
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Selected Status Definition MUST be different from the one used for the COR definition
The Revision block definitions are optional, but should be selected for any configuration that uses them.
The Datasheets application will list the selected revision blocks in the datasheet template explorer
Click the OK button from the Revision Configuration form to save the settings.
Once the revision configurations are completed, the administrator must link the revision configuration to the
datasheet template using the Datasheet Template Settings form as shown.
The UDA Setting Default Type field is used to modify or set preferred UDA type. This is only
applicable if auto database attribute creation is in use
Click the OK button from the Revision Configuration form to save the settings.
Revision Control in Datasheets uses Status transitions UI, based on the current selection in a Tags list and
as result a Tags Database View based on datasheet instance elements must be created as shown below:
The Database View should contain the following Attribute columns (ATTCOL) in the Database View as
shown.
Revision block is a block which defines the number of column and row to be displayed in relation to revision
in datasheet. Revision block can be mapped to cell by:
Clicking on the desired revision block in the template explorer and then drag and drop onto cell.
Selecting the cell and double click on the desired revision block in template explorer.
www.aveva.com
Copyright 1974 to current year. 187
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Click on the desired revision block in the template explorer and then drag and drop onto the cell as shown:
www.aveva.com
Copyright 1974 to current year. 188
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
When a revision block is mapped to datasheet cell, an area will be automatically defined in the datasheet
template to hold the defined data in the revision block.
A revision block mapped cell needs to have the required area on right and bottom to accommodate the revision
block/area.
To map Revision mark to datasheet template: Click on the Revision Mark in the template explorer and
then drag and drop onto desired cell.
Alternatively, select the preferred cell and double click on the desired Revision Mark in Template Explorer.
Revision Mark are generated by the System, they are not manually configured
www.aveva.com
Copyright 1974 to current year. 189
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Data Source: Select from the Add Data Source Form PUMP-NOZZLE-DBVIEW-SET_
2. Defined preferred Revision control configuration for the datasheet template as shown.
www.aveva.com
Copyright 1974 to current year. 190
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 191
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
(a.) Assign or map database attributes to the datasheets template using Auto mapping.
(b.) Assign defined Units of Measure (Unit Sets) to the datasheets template.
(c.) Assign defined of Revision to datasheets template.
(d.) Add continuation Area to the datasheets template.
www.aveva.com
Copyright 1974 to current year. 192
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 7
The engineering Project explorer is a configerable user interface based on the AVEVA Flexible explorer
tool.
This interface allows for the presentation of engineering items structured according to functional locations or
any other user defined structure formats. These structure formats are displayed in a hierarchical form within
the AVEVA Engineering Tags application.
Each structure is based on a template which is also defined as a Root Node. Further nodes can be built
beneath the root node. Templates and their contents are represented as individual hierarchies within the
Project Explorer. Every template is configured to be primarily based on a type of data, e.g. Systems, Classes,
and Documents or as a Project BreakDown Structure (PBS). Unlike a conventional tree view explorer, the
Project explorer has a dynamically active hierarchical structure. This means that the location of items will be
dependent on the current set criteria and attribute values.
The Project explorer is fully configurable and setup within the LEXICON module as well is demonstrated in
this chapter.
www.aveva.com
Copyright 1974 to current year. 193
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Using the Flexible explorer tool the Project Explorer can be configured according to the LEXICON elements
structure shown:
PBS Criteria:
PBSCRT This element is used to position resulting nodes below
appropriate/required parent nodes
The demonstration in the following examples covers the creation and definition of the dictionary
elements for a demo project explorer. This explorer will be developed and structured to display
hierarchies for a Project BreakDown structure (PBS), System, Document and Class Based
Structure as displayed in the opening screenshot
www.aveva.com
Copyright 1974 to current year. 194
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Within the Current Element Editor, fill in the attribute details of the created PBS world as shown.
Within the Current Element Editor, fill in the attribute details of the created PBSTPL as shown.
The PBS text entry specifies the text to be displayed on the created template, like a node name. This is set
to Project BreakDown Structure (PBS).
www.aveva.com
Copyright 1974 to current year. 195
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
PBS Sorting entry specifies the order in which items generated from nodes beneath the root node/template
will be placed. This is set to Natural Alpha Numeric, which is selected from the pick list. Hence items with
node texts which begin with higher alphabets will be listed first before lower alphabets etc.
A user defined context menu can be referenced and setup for the template node with the PBS context menu.
This could be extracted from a method within a pml function using the Flexible Explorer Editor form.
Each node and items on the Flexible Explorer interface can have an icon displayed next to its text. The PBS
icon entry specifies what icon is to be displayed by typing in the icons name (as this must already exist in the
Shared Resources location) or can be derived with a PML 1 expression.
This will be left blank, which will have the icon representing the object displayed.
From the created PBS World, and PBS Template, the resulting explorer hierarchy will be displayed within the
Engineering Tags application as shown:
The user will have to log into the engineering tags application and click the Project Explorer button
to display the Project Explorer. If the explorer user interface is already being displayed, then
running a get work updates the contents of the explorer with changes from the LEXICON module
www.aveva.com
Copyright 1974 to current year. 196
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Within the Current Element Editor, fill in the attribute details of the created PBSOBN as shown.
The PBS text entry is specified by an expression which combines the full name (FLNN) and the description
(desc) value of a resulting object separated by a dash ( - ), in order to derive the display text (node name) of
the objects.
The selection of a PBS formula type entry determines the kind of formula which is used to derive the objects
to be listed in the explorer (resulting nodes). Select the PML expression entry from the pick list.
The PBS formula entry is a text attribute whose entered values is dependent on the formula type selected.
Type in: Collect all sysgrp. This will fetch all available SYSGRP objects available in databases within the
current MDB.
PBS Sorting entry is set to Same as on Parent. Resulting nodes will be ordered using the same selection
that was selected for the owning PBSOBN element (Natural Alpha Numeric).
From the created PBS object, the resulting explorer hierarchy will be displayed within the Engineering Tags
application as shown:
www.aveva.com
Copyright 1974 to current year. 197
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Within the Current Element Editor, fill in the attribute details of the created PBSTXN as shown.
PBS formula type entry is set to PML function as this specifies that the following PBS formula entry will
be a global variable which points to a pml function within the pml library. Enter:
!!getAreasForSystemACE()
The pml functions will be made available along with the copy of the supplied ACE project utilised
for this training
The PBS formula can be entered using the Flexible Explorer formula editor form
www.aveva.com
Copyright 1974 to current year. 198
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The entered formula reads and deploys the methods contained within the referenced PML function. This
particular function is designed to generate a node which will be based on the Area numbers of engineering
items (ENGITE).
So this will create a folder in the explorer hierarchy which will be named after the area number which is shared
by objects it contains. This means that when an object is created, it will be grouped by area numbers in this
node.
The FlexibleExplorer formula editor is also used to make the entered pml function apply to every object
generated by the PBSOBN created earlier. This is done by dynamically entering the reference number of the
PBSOBN as an argument in the command:
Place the cursor inside the parenthesis ( | ) and then click the Insert parameter link label, then select the
entry as shown:
This will dynamically place the DB refno of the selected item as an argument within the function being called
www.aveva.com
Copyright 1974 to current year. 199
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Create another PBS text node (PBSTXN) which will generate a node to group and hold items according to
their element types. Its behaviour and node name will be derived from the pml function within the PBS formula,
which it references.
Within the Current Element Editor, fill in the attribute details of the created PBSTXN as shown.
PBS formula type entry is set to PML function. For the PBS formula entry, Enter:
!!getEngineeringClassesACE().
Create another PBS object node (PBSOBN) which will generate a node to group and hold items according to
their element types. Its behaviour and node name will be derived from the pml function within the PBS formula,
which it references.
Within the Current Element Editor, fill in the attribute details of the created PBSTXN as shown.
This created PBS Object node will generate the database object (Engineering item), which will be located and
grouped beneath the higher elements in the hierarchy of the structure.
PBS formula type entry is set to PML function. For the PBS formula entry, use the FlexibleExplorer
formula editor form as shown:
www.aveva.com
Copyright 1974 to current year. 200
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The formula indicates that the objects to be generated will be an item(s) whose element type is derived from
the parameter (the owning PBSTXN), and will be stored within that node. Another condition will be that the
item(s) will be located within a generated node based on its area number.
PBS context menu ensures that the resulting objects will be able to display a context menu when they are
selected and right clicked. The contents/entries of the context menu are obtained from a default xml files
which are located in the installation directory of the Administration product. This is set as
AVEVA.PBS.TAGS_Element_ + TYPE + .Menu.
Finally any resulting/derived engineering object will be further grouped within a special node which is based
on a user defined attribute :SPECIFICATION. This is entered within the PBS group by, which is a text
entry.
From the created PBS elements, the resulting explorer hierarchy will be displayed within the Engineering Tags
application as shown:
www.aveva.com
Copyright 1974 to current year. 201
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
In the cases where the PBS formula of the first PBS object node (PBSOBN) does not evaluate successfully
(i.e. from the example, the engineering object has no System (SYSGRP) attribute specified) then a node can
be setup and configured to hold such unassigned items.
A new PBS text node is created to derive and hold items which have no System (SYSGRP) attributes, as
shown:
Select the created PBS-TEMPLATE, display the context menu and click Create > PBSTXN: PBS Text Node
to create a new PBS Text Node.
Within the Current Element Editor, fill in the attribute details of the created PBSTXN as shown.
PBS formula type entry is set to PML function. For the PBS formula entry, Enter:
!!getUnassignedItemsNode().
The referenced pml function will enable items which are not assigned with a System (SYSGRP) to be created
within this node, instead of the nodes created earlier.
Create further PBS text node (PBSTXN) and PBS object node (PBSOBN) which is similar to those created
and described earlier as shown:
www.aveva.com
Copyright 1974 to current year. 202
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 203
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The PBS criteria element ensures that a given node fits to a specific parent hierarchy.
This means that when items are created, the criteria element will help determine enforce the placement of
these items within the appropriate node.
Within the Current Element Editor, fill in the attribute details of the created PBSCRT as shown.
The PBS criteria must be created beneath the item for which the location checks will have to be made.
Hence in the example shown, the PBSCRT was created beneath the PBSOBN which generates the
engineering items.
PBS query node allows for the selection of the appropriate node in which the location checks will be made.
So in the case shown, the PBS query node was selected as the top level PBS element, the PBS-
TEMPLATE created earlier. This means that items created will be checked for storage within the PBS-
TEMPLATE node only. Hence this selection is made from the pick list as shown.
www.aveva.com
Copyright 1974 to current year. 204
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Further PBS Text nodes and Object nodes can be configured to cater for member elements of items which
can be seen as parent object. For example, the Flexible explorer can be configured to display available
nozzles beneath equipment.
Select the last created (Within the PBS-TEMPLATE) PBS Object, display the context menu and click
Create > PBSTXN: PBS Text Node to create a PBS Text Node.
Within the Current Element Editor, fill in the attribute details of the created PBSTXN as shown.
The PBS Formula is configured to evaluate on items which are generated by its owning PBS object node
(PBSOBN). This is referenced as a parameter using the FlexibleExplorer Formula Editor to insert the
parameter
DBref of parameter
The methods within the referenced pml function will evaluate the items generated by the PBS object to identify
items which have member elements which are valid and exist.
A PBS object PBSOBN will be created which will generate/derive existing member items.
www.aveva.com
Copyright 1974 to current year. 205
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the last created PBS text node, display the context menu and click Create > PBSOBN: PBS Object
Node to create a PBS Object Node.
Within the Current Element Editor, fill in the attribute details of the created PBSOBN as shown.
The member elements are configured to display right click context menu as appropriate, and the contents
and menu entries will be extracted from an XML file located within the AVEVA Administration product
installation using the expression as shown in the PBS Context menu entry.
Derived elements displayed in the Flexible explorer can be configured to be grouped within classes, or any
required attributes.
Multiple instances of the object nodes can be created and configured to hold items which share a common
class or attribute value.
This will copy the PBS object node (configured to derive and display the main engineering elements in the
Flexible explorer) as well as its children elements, and create instances of them which can then be
individually modified as shown:
www.aveva.com
Copyright 1974 to current year. 206
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The PBS group by values are modified to allow for the class grouping of engineering items which are
Equipment, Valves, Lines, Instrument and Instrument Loop. The grouping could be done by any valid
attribute, but it should be noted that each template should hold no more than 1 grouping attribute per Node.
Modifications will also need to be made on each PBS formula expression entry, so as they reference the
correct parameters.
Enter :EquiClass in the PBS group by to group Equipment items by :EquiClass attribute. Modify PBS
Formula as shown:
Enter :InstClassDesc in the PBS group by to group Instrument items by :InstclassDesc attribute. Modify
PBS Formula as shown:
www.aveva.com
Copyright 1974 to current year. 207
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Enter :LoopClassDesc in the PBS group by to group Instrument Loops by :LoopClassDesc attribute.
Modify PBS Formula as shown:
Enter :VALVETYPE in the PBS group by to group Valves by :VALVETYPE attribute. Modify PBS
Formula as shown:
www.aveva.com
Copyright 1974 to current year. 208
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The previously described configuration is performed for the Unassigned items node:
www.aveva.com
Copyright 1974 to current year. 209
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Flexible Explorer can also be configured to display document items (non database items) within is
owns dedicated template structure.
Following on from the previous section, PBS templates will be created for the display of datasheets,
Diagrams, and Engineering lists elements.
Afterwards relevant PBS object nodes and PBS text nodes will be created and defined for each template.
Select the created PBS World, display the context menu and click Create > PBSTPL: PBS Template
Definition to create PBS Template definition for Documents.
Within the Current Element Editor, fill in the attribute details of the created PBSTPL as shown.
Select the created PBS Template, display the context menu and click Create > PBSTXN: PBS Text node
to create PBS Text node for Datasheets.
Within the Current Element Editor, fill in the attribute details of the created PBSTXN as shown.
www.aveva.com
Copyright 1974 to current year. 210
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the created PBS text node, display the context menu and click Create > PBSTXN: PBS Text node
to create PBS Text node.
Within the Current Element Editor, fill in the attribute details of the created PBSTXN as shown.
PBS formula type entry is set to PML function. For the PBS formula entry, Enter:
!!getEngineeringClassesACE().
This node allows for the generation of items which are of the type ENGITE.
Select the created PBS text node, display the context menu and click Create > PBSOBN: PBS Object
node to create PBS Object node.
Within the Current Element Editor, fill in the attribute details of the created PBSOBN as shown.
This node allows for the generation of datasheets from available engineering items. This uses an expression
which references a pml function to extract the datasheet instances from the engineering items derived in the
PBSTXN previously created.
It also carries a reference for a context menu for datasheet items on the Flexible explorer.
www.aveva.com
Copyright 1974 to current year. 211
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the created PBS Template, display the context menu and click Create > PBSTXN: PBS Text node
to create PBS Text node for Datasheets.
Within the Current Element Editor, fill in the attribute details of the created PBSTXN as shown.
Select the created PBS text node, display the context menu and click Create > PBSTXN: PBS Text node
to create PBS Text node.
Within the Current Element Editor, fill in the attribute details of the created PBSTXN as shown.
www.aveva.com
Copyright 1974 to current year. 212
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the created PBS text node, display the context menu and click Create > PBSOBN: PBS Object
node to create PBS Object node.
Within the Current Element Editor, fill in the attribute details of the created PBSOBN as shown.
PBS formula type entry is set to PML expression. For the PBS formula entry, Enter: collect all
scdiag.
The diagram context menu entry allows for the display of the diagram on its own viewer within the
Engineering Tags application
www.aveva.com
Copyright 1974 to current year. 213
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the created PBS Template, display the context menu and click Create > PBSTXN: PBS Text node
to create PBS Text node for Engineering Lists.
Within the Current Element Editor, fill in the attribute details of the created PBSTXN as shown.
Select the created PBS text node, display the context menu and click Create > PBSTXN: PBS Text node
to create PBS Text node.
Within the Current Element Editor, fill in the attribute details of the created PBSTXN as shown.
www.aveva.com
Copyright 1974 to current year. 214
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the created PBS text node, display the context menu and click Create > PBSTXN: PBS Text node
to create PBS Text node.
Within the Current Element Editor, fill in the attribute details of the created PBSTXN as shown.
PBS formula type entry is set to PML function. For the PBS formula entry, Enter: !!getCategories().
Select the created PBS text node, display the context menu and click Create > PBSTXN: PBS Text node
to create PBS Text node.
Within the Current Element Editor, fill in the attribute details of the created PBSTXN as shown.
www.aveva.com
Copyright 1974 to current year. 215
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
This node allows for the derivation of lists. The expression references
a pml function which contains the derivations syntax for lists within
available referenced categories parameters.
Exercise 9
1. Recreate the Flexible explorer configuration as demonstrated and displayed (This might require the
deletion of the items created during the examples). Refer to the supplied demo ACE project for
examples.
www.aveva.com
Copyright 1974 to current year. 216
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 8
The Database Views Editor is a General user interface for the creation definition and modification of
Database Views in a quick and user friendly manner.
Although Database Views can be fully defined and configured within the LEXICON module, the Database
Views Editor provides an easy access and manipulation of a collection of these Database Views and their
configuration as well allows for their creation, deletion and update.
The Database Views editor user interface sits in both the LEXICON and Tags Modules, as they can be utilised
from both applications, although there are Subtle differences between how they can be used.
A Database View is the presentation of an element type or UDET with a listing of its attributes or a
selection of its attributes, structured to allow the creation of objects and attribute values beneath
www.aveva.com
Copyright 1974 to current year. 217
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Database Views Editor User interface in the modules mentioned are one and the same, except in the
Tags Module where it carries a representation of a closed lock when the Project Views View Definition
Set is selected.
This is not the case for the Database View Editor within the LEXICON Module where it is represented as
Open.
This signifies that edits to the views contained in the Project Views can only be made within the LEXICON
module, and not the Tags module.
A Definition set are areas where the Database Views are created and placed, as well as modified and
updated.
Element View Database Views defined automatically to represent the database hierarchy, and
includes all available element types within the MDB utilised.
Project Views Database Views defined in the dictionary database for a project.
User Views Database Views defined as a file in the users project setting
A User defined Definition Set
These Definition sets are only visible and manageable from within the Database Views Editor as will be shown
later in this guide.
www.aveva.com
Copyright 1974 to current year. 218
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
On the Database Views Editor, select the Element Views from the View Definition Set drop down list, and
select the All entry from the Database Types Filter to display views of all database element types available
to project session being run.
Select Project Views view definition set, and then select the Engineering database type filter, to display
all DB views defined in the LEXICON module, which are based on engineering UDETs or distributed UDETs.
With the Project Views view definition set, filter on the database type All. This displays all DB views defined
in the LEXICON module which are based on any UDET.
Select the View Sets tab. This displays collections of sample DB views, which have been sorted according
to the database type which the relevant items will be located.
These collections are known as View sets, which is a collection of Database Views bunched together for a
similar purpose. The collections can be based on any required criteria.
www.aveva.com
Copyright 1974 to current year. 219
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
A View Set can be compiled by copying existing DB views (using its context menu) and paste within any
existing view set, as will be shown.
With the DB views editor within the Tags module, DB views can only be defined or modified within the User
Views view definition set, or within a user defined view definition set.
Database Views defined within the User Views view definition set are stored in an xml file format located in
a default location as shown for the ACE project below:
The following example will describe the definition of DB views for a Line element type and selected attributes,
as well as DB views for its disciplines and selected attributes appended to them.
Refer to Section 4.6 for details on setting up a Database View within the LEXICON module and definition
of utilised terminology
www.aveva.com
Copyright 1974 to current year. 220
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Log into the Engineering application of the ACE Project, using the Username: SYSTEM, MDB: ADMIN-
LEXICON. Click on the Admin tab and click on DB View Editor menu button to display the DB view editor..
Select the User Views view definition set from the drop down list. This should be displayed with an empty
view area.
Place the cursor on the empty area, and display the right click context menu. Select the New > View entries,
to create a new Database View.
Fill in the property details as shown, ensuring to type in the correct element type or make a selection with the
available browse button. www.aveva.com
Copyright 1974 to current year. 221
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the Data Source tab in the View Detail pane. Select the Allow row creation checkbox, as this will
allow row items to be created on any grid/list which is based on this dbview.
Leave the Auto assign or create owner checkbox unchecked, so as LineTag items will be stored in a
location which will be specified in the Owner Expression.
For the Owner Expression, type in the texts: (id /PipeLine ). This will be the name of the ENGGRP
(engineering group) where the Line items will be stored when they are created in the dbview based list.
The Type Expression is left unset, as it specifies the ActType attribute of the item to be created. But this
is not required as the element type being used can be dynamically derived.
Select the Columns tab, and configure the attribute columns which are required for the dbview.
Click on the New icon to create a new row (which represents a column). Select the Data source, attributes
and Description as shown.
www.aveva.com
Copyright 1974 to current year. 222
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Column name acts as a column header / caption, and can have texts typed into it.
Selecting the Read only checkbox, will ensure that the column will not be editable, and will appear greyed
out.
Select the Preview tab, to view how the columns will be displayed.
The list above is populated with values as the ACE project already contains Line items, and values against
available attributes. This Preview will be displayed with just the column headings and no values if this were a
fresh project.
The :Duty column has its entries greyed out, as it is a Read only column as specified in the Column
tab
This function is only available on the Database Editor initiated from within the Engineering application.
Or else, the Preview grid is not populated with any data
Return back to the Column tab, and include more rows of attributes as shown.
www.aveva.com
Copyright 1974 to current year. 223
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Create a new list which is based on the created Dbview from the Manage button in the home tab.
See (AVEVA Engineering Tags (Basic) for setting up and displaying a list
Create a new LineTag item LineA, and fill in the attribute details. Observe the creation of the item in both the
list view and in the correct location within the database explorer.
www.aveva.com
Copyright 1974 to current year. 224
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Next, define a Dbview for Line items and its attributes, of which 2 are owned by other disciplines.
For this example, a new user defined View Definition Set will be created and utilised.
In the View Definition Set group of the Database Views Editor, click on the New icon, to display the Create
Definition Set form.
This user defined View Definition Set is saved as an xml file in any location of the workstation used and can
be moved or emailed off.
Create a new DB view as was previously done, by right clicking on the empty Views pane, and selecting the
entries: New > View. Or the previously created db view LineTag DB View can be copied from the User
Views view definition set, and pasted into the newly created view definition set.
From the User Views view definition set, copy the LINE-BASIC-VIEW and paste this in the View Definition
Set for Set of Training DBViews.
www.aveva.com
Copyright 1974 to current year. 225
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
This pasted view will initially be named Table2 on the views table. Using the Rename command on the
context menu, change the name to Line+Discipline Data view.
Select the Data Sources tab, then expand and configure an attribute rule for the Creation Rules
This creation rule will ensure that each time a new item is created, the conditions of the rules must first be
met.
www.aveva.com
Copyright 1974 to current year. 226
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Click on the Add Rule button to include an attribute rule, and fill as shown.
This simple attribute rule ensures a request for the definition of a Name as an initial step (Create Element
information form) when a Line item is being created.
Click on the listed Dbview, and select the New SRCELEMENT from the context menu to create a source
element entry
The source element will point to a relevant element type whose attributes will be utilised in attribute columns.
The Line Process Data and Line Piping Data have been modelled as distributed UDETs, which are based
on the XPITEM Base type, and have specific sets of attributes assigned to them.
These distributed UDETs carry the user defined names :PROCESS-DATA, and :PIPING-DATA respectively.
They have both been nominated as distributed members of the :LINE element type.
www.aveva.com
Copyright 1974 to current year. 227
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the Columns tab to display the previously defined attribute columns for the :LINE element type, then
add new rows for attribute columns specific to the defined source elements ensuring to select the appropriate
data source from the drop down list as shown:
Select the Line Process Data entry as the source data of the attribute to be defined in the new row, then
select the required :PROCESS DATA attributes.
www.aveva.com
Copyright 1974 to current year. 228
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
It is possible to populate the Dbview with attribute columns for all available attributes of a selected data
source, by clicking on the Add Standard Attributes. This triggers an automated action which defines new
attribute columns for each available attribute.
Click on the Add Status Column text button to include an attribute column for the Status of the item, then
select a required attribute qualifier, as shown.
www.aveva.com
Copyright 1974 to current year. 229
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Run a SaveWork and preview the defined attribute columns. Create and display a list view based on this
new DB view.
When creating the new List, ensure that the correct Definition set is selected
The list shown carries the selected attributes for the LineTag, and the distributed data for both the Line process
data and Line stress data. The column grouping shown is a user defined layout.
Create a new LineTag item for a new row, and observe the Create Element Information form displayed.
This form carries the required condition which was defined in the Attribute rules (in the Creation rules section
of Data Sources for the DB view).
A new LineTag item will not be created until the required attribute of Name is supplied. www.aveva.com
Copyright 1974 to current year. 230
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Type in the text LineB in the Name entry, and click the OK button.
Save the view definition set, using the save icon to preserve the created Dbview and its configuration.
For each new session of the Tags module, user defined view definition sets will need to be Opened
using the icon to reload the Db views from the xml file
www.aveva.com
Copyright 1974 to current year. 231
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
As described earlier, a View Set is a collection of DB views, which are sorted and placed according to any
required criteria.
Select the View Sets tab, and create 4 new view sets with the context menu and rename as shown.
Select the User Views definition set, and copy the LINE-BASIC-VIEW which was created earlier.
www.aveva.com
Copyright 1974 to current year. 232
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Select the Line items views set in the View Set section of the user defined view definition set (Set of
Training DbViews), and Paste the copied LINE-BASIC-VIEW using the context menu then rename the default
name of Table2 to an appropriate name which has not been used before (LINE-BASIC-VIEW2) and hit the
icon.
The addition of this DB view to the set, has also created a copy of this DB view on the Views section.
Select the Project Views definition set, filter on the Engineering database, and copy 2 DB views for each
of these element types :EQUIPMENT, :LINE, and :INSTRUMENT. Then paste each copied DB view beneath
the relevant view set in the Set of Training DBViews. Finally, have them renamed as shown:
www.aveva.com
Copyright 1974 to current year. 233
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 234
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Each copied DB View will need to be renamed differently from its original name when it was copied
The addition of a DB View to a View Set, also creates a copy of that DB View on the Views section of
the definition set
Exercise 10
1. Create a user defined view definition set with the name Definition set for Training
3. Create a new Database View with the right click context menu, with the name Mechanical
DBViews and description
4. Assign the element type :EQUIPMENT to the newly created Mechanical DBViews
5. Include the owner expression ( id /MechanicalItems ) or any preferred database location, allow row
creation
6. Create attribute columns for Name, Description, Tag number, Tag Letter,and model number
7. Preview the created DB View, and generate a list based on the view.
8. Create a new DB View for Mechanical items and Distributed data, with the :EQUIPMENT
element type, and an appropriate description
10. Include a Source Element with the description Mechanical data, and expression XRQELE(
typename :MECHANICAL-DATA )
11. Include attribute columns for both the Mechanical items and source elements
12. Preview the DB view, and generate a list based on this new DB.
www.aveva.com
Copyright 1974 to current year. 235
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 236
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 9
AutoNaming allows for automated / dynamic selection of appropriate names for engineering items when they
are created or renamed. These names can be in a sequential format, can be placed in several patterns and
are rule based.
Within the Tags module, the AutoNaming feature can be reached from the Admin tab.
Click on the AutoNaming Setup button to display the Naming Settings form which allows for controlling
the use of the AutoNaming function in a session.
AutoNaming actions can be switched On or Off with the Auto Naming On/Off checkbox, and AutoNaming
rules can be managed through the Define Naming Rules button.
The Naming Mode group allows for the selection of required behaviours for sequential indexed naming.
Infill indicates that the any available index number will be used to name an element.
Append indicates that elements will be named using increasing index numbers.
The Load and Save buttons are utilised when defined name rules are to be saved or loaded from the Naming
rules file.
The user will need to be an ADMIN user, or a member of the Tags ADMIN team, in order to view and
access the Admin tab
The use of Auto Naming Rules configuration overrides any existing Creation Rules already in place.
www.aveva.com
Copyright 1974 to current year. 237
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
On the Naming Settings form, Click on the Define Naming Rules label button to display the Naming
Rules form.
This form allows for the creation of rules to generate and control the behaviour of the AutoNaming actions.
Before the naming rules can be defined, ensure that appropriate Element rules exist. Click on the Element
Rules button to display the Define Rules form.
www.aveva.com
Copyright 1974 to current year. 238
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
This form allows for the definition of the conditions (Element Rules) with which the naming rules must follow.
In other words, this form specifies the items which the naming rule(s) will be applicable.
The Location entries allows for the saving and loading of element rules file from the appropriate rules folders.
Each location entry specifies the possible folder/path to be utilised to save a newly defined rule:
Project indicates that the rules will be stored in the C:\AVEVA\Projects\ACE\acedflts project location.
Default indicates that the rules will be stored in the C:\AVEVA\AVEVA Engineering\Data14.1.0\DFLTS
directory.
Select the User location, and fill in the details as shown, then click the Include button.
The Include button places the name of the element rule in the Defined list. It can be observed to be
positioned beneath the User Defined Rules group, as this is because the User rules location was selected.
Click the Apply and then Cancel buttons to return to the Naming Rules form.
www.aveva.com
Copyright 1974 to current year. 239
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The Scan Level indicates the scope of the AutoNaming actions. In this case, all applicable items created
beneath the World level will be Autonamed.
The Rule Name entry is selected by clicking on the arrow button next to the entry. This brings up a form
listing available conditions/Element rules which this naming rule will apply to.
The Format is an expression which will control the pattern of the generated names.
The Indices is the parameter for including numbering character in the generated name.
After filling in the details, click the Insert button to place the created naming rule in the Data Display key list,
and also view a summary on the Data section
www.aveva.com
Copyright 1974 to current year. 240
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Rules in the Data Display key list can be Cut, Copied, and Replaced using the buttons, as part of rules
management activities.
Test the defined rules by selecting an engineering item on a list, and clicking the Test button, to display a
sample of how the generated autoname will appear. Click the OK button to return to the Naming settings
form.
On the Naming Settings form, select File > Save to save the rules, then check the Auto Naming On/Off
checkbox, to turn the naming rule on. Click the OK button.
Both the element and Naming rules can now be seen to be stored in the location shown:
From the Mechanical, Electrical, and Process categories, display the Mechanical Equipment and Lines
list.
www.aveva.com
Copyright 1974 to current year. 241
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Create 2 new Mechanical equipment items, and observe their auto generated names.
Create 2 new Electrical equipment items, and observe their auto generated names.
Finally create 2 new Line items, and observe their auto generated names.
www.aveva.com
Copyright 1974 to current year. 242
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
The created rule being utilised applies to all Engineering items (ENGITEs) and will apply the naming
structure to all engineering elements
Any created item with the ENGITE basetype, will be autonamed, using the configured naming rule.
Enter the rule expression as shown, as this will set the element condition for the naming rule to apply to Line
items only.
Select the newly created element rule for the Rule Name within the Naming rules form as shown:
www.aveva.com
Copyright 1974 to current year. 243
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Note: The newly created rule must be placed Before previously created rules, so as it will be read by the
function first.
Create 2 new Line items, and observe their auto generated names.
www.aveva.com
Copyright 1974 to current year. 244
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
New items of other element types will continue to be autonamed with the previous naming rule setup earlier,
as that still applies to ENGITEs without the extra element rule condition for LINEs.
Create a new Element rule for Mechanical equipment only as shown, and have this saved in the Default
naming rule location.
Click the Include button to create the rule in the Defined group. The new element rule should now be visible
beneath the Defined Rules rule group.
www.aveva.com
Copyright 1974 to current year. 245
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 246
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Display a mechanical equipment lists, and create a new mechanical equipment item. Observe the auto
generated name.
The utilised expression indicates that only items created in any location (with Owner attribute
MechanicalTags) will be autonamed in the defined format.
Naming rules will be utilised according to the order they are placed in the Data Display key.
If the conditions of the naming rule at the top of the list are met, then that rule will be used. Else, the conditions
in the next placed rule will be analysed, and possibly utilised.
Element and Naming rule files can be placed in the rules folder and referenced by the Engineering application.
Using the rule files generated within the supplied ACE project, the following autonaming rule formats can be
observed
These formats utilise the element attribute values and concatenate them to form a required autoname
structure.
www.aveva.com
Copyright 1974 to current year. 247
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 248
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
This rule applies to items element types (:EQUIPMENT) and whose database owner is an ENGGRP named:
Mechanical-Items.
www.aveva.com
Copyright 1974 to current year. 249
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Exercise 11
1. Delete the naming and element rules created during the exercise
3. Switch to the Infill Naming Mode and save rules in the User Location
5. Create a naming rule with the format 'ENGITE-' & !Index & 'B'
6. Create 2 items each, of Line items, Mechanical equipment and Electrical equipment
7. Create an element rule which applies to instrument tags only, using the rule expression: ActType
EQ :INSTRUMENT
8. Create an element rule which applies to valve tags only, using the rule expression: Owner EQ ( ID
/Valve-items )
9. Create naming rules with the above element rules, and observe the AutoNaming on newly created
applicable items
www.aveva.com
Copyright 1974 to current year. 250
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
CHAPTER 10
Exercise 13
1. From the List and Schedules group in the Home tab, select Mechanical from the category drop
down, and open the Mechanical Equipment list.
2. Display the Data Management ribbon, and select the Compare/Update/Link button in the
AVEVA Integration group, to display the Compare/Update form.
3. Click on the now visible Compare/Update Actions contextual tab to display its ribbon menu.
4. Select the Design Database from the Source Selection drop down list.
5. On the Map Element Types wizard step, select the Equipment from the drop down list, and Map
the source type EQUIPMENT to the Mapped type :EQUIPMENT.
6. From the Attributes Mapping(s) step of the wizard map Design attributes to Engineering attributes
7. Map the design attributes Name, Description, and Number with the engineering attributes
Name, :DESCRIPTION, and :TAGNUMBER respectively, for the Electrical equipment and
Mechanical Equipment element types.
8. Refresh the Compare the Design items with the Engineering items, and observe items with attribute
changes, matches, and non matches, for Design Equipment (Utilise the Attribute Details tab at
the bottom of the Compare/Update grid)
9. Accept all required changes and update the databases. Store new Mechanical Equipment items in
the ENGGRP Mechanical - Items, which is located in the ENGWLD Mechanical-Equipment.
10. Link and Update the attributes of new items, then Unlink a number of already linked items.
11. Observe the Compare/Update grid, the Electrical Equipment list, and also the database explorer
for all changes and updates.
12. Run the comparison and updates with a source Electrical data from an AVEVA Electrical, AVEVA
Instrumentation and an AVEVA P&ID project if available
www.aveva.com
Copyright 1974 to current year. 251
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
www.aveva.com
Copyright 1974 to current year. 252
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
APPENDICES
1 Appendix A
There are also a small number of pseudo attributes available on elements that are associated with
distributed attributes.
DATT NEW
The NEW command creates a new distributed attribute and associates the CE/on element with it.
Syntax:
The example creates a new distributed attribute of type :PRESSURE and associates it with CE.
Example:
DATT NEW :PRESSURE
DATT DELete
The DELete command removes distributed attributes from CE/from element
Syntax:
The example deletes the last distributed attribute member of type :PROCESS from /MyEquipment.
Example:
Q ATT
The existing Q ATT have been extended to allow for querying distributed attributes.
Syntax:
Q ATT [AS ANY | <type>]
The command displays all the values of the :PROCESS type associated with CE.
Example:
Q ATT AS :PROCESS
www.aveva.com
Copyright 1974 to current year. 253
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
2 Appendix B
Since more than one instance of a distributed element is handled [n] is used to qualify which instance the
user is interested in.
The syntax is used on both queries and manipulations of attributes, as well as in PML1
expressions.
Syntax:
:UDANAME\:UDETNAME
Example:
Q :LOCAL\:PROCESS
:local\process true
:LOCAL\:PROCESS false
-- Query all LNLIST elements where distributed attribute :local\:process equals true
Q :LOCAL\:PROCESS[2]
:local\process[2] true
-- Set the value of the second instance of distributed attribute :local\:process to false
:LOCAL\:PROCESS[2] false
-- Query all LNLIST elements where second instance of distributed attribute :local\:process equals true
www.aveva.com
Copyright 1974 to current year. 254
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
3 Appendix C
There are a few number of pseudo attributes available to all elements that may have distributed attributes
associated with them.
The attribute returns a list of all eligible distributed attribute types that may be associated with current
element. The list does not consider any constraints defined in the schema.
Example:
Q DLIST
This attribute returns a list of all distributed attribute types associated with current element.
Example:
Q XRLSTT
The attribute returns a list of all distributed attribute members (elements) associated with current element.
Example:
Q XRLIST
XRLIST
1 :PROCESS 1 of XPIFLD 2 of XPIFLD 1 of /THEPROCWLD
2 :PRESSURE 1 of XPIFLD 2 of XPIFLD 1 of /THEPROCWLD
The attribute returns the number of distributed attribute members (elements) associated with current
element. The attribute may take an optional qualifier on typename.
Example:
www.aveva.com
Copyright 1974 to current year. 255
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
AVEVA Engineering (14.1)
Engineering Administration (TM-3652)
Q XRQCNT
XRQCNT 2
The attribute returns a selected distributed attributes member of distributed attribute members (elements)
associated with current element. The attribute may take an optional qualifier of typename.and relative
position.
Example:
Q XRQELE
XRQELE 1 :PROCESS 1 of XPIFLD 2 of XPIFLD 1 of /THEPROCWLD
Q XRQELE ( 1 )
XRQELE 1 :PRESSURE 1 of XPIFLD 2 of XPIFLD 1 of /THEPROCWLD
The attribute is available on the distributed attribute member and returns a list of attributes
that should be shown by default as attributes. The attribute fulfils the same purpose as
Example:
Q ATTDST
The attribute is available on the any element, in addition to be used for distributed attributes, it may be used
in a generic way.
When used specifically for distributed attributes evaluation: It takes the typename of a bindable noun/UDET
as qualifier. It evaluates the actual home element using current element as when evaluating the test
expressions and returns a nulref or a ref to an XPIWLD element.
Note: The evaluation finds the associated DSXHOM from the typename qualifier, after that
processing is the same as for the generic case.
Using it for generic "find a default home" purposes: The DSXHOM reference passed as a qualifier is used to
evaluate the expressions defined in the DSXTST/DSXDST of that DSXHOM. It returns a nulref of the ref of
the ID value held in the DHTEXT attribute of the resulting DSXDST. The CE is passed to the expression for
evaluation.
Example:
-- distributed attributes, get the location to store distributed attributes of type process for CE.
-- Generic example, get the reference that results of evaluation the DSXHOM /MyHomeSelector
for/TESTTHIS.
Datal
Syntax:
For example: getting everything under the ZONE /MyZone including any distributed attributes would be done
by executing the following output command:
Part of the output would resemble the following, with the distributed attributes statements included:
NEW EQUI
DATT NEW :Process
:Local\:Process false
END
For further details on Distributed Syntax, please refer to Database Management Reference Manual.
www.aveva.com
Copyright 1974 to current year. 257
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.