Lexicon User Guide

LEXICON
User Guide
AVEVA Solutions Limited
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 such permission is granted, it expressly requires
that this copyright notice, and the above disclaimer, is prominently displayed at the beginning of every copy that is
made.
The manual and associated documentation may not be adapted, reproduced, or copied, in any material or
electronic form, without the prior written permission of AVEVA Solutions Limited. The user may not reverse
engineer, decompile, copy, or adapt the software. Neither the whole, nor part of the software described in this
publication may be 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.
Unauthorised or unlicensed use of the software is strictly prohibited.
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.
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.
LEXICON User Guide
Revision Sheet
Date Version Comments / Remarks

September 2011 12.1.1 Lexicon Toolbar and Graphical View added.
January 2012 Copyright added to all pages.
July 2012 Pipe Stress Interface Upgrade
January 2013 Intellectual Property Rights (IPR) Protection changes
incorporated.
June 2013 12.1.SP4 Datasheets added.
LEXICON User Guide
LEXICON User Guide
LEXICON User Guide
Contents Page
User Guide
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Guide Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1:1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
DBVWWL : Database View World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
DSTWLD : Datasheet Template Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
DSXWLD : Bound Attribute World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
REVCWL : Revision Configuration World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
STAWLD : Status World. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
UDETWLD: User Defined Element World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
UWRLD : User Defined Attribute World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2:2
Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Lexicon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Edit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Create . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2
Modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3
Pipe Stress Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3
Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3
Copyright 1974 to current year. i 12 Series

AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
LEXICON User Guide
Schematic Model Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3

Datasheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4
Unit Sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:4
Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Dictionary Explorer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:1
Edit Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:2
Current Element Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:3
Database Views Editor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:4
Graphical View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:5
Nodes and Links. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:6
Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8
Command Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4:8
Database Views Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1

View Definition Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:2
Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:2
Create Definition Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:2
Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:3
View Set Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:5
View Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:6
View Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:7
Data Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:8
Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:13
Preview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:15
User Defined Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1

Create a UDA World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1
Create a UDA Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:2
Create a UDA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:4
Select Element Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:7
Edit Valid Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:8
UDA Graphical View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:9
User Defined Element Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1

Create a UDET World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1
Create a UDET Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:2
Copyright 1974 to current year. ii 12 Series

LEXICON User Guide
Create a UDET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3

Select Base Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:5
Select Owner Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:5
Select Member Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:6
Select Hidden Attributes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:7
UDET Graphical View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:8
User System Defined Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1

Create a USDA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1
Select System Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:3
Select Element Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:4
Status Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1

Status Definitions Graphical View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1
Distributed Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1

Define Distributed Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
Create Bound Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1
Create Attributes for Bound Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:2
Create Binding Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:2
Distributed Attributes Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:2
Create Distributed Attribute Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:2
Distributed Attributes Graphical View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:5
Database Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1

Create Administrative Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1
Create a Database View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:2
Project Breakdown Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1

Setting up the PBS definition in Lexicon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1
Sample Definition of PBS Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:6
Datasheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:1
Datasheet Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:1
Datasheet Template World. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:1
Datasheet Template Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:2
Datasheet Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:3
Revision Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:6
REVCWL: Revision Configuration World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:6
REVCGP: Revision Configuration Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:7
Copyright 1974 to current year. iii 12 Series

LEXICON User Guide
REVNOD: Revision Number Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:8

Datasheet Template Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:13
Unit Sets Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:14
Datasheet Template Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:15
Datasheet Template Editor Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:15
Template Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:17
Attribute Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:18
Toolbox ............................................................ 13:20
Continuation area. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:21
Revision block addition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:23
Copyright 1974 to current year. iv 12 Series

LEXICON User Guide
Introduction
1 Introduction
LEXICON is supplied as a module within the AVEVA suite of products and allows the system
administrator to:
Create and modify User Defined Attributes and User Defined Element Types.
Group similar elements for administrative ease.
Delete elements.
View all available elements in a Explorer window.
Create and modify Database Views.
Create and modify the schema for distributed attributes.
1.1 Assumptions
The LEXICON User Guide has been written for System Administrators.
It is assumed that:
Users are familiar with the software at a System Administrator level.
Access to the LEXICON GUI is normally restricted to FREE users only.
The commands underlying the interface are described in the LEXICON Command
Reference Manual.
1.2 Guide Structure

The LEXICON User Guide is divided into the following sections:
Overview introduces the LEXICON module.
Toolbar gives quick access to all the tasks associated with the
creation and modification of the module
Window describes how the elements and attributes are displayed in

the LEXICON module.
User Defined Attributes describes the creation and attributes of the User Defined
Attributes elements.
User Defined Element describes the creation and attributes of the User Defined
Types Element Types elements.
User System Defined describes the creation and attributes of the User System
Attributes Defined Attributes elements.
Copyright 1974 to current year. 1:1 12 Series

LEXICON User Guide
Introduction
Status Definitions describes the Status Definitions.
Distributed Attributes describes the Tags, Attributes and create Elements.
Database Views describes the creation and maintenance of Database View

definitions.
Datasheets describes the creation and mapping of datasheet templates.

LEXICON User Guide
Overview
2 Overview
The LEXICON module can also be launched from the main AVEVA PDMS Login window.
To enter the LEXICON Module in the Design Module, from the main menu bar, click Design
> Modules > Lexicon.
To enter the LEXICON Module in the Engineering Module, click AVEVA Plant > Engineer
> Diagrams SP XX.XX > Lexicon.
2.1 Features
The LEXICON Module allows the system administrator complete control of the
administration of the Dictionary (DICT) database of a project.
Before a project can use any of the resources covered in this guide a DICTIONARY (DICT)
database must be created as part of a Multiple Database (MDB), which is done with the
use of the ADMIN module in the same way as for any other type of database. For more
information, refer to Administrator User Guide.
Elements within the LEXICON module can be changed or deleted during the course of a
project. The dictionary contains all the definitions for a project and if data is to be transferred
between projects the dictionary must be transferred as well. The data output and project re-
configuration functions can be used to do this. A user may create elements within other
databases such as DESIGN from definitions within the LEXICON database, however if the
LEXICON database is removed then these elements will become unrecognised in the
DESIGN database.
Note: A familiarity of common navigation practices within the software is recommended but
not essential.
2.2 Hierarchy
As with all elements in the software, all the LEXICON module elements are owned by other
elements, therefore elements must be created in strict order. The hierarchy for the
LEXICON module is displayed in the Dictionary Explorer.
Below the Dictionary world level in the LEXICON module, the LEXICON specific elements
are:
2.2.1 DBVWWL : Database View World

A Database View World element is a container for project defined database view definitions
used for reporting and grid based data. These define multi-element datasets that can be
presented in a single grid, used for export/import or reporting. These database views

LEXICON User Guide
Overview
present and allow the edit of selective data from several elements allowing the information
displayed to be configured for a users working practices.
2.2.2 DSTWLD : Datasheet Template Group

A Datasheet Template World element is a container for Datasheet Template (DSTMPL)
definitions used to create and control datasheet templates as they progress through their
lifecycles. The desired project configuration is created by administrators as DSTMPL with
the use of a hierarchy of Datasheet Template World, Datasheet Template Group, Datasheet
Template and Revision Block hierarchy. Refer to Datasheets for more information.
2.2.3 DSXWLD : Bound Attribute World

A Bound Attribute World element is a container for bound attribute definitions used for
adding separately managed attributes to database elements. These allow the attributes of
an element to be stored on separate database elements, potentially in different databases to
help with data management issues such as claiming and data access permissions.
2.2.4 REVCWL : Revision Configuration World

A Revision Configuration World element is a container for a revision block, the revision
block hierarchy must contain a Revision Number Definition (REVNOD), Revision Block
Definition (REVBLD) and Revision Configuration (REVCON). These definitions used to
create and control revision blocks, refer to Revision Configuration for more information.
2.2.5 STAWLD : Status World

A Status World element is a container for status definitions used to control and report on
the status of individual model objects as they progress their lifecycles. The desired project
configuration is created by administrators as Status Definitions in LEXICON with the use of
a hierarchy of Status World, Status Group, Status Definition and Status Value elements.
For more information on the creation of the hierarchy, refer to Status Control.
2.2.6 UDETWLD: User Defined Element World

A User Defined Element World element is a container for User Defined Element (UDET)
definitions. UDETs extend the definition of existing database elements. The definition of
UDETs when combined with UDAs allows elements to be classified according to project
requirements and the attributes to be assigned to elements only when appropriate. For
example Equipment (EQUI) elements may be sub classed as Vessel or Pump and attributes
assigned to the new types as appropriate.
2.2.7 UWRLD : User Defined Attribute World

A User Defined Attribute World element is a container for User Defined Attribute (UDA)
and User System Defined Attribute (USDA) definitions. UDAs define additional attributes for
database elements to meet individual project requirements. USDAs redefine the behaviour
of existing attributes by limiting the allowed values or hiding system attributes that are not
required for a project.

LEXICON User Guide
Toolbar
3 Toolbar
The toolbar gives quick access to all the tasks associated with the creation and modification
of the LEXICON module.
Depending on the selections made from the toolbar, the user will be presented with further
windows prompting for user input and options allowing the workflow to continue.
In this section, the user is introduced to the toolbar, specific tasks are described in later
sections, refer to Guide Structure.
The toolbar for the LEXICON module is automatically displayed in the top left hand corner of
the screen, once the module has been entered.
3.1 Lexicon
Quick access to the Save or Get Work options, open another module or exit the LEXICON
module.
3.2 Display
Allows the user to open or close the application windows in the LEXICON module, from the
main menu bar, select Display, the Display menu is displayed:
Dictionary Explorer Opens the Dictionary Explorer window.
Current Element Editor Opens the Current Element Editor window.
Database Views Editor Opens the Database Views Editor window.
Graphical View Open the Graphical View window.
Search Opens the generic Search window, for more information

refer to Schematic Model Manager User Guide.

LEXICON User Guide
Toolbar
Search Results Opens the results of any search in the generic Search
Results window. for more information refer to Schematic
Model Manager User Guide.
Command Line Opens the Command Window, for more information on

Command Line commands, refer to LEXICON Command
Reference Manual.
3.3 Edit
On a typical project, it may be necessary for a system administrator to edit the elements in
the Dictionary Explorer window. From the main menu bar, select Edit the Edit menu is
displayed:
Note: Dependent upon the actions carried out, several unavailable commands will be
displayed on the Edit menu.
Undo Performs an Undo of the last action performed.
Redo Performs a Redo of the previous Undo action.
Cut Cuts the current element from it position in the hierarchy.
Copy Copies the current element.
Paste Paste an element into the hierarchy below the current element. (The
element is named as Copy(1) of XXX).
Delete Delete the current element.
Note: If the current element has one or more members, both

element and members are deleted.
Validate Compiles the dictionary definitions which update the application and
display messages about the success or failure. The validate
functionality is particularly relevant to UDA definitions and must be
carried out to display up to date information about UDAs within the
application windows.
3.4 Create
Displays a drop-down menu listing all the Create options available for the selected element.
The elements available for selection are dependant upon the Current Element (CE).

LEXICON User Guide
Toolbar
3.5 Modify
Displays a drop-down menu listing all the Modify options available for the selected element.
From the main menu bar, select Modify the Modify menu is displayed. Dependent upon the
actions carried out, several unavailable commands are displayed on the Modify menu:
Lock Locks the current element.
Lock All Locks the current element and all of its members.
Unlock Unlocks the current element.
Unlock All Unlocks the current element and all of its members.
3.6 Pipe Stress Interface

Displays a drop-down menu listing the UpDate PSI Attributes option. This update option
enables users to upgrade the PSI UDAs. For more information refer to Pipe Stress Interface
Administrator Guide
Note: It is important for users upgrading from older versions of PSI to run this upgrade on
existing data.
3.7 Help
Displays a drop-down menu listing all the Help options.
3.8 Schematic Model Manager

Configuration tools are available for selection from the Schematic Model Manager module.
These tools are used to set up the UDAs and the associated data mappings for P&ID
import. Refer to Schematic Model Manager User Guide. for more information.

LEXICON User Guide
Toolbar
3.9 Datasheets
Displays the Settings window, which allows the user to create and control datasheet
templates. Refer to Datasheets for more information.
3.10 Unit Sets

Displays the Unit Set Configuration window, which allows the user to create and control the
units available for selection. Refer to Unit Sets Configuration for more information.

LEXICON User Guide
Window
4 Window
All of the tasks that a system administrator is required to do, can be carried out within the
LEXICON window.
By default, the LEXICON window is split into two window panes. To the left is the Dictionary
Explorer and to the right the Current Element Editor. An empty work area provides space
for additional application windows available from the application menus.
4.1 Dictionary Explorer

The Dictionary Explorer lists all available elements in the Dictionary (DICT) database. All
Dictionary Explorer functionality is provided through selections made by the system
administrator depending upon the selections made in the LEXICON window.

LEXICON User Guide
Window
Depending on the type of element currently selected, a different set of options will be
available for selection.
To display additional Dictionary Explorers, click to highlight the element in the hierarchy.
Right click and from the drop-down menu displayed, select New Explorer. An additional
Dictionary Explorer is displayed to the right of the Current Element Editor window,
displaying the selected element.
4.1.1 Edit Members

