Vous êtes sur la page 1sur 91
AVEVA Plant (12.1) Lexicon TM-1308 www.aveva.com
AVEVA Plant
(12.1)
Lexicon
TM-1308
www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

Revision Log

       

Reviewe

 

Date

Revision

Description of Revision

Author

d

Approved

11/01/2012

0.1

Issued for Review PDMS 12.1.SP2

KB / IRS

   

20/01/2012

0.2

Issued for Review

KB/IRS

IRS/SB

 

26/03/2012

1.0

Approved for Training PDMS 12.1.SP2

KB/IRS

IRS/SB

NG

           
           
           
           
           
           

Updates

All headings containing updated or new material will be highlighted.

Suggestion / Problems

If you have a suggestion about this manual or the system to which it refers please report it to AVEVA Training & Product Support at tps@aveva.com

This manual provides documentation relating to products to which you may not have access or which may not be licensed to you. For further information on which products are licensed to you please refer to your licence conditions.

Visit our website at http://www.aveva.com

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.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

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.

www.aveva.com

Contents
Contents
Contents
Contents

1

Introduction

..............................................................................................................................................

7

1.1

1.2

Objectives

1.3

Prerequisites

 

1.4

1.5

Using this guide

1.6

2.1

2.2

2.2.1

2.2.2

2.2.3

2.2.4

Database Views

2.3

2.4

The

2.5

The Utilities Menu

2.6

The Display

2.6.1

2.6.2

2.6.3

2.6.4

Graphical View

2.6.5

2.6.6

2.7

The Edit Menu

 

2.8

The Create Menu

2.9

The Modify Menu

2.10

The Help Menu

 

2.11

3.1

UDA Hierarchy

 

3.2

3.2.1

3.2.2

Basic Definition

3.2.3

3.2.4

3.2.5

Design

3.2.6

3.3

3.3.1

Creating

a

UDA

3.3.2

Creating

a

UDA

3.3.3

4.1

USDA Hierarchy

4.2

USDA Definition

4.2.1

4.3

5.1

UDET

5.2

UDET

5.2.1

5.2.2

Basic Definition

5.2.3

UDET Hierarchy

5.3

5.3.1

Aim.....................................................................................................................................................

7

7

7

7

7

8

9

9

.........................................................................................................................................

....................................................................................................................................

Course Structure ..............................................................................................................................

...............................................................................................................................

......................................................................................................

Setting up the Training Course

  • 2 Overview of the Lexicon Module

............................................................................................................

................................................................................................

10

10

10

10

10

11

11

12

12

12

13

14

14

15

15

15

16

16

16

16

16

17

17

18

18

18

21

21

22

22

23

23

23

24

26

27

27

27

28

28

32

33

33

33

33

34

34

Data Hierarchy and Element Types

User Defined Attributes

.................................................................................................................

...............................................................................................

User System Defined Attributes

User Defined Element Types

...................................................................................................

..................................................................................................

Status Definitions and Values

.......................................................................................................................

.......................................................................................

Features of the Lexicon User Interface

Lexicon Menu ..........................................................................................................................

..........................................................................................................................

Menu...........................................................................................................................

The Dictionary Explorer ............................................................................................................

Current Element Editor .............................................................................................................

.............................................................................................................

Database Views Editor

.........................................................................................................................

.....................................................................................................

Search and Search Results

Command Window

...................................................................................................................

.................................................................................................................................

............................................................................................................................

............................................................................................................................

................................................................................................................................

Schematic Model Manager ............................................................................................................

Exercise 1 Entry to PDMS

........................................................................................................................

  • 3 User Defined Attributes .........................................................................................................................

................................................................................................................................

...........................................................................................

UDA Fields (Current Element Editor)

General .....................................................................................................................................

.........................................................................................................................

Presentation .............................................................................................................................

Protection .................................................................................................................................

......................................................................................................................................

Miscellaneous ...........................................................................................................................

............................................................

Creating User Defined Attributes A Worked Example

World (UWRL) ................................................................................................

Group (UGRO) ...............................................................................................

............................................................................................

Creating a User Defined Attribute

Exercise 2 Creating and Using UDA’s

....................................................................................................

  • 4 User System Defined Attributes ...........................................................................................................

.............................................................................................................................

.............................................................................................................................

USDA Limits and Valid Values .................................................................................................

.......................................................................................

Creating a USDA A Worked Example

Exercise 3 Creating and Using USDA’s

..................................................................................................

  • 5 User Defined Element Type

..................................................................................................................

Hierarchy ..............................................................................................................................

Definition ..............................................................................................................................

General .....................................................................................................................................

.........................................................................................................................

.......................................................................................................................

Creating a User Defined Element Type (UDET) A Worked Example

35

www.aveva.com

35

......................................

Creating a UDET Element World (UDETWL)

..........................................................................

AVEVA Plant (12.1) Lexicon TM-1308

  • 5.3.2 Creating a UDET Group (UDETGR)

35

  • 5.3.3 Creating a User Defined Element Type (UDET)

36

Exercise 4 Creating and Using UDET’s

38

  • 6 Status Control

39

Overview

  • 6.1 .........................................................................................................................................

39

  • 6.2 The Status Control Data Model

39

  • 6.3 Overview........................................................................................................................

Hierarchy

40

  • 6.4 Status Control Hierarchy - Lexicon

..............................................................................................

40

  • 6.5 Status Control Hierarchy Constructor Modules

......................................................................

41

  • 6.6 Implementing Status Control A Worked Example

41

  • 6.6.1 Creating Status Worlds

............................................................................................................

42

  • 6.6.2 Groups ............................................................................................................

Creating

Status

42

  • 6.6.3 Definitions .......................................................................................................

Creating

Status

43

  • 6.6.4 Create Status Values

...............................................................................................................

44

  • 6.6.5 Testing Status Control in Design

47

Exercise 5 Creating Status Values ............................................................................................................

49

  • 6.7 Status Control Customisation

50

  • 6.8 Data Access Control

50

  • 6.8.1 Prevent Modification of an Object of a Certain Status

50

  • 6.8.2 Prevent Promotion of an Object by Certain Users

50

Auto Colours

  • 6.9 ..................................................................................................................................

51

  • 6.9.1 Equipment with Design Status Not Controlled

51

  • 6.9.2 Equipment with Design Complete

51

  • 6.10 Customisation........................................................................................................................

PML