The Edit Members menu option is available from the right click menu in Dictionary
Explorer. The Edit Members window is displayed populated with the attributes of the
dictionary elements beneath the CE.

LEXICON User Guide
Window
Elements can be created and edited with the Edit Members functionality. For more
information refer to Schematic Model Manager User Guide.
4.2 Current Element Editor

The Current Element Editor window displays the attributes of the currently selected
element in the Dictionary Explorer window. Attributes are grouped into categories, such as
General, Basic definition, Presentation, Protection, Design and Misc, the categories
displayed are dependent upon the CE.
When an attribute is selected a description of the attribute is displayed at the bottom of the
Current Element Editor window.

LEXICON User Guide
Window
Detach The Current Element Editor window can be detached so

that it stays focused to the element in the Dictionary
Explorer it was created for.
The user can create and detach multiple Current Element
Editor window and edit each element without the need to
navigate to it in the Dictionary Explorer window.
4.3 Database Views Editor

The Database Views Editor displays all available elements in the database view editor. All
Database Views Editor functionality is provided through selections made by the system
administrator in the LEXICON window.

LEXICON User Guide
Window
To display the Database Views Editor, from the main menu bar select Display > Database
Views Editor, for more information, refer to Database Views Editor.
4.4 Graphical View

The Graphical View displays a pictorial representation of database relationships, each
relationship is displayed in a separate tabbed panes in the Graphic View window of the
LEXICON window.
Views are only available for elements which are not administrative in the dictionary
hierarchy (WORLD, GROUP). Graphical views are therefore available for the four remaining
elements in LEXICON; UDA, UDET Status Definition and Distributed Attributes.
Each graphical view is opened by right-clicking the element in the Dictionary Explorer, the
view is displayed in a tabbed pane labelled with the name of the CE in the Graphical View
window.

LEXICON User Guide
Window
If no specific graphical views have been opened during the current LEXICON session then
the Graphical View pane remains empty. If one or more views have been previously open
during the current LEXICON session, then these views will be restored when the Graphical
View pane is re-opened. Views are not maintained across LEXICON sessions. Individual
view tabs can be closed, to close the current view, select close tab at right on the tab
header.
4.4.1 Nodes and Links

View nodes represent database elements. They consist of an outline, whose shape
depends on the element's type and the view context. Nodes contain a number of items,
starting at the top with the element name, followed by the element description, if there is
one. In addition, at top right above the element name the node may also include a
stereotype which helps to identify what type of element is shown. Example stereo types
include UDA, UDET and Element. These are shown as necessary to distinguish between
different types in the same view.
In many contexts the node contains lists of other items grouped into compartments. Each
compartment has a header followed by a list. The list items show an icon and name. If the
item has a value then the value will also be shown to the right of the name. If the item is a
UDA and the UDA Lock attribute is set, then the item is also shown with a padlock icon.
Example compartments are Attributes (ATTRIBUTES), Hidden Attributes (HIDDEN) and
UDAs (UDA). To the right of the compartment title is a chevron button that can be used to
open and close the compartment. If compartments are shown, then a node also has a
chevron at top right. This chevron closes all compartments and hides all compartment
headers.

LEXICON User Guide
Window
A progression is shown from left to right, where the chevrons are used to progressively
expand the node to show more detail. At right a node is shown with many compartment
items, each having an associated value. In this case they are the attributes and values of
the PID UDA type.
Selection of single items can be achieved with a left-click in the Graphical View window.
Multiple selections can be achieved by using bounding outline, selected nodes and links are
shown with handles. Selected items in a node compartment are shown by a change in the
item's background colour.
Nodes and links can be modified by dragging selection handles. The width of a node can be
adjusted by dragging the left and right handles. Node height cannot be adjusted. Likewise
the route of a node can be modified by dragging a node's selection handle. The node's
attachment points to a node are fixed, however, modifications to nodes and links are
temporary.
Selected items can be copied to the clipboard in the usual manner. The view's graphics can
therefore be pasted into another application, such as an image or document editor. For
example: press Ctrl-A to select all the items then press Ctrl-C to copy the graph to the
clipboard. The selected items can then be pasted into the application of choice.
A selected node or compartment item can be used to open a new Graphical View window,
right-click on the selected node or compartment item, select Navigate to a new Graphical
View window for the selected node or compartment item is displayed.

LEXICON User Guide
Window
4.4.2 Layout
The arrangement of nodes and links in a graphical view (the layout) is determined
automatically when the view is opened. The layout can be modified by dragging selected
items, layout modifications are temporary. Either individually selected nodes can be moved,
or groups of nodes can be moved together by dragging a multiple selection. When the
dragged nodes are released, the path of the affected links is recalculated automatically.
To return to the initial automatic layout, right-click on the graphical view background and
from the displayed menu, select Layout.
4.5 Command Window

The Command Line window allows the administrator to maintain the Dictionary database
through the use of a command line interface. Although it is possible to achieve the same
results using the GUI, it may be useful to revert to the command line in certain
circumstances.
By default the Command Window is not displayed. To open the Command Window select
Display > Command Window from the main menu bar.
For a detailed explanation of the LEXICON command line refer to the LEXICON Command
Reference Manual.

LEXICON User Guide
Database Views Editor
5 Database Views Editor
The Database Views Editor gives the user quick access to all the tasks associated with
Database View definitions. All Database Views Editor functionality is provided through
selections made by the system administrator in the LEXICON window.
To display the Database Views Editor window, select Display > Database Views Editor
from the main menu bar.
By default the Database Views Editor is populated with the Project Views which are the
Database Views defined in the Dictionary databases.

LEXICON User Guide
5.1 View Definition Set

The View Definition Set pane of the Database Views Editor allows the user to select and
manage the source for the Database View definitions being modified. By default there are
three Definition Sets available for selection from the drop-down menu.
Element Views A read-only set of Database Views which are automatically

generated from the database definitions. A default
Database View is provided for every system defined
element type and UDET for each database type it is allowed
in.
Project Views All of the Database Views that exist in the LEXICON
hierarchy.
User Views The Database Views for the current project as defined for
this user, these views are stored in %PDMSUSER%.
Additional Definition Sets can be created or added into the list with the use of the toolbar
provided.
5.1.1 Toolbar
The View Definition Set toolbar provides the ability to manage the Definition Sets
available for selection from the drop-down list. The user has the ability to create, load or
delete any file based definitions.
Open Displays an Open window which allows the user to navigate

to and open a Definition Set
Close Closes the currently selected file based Definition Set, the
default Definitions Sets cannot be closed.
New Displays the Create Definition Set window which allows the
user to create a new Definition Set.
Delete Deletes the currently selected Definition Set from the file
system and removes it from the list.
Save Saves the currently selected file based Definition Set.
The user can select from the drop-down menu which View Definition Set to use.
5.1.2 Create Definition Set

To create a Definition Set, select New from the View Definition Set toolbar to display the
Create Definition Set window.

LEXICON User Guide
The user must now input a Name and Description for the new Definition Set.
The location of the definition file must now be identified. Click the icon next to the Filename
field to display the Save Definition File As window.
Navigate to the required location, name the file and click Save, or click Cancel to return the
user back to the Create Definition Set window without saving the file.
The Filename field in the Create Definition Set window is automatically populated.
Click OK to create the new Definition Set or Cancel to discard any inputs and close the
Create Definition Sets window.
5.2 Views
The Views pane of the Database View Editor window displays the Database Views and
Database View Sets in the selected Definition Set, subject to the criteria selected from the
Database Types Filter. The filter allows the user to restricts the information that is displayed

LEXICON User Guide
in the Views tab, for example: only the information relevant for the selected database types
are displayed.
When a Database View or Database View Set is selected from the View tab, the View
Properties, Data Sources, Columns and a Preview are displayed in the View Detail pane
on the right hand side of the Database Views Editor. Each time a new Database Views or
Database View Sets is selected, the information displayed in the View Detail pane is
automatically updated to reflect the change.
The user can manage the Database Views and Database View Sets with the use of the
right click menu in the View tab:

LEXICON User Guide
New > View Creates a new Database View in the current context
New > View Set Creates a new Database View Set in the current context
Rename Allows the user to change the display name for the
Database View or Database View Set, this is not the name
of the definition in the Dictionary database.
Delete Deletes the currently selected Database View or Database

View Set.
Navigate to Sets the Current Element (CE) to the definition element for
the selected item, this is only enabled when the Project
Views Definition Set is selected. The item is then selected
in the Dictionary Explorer if it is displayed.
Cut Places the selected item on the Database Views Editor clip
board ready for a Paste operation. The item is moved when
the Paste operation is selected. Items on the Database
Views Editor clip board are not available in other contexts
such as the Dictionary Explorer. An item can be Cut from
one Definition Set and Pasted into another.
Copy Copies the selected item onto the Database Views Editor
clip board ready for a Paste operation. An Item can be
copied from one Definition Set into another
Paste Pastes the item currently on the Database Views Editor

clipboard into the selected context.
5.2.1 View Set Detail

If a Database View Set is selected in the Database Views Editor then the View Set Detail
Pane is displayed. If the definition can be modified, the display name and the description of
the Database View Set can also be modified.

LEXICON User Guide
A Database View Set is a set of Database Views that have been defined for a related
purpose and can be used to group Database Views for easy navigation. A Database View
belongs to a Database View Set if it is a member of the Database View Set definition or if
its DBVWSTREF attribute refers to the Database View Set.
Note: The DBVWSTREF attribute is not editable when the Database Views Editor is
being used.
The user can now modify the display name and the description of the Database View Set.
User-defined name The display name for the Database View Set, the name
needs to be unique. The display name is displayed at the
top of the View Set Detail pane by the padlock for easy
reference.
Description A description of the Database View Set.
5.3 View Detail

If a Database View is selected from the Views pane in the Database Views Editor, the
View Detail Pane is displayed. The Database View can be modified with the following
limitations:
Editing of Column Relations and Test Expressions are not supported
Editing of the DBVWSTREF attribute is not supported
The View Detail pane of the Database Views Editor window is displayed with four tabs
populated with following:
View Properties
Supports modification of the primary attributes of a Database View to define the display
name and the elements that the Database View rows are based on.
Data Sources
Defines rules for database element creation and navigation steps to additional information
elements such as an items catalogue specification.

LEXICON User Guide
Columns
The columns displayed to the user for each Data Source, these can be attribute values or
expressions evaluated on the selected Data Source.
Preview
A grid showing column data defined by the Database View. The grid only shows data that
the current user has access to. By default data access is restricted in LEXICON so this will
appear as an empty grid for most element types.
5.3.1 View Properties

The View Properties tab is populated with the information which defines the display name
and description for the Database View. As well as the element selection criteria for the data
rows. By default the View Properties tab is selected.
The user can now modify the primary attributes of a Database View and the elements that
the Database View rows are based on.
User-defined name The display name for the Database View, the name needs
to be unique or the Database View will be listed with a
derived name of the form Tablen. The display name is
displayed at the top of the View Detail pane by the padlock
for easy reference
Description A description of the Database View.
Element types The types of the elements to include in the Database View.

LEXICON User Guide
Attribute Filters
Attribute filters restrict the contents displayed in the Database View to only the elements
that meet the stated criteria. For a filter to be active it must have the Attribute Operator and
Value columns completed.
To display the Attribute filters, from the Attribute filters part of the View Properties tab,
click Expand. All the elements that meet the criteria of the Attribute filters are displayed.
Pseudo attributes and hidden attributes are not displayed in the right click drop-down menu
on the Attribute column but can be entered in the Attribute cell.
Expression Filters
Expression filters restrict the contents displayed in the Database Views to only the
elements that meet the stated criteria. For an expression filter to be active it must have a
valid expression that evaluates to a Boolean/LOGICAL result.
From the Expression filters part of the View Properties tab,click Expand. All the elements
that meet the criteria of the Expression filters are displayed.
5.3.2 Data Sources

Data Sources are elements that data columns can be based on. An Attribute column
based on the Database View (DBVW) Data Source displays the value of the attribute from
the elements selected by the view definition. An attribute column based on a Source
Element (SRCELE) Data Source displays the value of the attribute associated with
element defined by that data source.
From the View Detail pane of the Database Views Editor window, select the Data Sources
tab. The Data Sources for the Database View are displayed.

LEXICON User Guide
For the purposes of this user guide, an example Data Sources hierarchy is described:
If a Database View is created that has the Element Types (ELEL) attribute set to UDA
then the node at the top of the Data Sources tree represents the collection of UDA
elements.
If a SRCELEMENT node is created below this with its Expression set to OWNER, then
the Source Element represents UGROs, the OWNER elements of the selected UDAs
Since SRCELEMENTs are allowed to contain SRCELEMENTs navigation steps are
incremental. Another node with its Expression set to OWNER represents UWRLs, the
OWNERs of the OWNERs of the selected UDAs.
The NAME attribute is present on UDAs, UGRO and UWRLs. Creating an Attribute
column for the NAME attribute and selecting different Data Sources changes the
element the NAME attribute is being displayed/edited on.
From the explorer displayed in the Data Sources tab, the user can create a new Data
Source, delete, navigate to, cut, copy or paste a Data Source from the right click menu.
New SRCELEMENT Creates a new Data Source in the current context
Delete Deletes the selected Data Source.
Navigate To Sets the Current Element (CE) to the definition element for
the Data Source, this expands the Dictionary Explorer if
displayed
Cut Places the selected item on the Database Views Editor clip
board ready for a Paste operation. Pasting the item moves
it.

LEXICON User Guide
Copy Creates a copy of the selected item on the Database Views

Editor clip board.
Paste Pastes the item on the Database Views Editor clip board
into the current context
Properties
The Properties part of the Data Sources tab displays the significant properties of the
selected Data Source. If a DBVW is selected then only its description can be modified on
the Data Sources tab. The Expression field must be filled out with a valid expression for
SRCELE Data Sources to define the element navigation.
From the Expression drop-down list, select an expression from the list of available
expressions.
Allow Row Creation/Allow Element Creation

To create new rows for the Database View or to enable the creation of the Data Source
element in the event that it doesn't exist and the user tries to set a column value. Dependent
upon which element is selected as the CE will determine if the user can create new rows or
Data Sources element.
Click to select the Allow element creation to enable the Creation Rules part of the Data
Sources tab. The rules defined in the Creation Rules part of Data Sources tab are used
for the element creation. If insufficient information is defined for the element creation then
the user is prompted, this could include information such as OWNER and TYPE.

LEXICON User Guide
Creation Rules
The creation rules define the information to create an element when requested and set up
the initial state of the element created by setting attribute values and assigning status. The
user must populate the Creation Rules part of the Data Sources tab to make sure
additional information is not required during the element creation.
Auto assign or create owner - To create the new element in the first available owner or an
ownership hierarchy if one isn't present, click to select the Auto assign or create owner
checkbox.
Note: As ownership is usually significant for an element, this must be used with caution.
Owner Expression - In the Owner Expression field, enter the OWNER for the element
being created, if left unset then the user is prompted for the OWNER. The expression can
be that returns either the element such as id /Equipment or a string expression that
returns the name or identity of the element such as /SITE_' + $!Param2. For more
information on the expressions, refer to Create Parameters.
Type Expression - In the Type Expression field, enter a string expression returning the
type of the element to create such as ';MyUdet'. If this isn't set then the user is prompted for
the type of element to create.
Note: The user is not prompted if the type can be derived.
Additional rules can be used to request information from the user (Parameters), set attribute
values at the time of creation and assign status to the newly created element.
Create Parameters
Parameters are user defined variables that can be used in the create rule expressions. A
parameter can either be a value derived from an expression or information requested from
the user. If the Expression field is left unset then the user is prompted at the time of
creation. When using a parameter it should be treated as if the value is being substituted
into the expression before execution rather than as a PML variable.
The Create Parameters part of the Data Sources tab is populated with the following
attributes:
User-defined name The name of the parameter, as used in the expressions.
User Prompt The prompt to display to the user to request a value.

LEXICON User Guide
Expression The expression used to derive a value for the parameter, if

unset the user is prompted. If the element if being created
for a SRCELE Data Source then the expression is
executed on the element defined by the parent Data Source
otherwise it's executed on the Current Element (CE).
Expression Type The syntax of the expression (PML or XPATH), PML

expression must be PML 1 only
UDA Type The data type for the parameter, this affects user entry for
the parameter and not the parameter use.
Required Indicates the parameter is required and whether element

creation can succeed without it.
If a parameter is used to request the fluid from a user, the attributes in the Create
Parameters part of the Data Sources tab must be populated as follows:
User-defined name Fluid
User Prompt Fluid Code
Expression
Expression Type PML
UDA Type TEXT
Required True
The value entered by the user at the time of creation can be used in the Owner Expression
and in attribute rule as follows:
Owner Expression '/Equipment_' + '$!Fluid'
Attribute Rule
Attribute :Fluid
Expression $!Fluid
Note: The example expressions contains $!Fluid in '' characters since the value is
substituted into the expression before the expression is evaluated. The parameter is
not a PML variable.
Attribute Rules
The Attribute Rules define the initial values of attributes when the element is created.
These can be fixed by specifying expressions to derive the value or the user can be forced
to enter a value at the time of element creation.

LEXICON User Guide
The Attributes Rules part of the Data Sources tab is populated with the following
attributes:
User Prompt The prompt which is displayed to the user.
Attribute The attribute to set the value of.
Expression Expression to derive a value, if left unset the user is

prompted for a valve.
Expression Type The syntax of the expression (PML or XPATH).
Required Indicates whether a valve is required and whether element

creation can succeed without it.
Status Rules
The Status Rules assign the identified status definition to the element on creation or
prompts the user for a status definition to apply if the status definition is not defined.
The Create Status part of the Data Sources tab is populated with the following attributes:
User Prompt The prompt which is displayed to the user.
Status Definition Ref The status to assign to the created element, if left unset
then the user is prompted.
Required Indicates whether a status must be assigned for the element

creation to succeed.
5.3.3 Columns
The Columns tab displays the columns definitions for the Database View. A column can be
based on a database attribute or expression. Attribute columns are editable in the Database

LEXICON User Guide
View by the user unless the Readonly property is set. Columns based on expressions are
not editable by the user when accessed in the data grid. It may be helpful when managing
the columns to drag the Data Source field onto the grouping section in order to quickly see
what columns are defined from the different Data Sources.
From the View Detail pane of the Database Views Editor window, select the Columns tab.
The columns definitions for the Database View are displayed.
The drop-down list at the top of the Columns tab control contains the all the Data Sources
defined in the grid. The functionality of the toolbar which contains the New, Add Standard
Attributes and Add Status Column options are affected by which Data Source is selected
from drop-down list.
New Creates a column definition for the selected Data Source

and selects it in the grid.
Delete Deletes the selected column(s).
Add Standard Attributes Adds all of the common attributes for the elements of the
selected data source. Add Standard Attributes is enabled
if columns don't already exist for all of the common
attributes and the element type for the selected Data
Source can be identified.
Add Status Column Adds a column to display the status for the selected Data
Source. The Qualifier must then be set for the column to the
status definition to present to the user.

LEXICON User Guide
The fields in the grid are enabled/disabled depending on whether the column is based on an
attribute or an expression. The field shave the following meaning:
Data Source The element the attribute or expression is obtained from.
Attribute/Expression The database attribute or expression used to get the value

of the column. PML 2 is not supported.
Column Name The default display name for the column, if unset then the
display name is derived from the attribute or the expression
used to get the column value. If duplicate names are
entered then the first column will have the requested name,
subsequent columns will have an index added (for example:
'Name (2)')
Description The data type of the column, this is known for the columns
based on attributes but must be set for columns based on
expressions. If set to the wrong type then errors will be
shown when the data is accessed.
Type The data type of the column, this is known for the columns
based on attributes but must be set for the columns based
on expressions. If set to the wrong type then errors are
shown when the data is accessed.
Read Only If set the user is not able to modify the values in the column
Expression Syntax The syntax of the expression if the column is expression

based (PML or XPATH)
Qualifier A qualifier used for attributes that require qualification such

as STVVAL.
5.3.4 Preview
The Preview tab displays the data defined in the selected Database View definition. The
preview can only display the data for elements the user has access to. In LEXICON, the
contents of the grid may be significantly limited since LEXICON only has access to elements
in Dictionary Databases.
It is advised that a user configuring their Database Views must define the Database View
in their User Views in the module that they wish to use the view. Once the Database View
is defined and tested it can be copied or moved from the User Views to the Project Views
from within the LEXICON module. The Database Views Editor is available in LEXICON
and Tags (for TAGS ADMIN users) and can be added using the customisation menus to all
other modules.
From the View Detail pane of the Database Views Editor window, select the Preview tab.
The preview of the data for the elements the user has access are displayed.

LEXICON User Guide

LEXICON User Guide
User Defined Attributes
6 User Defined Attributes
User Defined Attributes (UDAs) enables the system administrator to add new attributes to
any element in the databases of a project. These UDAs are created as elements in the
LEXICON database inside the project. Because LEXICON databases are project specific, it
is possible to define attributes to suit individual project requirements.
Once defined, UDAs may be accessed in much the same way as normal attributes,
including setting values, querying and reporting upon these values. Utilities such as the
Data Output and Project Reconfiguration functions treat UDAs as they would other
attributes. UDAs can also be used in expressions.
For a full explanation of the structure of a Dictionary database refer to the LEXICON
Command Reference Manual.
6.1 Create a UDA World

A top level element within the DICT database is UDA World (UWRL) which must be created
directly below the Dictionary World element.
To create a UDA World, select Create > UWRLD:User defined attribute World from the
main menu bar. A UWRL element is created and is displayed in the Dictionary Explorer.
Note: When a new element is created in the database hierarchy using the Dictionary
Explorer the Current Element Editor will automatically update to display the
attributes for that element, these will initially be empty.

LEXICON User Guide
After the creation of a new UDA World, the following attributes in the Current Element
Editor must be populated:
Name Enter a valid name for the UDA World in the text box. Special
characters are not allowed.
Description Enter a brief description of the UDA World (can contain up to 120
characters of text).
The Dictionary Explorer will automatically update to show the specified name for the
element.
6.2 Create a UDA Group

If multiple elements of a similar type are to be created in the dictionary database then
groups can be used to simplify navigation of the database hierarchy.
A UDA Group (UGRO) must be created below a UDA World. To create a UDA Group select
Create > UGroup: User defined attribute group from the main menu bar. A UGRO
element is created and is displayed in the Dictionary Explorer.

LEXICON User Guide
After the creation of a new UGRO Group, the following attributes in the Current Element
Editor must be populated:
Name Enter a valid name for the UDA Group in the text box. Special
Description Enter a brief description of the UDA Group element.
element.

LEXICON User Guide
6.3 Create a UDA

A UDA must be created below a UDA Group (UGRO) element. To create a UDA, select
Create > UDA: User defined attribute from the main menu bar. A UDA element is created
and is displayed in the Dictionary Explorer.
After the creation of a new UDA, the following attributes in the Current Element Editor
must be populated. Dependent on the attribute chosen, other related attributes are enabled
or disabled accordingly.

LEXICON User Guide
Name Enter a valid name for the UDA in the text box. Special characters
are not allowed.
Lock From the drop-down menu, select True to lock the UDAs attributes.
Description Enter a brief description of the UDA to be created.
Abbreviation Specifies the minimum number of characters that the attribute name
Length can be shortened to when used in commands and attribute entry
fields. The abbreviation must be less than or equal to the number of
characters in 'User Defined Name' (UDNA). The shortened name
must still define a unique name for the attribute.

LEXICON User Guide
UDA type From the drop-down menu, select a UDA type. Dependant on the
type chosen, other related fields will be disabled accordingly. The
type options are:
integer
real
text
logical
reference
word
position
orientation
direction
datetime
UDA Length For attributes with a 'UDA Type' of 'Text' or 'Word', this specifies the
maximum number of characters that are permitted in the attribute.
For attributes with a UDA Type of 'Position', 'Direction', 'Orientation'
or 'Datetime', this must have a value of 1, For other attribute types
this specifies the number of values in an array.
Element types The list of element types that the attribute is available on. Up to 100
element types can be set. Enter a value directly in the Element
types field or click the icon to display the Select element types
window which can be used to make a list of Element types.
UDA Default Specifies the default value for the UDA to be used if the attribute
hasn't been set. All UDA definitions must provide a default value to
avoid errors being displayed in the event that the attribute is used in
expressions before being set by the user.
Pseudo attribute Indicates whether the attribute is a stored value or whether its value
is to be derived by software. If set to true software must be written
to calculate the value of the attribute. For information on how to
write software for Pseudo attributes, refer to NET Customisation
User Guide
Indexed UDA If set to true this creates an index of the UDA values to enable the
efficient retrieval of elements. The index must be set to help
performance if an attribute is used extensively for attribute filters in
searches, database views or collections. The index must not be set
on all attribute since it will increase database size and management
overheads.
User Defined Enter a name for the UDA that will be displayed in the modules.
Name Special characters are not allowed. To know more about Names
and UDA Names, please refer to the LEXICON Command
Reference Manual.
Reporter Text Specifies the name used for the attribute when presented to the
user. The name must be set so that the user is presented with a
meaningful attribute names instead of the colon prefixed attribute
name (UDNA).