51

  • 6.11 .Net Customisation (C#)

................................................................................................................

51

  • 6.12 Status Control Customisation A Worked Example

52

  • 7 Database Views ......................................................................................................................................

55

  • 7.1 Overview

55

  • 7.2 Database View World (DBVWWL) Hierarchy

56

  • 7.2.1 Creating Database View Administrative Elements

56

  • 7.3 Database View (DBVW) Hierarchy ................................................................................................

57

  • 7.3.1 Creating Database View

58

  • 7.3.2 Creating a Database Views Elements

60

  • 7.4 Database Views Editor

63

  • 7.4.1 Displaying the Database Views Editor

64

  • 7.4.2 View Properties tab

68

Data Sources

  • 7.4.3 tab......................................................................................................................

69

Columns tab

  • 7.4.4 .............................................................................................................................

69

  • 7.4.5 Preview tab ...............................................................................................................................

71

  • 7.5 Creating a Branch and Pipe Database View A Worked Example

72

  • 7.5.1 Creating the DBVW

..................................................................................................................

72

  • 7.5.2 Defining the Data Sources

74

  • 7.5.3 Defining the ATTCOL and EXPCOL columns

75

  • 7.5.4 Testing the Database View

78

Exercise 6 Creating a Nozzle Database View

79

  • 7.6 Modifying the Branch and Pipe DBVW using SRCELE A Worked Example

80

  • 7.6.1 Copying a Database View ........................................................................................................

81

  • 7.6.2 Testing the Database View

85

Exercise 7 Modifying the Nozzle Database View

87

  • 7.7 Using Database Views for Lexicon Administration A Worked Example

88

Exercise 8 Create a DBVW that checks for UNSET Descriptions

91

www.aveva.com

CHAPTER 1
CHAPTER 1
CHAPTER 1
CHAPTER 1
1 Introduction
1
Introduction

The AVEVA Plant (12.1) Lexicon training guide is designed as a continuation to the AVEVA Plant (12.1) System Administration Basic and Advanced training guides. The LEXICON Module allows the system administrator complete control of the administration of the Dictionary (DICT) databases of a project.

  • 1.1 Aim

To understand the use of Lexicon on a PDMS Project using practical worked examples and exercises.

  • 1.2 Objectives

Through the completion of the training, the Trainee will have sufficient knowledge to complete the following tasks:

Create and use User Defined Attributes (UDA’s), User System Defined Attributes (USDA’s), and User

Defined Element Types (UDET’s). Outline the principles of Status Control and its administrative hierarchy.

Create, modify and implement Status Definitions and Values.

Consider simple examples of automated Status Control events.

Create, modify and implement Database Views.

  • 1.3 Prerequisites

It is expected that trainees will have completed the following training courses: TM-1300 AVEVA Plant (12.1) System Administration (Basic) and TM-1301 AVEVA Plant (12.1) System Administration (Advanced).

Trainees who have not completed these courses, but can demonstrate a working knowledge of PDMS Administration, may be permitted to undertake the course at the Trainers discretion.

  • 1.4 Course Structure

Training will consist of oral and visual presentations, demonstrations and set exercises.

Each workstation will have a training project, populated with model objects. This will be used by the trainees to practice their methods, and complete the set exercises.

  • 1.5 Using this guide

Certain text styles are used to indicate special situations throughout this document:

Menu pull downs and button press actions are indicated by bold dark turquoise text.

Information the user has to key-in indicated by bold red text.

Supplementary information or guidance notes will be distinguished by a turquoise information symbol and accompanying text:

Additional information

References to other training guides/sections and documents will be distinguished by a book symbol and accompanying text:

  • Refer to other documentation

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

System prompts will be displayed in inverted commas using italicised bold text e.g. 'Choose function'.

Example files or inputs will be in the courier new font, utilising colours and styles outlined above where appropriate.

  • 1.6 Setting up the Training Course

As Lexicon is an Administrative module, access is restricted to free users only. Login to PDMS using the details provided by the Trainer. They will typically be as shown below:

AVEVA Plant (12.1) Lexicon TM-1308 System prompts will be displayed in inverted commas using italicised bold

Project

Training

Username

-

SYSTEM

Password

-

XXXXXX

MDB

-

A-PIPING

Click the Login button.

Select Utilities > Training Setup… from the main menu to display the Training Setup form. Navigate to the Lexicon tab.

AVEVA Plant (12.1) Lexicon TM-1308 System prompts will be displayed in inverted commas using italicised bold

Check the Setup Training Course checkbox, click the Apply button and close the form.

www.aveva.com

CHAPTER 2
CHAPTER 2
CHAPTER 2
CHAPTER 2
  • 2 Overview of the Lexicon Module

The Lexicon Module allows the system administrator to create and manage a number of user defined attributes and element types. System attributes can also be managed allowing administrators to set valid values and limits.

The Lexicon module allows the creation and management of status workflows, via user defined status values and status change events. Database views can also be constructed within Lexicon, enhancing project reporting methods and allowing for the use of distributed attributes in projects.

  • 2.1 Data Hierarchy and Element Types

Elements created in Lexicon are stored in Dictionary (DICT) databases. To make elements created in Lexicon appear in a project, the DICT database must be included in a project Multiple Database (MDB) using the Admin module.

As with other PDMS modules, Lexicon elements are owned by other elements and must adhere to a specific data hierarchy. Some minor variations exist in the Lexicon hierarchy; however the general hierarchy is of the form shown. An Explorer is available within Lexicon and the hierarchy for a specific element can be viewed within it.

Dictionary World Element World Element Group Element
Dictionary World
Element World
Element Group
Element
CHAPTER 2 2 Overview of the Lexicon Module The Lexicon Module allows the system administrator

All elements created in Lexicon are owned by the top level element, the Dictionary World. Beneath the Dictionary World a number of element specific Worlds can be created. In turn, the element worlds may own element Groups. Worlds and Groups are administrative elements, providing a means of organising Lexicon elements to meet project requirements.

A range of elements can be created within Lexicon including:

  • User Defined Attributes.

  • User System Defined Attributes.

  • User Defined Element Types.

  • Status Definitions and Values.

  • Database Views.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

Hierarchy details specific to each element will be considered later in the training guide. A brief description of each element type is provided in the sections that follow.

  • 2.2 User Defined Attributes

A User Defined Attribute (UDA) enables the administrator to add new attributes to any element in the databases of a project. A UDA can be used to add engineering data to elements for example “Designed”, “Checked”, etc.

UDAs are created as elements in Dictionary databases inside a 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 any other attributes. UDAs can also be used in expressions.

  • 2.2.1 User System Defined Attributes

A User System Defined Attribute (USDA) allows the administrator to place behaviour on a standard PDMS element. For example, limits may be applied to the attributes of top level elements within PDMS.

A USDA allows the administrator to add the following behaviour to system attributes:

  • Set valid values.

  • Define limits.

  • Hide attributes on forms.

  • Category.

  • 2.2.2 User Defined Element Types

Within PDMS 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. UDETs allow Designers to create real engineering items e.g. “Pumps”, “Towers” or Areas. UDETs are based on existing PDMS Item

Types.

  • 2.2.3 Status Definitions and Values

Status Control provides administrators with a means to control and report on the status of individual model objects as they progress through their lifecycles. Status control can be applied to any PDMS element used in the constructor modules e.g. Design, Paragon, Spooler, Diagrams, Draft, Tags.

The desired project workflow is created by the administrator as a Status Definition, or number of Status Definitions, in the Lexicon module. Status Definitions own Status Values, which describe the stage of development for the PDMS element concerned.

  • 2.2.4 Database Views

Database views provide a way to consolidate data from elements and attributes distributed across databases in an MDB.

These views are set up by an administrator using the Database Views Editor and stored in the Lexicon (DICT) database in a Database View World (DBVWWL). User database views may also be saved in a local settings file. As well as the user definable views, each PDMS element type has its own Element View.

A Database View uses a table to define a view of the data, which may be derived from a single or multiple elements. There is a row in the Database View table for each element of a particular type that meets the

www.aveva.com

criteria defined by filters. These filters use the same concept as the search grid. If the criteria cannot be

AVEVA Plant (12.1) Lexicon TM-1308

expressed using attribute filters, it is also possible to define an expression for evaluation. A row is present in the table only if all the filter criteria are met.

Database Views provide method to derive data structures for a variety of purposes, in particular List definitions in the Engineering Tags module, as well as for the Report Designer.

  • 2.3 Features of the Lexicon User Interface

The Lexicon Module has a similar User Interface (UI) to other PDMS modules. When the UI is first accessed the left hand side of the UI is populated with the Dictionary Explorer and Current Element Editor. The Search toolbar is also displayed beneath the main menus.

AVEVA Plant (12.1) Lexicon TM-1308 expressed using attribute filters, it is also possible to define an

Space to the right hand side of the UI is gradually populated as other options, such as displaying Graphical Views and Search Results, are selected from the Lexicon menus.

A number of functions are available from the main menu. An overview of the menu options is provided in the sections that follow.

  • 2.4 The Lexicon Menu

AVEVA Plant (12.1) Lexicon TM-1308 expressed using attribute filters, it is also possible to define an

The Lexicon menu options available include getting and saving database changes, switching to other modules, and exiting the application.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

  • 2.5 The Utilities Menu

AVEVA Plant (12.1) Lexicon TM-1308 2.5 The Utilities Menu 2.6 The Display Menu The Utilities menu
  • 2.6 The Display Menu

The Utilities menu is normally only available if the AVEVA Training Setup has been loaded. It is used by AVEVA Trainers to aid the Training Process.

AVEVA Plant (12.1) Lexicon TM-1308 2.5 The Utilities Menu 2.6 The Display Menu The Utilities menu
  • 2.6.1 The Dictionary Explorer

The Display menu allows users to select the forms that will be displayed in the UI.

The options available under the Display menu are outlined below.

The Display > Dictionary Explorer option is used to display or hide the Dictionary Explorer.

AVEVA Plant (12.1) Lexicon TM-1308 2.5 The Utilities Menu 2.6 The Display Menu The Utilities menu

A list of elements held in the Lexicon Database is populated in the Dictionary Explorer. Any element can be selected, copied, or deleted, by clicking the right mouse button on the element.

Options displayed when using the right click menus are context sensitive. The options displayed will vary depending on the element selected. For example, if the Current Element (CE) is the Dictionary World:

AVEVA Plant (12.1) Lexicon TM-1308 2.5 The Utilities Menu 2.6 The Display Menu The Utilities menu

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

Examples of other menu options are shown below.

AVEVA Plant (12.1) Lexicon TM-1308 Examples of other menu options are shown below. Example of the

Example of the options when the CE is a UWRL (UDA World).

  • 2.6.2 Current Element Editor

AVEVA Plant (12.1) Lexicon TM-1308 Examples of other menu options are shown below. Example of the

Example of the options when the CE is a UGRO (UDA Group).

The Display > Current Element Editor option prompts the Current Element Editor form. This form is used to edit the CE and dynamically tracks the Dictionary Explorer. The displayed information changes depending of the type of element selected.

AVEVA Plant (12.1) Lexicon TM-1308 Examples of other menu options are shown below. Example of the

Example of a UWRL.

AVEVA Plant (12.1) Lexicon TM-1308 Examples of other menu options are shown below. Example of the

Example of a UDA.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

  • 2.6.3 Database Views Editor

The Display > Database Views Editor option displays the Database View Editor which, as the name suggests, is used to create views on the PDMS database. This option is discussed in full later in this guide.

AVEVA Plant (12.1) Lexicon TM-1308 2.6.3 Database Views Editor The Display > Database Views Editor option
  • 2.6.4 Graphical View

The Display > Graphical View option displays the Graphical View which, in turn may be populated by a right-click menu option within the Dictionary Explorer.

AVEVA Plant (12.1) Lexicon TM-1308 2.6.3 Database Views Editor The Display > Database Views Editor option

This example shows a Status Definition workflow.

AVEVA Plant (12.1) Lexicon TM-1308 2.6.3 Database Views Editor The Display > Database Views Editor option

The example below shows User Defined Element Types based on Equipment.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

  • 2.6.5 Search and Search Results

The Display > Search… and Display > Search Results… options are common across a number of PDMS modules, allowing the searching, display and editing of data.

AVEVA Plant (12.1) Lexicon TM-1308 2.6.5 Search and Search Results The D isplay > Search… and
  • 2.6.6 Command Window

AVEVA Plant (12.1) Lexicon TM-1308 2.6.5 Search and Search Results The D isplay > Search… and

The Display > Command Window… option allows use of the Command Window in Lexicon.

  • 2.7 The Edit Menu

The options under the Edit menu, with the exception of Validate, are commonly used PDMS functions and should be self-explanatory. Validate is used to check the Lexicon Database for errors which must be corrected prior to using the Lexicon data.

AVEVA Plant (12.1) Lexicon TM-1308 2.6.5 Search and Search Results The D isplay > Search… and
www.aveva.com
www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

  • 2.8 The Create Menu

The Create menu can be used to create Lexicon Elements. It is context sensitive depending on the CE selected in the PDMS Hierarchy. This is illustrated in the examples below.

AVEVA Plant (12.1) Lexicon TM-1308 2.8 The Create Menu The Create menu can be used to

These options are available at World Level.

AVEVA Plant (12.1) Lexicon TM-1308 2.8 The Create Menu The Create menu can be used to

The creation of a UDA and USDA are only available when at UGRO Level.

  • 2.9 The Modify Menu

AVEVA Plant (12.1) Lexicon TM-1308 2.8 The Create Menu The Create menu can be used to

The Modify menu lists

a number

of

options

relating to the Lock attribute of Lexicon elements.

Subject to the type of element selected, some of the options may not be available.

  • 2.10 The Help Menu

AVEVA Plant (12.1) Lexicon TM-1308 2.8 The Create Menu The Create menu can be used to

The Help menu displays a range of standard PDMS help options available to the user.

  • 2.11 Schematic Model Manager

Schematic Model Manager is an optional module. For further information refer to Schematic Model Manager User Guide.

Exercise 1 Entry to PDMS
Exercise 1
Entry to PDMS

Enter the PDMS Training Project as described and explore the Lexicon menu options.

www.aveva.com

CHAPTER 3
CHAPTER 3
CHAPTER 3
CHAPTER 3
  • 3 User Defined Attributes

User Defined Attributes enable the PDMS system administrator to add new attributes to any element in the databases of a project.

UDAs can contain Limits e.g. Temperature 1 200, or have Valid Values e.g. AREA01, AREA02, etc. applied to them.

  • 3.1 UDA Hierarchy

CHAPTER 3 3 User Defined Attributes User Defined Attributes enable the PDMS system administrator to

In order to create a User Definable Attribute (UDA) the user must first navigate to the correct place in the Lexicon hierarchy. A UDA can only be created from a UDA World (UWRL) or UDA Group (UGRO).

With the Dictionary World selected as the CE, the user can create a new UDA World using either the main Create menu or via the right click context menu in the Dictionary Explorer.

CHAPTER 3 3 User Defined Attributes User Defined Attributes enable the PDMS system administrator to
CHAPTER 3 3 User Defined Attributes User Defined Attributes enable the PDMS system administrator to

A UDA Group and a UDA are created in a similar way.

www.aveva.com
www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

  • 3.2 UDA Fields (Current Element Editor)

Once the UDA is created, the Current Element Editor form displays a number of fields associated with the UDA. The fields are grouped into a number of categories. The fields relevant to each category are considered in the sections that follow.

AVEVA Plant (12.1) Lexicon TM-1308 3.2 UDA Fields (Current Element Editor) Once the UDA is created,
  • 3.2.1 General

Fields grouped into the General category include some system generated values that cannot be directly changed by the user (e.g. Owner). These fields appear in a lighter colour than fields that can be edited directly.

AVEVA Plant (12.1) Lexicon TM-1308 3.2 UDA Fields (Current Element Editor) Once the UDA is created,

Fields that can be edited directly include:

Name

The user can enter a valid name for the UDA in the Lexicon database. Special characters are not

allowed. Although the system will accept numeric values it is

good practise to avoid using them.

Lock This field determines whether or not the fields defining a UDA are locked. The field can be set to True (locked) or False.

Description

A brief description of the UDA can be provided to assist users.

  • 3.2.2 Basic Definition

Several fields relating to the Basic Definition category are dynamic. The selections made in one field dictate the values and other fields displayed in the Current Element form.

www.aveva.com
www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

Abbreviation Length

This field defines the minimum number of characters that the attribute name can be shortened to for use in commands and attribute entry fields. For example, if the UDA Name is DIAGRAM, and the Abbreviation Length is 5, the user must type 5 characters to define the UDA (e.g. DIAGR). The abbreviation name must be less than or equal to the number of characters used in the User Defined Name and must be unique in its own right.

UDA Type

Subject to the type chosen, other relevant fields will be displayed accordingly. This is

demonstrated in the examples that follow. Consider first a UDA Type set to logical.

AVEVA Plant (12.1) Lexicon TM-1308  Abbreviation Length This field defines the minimum number of characters

The UDA Default value can then only be set as either ‘Trueor ‘False.

AVEVA Plant (12.1) Lexicon TM-1308  Abbreviation Length This field defines the minimum number of characters

If the user selects the UDA Type of reference, then the Referred types field is displayed (and the UDA Default field is not).

AVEVA Plant (12.1) Lexicon TM-1308  Abbreviation Length This field defines the minimum number of characters

The Referred types field can be populated from the Select Element Types form. allows users to select the required elements from a pre-populated list.

This form

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

A filter is available to assist users in making an appropriate selection.

AVEVA Plant (12.1) Lexicon TM-1308 A filter is available to assist users in making an appropriate

If the UDA Type is set to real the UDA Units can be set.

AVEVA Plant (12.1) Lexicon TM-1308 A filter is available to assist users in making an appropriate

Element Type

This is the PDMS element that the UDA will be applied too e.g. Pipe, Equipment, Drawing, etc.

AVEVA Plant (12.1) Lexicon TM-1308 A filter is available to assist users in making an appropriate

As with Referred elements, there is a filter option to help users select the required Element Types.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

Pseudo Attribute

Setting this logical attribute to True will indicate the UDA is pseudo attribute. Pseudo attributes allow for dynamic values to be returned as needed, rather than having static values stored in the database.

The code required to return a pseudo attribute value must be plugged in through the use of the C# API and is out of the scope of this guide.

Indexed UDA The indexing of UDA’s is controlled by the UTABLE attribute on the UDA definition in the dictionary DB. If this is set to True then the UDA will be indexed. Indexing is allowed for text, reference and integer UDAs only.

User Defined Name

This allows the user to enter a name that will be given to the UDA of the element it will be created for. It should be set to a similar name as the UDA.

Special characters are not allowed for UDA names. Although the system will accept numeric values it is good practise to avoid using them.

  • 3.2.3 Presentation

The fields within the Presentation category remain the same irrespective of the type of UDA created. A brief description of each field is provided below.

AVEVA Plant (12.1) Lexicon TM-1308  Pseudo Attribute Setting this logical attribute to True will indicate

Reporter text

A text attribute used to define the default column heading used in reports. This field can be up to 20 characters in length.

UDA Category This can be used to Group UDAs together within the Modify Attributes form.

Hidden If this field is set to True the data will be hidden from the user.

Hyperlink If this field is set to True the text value of a UDA will be allowed to contain a path to an external file.

Connection If this field is set to True it indicates that the UDA is a connection in the reference list.

  • 3.2.4 Protection

The Protection category only contains one field relating to the UDA.

AVEVA Plant (12.1) Lexicon TM-1308  Pseudo Attribute Setting this logical attribute to True will indicate

Protected If this field is set to True, and the UDA is to be stored in a protected database, it will not be viewed.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

  • 3.2.5 Design

The Design category only contains one field relating to the UDA.

AVEVA Plant (12.1) Lexicon TM-1308 3.2.5 Design The Design category only contains one field relating to

Valid Values

Depending on the type of UDA created, numeric values, a range of values, or text strings can be set in this field. Items must be separated by a suitable delimiter specific to the type of value being entered.

To assist this process, the Edit Valid Values form can be opened from the valid value entry cell.

AVEVA Plant (12.1) Lexicon TM-1308 3.2.5 Design The Design category only contains one field relating to
  • 3.2.6 Miscellaneous

The Miscellaneous category only contains one field relating to the UDA.

AVEVA Plant (12.1) Lexicon TM-1308 3.2.5 Design The Design category only contains one field relating to

Limits or Valid Values Optional Flag If this field is set to True the limits or valid values set in the form are optional.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

  • 3.3 Creating User Defined Attributes A Worked Example

The following example creates three UDAs: Designed, Checked, and Approved. The UDAs will be assigned to PIPE, EQUIP, SHEET, and SPLDRG PDMS elements.

  • 3.3.1 Creating a UDA World (UWRL)

When the Lexicon Dictionary database is created using the Training Setup, a Lexicon world called UWRL- PROJECT/DICT is created. This database will be used during this training course.

However, if a new UDA World is required it can be created by following the steps outlined here.

AVEVA Plant (12.1) Lexicon TM-1308 3.3 Creating User Defined Attributes – A Worked Example The following
AVEVA Plant (12.1) Lexicon TM-1308 3.3 Creating User Defined Attributes – A Worked Example The following

Navigate to the Dictionary World /* then click the right hand button of the mouse.

From the resulting context menu select:

Create > UWRLD: User defined attribute world

Use the Current Element Editor to set the Name and the Description as follows.

Name: UWRL-TRAINING

Description: UWRL Training

  • 3.3.2 Creating a UDA Group (UGRO)

Navigate to the UDA World /UWRL-PROJECT/DICT.

AVEVA Plant (12.1) Lexicon TM-1308 3.3 Creating User Defined Attributes – A Worked Example The following
AVEVA Plant (12.1) Lexicon TM-1308 3.3 Creating User Defined Attributes – A Worked Example The following

From the right-click context menu select:

Create > UGROUP: User defined attribute group

Using the Current Element Editor set the following:

UDA Group Name

UGRO-TRAINING

Description

UDA Group Training

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

  • 3.3.3 Creating a User Defined Attribute

Navigate to the UDA Group UGRO-TRAINING

AVEVA Plant (12.1) Lexicon TM-1308 3.3.3 Creating a User Defined Attribute Navigate to the UDA Group

From the right click context menu select:

Create > UDA: User defined attribute

Enter the following values into the appropriate fields:

AVEVA Plant (12.1) Lexicon TM-1308 3.3.3 Creating a User Defined Attribute Navigate to the UDA Group
AVEVA Plant (12.1) Lexicon TM-1308 3.3.3 Creating a User Defined Attribute Navigate to the UDA Group

Name

DESIGNED

Description

Designed

Abbreviation Length

8

UDA Type

text

 

UDA Length

15

User-define name

DESIGNED

Reporter text

Designed

 

Select the Element Types

Select the Element Types Icon.

Icon.

This will display all available types. Reduce the selection displayed using the Filter Option.

AVEVA Plant (12.1) Lexicon TM-1308 3.3.3 Creating a User Defined Attribute Navigate to the UDA Group

Filter EQUIP

Select EQUIPMENT followed by the Add to List button.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

AVEVA Plant (12.1) Lexicon TM-1308 Repeat for the PIPE , SHEET and SPLDRG element types. Select
AVEVA Plant (12.1) Lexicon TM-1308 Repeat for the PIPE , SHEET and SPLDRG element types. Select
AVEVA Plant (12.1) Lexicon TM-1308 Repeat for the PIPE , SHEET and SPLDRG element types. Select

Repeat for the PIPE, SHEET and SPLDRG element types.

Select the OK button.

On the new UDA DESIGNED select:

Create > UVALID: User defined valid value

Enter the following information:

Description

JOE BLOGS

UDA VALUE

JB

The process should be repeated for: JJ - JIMMY JAMES, and FS - FRED SMITH.

Also set the Limits or Valid values Optional flag to True.

AVEVA Plant (12.1) Lexicon TM-1308 Repeat for the PIPE , SHEET and SPLDRG element types. Select

The UDA should now be set as follows.

In a similar way UDAs Checked and Approved can be created.

Save work.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

Exercise 2

Creating and Using UDA’s

Create the UDA’s Checked and Approved and assign them to “PIPE”, “EQUIP”, “SHEET” and “SPLDRG”.

Check that you can add information in Design, Draft or Spooler. Set the Limits or Valid values Optional flag to TRUE on Designed and Checked but to False on APPROVED.

In Design navigate to a Pipe and select Modify > Attributes

AVEVA Plant (12.1) Lexicon TM-1308 Exercise 2 Creating and Using UDA’s Create the UDA ’s Checked
AVEVA Plant (12.1) Lexicon TM-1308 Exercise 2 Creating and Using UDA’s Create the UDA ’s Checked

Try setting :DESIGNED, :CHECKED and :APPROVED to valid and invalid values.

www.aveva.com

CHAPTER 4
CHAPTER 4
CHAPTER 4
CHAPTER 4
  • 4 User System Defined Attributes

A User System Defined Attribute (USDA) allows the administrator to place behaviour on a standard PDMS element. For example limits may be applied to attributes of top level elements within PDMS.

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. These values are defined by creating a USDA element in the dictionary database.

  • 4.1 USDA Hierarchy

UWRL UGRO USDA ULIMIT UVALID
UWRL
UGRO
USDA
ULIMIT
UVALID

In order to create a User System Definable Attribute (USDA) the user

must navigate to a UDA Group (UGRO).

  • 4.2 USDA Definition

A number of fields are associated with the definition of a User System Defined Attribute. A brief description of each field is provided below.

Name

The name by which the USDA will be

referred to in the PDMS modules.

Description

A Text attribute which may be used to

give a description of the USDA.

System Attribute

Underlying system attribute to which the USDA is to be applied.

CHAPTER 4 4 User System Defined Attributes A User System Defined Attribute ( USDA )

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

Element types A logical attribute, if set to true the USDA will be applied to all PDMS elements with the attribute defined in USYSTY ELEL an Array containing a list of PDMS elements to apply the USDA to.

UDA Category This field allows the administrator to group USDAs on the Attributes form within PDMS modules, e.g. UCAT ‘MYCATAGORY’. If UCAT is left unset then it has no effect.

Hidden On setting this logical attribute to True will indicate that the USDA will be hidden from the

‘Q ATT’ command and from the attribute form within PDMS. Querying of the individual UDA will not be

affected by this setting.

UTEAMS

If the UHIDE attribute has been set then the UTEAMS attribute can be used to indicate which teams the USDA will be available too. UTEAMS can hold an array of values.

  • 4.2.1 USDA Limits and Valid Values

A USDA may own ULIMIT and UVALID elements to denote the limits and valid values.

These are described in Valid Values and Creating a USDA.

  • 4.3 Creating a USDA A Worked Example

The following example will restrict the FUNC attribute on EQUIPMENT to be 'Heatx' or 'Pump'. Create a USDA as follows.

A new UDA World is required, navigate to the Dictionary World /*.

Using the right click context menu select: Create > UWRLD: User defined attribute world.

AVEVA Plant (12.1) Lexicon TM-1308  Element types A logical attribute, if set to true the

Use the Current Element Editor to set the Name and the Description as follows.

AVEVA Plant (12.1) Lexicon TM-1308  Element types A logical attribute, if set to true the

Name

USWRL-TRAINING

Description

System Attribute World

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

AVEVA Plant (12.1) Lexicon TM-1308 Navigate to the UDA World USWRL-TRAINING Using the right click context
AVEVA Plant (12.1) Lexicon TM-1308 Navigate to the UDA World USWRL-TRAINING Using the right click context
AVEVA Plant (12.1) Lexicon TM-1308 Navigate to the UDA World USWRL-TRAINING Using the right click context

Navigate to the UDA World USWRL-TRAINING

Using the right click context menu select:

Create > UGROUP: User defined attribute group

Set the following:

UDA Group Name Description

USDA-GROUP Training System Attribute Group

Navigate to the UDA Group USDA-GROUP

Using the right click context menu select:

Create > USDA: User system defined attribute

In a similar way to the creation of a UDA the following should be set:

AVEVA Plant (12.1) Lexicon TM-1308 Navigate to the UDA World USWRL-TRAINING Using the right click context
AVEVA Plant (12.1) Lexicon TM-1308 Navigate to the UDA World USWRL-TRAINING Using the right click context

Name

UFUNC

Description

Set restriction on FUNC attribute on EQUI

System Attribute

FUNC

Element Types

EQUIPMENT

On the New USDA UFUNC select:

Create > UVALID: User defined valid value

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

AVEVA Plant (12.1) Lexicon TM-1308 Description Pump UDA VALUE PUMP Repeat the process for “Heat Exchanger”,
AVEVA Plant (12.1) Lexicon TM-1308 Description Pump UDA VALUE PUMP Repeat the process for “Heat Exchanger”,

Description

Pump

UDA VALUE

PUMP

Repeat the process for “Heat Exchanger”, HEATX

UFUNC is set as shown.

The following is an example of limiting the Temperature range on a Pipe and Pipe Branch.

AVEVA Plant (12.1) Lexicon TM-1308 Description Pump UDA VALUE PUMP Repeat the process for “Heat Exchanger”,
AVEVA Plant (12.1) Lexicon TM-1308 Description Pump UDA VALUE PUMP Repeat the process for “Heat Exchanger”,
AVEVA Plant (12.1) Lexicon TM-1308 Description Pump UDA VALUE PUMP Repeat the process for “Heat Exchanger”,

Name

ULIMITTEMP

Description

Set Temp Limits on a Pipe & Branch

System Attribute

TEMP

Element Types

BRANCH PIPE

On the New USDA ULIMITTEMP select:

Create > ULIMIT: User defined Limits

Description

Temperature Range

MINIMUM VALUE

-50

MAXIMUM VALUE

500

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

AVEVA Plant (12.1) Lexicon TM-1308 ULIMITTEMP should now be set as shown www.aveva.com © Copyright 1974

ULIMITTEMP should now be set as shown

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

Exercise 3

Creating and Using USDA’s

Using the described Worked Example create the USDA “UFUNC” and “ULIMITTEMP” and test them in Design.

In Design Navigate to Equipment and Select Modify > Attributes.

AVEVA Plant (12.1) Lexicon TM-1308 Exercise 3 Creating and Using USDA’s Using the described Worked E

Valid Values are available in a Pull down.

AVEVA Plant (12.1) Lexicon TM-1308 Exercise 3 Creating and Using USDA’s Using the described Worked E

In Design, navigate to a Pipe and select Modify > Attributes

AVEVA Plant (12.1) Lexicon TM-1308 Exercise 3 Creating and Using USDA’s Using the described Worked E

Try setting Temperature to 50 and -200.

AVEVA Plant (12.1) Lexicon TM-1308 Exercise 3 Creating and Using USDA’s Using the described Worked E

www.aveva.com

CHAPTER 5
CHAPTER 5
CHAPTER 5
CHAPTER 5
  • 5 User Defined Element Type

Within PDMS 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. UDET’s allow Designers to create real engineering items e.g. “Pumps”, “Towers” or Areas. UDETs are based on existing

PDMS Item Types.

  • 5.1 UDET Hierarchy

CHAPTER 5 5 User Defined Element Type Within PDMS the standard set of elements are

In order to create a User Defined Element Type (UDET) the user must navigate to the correct place in the Hierarchy, i.e. a UDET World (UDETWL) or UDET Group (UDETGR).

  • 5.2 UDET Definition

A

number

of

fields

are

associated

with

the

definition of a User Defined Element Type.

CHAPTER 5 5 User Defined Element Type Within PDMS the standard set of elements are

A brief description of each field is provided in the sections that follow.

5.2.1

General

The fields available in the General section are described below.

Name

This allows the user to enter a valid name for the UDET in the Lexicon database. Special characters are not allowed and only alphabetic characters are allowed.

Description

This allows the user to add a descriptive phrase to the UDET.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

  • 5.2.2 Basic Definition

The fields available in the Basic Definition section are described below.

User-defined name

This allows the user to enter a name that will be given to the element for which the UDET is created. It should be set to the Name of the UDET. But the user is allowed to change the UDET Name if required.

Special characters are not allowed for the UDET name and only alphabetic characters are allowed.

Base Type

This allows the user to select the System Type that the UDET will be based on.

AVEVA Plant (12.1) Lexicon TM-1308 5.2.2 Basic Definition The fields available in the Basic Definition section
  • 5.2.3 UDET Hierarchy

There

is

a

filter

option

to

assist

with

element

selection.

 

The fields available in the UDET Hierarchy section are described below.

Owner Types

The UDET Owners list is automatically populated with the list of valid owners based on the Base Type selected.

AVEVA Plant (12.1) Lexicon TM-1308 5.2.2 Basic Definition The fields available in the Basic Definition section

The User can remove valid owners from the list using the tick box.

There must be at least one owner.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

Member Types

The UDET Members list is automatically populated with the list of valid members based on the Base Type selected.

AVEVA Plant (12.1) Lexicon TM-1308  Member Types The UDET Members list is automatically populated with

The user can remove valid members from the list using the tick Box.

  • 5.3 Creating a User Defined Element Type (UDET) A Worked Example

In the following example a Tank and Tower are created based on a PDMS base type of Equipment.

  • 5.3.1 Creating a UDET Element World (UDETWL)

AVEVA Plant (12.1) Lexicon TM-1308  Member Types The UDET Members list is automatically populated with
AVEVA Plant (12.1) Lexicon TM-1308  Member Types The UDET Members list is automatically populated with

Navigate to the Dictionary World /*.

Using the right-click context menu select:

Create > UDETWL: User defined element world

In the Current Element Editor enter the following:

Name

TRAINING/UDETWL

Description

Training Detail World

  • 5.3.2 Creating a UDET Group (UDETGR)

AVEVA Plant (12.1) Lexicon TM-1308  Member Types The UDET Members list is automatically populated with

Navigate to the UDET World, then using the right click context menu select:

Create > UDETGR: User defined element group

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

AVEVA Plant (12.1) Lexicon TM-1308 Use the Current Element Editor to set the following: Name EQUIP/UDET/GROUP

Use the Current Element Editor to set the following:

Name

EQUIP/UDET/GROUP

Description

Equipment UDET Group

  • 5.3.3 Creating a User Defined Element Type (UDET)

Navigate to UDETGR EQUIP/UDET/GROUP

AVEVA Plant (12.1) Lexicon TM-1308 Use the Current Element Editor to set the following: Name EQUIP/UDET/GROUP
AVEVA Plant (12.1) Lexicon TM-1308 Use the Current Element Editor to set the following: Name EQUIP/UDET/GROUP
AVEVA Plant (12.1) Lexicon TM-1308 Use the Current Element Editor to set the following: Name EQUIP/UDET/GROUP
AVEVA Plant (12.1) Lexicon TM-1308 Use the Current Element Editor to set the following: Name EQUIP/UDET/GROUP

From the right click context menu select:

Create > UDET: User defined element

Use

the

Current

Element

Editor

to

set

the

following:

 

Name

TANK

Description

Tank

User-defined Name

TANK

Base Type

 

Select

Base Type Select Icon

Icon

This will display all available types. The selection can be reduced using the Filter option.

Filter EQUI Select EQUIPMENT

Click the OK button.

The Owner types, Member types and Hidden attributes can be left set to default.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

AVEVA Plant (12.1) Lexicon TM-1308 The operation can be repeated for TOWER. www.aveva.com © Copyright 1974

The operation can be repeated for TOWER.

AVEVA Plant (12.1) Lexicon TM-1308 The operation can be repeated for TOWER. www.aveva.com © Copyright 1974

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

Exercise 4

Creating and Using UDET’s

Using the above example, create a Tank and Tower element based on Equipment and test its use in Design.

In Design navigate to an Equipment Zone for example /ZONE-EQUIPMENT-AREA01 and in the Equipment Application Select Create > Standard EquipmentSelect Tank from the User Define Type Pull down.

AVEVA Plant (12.1) Lexicon TM-1308 Exercise 4 Creating and Using UDET’s Using the above example, create

The Command Line Syntax in Design would be NEW :TANK.

www.aveva.com

CHAPTER 6
CHAPTER 6
CHAPTER 6
CHAPTER 6
  • 6 Status Control

Throughout a projects lifecycle a typical AVEVA Plant project contains a number of design disciplines and processes. In order to maximise productivity and minimise costs it is essential to control and communicate the progress of design activities. The Status Control utility has been developed to assist designers with this process.

  • 6.1 Overview

The Status Control utility is a highly configurable tool that allows the user to control and report on the progress of model objects. It works by defining a number of Status Values, that describe the current state of a model object, and applying them to appropriate elements in the Constructor Modules (i.e. Design, Draft, Paragon, etc.).

Status Values can perform two functions. They inform the user of an objects current status and they can be used to influence subsequent design activities.

The terms used to describe Status Values are defined by the user. They may represent project milestones, WBS elements, percentage completion rates, or they may be simple descriptive terms. The user can also define the object types that the Status Values will be applied to. The object type will vary in each Constructor Module e.g. in Draft the object type may be DRWG but in Design the object type could be PIPE, EQUI, etc.

By applying Data Access Control (DAC) the administrator can impose restrictions on model objects that have reached a particular status. For example, certain activities, such as modifying an objects position, may be prohibited once a certain status is reached.

Model objects that have one or more status values assigned to them are considered to be Controlled Objects. It may not be necessary to control all instances of a model object type. As such the status control tool allows the user to select which instances of the model object type will be controlled.

  • 6.2 The Status Control Data Model

The diagram below illustrates the relationships that are utilised in AVEVA Plant by the Status Control tool.

www.aveva.com
www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

Status Values are created and stored in the dictionary database hierarchy. Within the Constructor Modules a Status Link hierarchy is referenced by model objects. The Status Link also references the Status Value held in the dictionary database.

  • 6.3 Hierarchy Overview

Unique hierarchy structures are required in both Lexicon and the Constructor Modules in order to successfully implement the status control utility. The nature and function of the hierarchy structures are considered in the sections that follow.

  • 6.4 Status Control Hierarchy - Lexicon

New hierarchical elements have been created in Lexicon to facilitate Status Control.

Status World elements (STAWLD) own Status Definitions (STADEF) which in turn own Status Values (STAVAL). An optional level of hierarchy, sitting immediately below the Status World, is the Status Group (STAGRP).

Status Worlds have an administrative function. They may store a number of status groups and definitions. Each group or definition may be associated with a project, design discipline, or PDMS module.

Status Groups are an optional level of hierarchy. They allow a number of definitions to be grouped within a status world. This may be useful where a number of workflows exist within a particular discipline (i.e. different checking requirements within a design discipline).

Status Definitions allow the user to set which model object types the status values will be applicable to in the constructor modules (e.g. PIPE, EQUI, etc.). An initial status value, used when a model object is first controlled, can also be set in the Status Definition.

AVEVA Plant (12.1) Lexicon TM-1308 Status Values are created and stored in the dictionary database hierarchy.

Status Values provide the descriptive terms and numerical values that will be applied to model objects as they progress through the design process.

An objects status changes throughout the design process; therefore it is necessary to update the status value associated with it. This is achieved by setting valid transition values for each status value. From the valid transitions, default settings to Promote and Demote the objects status can then be set. Only one status value can be set for either the Promote or Demote default; however the object can have any defined status values set as a valid transition.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

  • 6.5 Status Control Hierarchy Constructor Modules

Most administrative tasks relating to Status Control are carried out in Lexicon. However additional hierarchy and pseudo attributes have been introduced to the constructor modules. Administrators need to be aware of

these elements if DAC’s is to be implemented or further customisation is carried out.

The hierarchy employed for status control within the constructor modules is hidden from the user. A Status Link World (STLNKW) owns a number of Status Links (STALNK). Contained within the STALNK are a number of pseudo attributes that are used to reference both status values and model objects.

AVEVA Plant (12.1) Lexicon TM-1308 6.5 Status Control Hierarchy – Constructor Modules Most administrative tasks relating

A comprehensive list of pseudo attributes relating to status control is supplied in the Status Control Reference Manual. Simple examples of

customisation and DAC’s are provided in later sections.

AVEVA Plant (12.1) Lexicon TM-1308 6.5 Status Control Hierarchy – Constructor Modules Most administrative tasks relating
  • 6.6 Implementing Status Control A Worked Example

The focus of this example is the creation of the hierarchy elements required in Lexicon. The hierarchy required in the constructor modules is globally distributed with the model objects. As such, Administrators should only ever need to reference such elements, not create them.

This example will consider a simplified workflow that could be implemented for pipe modelling as shown below.

AVEVA Plant (12.1) Lexicon TM-1308 6.5 Status Control Hierarchy – Constructor Modules Most administrative tasks relating

Prior to creating the hierarchy in Lexicon the Administrator must ensure that the MDB selected contains a Dictionary database that can be written to.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

6.6.1 Creating Status Worlds In the Current Element Editor enter the details provided below. Name: PIPE-WORKFLOW
6.6.1
Creating Status Worlds
In
the
Current
Element
Editor
enter
the
details
provided below.
Name: PIPE-WORKFLOW
Desc: PIPE WORKFLOW STATUS MANAGEMENT
A new STAWLD element will be created and displayed
in the Dictionary Explorer.
6.6.2
Creating Status Groups

To create the necessary hierarchy navigate to world level then click the right mouse button. From the context menu select Create > STAWLD: Status Configuration world.

AVEVA Plant (12.1) Lexicon TM-1308 6.6.1 Creating Status Worlds In the Current Element Editor enter the
AVEVA Plant (12.1) Lexicon TM-1308 6.6.1 Creating Status Worlds In the Current Element Editor enter the

The workflow in this example caters for pipes that require stress tests and specialised supports. The following exercise will allow for pipes that only require layout checks.

To distinguish between the two workflows, two Status Groups will be created. One for Critical Pipes, requiring stress and support checks, and one for Non-Critical Pipes. This will allow users in the design module to set a suitable Focus Status to manage each type of pipe.

With the newly created STAWLD selected as the CE, click the right mouse button.

From the context menu select:

Create >STAGRP: Status definitions group.

AVEVA Plant (12.1) Lexicon TM-1308 6.6.1 Creating Status Worlds In the Current Element Editor enter the

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

In the Current Element Editor enter the details provided below.

Name: CRITICAL-PIPES Desc: FOR PIPES WITH STRESS TESTS

AVEVA Plant (12.1) Lexicon TM-1308 In the Current Element Editor enter the details provided below. Name:

A new STAGRP element will be created and displayed in the dictionary explorer.

A second STAGRP is required for the exercise that follows (for Non-critical pipes). In a similar manner create a second STAGRP.

In the Current Element Editor enter the details provided below.

Name: NON-CRITICAL-PIPES Desc: LAYOUT CHECKS ONLY

AVEVA Plant (12.1) Lexicon TM-1308 In the Current Element Editor enter the details provided below. Name:

The two STAGRP elements will be displayed in the Dictionary Explorer and the hierarchy should look similar to this:

AVEVA Plant (12.1) Lexicon TM-1308 In the Current Element Editor enter the details provided below. Name:
  • 6.6.3 Creating Status Definitions

With the newly created STAGRP CRITICAL-PIPES selected as the CE, click the right mouse button.

From the context menu select:

Create > STADEF: Status Definition.

In the Current Element Editor enter the details provided below.

Name: CRITICAL-PIPE-DEFINITION Desc: WORKFLOW FOR CRITICAL PIPES

AVEVA Plant (12.1) Lexicon TM-1308 In the Current Element Editor enter the details provided below. Name:

At

this

stage

the

Initial

Status

for

controlled

model

elements cannot be set, as no Status Values have been defined. For the time being, this field will be left blank.

The STADEF allows the user to define the type of model elements that can be controlled in the constructor modules. This is achieved by setting the Controllable Element Types field in the Current Element Editor.

Click the left mouse button when the pointer is in the blank text box adjacent to the Controllable Element Types field. A browse button will be displayed. Selecting the browse button will display the Select Element Types form.

AVEVA Plant (12.1) Lexicon TM-1308 In the Current Element Editor enter the details provided below. Name:

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

AVEVA Plant (12.1) Lexicon TM-1308 All valid element types are displayed in the upper half of

All valid element types are displayed in the upper half of the form. Above them is a filter text box allowing the user to refine searches for particular element types.

As the status definition will be used for Pipes

in

the

Design application type PIPE in the Filter text box. In the scrollable list below the Filter field select the Pipe element. The Add to List button will now be active. Click the Add to List button to add the Pipe element type to the Chosen Element Types area of the form.

Click the OK button. The Current Element Editor will update the STADEF to show a Controllable Element Type of PIPE.

AVEVA Plant (12.1) Lexicon TM-1308 All valid element types are displayed in the upper half of
  • 6.6.4 Create Status Values

With the necessary hierarchy and controllable elements defined the first status value can now be created.

With the newly created STADEF selected as the CE, click the right mouse button. From the context menu select:

Create > STAVAL: Status Value.

AVEVA Plant (12.1) Lexicon TM-1308 All valid element types are displayed in the upper half of

In the Current Element Editor enter the details provided below.

Name: WORK-PENDING Desc: AWAITING RESOURCES

Both the name and description fields can be viewed in the constructor modules. As such, the description field can be used to supplement the name given to the status value.

AVEVA Plant (12.1) Lexicon TM-1308 All valid element types are displayed in the upper half of

In addition to the name and description fields a Numerical Value can also be associated with a Status Value. The value used may indicate a task completion percentage, a work breakdown code, or other similar parameters. In this case, the numerical value will represent how far through the design process (between 0 and 100) a particular pipe is.

In this case, the Work Pending status value represents a period where work has not started. As such, the numerical value will be left at zero.

The Transitions area of the form governs the relationships between Status Values. As this is the first Status Value this area will be left blank for now. Transitions will be set when all required Status Values have been created.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

In the Dictionary Explorer, navigate to the STADEF CRITICAL-PIPE-DEFINITION. Click the right mouse button and select:

Create > STAVAL: Status Value.

In the Current Element Editor enter the details provided below.

Name: DESIGN Desc: PROVISIONAL LAYOUT Numerical Value: 30

AVEVA Plant (12.1) Lexicon TM-1308 In the Dictionary Explorer, navigate to the STADEF CRITICAL-PIPE-DEFINITION . Click

In a similar manner create the following Status Values:

Name: LAYOUT-CHECKS Desc: CONFIRM LAYOUT Numerical Value: 60

Name: STRESS-CHECKS Desc: CONFIRM STRESS Numerical Value: 70

Name: SUPPORT-CHECKS Desc: CONFIRM SUPPORTS Numerical Value: 80

Name: ISSUED Desc: ISSUED TO DRAFT TEAM Numerical Value: 100

Name: RE-WORK Desc: ADJUSTMENTS REQUIRED Numerical Value: 50

The status of a model object should be controlled in a series of suitably sized steps that are appropriate to the work flow. For example, there is little benefit in changing the status of an object from Not Started to Completed in one step. To ensure that users make suitable status changes, Valid Transitions should be defined for each Status Value.

Due to the cyclic nature of design processes the work flow associated with a model object may be quite complex. To address this difficulty it is possible to associate a number of Valid Transitions with each Status Value.

Make the STAVAL LAYOUT-CHECKS the current element. Click the left mouse button when the pointer is in the blank text box adjacent to the Valid Transitions field. A browse button will be displayed. Selecting the browse button will display the Select Valid Status Transitions form.

In this simple example two workflows are possible from this status value. If the work is accepted, the status may be changed to show that layout checks have been completed and stress checks can now be considered.

If the work is rejected, adjustments will be required and re-work must occur. Selecting the STRESS-CHECKS and RE-WORK checkboxes will account for these two scenarios.

AVEVA Plant (12.1) Lexicon TM-1308 In the Dictionary Explorer, navigate to the STADEF CRITICAL-PIPE-DEFINITION . Click

Click the OK button to accept the transition values. The STAVAL will update to show the valid transitions.

www.aveva.com
www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

In the constructor modules the user will also be able to edit model objects by promoting or demoting the status. The promotion and demotion statuses are set in the Transitions area.

AVEVA Plant (12.1) Lexicon TM-1308 In the constructor modules the user will also be able to

An option list is provided adjacent to the Promote field. Selecting the drop down arrow will display the Valid Transitions for the STAVAL.

In

this

instance

CHECKS.

select

the

Status

Value

STRESS-

The same process should be repeated for the Demote field, this time setting the Status Value to RE-WORK.

The Current Element Editor will update to reflect the new values.

AVEVA Plant (12.1) Lexicon TM-1308 In the constructor modules the user will also be able to

Transition settings need to be made for each of the Status Values. Return to each Status Value and set the following valid values and Promote/Demote default settings:

Name: WORK-PENDING Valid Transitions: DESIGN Promote: DESIGN Demote: Leave Blank

Name: DESIGN Valid Transitions: LAYOUT-CHECKS Promote: LAYOUT CHECKS Demote: Leave Blank

Name: LAYOUT-CHECKS Valid Transitions: RE-WORK, STRESS-CHECKS Promote: STRESS-CHECKS Demote: RE-WORK

Name: SUPPORT-CHECKS Valid Transitions: ISSUED, RE-WORK Promote: ISSUED Demote: RE-WORK

Name: ISSUED Valid Transitions: Leave Blank Promote: Leave Blank Demote: Leave Blank

Name: RE-WORK Valid Transitions: LAYOUT-CHECKS Promote: LAYOUT CHECKS Demote: Leave Blank

Name: STRESS-CHECKS Valid Transitions: RE-WORK, SUPPORT-CHECKS Promote: SUPPORT-CHECKS Demote: RE-WORK

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

Once all the transitions are set save work then switch to the Design module. Use the login details provided by the Trainer. They will typically be similar to this:

AVEVA Plant (12.1) Lexicon TM-1308 Once all the transitions are set save work then switch to
  • 6.6.5 Testing Status Control in Design

Project

Training

Username

A.PIPER

Password

A

MDB

A-PIPING

In the Design module, select Display > Status Controllerfrom the main menu. The Status Controller form will be displayed.

AVEVA Plant (12.1) Lexicon TM-1308 Once all the transitions are set save work then switch to

The Status Controller form will initially be blank unless Status Layouts have been created previously. A Status Layout will be created to track the progress of a number of pipes.

Select the Status Layout option list and select the New Layout… option.

The Select Status Columns form will be displayed. Select the checkbox adjacent to WORKFLOW FOR CRITICAL PIPES.

This form displays the description associated with the Status Definitions created in Lexicon.

Selecting the checkbox will expand the column listing available for the status definition. By default, Status Layouts are initially created with up to four columns.

Three of the columns reflect fields populated when the Status Values are created in Lexicon; Name, Description, and Numeric value. The fourth column allows comments relating to status changes to be recorded.

The user can select which columns are displayed by de- selecting checkboxes as required. If additional columns are required to display other PDMS attributes (e.g. Owner) they can be added after the initial layout is created.

Leave all columns selected then click the OK button.

The Status Controller form will be populated with all PDMS elements that have their Type set to Pipe, as this was the element type specified for this Status Definition in Lexicon.

AVEVA Plant (12.1) Lexicon TM-1308 Once all the transitions are set save work then switch to
www.aveva.com
www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

AVEVA Plant (12.1) Lexicon TM-1308 Save the layout by selecting the Save Status Layout button from

Save the layout by selecting the Save Status Layout button from the Status Controller form.

The Save Layout As form will be displayed. Enter the name Detailed in the text field then click the OK button.

The Status Controller form will update to reflect the name of the saved layout. Although the layout contains a range of pipes, none of them are controlled by the Status Definition at this stage.

To apply the status definition to the pipes select a range of pipes in the grid area of the Status Controller form (now titled Detailed).

Standard windows Shift and Control key functionality can be used in this grid.

With the mouse pointer over one of the selected grid entries click the right mouse button. From the context menu select the Edit Status… option.

AVEVA Plant (12.1) Lexicon TM-1308 Save the layout by selecting the Save Status Layout button from
AVEVA Plant (12.1) Lexicon TM-1308 Save the layout by selecting the Save Status Layout button from
AVEVA Plant (12.1) Lexicon TM-1308 Save the layout by selecting the Save Status Layout button from

From the resulting Status form select AWAITING RESOURCES from the Value option list then click the OK button.

The Status Controller form will update to reflect the new status of the controlled pipes.

Select one of the pipes then select Promote from the right click context menu in the Status Controller form.

Continue modifying the status of the controlled pipes, checking that promote and demote commands update the status to the correct value.

AVEVA Plant (12.1) Lexicon TM-1308 Save the layout by selecting the Save Status Layout button from

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

Exercise 5 Creating Status Values

Return to the Lexicon module and open the STAWLD PIPE-WORKFLOW. Navigate to the STAGRP NON-CRITICAL-PIPES and create the necessary definitions and values to support the workflow below.

AVEVA Plant (12.1) Lexicon TM-1308 Exercise 5 – Creating Status Values Return to the Lexicon module

Test the Status Definition in Design. Try creating a Status Focus for Critical and Non-Critical pipes within a single Status Layout.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

  • 6.7 Status Control Customisation

Status Control supports an extensive range of customisation options in the areas of Data Access Control, PML and C#. Extensive consideration of this topic is outside the scope of this training course, however a brief overview of possible functionality is provided in the sections that follow.

  • For details of customisation requirements please refer to the Status Control Reference Manual.

    • 6.8 Data Access Control

The Status Control utility can be coupled closely with Data Access Control to preserve data integrity. A variety of activities can be restricted. For example, only users with particular access rights may change the status of an object once it has reached a certain stage; or, only certain users can assign or remove status from a controlled object. Suitable error messages can also be generated to alert the user of any restriction.

Provided below are two example Data Access Control rules. They have been created on the basis of Roles where the first PEROP grants all rights on all elements and attribute classes, then successive PEROP’s deny some rights under specific conditions.

  • 6.8.1 Prevent Modification of an Object of a Certain Status

It may be desirable to ensure that a model object cannot be changed once it has reached a certain status value. For example, if an item of equipment was very close to being issued but needed sign off, no further modifications would be required. For the purpose of this example, this state could represent a Design Status of 90%.

The Administrator can cater for this situation by creating a PEROP that denies modify and delete operations on equipment for all attributes, with the qualifying condition that the Design Status is greater than or equal to 90%. The syntax for the condition would be:

COND ( ATTRIB STVNUM(ID /DesignStatus ) GE 90 )

Expressions relating to Status Values usually require the name of the owning Status Definition to be provided as a qualifier. In this example /DesignStatus is the name of the Status Definition.

A suitable error message would also need to be returned to the user e.g. DAC: You may not modify an object that is ready for issue.

  • 6.8.2 Prevent Promotion of an Object by Certain Users

It may be necessary to restrict which users are capable of promoting a model object once the object reaches a certain status value. For example, a model object has been promoted to a Check Stress status by a designer, but the Administrator wants to ensure that only a supervisor promotes the status to Checked.

In this case the Administrator should create a PEROP that denies modify and delete operations on STALNK (status link) elements for attribute VALREF (status value reference) with the qualifying condition that the Design Status is currently at Check Stress. The syntax for the condition would be:

COND ( ATTRIB OWNER OF VALREF EQ ID /Design Status AND ATTRIB DESC OF VALREF EQ

‘Stress Check’ )

As with the previous example, a suitable error message should be provided to the user e.g. DAC: You may not modify an object that awaits stress checks.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

  • 6.9 Auto Colours

Status Values can be used in the Element Rules for Auto Colours. If suitable Element Rules are defined, and Auto Colour rules added, then status distinctions can be made in the 3D model. For example, uncontrolled equipment could be shown in red, while a range of other colours could be used to reflect key status values. Typical syntax for element rules are shown below.

The use of Auto Colours is not applicable to Status Control definitions that are applied to the DRAFT application.

  • 6.9.1 Equipment with Design Status Not Controlled

If the user wishes to show equipment items that are not controlled in a different colour the element rule syntax would be:

Rule Name: Equipment Not Controlled Types: EQUI Rule: badref( attrib stvval( /EquipmentDesignStatus ) )

Where EquipmentDesignStatus is the name of the STADEF defined in Lexicon.

  • 6.9.2 Equipment with Design Complete

If the user wishes to show equipment items that are completed in another colour the element rule syntax would be:

Rule Name: Equipment Complete Types: EQUI Rule: attrib stvnum( /EquipmentDesignStatus ) eq 100

Where EquipmentDesignStatus is the name of the STADEF defined in Lexicon.

  • 6.10 PML Customisation

Status Control operations can be carried out using PML. Any operation that can be carried out using the Status Controller can also be done using appropriate PML objects and syntax.

By incorporating an event mechanism, specific company and project requirements can be accommodated. User methods can be added as event handlers and called with single array arguments. Both Status change events and database change events can be catered for in this way.

Status data can be manipulated using the PML object statusProjectHandler.pmlobj. This object encapsulates a number of core routines that could also be used directly.

  • Please refer to the Status Control Reference Manual for further details.

    • 6.11 .Net Customisation (C#)

Customisation can be undertaken in .NET applications. This may be as an alternative to, or in conjunction with the PML customisation. Where such customisation is carried out using C#, a number of Classes are available to the user. They have similar functionality to the PML objects and can be used status values and events.

  • Please refer to the Status Control Reference Manual and PDMS .Net documentation for further information.

www.aveva.com

AVEVA Plant (12.1) Lexicon TM-1308

  • 6.12 Status Control Customisation A Worked Example

For the purpose of reporting project progress, it is often desirable to run an overview status definition in conjunction with a detailed status definition. Returning to the workflow considered in the previous worked example, an additional overview status definition will be added. The diagram below shows the relationship between the two status definitions.

AVEVA Plant (12.1) Lexicon TM-1308 6.12 Status Control Customisation – A Worked Example For the purpose

Design Phase I - Initial design activities, ending when a pipe is promoted to the status value Stress Checks.

Design Phase II - Starts when a pipe has the status value set to Stress Checks and finishes when the status value Issued is achieved.

Design Phase III