LEXICON User Guide
UDA Category Enter a value to allow the UDA to be grouped together on the
attributes form within other modules.
Hidden Holds a logical value, setting this to true will indicate that the UDA
will be hidden from the Q ATT command and from the attribute
form within other Modules. Querying of the individual UDA will not
be effected by this setting.
Hyperlink Holds a logical value, setting this to true will allow the text value of a
UDA to contain a path to the external file.
Connection Holds a logical value, setting the value to true will signal that the
UDA is a connection in the reference list.
Protected Holds a logical value, setting to True will not allow the attribute in a
protected database to be viewed. Access to protected UDAs will be
granted to appware encrypted with a suitable password.
Units Specifies the Dimension for the attribute, if the attribute has a UDA
Type of Real. If the units are set then the attribute becomes unit
qualified with appropriate units for the selected dimension.
Length An integer value from 1 to 120 can be set in this field to denote UDA
Length. The length option is applicable only for UDA types REAL,
INTEGER, TEXT, WORD and REFERENCE.
Valid values Depending on the type of element selected enter a valid numeric
value, value range or text strings.
For numeric ranges separate minimum from maximum value with a
single dash (-).
Multi-word strings must be enclosed in either single quotes (') or
apostrophes (`) or vertical bars (|).
Single-word strings do not have to be enclosed.
All items must be separated by commas or white space.
For example: if the UDA Type is set to real or integer then enter a
numeric range such as 5-9.
To simplify editing valid values click the icon to open the Select
Element Types window.
Limits or Valid This attribute holds an optional flag, setting the attribute to true
values indicates that the attribute can have a value outside the valid values
or range.
6.3.1 Select Element Types

To display the Select element type window, click the icon in the Element types field of a
UDA in the Current Element Editor.
The Select element types window allows the system administrator to select from the list all
available element types.
To filter the list enter a text value in the Filter field. The list will refresh to display all element
types that contain all or part of the text value entered in the Filter field.

LEXICON User Guide
To choose an element type from the Available element types: pane of the Select element
types window, click an entry to highlight the required element, click Add to list.
The element types are automatically displayed in the Chosen element types: pane of the
Select element types window. To remove an element type, click to highlight the required
element, click Remove selected.
Click OK to close the window and pass the selected element types back to the Current
Element Editor or Cancel to discard any inputs.
6.3.2 Edit Valid Values

The Edit Valid Values window is opened via the Valid Values field of a UDA in the Current
Element Editor. The Edit valid values window provides a large input area to allow multiple
valid values to be input.

LEXICON User Guide
If a valid value has already been set this will be displayed in the input area allowing the user
to edit the value, alternatively input a new set of values. Values can be removed by simply
deleting the text.
Click OK to close the Edit valid values window and populate the Valid Values field of the
Current Element Editor window or click Cancel to discard any inputs and close the Edit
valid values window.
6.4 UDA Graphical View

Relationships between a UDA and its associated element types can be displayed in the
Graphical View window of the LEXICON window. The UDA element must be selected in
the Dictionary Explorer, right click, from the displayed menu, select Graphical View. The
graphical view for the selected element is displayed.
The type of view displayed is determined by how many other elements are dependent upon
the selected UDA element:
List views
Spiders views
Note: The spider and list views and the rules for displaying them also apply to the
Distributed Attributes view. For more information on Distributed Attributes View, refer
to Define Distributed Attributes.
List Views
For this example, the selected UDA element has only one dependent element. The
PMGHeight node represents the UDA element, the SCNOZZLE node has a link to the UDA
element.

LEXICON User Guide
The link (shown as a open head arrow) represents a dependency of the source node on the
target node. In this case the dependency is that the SCNOZZLE element has a UDA
attribute of the type PMGHeight.

LEXICON User Guide
In this example: when the UDA element can be applied to more than 20 elements then the
relationships between the elements are displayed as follows in the graphical view.
The UDA node is shown at the top and the dependent element nodes are shown in a
vertical list below. The view only displays the first 4 dependent elements, use the scroll bar
to view the other dependent element nodes in the graphical view.
Spider View
In this example: when the UDA is applied to less than 20 elements, the UDA is shown where
11 elements are dependent on the UDA. The relationships are displayed as follows in the
graphical view.

LEXICON User Guide
The UDA node is at the centre and is surrounded by the dependent element nodes, this is
known as a spider layout.

LEXICON User Guide
User Defined Element Types
7 User Defined Element Types
Within the software the standard set of elements are often used for a variety of purposes. A
User Defined Element Type (UDET) allows an element to be created with a more
meaningful name, for example an administrator could create clearly defined sub types such
as Pipe Lagging, Pipe Painted and Pipe Heated.
For a full explanation of the structure of a Dictionary database refer to the LEXICON
Command Reference Manual.
7.1 Create a UDET World

A top level elements within the DICT database is UDET World (UDETWL) which must be
created directly below the Dictionary World.
To create a UDET World select Create > UDETWL: User defined element world from the
main menu bar. An UDET world element is created and displayed in the Dictionary
Explorer.

LEXICON User Guide
After the creation of a new UDET World the following attributes in the Current Element
Editor must be populated.
Name Enter a valid name for the UDET World in the text box. Special
Description Enter a brief description of the UDET World (can contain up to 120
characters).
element.
7.2 Create a UDET Group

A UDET Group (UDETGR) must be created below a UDET World.
To create a UDET Group, select Create > UDETGR User defined element group from the
main menu bar. A UDET element is created and displayed in the Dictionary Explorer.

LEXICON User Guide
After creating a new UDET Group the following attributes in the Current Element Editor
must be populated.
Name Enter a valid name for the UDET Group in the text box. Special
Description Enter a brief description of the UDET Group.
element.
7.3 Create a UDET

A UDET must be created below a UDET Group (UDETGR) element. To create a UDET
Group, select Create > UDET: User defined element from the main menu bar. A UDET
element is created and displayed in the Dictionary Explorer.

LEXICON User Guide
After the creation of a new UDET, the following attributes fields in the Current Element
Editor must be populated. Some attributes are enabled or disabled when the values of
related attributes are set
Name Enter a valid name for the UDET in this text box. Special characters
are not allowed.
Description Enter a brief description of the UDET to be created or modified.
User-defined Enter a name for the UDET. This is the name that will be displayed
name in the other modules. Special characters are not allowed.
To know more about Names and UDET Names, refer to the
LEXICON Command Reference Manual.
Base type A UDET must be based on an existing system defined element

type, The UDET created will have the same system attributes as
the Base type unless attributes are hidden with Hidden Attributes
property. The UDET will not have the UDAs associated with the
Base Type.
Enter a base type or select from a list of base types, click the icon
to open the Select Base Type.
Owner types The Owner types list is automatically populated with the list of valid
owners when the Base Type is selected.
To remove owners from the list, click the icon to display the Select
Owner Types.
Note: There should be at least one valid owner for an element.
Member types The UDET Members list is automatically populated when the Base
Type is selected.
To remove members from the list, click the icon to display the
Select Member Types.

LEXICON User Guide
Hidden The Hidden Attributes list is automatically populated when the Base
Attributes Type is selected.
The user can selectively hide attributes from the list and/or re-add
them if required and also hide attributes from the list by clicking to
display the Select Hidden Attributes.
7.3.1 Select Base Type

To display the Select Base Type window, click the icon in the Base Types field of a UDET
in the Current Element Editor.
The Select Base Type window allows the system administrator to select from the list all
available base types. The selection will then be used to derive a UDET.
To filter the list enter a text value in the Filter field. The list will refresh to display all system
element types.
To choose a base type, click an entry to highlight the required element type.
Click OK to close the window and pass the selected base type back to the Current Element
Editor or Cancel to discard any inputs.
7.3.2 Select Owner Types

To display the Select Owner Type window, click the icon in the Owner Types field of a
UDET in the Current Element Editor.
When a UDET has been assigned a Base Type it will automatically inherit all of the owner
types of that base type.

LEXICON User Guide
The Select Owner Type window allows the system administrator to select which base types
are owners of the UDET.
To associate or disassociate an owner check or uncheck the relevant box to the left of the
base type.
To associate or disassociate all owners, click Select/Deselect All.
Click OK to close the window and return the values to the appropriate field in the Current
7.3.3 Select Member Types

To display the Select Member Type window, click the icon in the Member Types field of a
When a UDET has been assigned a Base Type it will automatically inherit all of the member
types of that base type.
The Select Member Type window allows the system administrator to select which base
types are members of the UDET.

LEXICON User Guide
To associate or disassociate a member check or uncheck the relevant box to the left of the
base type which you do not want to be an member of the UDET.
To associate or disassociate all members, click Select/Deselect All.
7.3.4 Select Hidden Attributes

To display the Select Hidden Type window click the icon in the Hidden Attributes field of a
When a UDET has been assigned a Base Type it will automatically inherit all of the system
attributes of that base type.
The Select Hidden Attributes window allows the system administrator to select which
attributes are to be hidden when using the UDET.

LEXICON User Guide
To hide an attribute check the relevant check box to the left of the attribute which you do not
want to be visible when using the UDET.
7.4 UDET Graphical View

Relationships between UDETs, UDAs and the selected Base Types can be displayed in the
Graphical View window of the LEXICON window. The UDET element must be selected as
the CE in the Dictionary Explorer, right click, from the displayed menu, select Graphical
View. The graphical view for the selected element is displayed.

LEXICON User Guide
For this example: the relationships displayed are a node for the selected
UDET,:VALVCHAR and a link from it to another node, which is its base element type
XPITEM.
The link (shown as a filled head arrow) represents a parent-child relationship and begins on
the child and points to the parent.
Other UDETs that have the same base element as the selected element are also shown in
the view. The layout of the nodes is intended to show an inheritance hierarchy. The base
element is shown at the top, the UDET elements based on it are aligned below.
When the UDET has Distributed Attributes the Distributed Attributes Graphical View can
be displayed by right-clicking the UDET and selecting Navigate to from the displayed
menu. The Distributed Attributes View is displayed in a new tab, for more information on
the Distributed Attributes View, refer to Distributed Attributes Graphical View.

LEXICON User Guide

LEXICON User Guide
User System Defined Attributes
8 User System Defined Attributes
A User System Defined Attribute (USDA) allows the administrator to change the behaviour
of system defined attributes for selected element types. For example limits may be applied
to attributes of top level elements within the software.
A USDA allows the administrator to add the following behaviour to system attributes:
Set valid values
Define limits
Hide attributes on forms
Category
The valid values and limits may be varied with element type. For a full explanation of the
structure of a Dictionary database refer to the LEXICON Command Reference Manual.
8.1 Create a USDA

A USDA must be created below a UDA Group (UGRO) element. To create a USDA, select
Create > USDA: User system defined attribute from the main menu bar. A USDA element
is created and is displayed in the Dictionary Explorer.

LEXICON User Guide
After the creation of a new USDA, the following attributes in the Current Element Editor
must be populated. Dependent upon the attribute chosen, determines which other related
attributes are enabled or disabled accordingly.
Name Enter a valid name for the USDA in the text box, (special
characters are not allowed).
Description Enter a brief description of the USDA to be created or modified.

LEXICON User Guide
System attribute Enter the underlining system attribute to which the USDA is to
be applied. To select from a list of system attributes click the
icon to open the Select System Attribute window. For more
information refer to Select System Attribute.
Element types Contains the list of element types for which the USDA is valid,
up to 100 element types may be set.
To set the Element types, click the icon to open the Select
Element Types window. For more information, refer to Select
Element Types.
Category Enter a value to allow the USDA to be grouped together on the

attributes form within other modules.
Hidden This attribute holds a logical value, setting this to true will
indicate that the UDA will be hidden from the Q ATT command
and from the attribute form within other Modules. Querying of
the individual UDA will not be effected by this setting.
8.1.1 Select System Attribute

The Select System Attribute window allows the user to select a base System Attribute
when creating a USDA.
To filter the list enter a text value in the Filter field. The list will refresh to display all system
attributes that contain all or part of the text value entered in the Filter field.
To choose a System Attribute, click an entry to highlight it.

LEXICON User Guide
Click OK to close the window and pass the selected system attribute back to the Current
Element Editor or Cancel to discard any inputs and return to the LEXICON window.
8.1.2 Select Element Types

The Select Element Types window displays the available element types, from the Element
Types field of the Current Element Editor, click the icon to display the Select element
types window. The remaining functionality to create a new USDA is identical to that for a
UDA. For more information, refer to Create a UDA.

LEXICON User Guide
Status Definitions
9 Status Definitions
Status Control is the ability to control and report on the status of individual model objects as
they progress their lifecycles. It can be applied to any model objects, for example tagged
items, catalogue components, drawings etc.
The desired project configuration is created by administrators as Status Definitions in
LEXICON with the use of a hierarchy of Status World, Status Definition and Status Value
elements.
These elements can then be applied to model objects in any of the constructor modules -
Design, PARAGON, SPOOLER, Diagrams, DRAFT. For more information on the creation of
the hierarchy, refer to Status Control.
9.1 Status Definitions Graphical View

The required STADEF or STAVAL elements must be selected in the Dictionary Explorer,
right click, from the displayed menu, select Graphical View. The graphical view for the
selected element is displayed.

LEXICON User Guide
Status Definitions
The nodes represent the state of individual model objects, the links (arrows) represents
transitions between states of the individual model objects as they progress through their
lifecycle. The arrow direction indicates the direction of the allowed transition. The source
state is the initial state of the individual model objects and the target state is the final state of
the individual model objects.
The graphical view shows all the states and transitions that belong to the status definition or
STADEF element. This is either the selected STADEF or the STADEF owning the selected
STAVAL, unconnected node representing the STADEF can also be displayed.
The transitions are colour coded. A green transition indicates a promote state transition, a
red transition indicates a demote state transition. Black transitions are valid state transitions
that have not been marked as either promote or demote.
An alternative to using coloured transitions can be used as shown in the following graphical
view:

LEXICON User Guide
Status Definitions
In this graphical view promote transitions are indicated by dashed arrows, while demote
transitions are indicated by a dotted arrow. Switching between the alternate styles for state
transitions can be achieved by right-clicking on the graphical view background and selecting
from the displayed menu, Coloured links or Dashed links.

LEXICON User Guide
Status Definitions

LEXICON User Guide
Distributed Attributes
10 Distributed Attributes
New functionality features called Bound elements and Binding elements have been
introduced to the database system. The basic principle of bound and binding attributes is to
enable elements to have groups of attributes distributed across other hierarchies and
different databases. These attributes are called Distributed Attributes.
For example, a engineering equipment Tag can be created by the process discipline with a
set of process condition attributes directly onto the tag. Other sets of attributes (for example
the mechanical and electrical attributes) can then be distributed across the mechanical and
electrical databases.
As a result, team members of the three teams irrespective of their location will have write
access to the attributes under their control and read only access to those not under there
control concurrently.
Engineering tags are created in the Tags module, for more information on Tags, refer to the
Tags User Guide. Data modelling is managed in the LEXICON module, for more information
on distributed attributes, refer to Define Distributed Attributes. The disciplines and locations
are identified and the databases and distributed hierarchy are created in the Admin module,
for more information refer to Administrator User Guide.
10.1 Define Distributed Attributes

To spread the distributed attributes, the user must identify the elements and attributes
required, create, define and connect elements:
Create bound elements
Create attributes for bound elements
Create the distributed attribute schema
Define binding elements
Connect bound elements to binding elements
For more information on distributed attributes, refer to Database Management Reference
Manual.
10.1.1 Create Bound Elements

The task only differs from the creation of a regular UDET in one aspect, and that is that the
UDET intended for use as bound attribute group must be based on the XPITEM element
type.
To create bound elements, the user must create the UDETs to be used as bound attribute
groups, these UDETs needs to be defined with XPITEM as their basetype, then the
attributes must be created. For more information on the creation of a UDET, refer to User
Defined Element Types.

LEXICON User Guide
10.1.2 Create Attributes for Bound Elements

The attributes can be defined as any regular UDA, no special considerations need to be
taken. For more information on the creation of a UDA, refer to User Defined Attributes.
10.1.3 Create Binding Elements

A binding element can be any system defined element type or UDET. Engineering items for
use in Tags must be UDETs with a Base Type of ENGITE. For more information on the
creation of a UDET, refer to User Defined Element Types.
10.1.4 Distributed Attributes Hierarchy

Before distributed attributes can be used, the top level XPIWLD elements must be created
in the required databases for the bound elements to be created in. These must be all of the
XPIWLDs identified by the DSXDST elements for the distributed attributes and can be
created with the ADMIN module or another application module.
10.1.5 Create Distributed Attribute Schema

To create the distributed attribute schema, the user must:
Link binding and bound elements
Create DSXSCH
Create DSXOWN
Create DSXMBR
Define which database the bound elements are created and stored in
Create DSXHOM
Create DSXTST
Create DSXDST
It is assumed that the two administrative levels, DSXWLD and DSXGRP elements have
been navigated to or have being created.
Create DSXSCH Element

DSXSCH elements represent distributed attribute schema and consists of a name and an
optional default home reference. The default home reference specifies the location that the
bound elements are created in. The location can be overridden at lower levels in the
schema.

LEXICON User Guide
For more information on the attributes, configuration and details, refer to Database
Management Reference Manual.
Create DSXOWN Element

DSXOWN represents the binding element type definition, the user can define the element
type that may be extended by attributes. The definition contains an element list which
designates the element type and a default home reference that specifies the hierarchy
where the Bound elements are created.
Create DSXMBR Element

The DSXMBR binds the distributed attributes to the binding element defined by the owning
DSXOWN. The definition specifies which XPITEM based UDETs that can be used as
attributes for the specified owner. There is a cardinality definition available that defines the
minimum and maximum number of each of the attributes that may be created. A -1 in the
maximum definition represents an infinite number. It also contains an allocation reference
that might override anything defined at schema or owner level. The default Home definition
is the location where attributes are created and managed.

LEXICON User Guide
Create DSXHOM Element

The DSXHOM element represent the actual default home, for example: creates the top-level
elements where the attribute groups are created.
the default home destination contains a string or ID expression that evaluates the name or
ID of the default home to be used.
Create DSXTST Element

The DSXTST element defines the default home valve as a text string. It also contains a test
that needs to yield true upon evaluation for considering this default home being valid.

LEXICON User Guide
Create DSXDST Element

The DSXDST element denotes the default home valve as a text string. It contains a test that
needs to yield true upon evaluation for considering this default home being valid.
10.1.6 Distributed Attributes Graphical View

Relationships between a UDET and its distributed attribute element types can be displayed
in the Graphical View window of the LEXICON window. In the Dictionary Explorer, right
the DSXOWN or DSXMBR, from the displayed menu select Graphical View. The graphical
view for the selected element is then displayed.

LEXICON User Guide
The central node is the Binding Element, the list in this node shows the elements to which
the distributed attributes can be bound. The list is populated with the element types form the
ELEL attribute of the DSXOWN element (:VALVTAG in this case).
The bound element types (based on XPITEM) are shown as nodes that depend on the
binding element. The arrangement of nodes in the distributed attributes view window follows
the same rules as the UDA graphical view window, when there are less than 20 bound
nodes, the view is arranged in spider layout, otherwise the list layout is displayed.

LEXICON User Guide
Database Views
11 Database Views
The Database Views functionality available in the LEXICON module provides the System
Administrator with the ability to map element data into sets of related tables (Database View
Sets). The database view sets are populated with rows that exists in a table for each
element that meets specified criteria. The columns are derived from attributes, PML 1 or
XPath1.0 expressions. Attributes and expressions for the columns are specified from the
elements defined in the view definition (that is from multiple elements not just the row
element).
Database Views are managed in Definition Sets, these include:
Element View - Database views defined automatically to represent the database
hierarchy.
Project Views - Database views defined in the dictionary data bases for a project.
User Views - Database views defined as a file in the users project settings.
It is advised to create Database Views as User Views with the Database Views Editor in the
relevant module. For more information on the Database Views Editor, refer to Database
Views Editor.
If the editor is not available it can be added with the customisation command Aveva.Pdms.
Database View Editor. The customisation command allows a user, the opportunity to
test the view as a user view with full data access.
Once a view is stable, it is easily copied with the editor from the User Views to the Project
Views which adds it to the Dictionary database definitions.
Note: Database Views can also be created and edited in the Current Editor Element, for
more information, refer to Current Element Editor.
11.1 Create Administrative Elements

The administrative elements must be created first, make sure that the correct element in the
dictionary hierarchy is selected, right click and from the displayed menu select Create then
select the required database element. For a more detailed description, refer to LEXICON
Command Reference Guide.
Database View World (DBVWWL) element - the DBVWWL element must be located
in the database for the master databases requiring the view.
Database View Group (DBVGR) element - is used to manage definitions.
Database View Set (DBVSE) element - is a storage area for views that are used for
the same purpose or workflow.

LEXICON User Guide
Database Views
11.1.1 Create a Database View

A Database View defines a table definition for how the element data is displayed. The data
can be derived from a single element or multiple elements. Make sure that the correct
element in the dictionary hierarchy is selected, right click and from the displayed menu
select Create then select the required database element from the displayed list.
For a more detailed description, refer to LEXICON Command Reference Guide.
Create an Attribute Filter (ATTFILTER) Element

Rows are present in the resulting Database View table for each element that has a particular
element type (ELEL) and meets any defined criteria (ATTFILTER and EXPFILTER). The
Attribute Filter element is used to define matching criteria.
Make sure that the correct element in the dictionary hierarchy is selected, right click and
from the displayed menu select Create then select ATTFILTER: Attribute filter from the
displayed list.

LEXICON User Guide
Database Views
Create an Expression Filter (EXPFILTER) Element

The Expression Filter element is used to define matching criteria, rows are present in the
resulting Database View table for each element that has a particular element type (ELEL)
and meets any defined criteria (ATTFILTER and EXPFILTER). Additionally if element match
criteria cannot be expressed using attribute filters then it is possible to define an expression
for evaluation. All EXPFILTER criteria must be met for a row to be present in the table.
from the displayed menu select Create then select EXPFILTER: Expression filter from the
displayed list.
Create a Source Element (SCRELEMENT)

If attributes or expressions from other elements are needed, a source element must be
created. A Source Element defines a step from the current context to another element from
which column values can be derived. The following are equivalent in terms of the data
displayed:-
Option 1: use of expression columns
EXPCOL ( Expression : NAME OF OWNER )
EXPCOL ( Expression : TEMP OF OWNER )
Option 2: use of attribute columns
SRCELE ( Expression : OWNER )
ATTCOL ( Database Attribute : NAME )
ATTCOL ( Database Attribute : TEMP )
The difference is that the columns inside the SRCELEMENT are editable and allow the user
to choose the units of measure for display. The columns based on expressions are
Readonly and do not allow the user to choose units of measure for display. These can report
errors if they contain UDAs that do not have their default values configured.
from the displayed menu select Create then select SRCELEMENT : Source element from
the displayed list.

LEXICON User Guide
Database Views
Create an Attribute Column (ATTCOLUMN) Element

The ATTCOLUMN element defines the attribute columns displayed in the database view,
the columns operate on the SRCELEMENT that contains them.
Make sure that the correct SRCELEMENT in the dictionary hierarchy is selected, right click
and from the displayed menu select Create then select ATTCOLUMN: Attribute column
from the displayed list.
Create an Expression Column (EXPCOLUMN) Element

A EXPCOLUMN element defines a column in the database view is based on an expression
result, by default these columns are read only.

LEXICON User Guide
Database Views
from the displayed menu select Create then select EXPCOLUMN : Expression Column
from the displayed list.
Create a Create Rule (CRERULES) Element

A CRERULES element defines the rules for the creation of the context element. If owned by
a DBVW element, the rules define row element creation, if owned by a SCRELEMENT the
rules define column element creation.
from the displayed menu select Create then select CRERULES : Create rules from the
displayed list.

LEXICON User Guide
Database Views
Create a Set Attribute (SETATTRIBUTE) Element

A SETATTRIBUTE element defines the setting specified attribute. Make sure that the
correct CRERULES element in the Dictionary hierarchy is selected, right click and from the
displayed menu select Create then select SETATTRIBUTE : Set attribute rule from the
displayed list.
Create a Set Parameter (SETPARAMETER) Element

A SETPARAMETER element defines a parameter that can be used with create
expressions. The parameter value can be defined with the use of an expression, if unset,
the user is prompted for input.
Make sure that the correct CRERULES element in the dictionary hierarchy is selected, right
click and from the displayed menu select Create then select SETPARAMETER : Set
Parameter from the displayed list.

LEXICON User Guide
Database Views
Create a SetStatus (SETSTATUS) Element

A SETSTATUS element assigns the status to newly created elements, make sure that the
correct CRERULES element in the dictionary hierarchy is selected, right click and from the
displayed menu select Create then select SETSTATUS : Set status rule from the displayed
list.

LEXICON User Guide
Database Views

LEXICON User Guide
Project Breakdown Structure
12 Project Breakdown Structure
The Project Breakdown Structure is functionality allowing to organise database data to be

presented in a user-defined structure.
For instance it is possible to configure the presentation of database items according to their
belonging to system, class, etc. The data is presented as a tree structure that is generated
during runtime.
More than one data structure can be defined, each structure starting from a root node,
called PBS Template. The PBS structures defined by templates are presented as separated
hierarchies in the PBS Explorer.
To show any data in the PBS Explorer, a template definition must be created. This is done in
lexicon by an administrator.
12.1 Setting up the PBS definition in Lexicon

The PBS explorer look is defined in Lexicon and the definition is stored in the dictionary
database. All the PBS definitions should be created below PBS World (PBSWLD). PBS
World can own PBS Templates (PBSTPL). Each PBS Template is a definition of separate
PBS hierarchy and will be presented in PBS Explorer as a single root node. This makes it
possible to define several PBS structures, for instance one structure presenting engineering
items organised by their belonging to different systems, another structure organising
schematic elements by classes or other properties, and one more structure for presenting
design data.
Below the PBS Template it is possible to define what data should be shown in the structure
and how to organise it. The data can be represented in PBS tree as just text nodes, or
nodes connected to existing database elements. In both cases it is possible to choose
different methods for generating the result nodes.
There are two kinds of elements possible to be created below PBS Template. These are:
PBS Object Node (PBSOBN), which contains definition of a way to generate set of
nodes at particular level. The nodes are generated at runtime depending on the
definition and database content. The result nodes are supposed to represent existing
database elements, e.g. systems, schematic equipment, mechanical tags etc.
PBS Text Nodes (PBSTXN) which are generating nodes not representing any
database element in resulting tree.
So to define a PBS tree, the following should be done:
Create new PBSWLD or use existing one for storing PBS definitions
Create PBSTPL element which represents root of single PBS structure and will appear
in resulting hierarchy as root node. Text of the root node is specified in PBS Text
(PBSTXT) attribute of the template

LEXICON User Guide
Create number of PBS text and PBS object nodes (PBSTXN and PBSOBN) defining
set of result nodes on particular level in PBS tree hierarchy. To put the result nodes
below appropriate parent nodes, PBS criteria (PBSCRT) should be used.
The PBS object node should be used if nodes in result tree are supposed to represent
existing database elements, e.g. equipment, systems and so on. The PBSOBN has
following attributes that can be used to configure generated nodes:
PBS formula type (PBSFMT) - this attribute specifies what method should be used to
generate result nodes. Possible values are:
PML expression
PML function
External method
From owners attribute
PBS formula (PBSFML) - it is a text attribute and its content is interpreted depending
on what formula type has been selected:
For "PML expression" it is supposed to be valid PML expression returning array of
database elements. It could be for example "collect all SYSGRP" which will return
all systems existing in current MDB. Then a node will be created for each system in
result tree
For "PML function" it is supposed to be "function call string", than means function
name together with function argument if required, e.g. !!GetAll('SYSGRP'). It should
be in the same format as the function call in command window. The PML function
could be any existing function returning array of database elements.
For "External method" the string should contain name of external class to be used
and also name of the dll where the class is defined. All available classes can be
picked up from Formula Edition dialogue.
There are a number of external classes provided in StandardPBSLibrary.dll and it is
possible to implement custom classes as well. There is required that custom class
supposed to be used as external method should implement IPBSCollection
interface provided by PBSCore.dll. Name of the dll containing the class should end
with "PBSLibrary".
For "From owners attribute" the string should contain name of attribute that should
be used to generate resulting nodes. The attribute should be valid for element
generated from owning PBSOBN. E.g. if the owning PBS object node has
generated set of schematic equipment and the member node specifies DIAREF as
"From owner attribute" formula, then resulting child nodes will be generated by
evaluating DIAREF attribute on each schematic equipment represented by
appropriate node.
It is possible to use "From owners attribute" even for nodes that are not owned by
PBSOBN. In this case system will search up the hierarchy until PBS object node is
found. All text nodes will be skipped as database attribute can't be evaluated on
them.
PBS text (PBSTXT) - this attribute specifies what text should be displayed on nodes
generated by the PBSOBN. By default it is full element name, but it can be specified as
any PML1 expression (including simple attribute name) returning string value.
PBS icon (PBSICO) - specifies icon to be displayed on result nodes. The icon can be
assigned statically by giving icon name or can be dynamically generated from PML1
expression. If no icon is specified, then the icon representing the object type will be
displayer, for example EQUI:

LEXICON User Guide
Note: The icon must exist in the in Shared.resouces file. These can be viewed in the UI
Customize window:
PBS group by (PBSGRB) - the attribute provide possibility to define formula for
dynamically generating parent nodes. It could be simple attribute name or PML1
expression returning string. The attribute or expression will be evaluated on database
element got from PBSFML and a parent node will be automatically created for each
value. For example if PBSGRB is "FUNC" and PMSFML returned set of equipment,
then FUNC will be evaluated on every equipment and the equipment will be grouped
below appropriate parent nodes automatically created for each distinct value of FUNC.
PBS recurrent node (PBSRCR) - for use in future enhancements. This is currently not
used.
The PBS text node should be used if nodes in result tree are not going to represent existing
database elements, so they are only labelled appropriately. The PBSTXN has following
attributes that can be used to configure generated nodes:
PBS formula type (PBSFMT) - this attribute specifies what method should be used to
generate result nodes. Possible values are:
PML expression
PML function
External method
Static text
PBS formula (PBSFML) - it is a text attribute and its content is interpreted depending
on what formula type has been selected:

LEXICON User Guide
For "PML expression" it is supposed to be valid PML expression returning array of

string values for generated nodes.
For "PML function" it is supposed to be "function call string", than means function
name together with function argument if required, e.g. !!GetSchematicClasses(). It
should be in the same format as the function call in command window. The PML
function could be any existing function returning array of string values to be
assigned to generated nodes. Node value is used for matching criteria and so on. If
it should differ from the node text, then function should return array contained of two
other arrays:
Array of string values
Array of corresponding texts to be displayed on nodes
For example, if the function should return three engineering Classes, then the
names of these need to be the three first elements in the array:
<SCEQUI>,<SCNOZZ>,<SCPLIN>
Then the descriptions should follow:
<Schematic equipment>,<Schematic nozzles>,<Schematic
pipelines>
So the returned array will look like this:
<SCEQUI>,<SCNOZZ>,<SCPLIN>,<Schematic
equipment>,<Schematic nozzles>,<Schematic pipelines>
Example PML function:
define function !!getSchematicClasses() is ARRAY
!classes = ARRAY()
!texts = ARRAY()
!classes.append('SCEQUI')
!texts.append('Schematic equipment')
!classes.append('SCNOZZ')
!texts.append('Schematic nozzles')
!classes.append('SCPLIN')
!texts.append('Schematic pipelines')
!result = ARRAY()
!result.append(!classes)
!result.append(!texts)
return !result
endfunction

LEXICON User Guide
For "External method" the string should contain name of external class to be used
and also name of the dll where the class is defined. All available classes can be
picked up from Formula Edition dialogue. This is working similar to PBSOBN
elements.
For "From owners attribute" the string should contain name of attribute that should
be used to generate resulting nodes. This is working similar to PBSOBN elements.
PBS icon (PBSICO) - specifies icon to be displayed on result nodes. As nodes
generated by the PBS text node don't have database representation, the icon can
be assigned only statically by giving icon either directly by writing it her, or by
specifying a PML expression that will return the name. If icon name is given, then
the icon should exist in Shared.resources.
PBS recurrent node (PBSRCR) - for use in future enhancements. This is currently not
used.
After the nodes for each level of result PBS tree are generated, they need to be organised
under the appropriate parent nodes. The PBS criteria (PBSCRT) element is defining a way
to determine if given node fits to specific parent hierarchy. The criteria should be owned by a
node representing the nodes for "sorting" and then it should refer to owner node the check
should be performed for. For example, if we have a PBSOBN named "GetEngItems"
generating set of equipment and we would like to place the equipment below appropriate
nodes representing systems, then PBSCRT should be created below "GetEngItems" and
should point to the node generating systems.
After this is done, appropriate attributes on PBSCRT should be filled in for defining a way of
checking if equipment fits given systems. All attributes possible to set in PBSCRT are as
follows:
PBS query node (PBSQNO) - reference to node we want to match the element against.
It could be any PBSTXN or PBSOBN in hierarchy below node owning the PBSCRT.
"PBS formula type (PBSFTY) and PBS formula (PBSFML) - determine a way the check
is performed. The methods can be as follows:
PML expression - if PBSFTY is set to this value, then PBSFML is supposed to
contain valid PML1 expression which is going to be evaluated on node being
checked. The result value is compared with value of parent referenced by PBSQNO
and if matched, then the new node is placed below the parent.
PML function - if PBSFTY is set to this value, then PBSFML is supposed to contain
valid PML1 expression which is going to be evaluated on node being checked. The

LEXICON User Guide
result value is compared with value of parent referenced by PBSQNO and if

matched, then the new node is placed below the parent.
External method
Attribute
Using parameters in PBS expressions.
It is possible to use parameters which are being replaced by values of concrete nodes
during runtime. The parameters can be used in following attributes:
PBS formula
PBS text
PBS icon
PBS group by
12.2 Sample Definition of PBS Hierarchy

The sample PBS structure step by step definition for engineering is presented below. The
tree is supposed to show nodes for all existing systems at first level below root. Below each
system there are appropriate engineering items grouped by their class (actual type) and
description. The engineering items nodes can be expanded to show item members,
drawings containing the item and also associated 3D and schematic items.
Note: All PML functions and external method used in example are delivered as part of
installation.
Create PBS world for storing template definition.

Then create PBS template which will be seen in result structure as root of the tree.

LEXICON User Guide
The template definition in Lexicon looks like below:
And will result in following in PBS explorer. The root node text displayed comes from the
PBS Text attribute in the PBSTPL object:
So far there is only root of the PBS hierarchy defined in Lexicon. Now definition generating
system nodes is needed. To achieve this PBS object node should be created below PBS
template. In the example, PML expression is used for getting all available SYSGRP
elements:

LEXICON User Guide
And in PBS Explorer the tree contains nodes for systems. Text of the nodes is generated
according to PBS text defined in Lexicon:
Now systems should expand to show engineering classes and engineering items below
them. To generate engineering classes PBS text node will be used and the classes will be
got from PML function:
And every system node can be expanded to show list of engineering classes returned by
the !!GetEngineeringClasses() function. Additionally, the icon is set to "SCGROU" available
in Shared.resources:

LEXICON User Guide
The !!GetEngineeringClasses() function is creating two arrays: first containing text values to
be used by PBS criteria and the second contains corresponding presentation strings that
should be displayed on appropriate nodes. The two arrays are organised in another array as
the PBS standard requires. The function is available in %PMLLIB%\PBS\functions.
When the class nodes are available, it is needed to generate engineering items and put
them below appropriate systems and classes. The items should be also grouped by
description. To achieve this PBSOBN should be created and formula collecting engineering
elements should be specified. In example below, external method is used - the
"CollectEngItems" class from StandardPBSLibrary.dll. It has been selected from list
available from PBS Formula Editor dialogue. In addition the PBS group by is set to "DESC".

LEXICON User Guide
As a result nodes for all engineering items are created and they are grouped into parent
nodes generated for each distinct value of item description. For current definition the nodes
will appear below every System/Class hierarchy, so additional criteria needs to be defined
for placing the new nodes below appropriate parents only. Because of this one criteria
referring to /GetAllSystems and another referring to /GetEngClasses node should be
created. The first PBSCRT definition resolving if engineering item can be placed in hierarchy
below given system looks like below:

LEXICON User Guide
And the second one, determining which class the engineering item belongs to has following
attribute values:
The tree defined for such structure is shown below. Engineering items are placed below the
appropriate parent nodes, according to their SCSYSF and ACTTYP attributes. They are
grouped in nodes generated from the DESC values:
After engineering items are displayed and organised as designed, there is a need to show
following elements for every engineering item:
1. Drawings containing the item
2. Available datasheets

LEXICON User Guide
3. Linked schematic element

4. Associated design element
5. Members
At first label node is needed for every group above. To achieve this five PBS text nodes
should be created and PBS formula type of them should be set to "Static text". This means
that such node will generate one node only and text for the result node is evaluated from
PBS formula. So definitions of the nodes will look like on picture below:
They are generating label nodes below every engineering item:

LEXICON User Guide
Definitions of content for every label node are needed now. Again, PBS object nodes should
be used as the members are going to represent existing database elements. At first node
generating drawings containing given engineering item will be described. This goes via the
DIAREF array on the connected Schematic element, provided by the PML function
"GetPIDs.pmlfnc, using the Engineering Item as a parameter. (See the Using parameters in
PBS expressions section for more information on parameters.)
For every engineering item, child nodes will be displayed by running the "GetPIDs" function.
The child nodes will be placed below the node generated by /PandID_label:
Next is definition for generating datasheet nodes. In the example, to illustrate different
options, a list of available datasheets is provided by a PML function:

LEXICON User Guide
The "GetAllRefNo" function is defined as follows:

define function !!getAllRefNo(!type is STRING) is ARRAY
var !objects collect all $!type

return !objects
endfunction
It is collecting all database elements with given type and returns the collection as an array of
database references.
Now, when all datasheet instance are got, criteria is needed to put datasheet nodes below
right places in the PBS hierarchy. The criteria shown below is based on DSIAST attribute of
datasheet and is matching its value against engineering items:

LEXICON User Guide
Now definitions for associated schematic and design items are needed. They are created
using PBS object nodes with "From owners attribute" formula type just like it was done for
getting diagrams containing given engineering item. In definition generating linked
schematic item SCHLNK attribute is used. That means that for every engineering item in
tree child nodes will be taken by evaluating their SCHLNK attribute and will be placed below
node generated by /SchematicItem_label:
PBS object node generating nodes for associated design items is defined in the same way
using DESLNK attribute:

LEXICON User Guide
The last needed definition is supposed to generate nodes for engineering item members. It
also could be done using "From owners attribute" formula type and MEMB attribute.
However to show different possibilities in the example it will be defined using PML
expression with parameter. The expression is in format "collect members of #PARAM(/
GetEngItems)" and that means that it will be called for every engineering item and the
"#PARAM(/GetEngItems)" will be replaced with the item reference number. Then generated
nodes will be placed under appropriate owner in hierarchy (the engineering item
>Members). The parameter string can be inserted using standard PBS dialogue:
After all definitions are created, the result PBS tree structure shows data like it was
specified:

LEXICON User Guide

LEXICON User Guide

LEXICON User Guide
Datasheets
13 Datasheets
The Datasheets functionality available in the LEXICON module provides the System
Administrator with the ability to create, modify, view or exchange datasheets with third
parties. These datasheets are stand-alone documents which can be created for tagged
items.
13.1 Datasheet Hierarchy

As with all elements in the software, all the LEXICON module elements are owned by other
elements, therefore elements must be created in strict order. The datasheet hierarchy for
the LEXICON module is displayed in the Dictionary Explorer.
Below the Dictionary world level in the LEXICON module, the datasheet specific elements
are:
13.1.1 Datasheet Template World

A Datasheet Template World element is a container for Datasheet Template (DSTMPL)
definitions.
To create a Datasheet Template World, right click the required element in the Dictionary
Explorer, select Create > DSTWLD: Datasheet Template World from the main menu bar.
A DSTWLD element is created and displayed in the Dictionary Explorer.

LEXICON User Guide
Datasheets
After the creation of a new DSTWLD, the attributes in the Current Element Editor can be
populated. Dependent on the attribute chosen, other related attributes are enabled or
disabled accordingly.
13.1.2 Datasheet Template Group

A Datasheet Template Group (DSTGRO) must be created below a DSTWLD element. To
create a DSTGRO element, right click the DSTWLD element in the Dictionary Explorer,
select Create > DSTGRO: Datasheet Template Group from the displayed menu. A
DSTGRO element is created and is displayed in the Dictionary Explorer.
Explorer the Current Element Editor automatically updates to display the attributes
for that element, these will initially be empty.
After the creation of a new DSTGRO, the attributes in the Current Element Editor can be
Alternatively the datasheet hierarchy can be created in the following way:
From the Dictionary Explorer, select the required DSTWLD element as CE, then from the
main menu bar, select Create > DSTGRO: Datasheet Template Group. The Datasheet
Template Group element is displayed in the Dictionary Explorer.

LEXICON User Guide
Datasheets
From the Dictionary Explorer, select the required DSTGRO element as CE, then from the
main menu bar, select Create > DSTMPL: Datasheet Template. The Datasheet Template
element is displayed in the Dictionary Explorer.
To display the New Template window, right click the new DSTMPL element in the
Dictionary Explorer.
13.1.3 Datasheet Template

A DSTMPL must be created below a DSTGRO element, to create a DSTMPL element, right
click the DSTGRO element in the Dictionary Explorer, select New Datasheet Template
from the displayed menu.

LEXICON User Guide
Datasheets
The New Datasheet Template window is displayed.
Enter a valid name for the new DSTMPL element in the Name field, (special characters or
spaces are not allowed).
Enter a brief description of the new DSTMPL element to be created.
The Data Source defines the rules for database element creation and the navigation steps
required to additional information elements such as an items catalogue specification. The
data source is linked to the database views editor, refer to Database Views Editor for further
information.
Note: The only Definition Set available for selection is Project Views.
Select Add, the Add Data Source window is displayed.

LEXICON User Guide
Datasheets
Select the data source, click Add.

Or
Click Cancel to discard any inputs and close the Add Data Source window.
Template File: - location of the file to be used as a basis of the datasheet. Click Browse
and navigate to the file.
Edit the template when finished checkbox - to display the Datasheet Template Editor is
displayed, refer to Datasheet Template Editor.
Click Ok to create a new datasheet template. A new DSTMPL element is created and
displayed in the Dictionary Explorer.
Or

LEXICON User Guide
Datasheets
Click Cancel to discard any inputs and close the window.

When a new element is created in the database hierarchy, the Current Element Editor
automatically updates to display the attributes for that element, these are initially empty.
After the creation of a new DSTMPL, the attributes in the Current Element Editor can be
13.2 Revision Configuration

The revision configuration functionality allows the user to create a revision configuration and
a hierarchy at the same time:
Revision Configuration World
Revision Configuration Group
Revision Configuration
Revision Block Definition
Revision Number Definition.
13.2.1 REVCWL: Revision Configuration World

A Revision Configuration World (REVCWL) element is a container for Revision
Configuration definitions used in the Datasheets application
To create a REVCWL, select Create > REVCWL: Revision Configuration World from the
main menu bar. A REVCWL element is created and displayed in the Dictionary Explorer.

LEXICON User Guide
Datasheets
After the creation of a new REVCWL, the attributes in the Current Element Editor can be
13.2.2 REVCGP: Revision Configuration Group

A Revision Configuration Group (REVCGP) must be created below a REVCWL element.
To create a Revision Configuration Group element, right click the Revision Configuration
World element in the Dictionary Explorer, select Create > REVCWL: Configuration
Group from the displayed menu. A REVCGP element is created and is displayed in the
Dictionary Explorer.
After the creation of a new REVCGP, the attributes in the Current Element Editor can be
Each definition and configuration of the Revision Block and Revision Number are
independent and can be linked to other configurations. Block definition and configuration are
dependent upon the status definition.
There is no specific order in which the REVBLD, REVCON, REVNOD elements can be
created in the dictionary hierarchy. To create any of these elements, right click the required
REVGRP element in the Dictionary Explorer, the following menu is displayed.

LEXICON User Guide
Datasheets
13.2.3 REVNOD: Revision Number Definition

A Revision Number Definition (REVNOD) element allows the user specify how the
revision number is displayed.
Right click the required REVNOD element in the Dictionary Explorer, select Edit Revision
Number Definition from the displayed menu, the Revision Number Definition window is
displayed.
Display Name Enter a Name for the Revision Number
Working revision text Enter text or a symbol.
Number of parts Select the number of parts to the revision (for example: A1
is 2 parts).
Part Select the number of part to be formatted.
Part name Enter a name for the part (for example: Major).
Value type Select Numeric or Alphabetic.
Reset to blank Select the Reset to blank check box to reset the part to a
blank value when a higher order part is incremented.
Values From the Values part of the Revision Number Definition

window,
Formatting From the Formatting part of the Revision Number

Definition window,
Test Click Test to display the Test Revision Number window.

LEXICON User Guide
Datasheets
OK Click OK to save the Revision Number Definition.
Cancel Click Cancel to discard any inputs and close the Revision
Number Definition window.
REVBLD: Revision Block Definition

A Revision Block Definition (REVBLD) element allows the user to specify how the
revision block is displayed in the datasheet. The REVBLD element is an independent
definition and can be linked into other configurations, however it is dependent upon the
selected status definition.
Right click the required REVBLD element in the Dictionary Explorer, select Edit Revision
Block Definition from the displayed menu, the Revision Block Definition window is
displayed.

LEXICON User Guide
Datasheets
Display name Enter a name for the revision block definition.
Status definition Allows the use to tie the revision block definition to a
particular status definition.
Limit the number of Allows the user to limit the number of revisions displayed.
revisions displayed to
Display latest revision Displays the latest revision first in the revision block,
first otherwise displays the latest last.
Display revisions in Displays the revisions in rows or columns in the revision

block.
Display headers Display a header row or column in the revision block.
From the Attributes part of the Revision Block Definition window, the user can add the
attributes to be displayed in the Revision Block.

LEXICON User Guide
Datasheets
Select Add attribute, choose an attribute from the displayed list, type the name of the
attribute to be displayed in the header of the revision block. Repeat as required.
To remove an attribute from the revision block, select Remove attribute. Repeat as
required.
Click OK to save the changes.
Or
Click Cancel to discard any inputs and close the Revision Block Definition window.
REVCON: Revision Configuration
A Revision Configuration (REVCON) element ties all of the configuration (REVBLD and
REVNOD) elements together.
Right click the required REVCON element in the Dictionary Explorer, select Edit Revision
Configuration from the displayed menu, the Revision Configuration window is displayed.

LEXICON User Guide
Datasheets
Display name Enter a name for the revision configuration.
Element types Allows the user to tie the configuration element to a

particular element type or set of element types.
Status definition Allows the use to tie the revision configuration to a particular
status definition. (The status definitions displayed are linked
to the element type selected).
Create working revision Allows the user to specify when a working revision is
at created.
Issue revision at Allows the user to specify when an revision is issued.
Revision number Allows the user to select the format of the revision number,
definition refer to REVNOD: Revision Number Definition for further
information,
Revision block Allows the user to select how the revision block is displayed
definition in the datasheet. Refer to REVBLD: Revision Block
Definition for further information. The block definitions
displayed are linked to the status definition selected.

LEXICON User Guide
Datasheets
OK Click OK to save the revision block definition, number and

configuration.
Cancel Click Cancel to discard any inputs and close the Revision
Configuration window.
13.3 Datasheet Template Settings

Datasheet Template Settings allows the user to configure the UDA Settings, Colour Settings
and the Revision Control of the Datasheet Template.
From the main menu bar, select Datasheet > Settings, the Datasheet Template Settings
window is displayed.
UDA Settings
Owner Allows the user to select the User Defined Attribute Group
(UGRP), under which the newly created UDAs are stored in
the hierarchy as a result of auto mapping. Refer to User
Defined Attributes for more information.
Default Data Type Allows the user to specify the default data type for the newly
created UDAs.
Colour Settings
Bound Cell Colour Allows the user to choose what colour is displayed in a cell
of a datasheet when a attribute is mapped to it.
Free Text Cell Colour Allows the user to choose what colour is displayed in a cell
of a datasheet when the free text attribute is mapped to it.

LEXICON User Guide
Datasheets
Revision Control
From the Configuration drop down list, select a configuration from the list of available
configurations. Refer to Revision Configuration for further information.
13.4 Unit Sets Configuration

Unit Sets Configuration allows the user to create, configure and delete the units sets
available for selection. From the main menu bar, select Unit Sets > Configure, the Unit Set
Configuration window is displayed.
Name Enter a name for the new unit set, the unit set is displayed in
the Unit sets pane of the Unit Sets Configuration window.
Dimension Select the appropriate dimension from the displayed list, if

the required dimension is not available type in the required
dimension.
Unit Enter appropriate unit(s) of measure, if required the user

can add multiple units of measure, click Add. To delete a
unit of measure, click Delete.
System Select a system of measure from the displayed list

(Imperial, Metric, SI or US). if the required system is not
available type in the required system.
New Adds the new unit set(s).
Delete Deletes the selected unit set.
Click OK to save any changes and close the Unit Sets Configuration window.
Or
Click Cancel to discard any inputs and close the Unit Sets Configuration window.

LEXICON User Guide
Datasheets
13.5 Datasheet Template Editor

The Datasheet Template Editor window allows the user to design a datasheet template
with the use of attribute mapping and the various editing tools and controls. The user can
design a basic template in Excel then use the Datasheet Template Editor to edit, map
attributes and add controls to the datasheet.
All of the tasks that a user would carry out that are associated with the creation or
modification of a datasheet template are initiated from a central window which acts as a task
hub.
Depending on selections made in the Datasheet Template Editor window the user will be
presented with further prompts requiring user input. After inputting information in these
windows the user will always be returned to the Datasheet Template Editor window
allowing the workflow to continue.
13.5.1 Datasheet Template Editor Toolbar

The Datasheet Template Editor Toolbar, allows the user to save, print, edit, format and
auto map attributes.

LEXICON User Guide
Datasheets
Save Saves the datasheet.
Print Prints the datasheet.
Cut Cuts an identified area of the datasheet.
Copy Copies an area of the datasheet.
Paste Pastes the copied area to the datasheet.
Delete Deletes an area of the datasheet.
Zoom In/Out Zooms in and out from the datasheet.
Add Adds an continuation area to the datasheet.

Continuation
Area
Remove Removes the continuation area from a

Continuation datasheet.
Area
Auto-map Auto-maps attributes from the data source to the

Attributes selected area on the datasheet.
Format Font Formats the font(s) of the datasheet.
Merge Merges selected cell(s) of a datasheet.

LEXICON User Guide
Datasheets
Lock Locks the selected cell(s) of a datasheet.
Properties Displays the Properties window, refer to

Properties for further information
Template Displays the Template Explorer window, refer

Explorer to Template Editor for further information
Toolbox Displays the Toolbox, refer to Revision block

addition for further information.
13.5.2 Template Editor

The Template Editor part of the Datasheet Template Editor window, is populated with the
hierarchy of the datasheet template.
Datasheet Template Name of the datasheet template.
Revision Block Populated with the revision block(s).
Data Source Populated with database view(s) (attributes), refer to

Datasheet Hierarchy for more information.
The user can select what content is displayed in the Template Explorer:

LEXICON User Guide
Datasheets
All Displays all the of the content of the datasheet template.
Mapped Displays the mapped content of the datasheet template.
Unmapped Displays the unmapped content of the datasheet template.
Search by
The Search by functionality allows the user to filter the list of database views displayed in
the Template Explorer.
Properties
The Properties part of the Datasheet Template Editor window is populated with the
appearance, binding, design, function and misc properties.
13.5.3 Attribute Mapping

The datasheet functionality allows the user to auto-map or manually map attributes to the
cell(s) of a datasheet template.
Auto-map
Manual map

LEXICON User Guide
Datasheets
Auto-map Attributes
The Auto-map functionality searches for the attribute with the same name as the boiler plate
text in the data source of the datasheet template. If an attribute cannot be located in the data
source, the dictionary database for the UDA is searched.
Once the searches have been completed, the Create and Map window is populated with
the results. The results can be accepted to continue with the mapping process.
From the Datasheet Template Editor window, select the cell to be mapped, then from the
main menu toolbar, select Auto-map Attributes.
The Create and Map window is displayed populated with the results of the searches:
Matched The Boiler Plate Text matches an attribute in the data

source of the datasheet template. Select the Accept check
box to map the templates cell to the attribute.
If required the Attribute Name can be modified.
Matched - Multiple data The Boiler Plate Text matches more than one attribute in the
source data source (database views and dictionary database. From
the Data Source column, select the required data source,
then select the Accept check box to map the templates cell
to the attribute.
Not Matched The Boiler Plate Text does not match an attribute, a new
attribute need to be created or the data source modified.
if an error occurs it is highlighted in the Create and Map window along with a message
describing the error.

LEXICON User Guide
Datasheets
Manual map
If require the attribute from the data source can be mapped to a cell(s) in the datasheet
template.
From the Template Explorer, select the required attribute, drag and drop the attribute into
the cell adjacent to the matching boiler plate text in the datasheet template.
Or
From the Datasheet Template Editor window, select the cell adjacent to the required boiler
plate text, then double click on the required attribute in the Template Explorer.
13.5.4 Toolbox
The Toolbox functionality allows the user to add standard controls to the datasheet template.

LEXICON User Guide
Datasheets
From the Toolbox, select the required control, drag and drop the attribute into the cell
adjacent to the matching boiler plate text in the datasheet template.
Or
From the Datasheet Template Editor window, select the cell adjacent to the required boiler
plate text, then double click on the required control in the Toolbox.
13.6 Continuation area

The continuation area functionality allows the user to identify an area in the datasheet
template in which to display data related to a sub element of a datasheet tag (parent-child
relation), for example: piece of equipment and nozzles.
Parent attributes:

LEXICON User Guide
Datasheets
Child attributes:
When a continuation area has been added to the datasheet template, a border is displayed
this border is not visible in the datasheet.
Once an attribute from the nozzle data source (child) has been mapped on to the first row
within the continuous area, the mapping is then repeated horizontally for each nozzle
associated with the datasheet tag.

LEXICON User Guide
Datasheets
If the nozzles outnumber the number of rows selected in the continuous area then a new
sheet is generated until all the nozzles are displayed.
13.7 Revision block addition

Revision blocks can be mapped to the datasheet template, to create and configure a
revision block, refer to Revision Configuration for more information.
From the Template Explorer, select the element beneath the revision block (in this case:
generic pump), drag and drop the attribute into the in the datasheet template.
Or
From the Datasheet Template Editor window, select the cell then double click on the
required attribute in the Template Explorer.
Note: The selected cell in the datasheet template requires enough area to the right and
bottom to accommodate the revision block. For example: the number of revisions
displayed (rows) and the number of attributes added (columns). Refer to Revision
Configuration for more information.

LEXICON User Guide
Datasheets

LEXICON User Guide
Index
A Template
New . . . . . . . . . . . . . . . . . . . . . 13:3
Attribute Mapping . . . . . . . . . . . . . . . . 13:18 Template Group
Auto . . . . . . . . . . . . . . . . . . . . . . . 13:19 New . . . . . . . . . . . . . . . . . . . . . 13:2
Manual . . . . . . . . . . . . . . . . . . . . . 13:20 Datasheet Template Editor
Toolbox . . . . . . . . . . . . . . . . . . . . 13:20
C Datasheet Template Settings . . . . . . . 13:13
Colour Settings . . . . . . . . . . . . . . 13:13
Command Line . . . . . . . . . . . . . . . . . . . . 4:8 Revision Control . . . . . . . . . . . . . 13:14
Continuation Area . . . . . . . . . . . . . . . . 13:21 UDA Settings . . . . . . . . . . . . . . . . 13:13
Current Element Editor . . . . . . . . . . . . . . 4:3 Datasheets . . . . . . . . . . . . . . . . . . . . . . 13:1
Dictionary Explorer . . . . . . . . . . . . . . . . . 4:1
D Edit Members . . . . . . . . . . . . . . . . . . 4:2
Distributed Attributes . . . . . . . . . . . . . . 10:1
Database View . . . . . . . . . . . . . . . . . . . 11:2 Attributes
Database Views . . . . . . . . . . . . . . . . . . 11:1 Bound Elements . . . . . . . . . . . 10:2
Administrative Elements Binding Items
Create . . . . . . . . . . . . . . . . . . . 11:1 Create . . . . . . . . . . . . . . . . . . . 10:2
Attribute Column (ATTCOLUMN) Element Bound Elements
11:4 Create . . . . . . . . . . . . . . . . . . . 10:1
Attribute Filter Element . . . . . . . . . . 11:2 Define . . . . . . . . . . . . . . . . . . . . . . 10:1
CRERULES Element . . . . . . . . . . . 11:5
Graphical View . . . . . . . . . . . . . . . . 10:5
Expression Column (EXPCOLUMN) Ele- Hierarchy . . . . . . . . . . . . . . . . . . . . 10:2
ment . . . . . . . . . . . . . . . . . 11:4
Schema . . . . . . . . . . . . . . . . . . . . . 10:2
Expression Filter (EXPFILTER) Element DSXDST . . . . . . . . . . . . . . . . . 10:5
11:3 DSXHOM . . . . . . . . . . . . . . . . 10:4
Set Attribute (SETATTRIBUTE) Element
DSXMBR . . . . . . . . . . . . . . . . . 10:3
11:6 DSXOWN . . . . . . . . . . . . . . . . 10:3
Set Parameter (SETPARAMETER) Element
DSXSCH . . . . . . . . . . . . . . . . . 10:2
11:6 DSXTST . . . . . . . . . . . . . . . . . 10:4
Set Status (SETSTATUS) Element 11:7
Source Element (SCRELEMENT) . 11:3
Database Views Editor . . . . . . . . . . 4:4, 5:1 F
Datasheet Features . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
Hierarchy . . . . . . . . . . . . . . . . . . . . 13:1
Copyright 1974 to current year. Index page 1 12 Series

LEXICON User Guide
G Template Explorer
Properties . . . . . . . . . . . . . . . . . . 13:18
Graphical View . . . . . . . . . . . . . . . . . . . . 4:5 Search by . . . . . . . . . . . . . . . . . . . 13:18
Layout . . . . . . . . . . . . . . . . . . . . . . . . 4:8 Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . 3:1
Nodes and Links . . . . . . . . . . . . . . . . 4:6
U
H
UDA . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1
Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . 2:1 Element types
DBVWWL . . . . . . . . . . . . . . . . . . . . . 2:1 Select . . . . . . . . . . . . . . . . . . . . 6:7
DSTWLD . . . . . . . . . . . . . . . . 2:2, 13:1 Graphical View . . . . . . . . . . . . . . . . . 6:9
DSXWLD . . . . . . . . . . . . . . . . . . . . . 2:2 New . . . . . . . . . . . . . . . . . . . . . . . . . 6:4
REVCWL . . . . . . . . . . . . . . . . 2:2, 13:6 Valid Values
REVCWL Group . . . . . . . . . . . . . . . 13:7 Edit . . . . . . . . . . . . . . . . . . . . . . 6:8
REVNOD UDA Group
Revision Number Definition . . . 13:8 New . . . . . . . . . . . . . . . . . . . . . . . . . 6:2
STAWLD . . . . . . . . . . . . . . . . . . . . . 2:2 UDA World
UDETWL . . . . . . . . . . . . . . . . . . . . . 2:2 New . . . . . . . . . . . . . . . . . . . . . . . . . 6:1
URWL . . . . . . . . . . . . . . . . . . . . . . . . 2:2 UDET
Base Type
L Select . . . . . . . . . . . . . . . . . . . . 7:5
Graphical View . . . . . . . . . . . . . . . . . 7:8
LEXICON Toolbar Hidden Types
Create . . . . . . . . . . . . . . . . . . . . . . . . 3:2 Select . . . . . . . . . . . . . . . . . . . . 7:7
Datasheets . . . . . . . . . . . . . . . . . . . . 3:4 Member Types
Display . . . . . . . . . . . . . . . . . . . . . . . 3:1 Select . . . . . . . . . . . . . . . . . . . . 7:6
Edit . . . . . . . . . . . . . . . . . . . . . . . . . . 3:2 New . . . . . . . . . . . . . . . . . . . . . . . . . 7:3
Help . . . . . . . . . . . . . . . . . . . . . . . . . 3:3 Owner Types
LEXICON . . . . . . . . . . . . . . . . . . . . . 3:1 Select . . . . . . . . . . . . . . . . . . . . 7:5
Modify . . . . . . . . . . . . . . . . . . . . . . . . 3:3 UDET Group
Pipe Stress Interface . . . . . . . . . . . . 3:3 New . . . . . . . . . . . . . . . . . . . . . . . . . 7:2
Schematic Model Manager . . . . . . . . 3:3 UDET World
Unit Setsd . . . . . . . . . . . . . . . . . . . . . 3:4 New . . . . . . . . . . . . . . . . . . . . . . . . . 7:1
LEXICON Window . . . . . . . . . . . . . . . . . 4:1 Unit Sets Configuration . . . . . . . . . . . 13:14
USDA
O Element Types
Select . . . . . . . . . . . . . . . . . . . . 8:4
Overview . . . . . . . . . . . . . . . . . . . . . . . . . 2:1
New . . . . . . . . . . . . . . . . . . . . . . . . . 8:1
System Attribute
R Select . . . . . . . . . . . . . . . . . . . . 8:3
User Defined Element Types . . . . . . . . . 7:1
Revision Block
User System Defined Attributes . . . . . . . 8:1
Addition . . . . . . . . . . . . . . . . . . . . 13:23
Revision Configuration . . . . . . . . . . . . . 13:6
V
S View Definition Sets . . . . . . . . . . . . . . . . 5:2
Definition Set
Status Definitions . . . . . . . . . . . . . . . . . . 9:1
Create . . . . . . . . . . . . . . . . . . . . 5:2
Graphical View . . . . . . . . . . . . . . . . . 9:1
Toolbar . . . . . . . . . . . . . . . . . . . . . . . 5:2
Views . . . . . . . . . . . . . . . . . . . . . . . . 5:3
T Columns . . . . . . . . . . . . . . . . . 5:13
Data Sources . . . . . . . . . . . . . . 5:8
Template Editor . . . . . . . . . . . . 13:15, 13:17
Toolbar . . . . . . . . . . . . . . . . . . . . . 13:15 Preview . . . . . . . . . . . . . . . . . . 5:15
View Detail . . . . . . . . . . . . . . . . 5:6

LEXICON User Guide
View Properties . . . . . . . . . . . . . 5:7

View Set Detail . . . . . . . . . . . . . . 5:5

LEXICON User Guide


Lexicon User Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Lexicon User Guide

Uploaded by

Copyright:

Available Formats

LEXICON

Date Version Comments / Remarks

LEXICON User Guide

Copyright 1974 to current year. i 12 Series

Schematic Model Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3:3

Database Views Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5:1

User Defined Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6:1

User Defined Element Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:1

Copyright 1974 to current year. ii 12 Series

Create a UDET . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7:3

User System Defined Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8:1

Status Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9:1

Distributed Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10:1

Database Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11:1

Project Breakdown Structure. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12:1

Copyright 1974 to current year. iii 12 Series

REVNOD: Revision Number Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13:8

Copyright 1974 to current year. iv 12 Series

1.2 Guide Structure

Overview introduces the LEXICON module.

Window describes how the elements and attributes are displayed in

Copyright 1974 to current year. 1:1 12 Series

Status Definitions describes the Status Definitions.

Distributed Attributes describes the Tags, Attributes and create Elements.

Database Views describes the creation and maintenance of Database View

Datasheets describes the creation and mapping of datasheet templates.

Copyright 1974 to current year. 1:2 12 Series

2.2.1 DBVWWL : Database View World

Copyright 1974 to current year. 2:1 12 Series

2.2.2 DSTWLD : Datasheet Template Group

2.2.3 DSXWLD : Bound Attribute World

2.2.4 REVCWL : Revision Configuration World

2.2.5 STAWLD : Status World

2.2.6 UDETWLD: User Defined Element World

2.2.7 UWRLD : User Defined Attribute World

Copyright 1974 to current year. 2:2 12 Series

Dictionary Explorer Opens the Dictionary Explorer window.

Current Element Editor Opens the Current Element Editor window.

Database Views Editor Opens the Database Views Editor window.

Graphical View Open the Graphical View window.

Search Opens the generic Search window, for more information

Copyright 1974 to current year. 3:1 12 Series

Command Line Opens the Command Window, for more information on

Undo Performs an Undo of the last action performed.

Redo Performs a Redo of the previous Undo action.

Cut Cuts the current element from it position in the hierarchy.

Copy Copies the current element.

Delete Delete the current element.

Note: If the current element has one or more members, both

Copyright 1974 to current year. 3:2 12 Series

Lock Locks the current element.

Unlock Unlocks the current element.

3.6 Pipe Stress Interface

3.8 Schematic Model Manager

Copyright 1974 to current year. 3:3 12 Series

3.10 Unit Sets

Copyright 1974 to current year. 3:4 12 Series

4.1 Dictionary Explorer

Copyright 1974 to current year. 4:1 12 Series

4.1.1 Edit Members

Copyright 1974 to current year. 4:2 12 Series

4.2 Current Element Editor

Copyright 1974 to current year. 4:3 12 Series

Detach The Current Element Editor window can be detached so