Getting Started With Pd Ms 116 Sp 1

Getting Started with PDMS Version 11.6SP1

pdms1161/Getting Started with PDMS issue 260605

PLEASE NOTE:

AVEVA Solutions has a policy of continuing product development: therefore, the information contained in this document may be subject to change without notice. AVEVA SOLUTIONS MAKES NO WARRANTY OF ANY KIND WITH REGARD TO THIS DOCUMENT, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

While every effort has been made to verify the accuracy of this document, AVEVA Solutions shall not be liable for errors contained herein or direct, indirect, special, incidental or consequential damages in connection with the furnishing, performance or use of this material. 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.

Copyright 1991 through 2005 AVEVA Solutions Limited All rights reserved. No part of this document may be reproduced, stored in a retrieval system or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without prior written permission of AVEVA Solutions. The software programs described in this document are confidential information and proprietary products of AVEVA Solutions or its licensors.

For details of AVEVA's worldwide sales and support offices, see our website at http://www.aveva.com

AVEVA Solutions Ltd, High Cross, Madingley Road, Cambridge CB3 0HB, UK

Revision History

Date Version Notes

October 2003

11.5 New manual at this PDMS version

Sept 2004 11.6 Updated for this release. June 2005 11.6SP1 Minor corrections and updates.

VANTAGE PDMS Getting Started with PDMS Revision-History-i Version 11.6SP1

Revision History

Revision-History-ii VANTAGE PDMS Getting Started with PDMS Version 11.6SP1

Contents

1 The scope of this guide................................................................................1-1 1.1 What it includes ..........................................................................................................1-1 1.2 What it excludes .........................................................................................................1-1 1.3 Who it is meant for......................................................................................................1-1

1.3.1 Assumptions......................................................................................................1-2 1.4 How the manual is set out ..........................................................................................1-2 1.5 Text conventions.........................................................................................................1-2

2 PDMS functions ............................................................................................2-1 2.1 PDMS and what it can do for you ...............................................................................2-1 2.2 Using PDMS in the Plant Design process ..................................................................2-3 2.3 PDMS modules...........................................................................................................2-3

2.3.1 Design modules.................................................................................................2-3 2.3.2 Drafting modules ...............................................................................................2-4 2.3.3 Catalogue and specification management modules..........................................2-6 2.3.4 Project administration modules .........................................................................2-7

3 Finding out more the user documentation and the online help ............3-1 3.1 The User Documentation............................................................................................3-1

3.1.1 Accessing and using the documentation...........................................................3-1 3.1.2 The content of the documentation.....................................................................3-2

3.2 The online help ...........................................................................................................3-6 3.2.1 Accessing and using the help............................................................................3-6 3.2.2 The help icons ...................................................................................................3-7

4 The PDMS databases ...................................................................................4-1 4.1 Introduction.................................................................................................................4-1 4.2 The database types ....................................................................................................4-1

4.2.1 The Project ........................................................................................................4-1 4.2.2 DESIGN database.............................................................................................4-2 4.2.3 PADD database.................................................................................................4-2 4.2.4 ISOD database..................................................................................................4-2 4.2.5 CATALOGUE database.....................................................................................4-3 4.2.6 LEXICON database...........................................................................................4-3 4.2.7 PROPERTIES database....................................................................................4-3 4.2.8 SYSTEM database............................................................................................4-3 4.2.9 COMMS database.............................................................................................4-4 4.2.10 MISC database ...............................................................................................4-4 4.2.11 TRANSACTION database ..............................................................................4-4

4.3 PDMS project structure...............................................................................................4-4 4.3.1 Other projects....................................................................................................4-5

4.4 The relationships between databases ........................................................................4-5 4.5 Multiple databases (MDBs).........................................................................................4-6

VANTAGE PDMS Getting Started with PDMS Contents-i Version 11.6SP1

Contents

5 How PDMS data is stored ............................................................................5-1 5.1 The Design database element types ..........................................................................5-2

5.1.1 WORLD .............................................................................................................5-2 5.1.2 SITE ..................................................................................................................5-2 5.1.3 ZONE ................................................................................................................5-2 5.1.4 EQUIPMENT (EQUI) .........................................................................................5-2 5.1.5 SUB-EQUIPMENT (SUBE) ...............................................................................5-3 5.1.6 PRIMITIVES ......................................................................................................5-4 5.1.7 STRUCTURES (STRU).....................................................................................5-4 5.1.8 FRAMEWORK (FRMW) ....................................................................................5-4 5.1.9 SUB-FRAMEWORK (SBFR) .............................................................................5-5 5.1.10 STRUCTURAL COMPONENTS.....................................................................5-5 5.1.11 PIPE................................................................................................................5-5 5.1.12 BRANCH (BRAN) ...........................................................................................5-6 5.1.13 PIPING COMPONENTS.................................................................................5-6

5.2 Attributes in PDMS .....................................................................................................5-7 5.2.1 NAME ................................................................................................................5-8 5.2.2 TYPE .................................................................................................................5-8 5.2.3 LOCK.................................................................................................................5-8 5.2.4 OWNER.............................................................................................................5-8 5.2.5 POSITION .........................................................................................................5-9 5.2.6 ORIENTATION................................................................................................5-10 5.2.7 LEVEL .............................................................................................................5-10 5.2.8 OBSTRUCTION ..............................................................................................5-10 5.2.9 HEIGHT...........................................................................................................5-11 5.2.10 DIAMETER ...................................................................................................5-11

5.3 UDAs (User Defined Attributes)................................................................................5-11

6 Using PDMS ..................................................................................................6-1 6.1 Getting into PDMS......................................................................................................6-1

6.1.1 Working in a module..........................................................................................6-2 6.1.2 Changing to another module .............................................................................6-2

6.2 Getting out of PDMS...................................................................................................6-3 6.3 Internationalisation .....................................................................................................6-5 6.4 Customisation facilities; the programmable macro language .....................................6-6

7 Basic GUI features........................................................................................7-1 7.1 Using the mouse.........................................................................................................7-1 7.2 Using forms.................................................................................................................7-1

7.2.1 Using text boxes................................................................................................7-2 7.2.2 Using drop-down lists ........................................................................................7-2

7.3 Using menus...............................................................................................................7-2

Select Position>At>Explicit means: ....................................................................7-2 7.4 Using the toolbars.......................................................................................................7-3 7.5 Using the status bar....................................................................................................7-3 7.6 More on using forms...................................................................................................7-3

7.6.1 Using option buttons..........................................................................................7-4 7.6.2 Using check boxes ............................................................................................7-4 7.6.3 Using scrollable lists..........................................................................................7-4 7.6.4 Using action buttons..........................................................................................7-4

7.7 Responding to alert forms...........................................................................................7-5

Contents-ii VANTAGE PDMS Getting Started with PDMS Version 11.6SP1

Contents

7.8 Dockable Windows, Menu Bars and Tool Bars ..........................................................7-5 7.9 Using commands ........................................................................................................7-5

7.9.1 Why use command syntax? ..............................................................................7-6

8 Basic operations in PDMS ...........................................................................8-1 8.1 Querying .....................................................................................................................8-1 8.2 Current element and current list position ....................................................................8-2 8.3 Navigating to a given element ....................................................................................8-4

8.3.1 The Design Explorer..........................................................................................8-4 8.3.2 The Members List..............................................................................................8-5 8.3.3 Other Explorers .................................................................................................8-6 8.3.4 My Data .............................................................................................................8-6

8.4 Modifying the content of a database...........................................................................8-6

9 Interfaces to other systems .........................................................................9-1 9.1 VANTAGE Plant Enginerring (VPE) ...........................................................................9-1

9.1.1 VPE Workbench ................................................................................................9-1 9.1.2 Introducing the VPE Workbench user interface ................................................9-2 9.1.3 VPE P&ID..........................................................................................................9-4

9.2 VANTAGE Plant Resource Management (VPRM) .....................................................9-5 9.2.1 VPRM Interfaces ...............................................................................................9-6 9.2.2 VPRM Facilities .................................................................................................9-7 9.2.3 VPRM Architecture ............................................................................................9-8 9.2.4 Introducing the VPRM user interface ................................................................9-8

9.3 VPE and VPRM Interfaces - Summary.......................................................................9-9 9.4 VANTAGE Plant Design Model Management ..........................................................9-10

9.4.1 The Model Management System core facilities...............................................9-11 9.4.2 Introducing the Model Management System GUI............................................9-11

9.5 VANTAGE Enterprise NET (VNET) ..........................................................................9-12 9.6 VANTAGE Plant Design Global................................................................................9-12

9.6.1 The Transaction database...............................................................................9-13 9.7 VANTAGE Plant Design Review ..............................................................................9-13 9.8 The Data Exchange Interfaces .................................................................................9-14

VANTAGE PDMS Getting Started with PDMS Contents-iii Version 11.6SP1

Contents

Contents-iv VANTAGE PDMS Getting Started with PDMS Version 11.6SP1

1 The scope of this guide

1.1 What it includes

This manual is designed to introduce you to PDMS as a system and how it fits into AVEVAs VANTAGE product family. The manual gives an introduction to what PDMS does and how it does it, including introductions to:

the PDMS modules and what they do the PDMS databases the PDMS user interface

More detailed information, particularly on the PDMS modules and the databases they use, can be found elsewhere in the PDMS user documentation set. See Chapter 3.

1.2 What it excludes

This manual does not include information about: Facilities which are related to the computer operating system from which PDMS

is entered. For information about these, see your computer operating system manuals or ask your system administrator.

Facilities which apply only to a small proportion of PDMS modules. For information about these, see the user documentation or online help for the relevant modules.

Detailed information on any of the PDMS modules or databases Facilities needed to create macros and use the Programmable Macro Language

(PML) to create intelligent macros, new interfaces etc. Youll find information on these topics in the VANTAGE Plant Design Software Customisation User Guide and Software Customisation Reference Manual.

1.3 Who it is meant for

The manual is written for a new user who is: coming to a 3D Plant Design Management System (i.e. PDMS) for the first time or migrating from a similar 3D system

Both types of user will probably, but not necessarily, have attended a PDMS Basic Training course.

VANTAGE PDMS Getting Started With PDMS 1-1 Version 11.6SP1

The scope of this guide

1.3.1 Assumptions

It is assumed that the reader: is familiar with typical Intel PC hardware and Microsoft Windows 2000 and/or

XP has a reasonable understanding of the principles and jargon of process plant

design

1.4 How the manual is set out

The manual is organised as follows: Chapter 2 introduces the basic steps to be taken to design a Process Plant using

PDMS, and introduces the PDMS modules. Chapter 3 describes the User Documentation set and the online help Chapters 4 and 5 introduce the PDMS databases and the way data in PDMS is

structured and how it is stored Chapters 6 to 8 describe how to get in to PDMS and use it perform simple

operations. Chapter 9 introduces the other products in the VANTAGE suite, which PDMS

can interface with. Appendix A is a glossary of PDMS terms and abbreviations.

Note that this guide does not always provide full details of menus and forms associated with these topics. For this information see the PDMS Design online help. Direct references may be made to topics within the online help, the following device being used to indicate such references:

: The 3D View Window; Creating a 3D View Window

1.5 Text conventions

This guide uses the following text conventions:

Serif for the majority of the text.

Bold to highlight important information, and to introduce special terminology.

Serif italic to denote internal cross references and citations.

Sans-serif to denote keys on your keyboard.

Sans-serif bold for menu names and options, and for the names of forms.

1-2 VANTAGE PDMS Getting Started With PDMS Version 11.6SP1


Typewriter text output to the screen, including text that you enter yourself using the keyboard. Also for text within a form

Note that this manual may refer to the PDMS online help, but it will not always provide full details of menus and forms associated with specific help topics. For this information see the relevant online help. Direct references may be made to topics within the online help, the following device being used to indicate such references:

: The Current Session Units form


2 PDMS functions

PDMS is part of AVEVAs VANTAGE suite of Plant Design products. PDMS can interact with the other two principal members of the VANTAGE suite, VANTAGE Plant Engineering (VPE) and VANTAGE Project Resource Management (VPRM) (see Chapter 9). Chapter 6 introduces the principles of using PDMS.

2.1 PDMS and what it can do for you

PDMS (the Plant Design Management System) enables you to design a 3D computer model of a process plant. PDMS allows you to see a full colourshaded representation of the plant model as your design progresses, adding an extremely impressive level of realism to traditional drawing office techniques. In the model you can store huge amounts of data referring to position, size, part numbers and geometric relationships for the various parts of the plant. This model becomes a single source of engineering data for all of the sections and disciplines involved in a design project. All this information is stored in databases. There are many different output channels from the databases through which information can be passed on. These range from reports on data stored in the databases, fully annotated and dimensioned engineering drawings, to full colourshaded 3D walkthrough capabilities which allow you to visualise the complete design model.

Figure 2-1 Different types of output from PDMS


PDMS functions

Even with the advanced features of PDMS, the main form of communication between the plant designer and the fabricator remains the drawings. Without engineering drawings the task of building a plant would be almost impossible. To meet this requirement, PDMS can produce numerous types of drawing, ranging from complex 3D illustrations to fully annotated and dimensioned arrangement drawings and piping isometrics. All the data in a PDMS design would be of little value without the ability to ensure the quality of the design information. PDMS contributes to the quality of the design in the following ways:

Ensures consistent and reliable component data In a design environment which uses only 2D drawing techniques, the size of each fitting must be decided before it can be drawn. This is a time-consuming and error-prone process, where often the design errors are only found during the erection stage of the project. With PDMS, all piping component sizes and geometry are predefined and stored in a catalogue, which cannot be changed by the designer. This ensures that all items are true to size and are consistent throughout the design, no matter how many users there are on the project.

Adheres to definable engineering specifications Piping specifications and steelwork catalogues, stating precisely the components to be used, are compiled for the purpose of ensuring consistent, safe and economic design. Design applications for Piping, Hangers and Supports, HVAC, Cable trays and Steelwork all use specifications to assist component selection.

Ensures correct geometry and connectivity There are many different ways of making design errors, such as incorrect fitting lengths, incompatible flange ratings, or simple alignment errors. PDMS can check all of these using data consistency procedures built into the system to check all or individual parts of the design model.

Avoids component interferences Despite a wealth of skill and experience in plant design, traditional drawing office techniques are still subject to human error. Laying out complex pipe runs and general arrangements in confined areas using conventional 2D methods, inevitably leads to clashes between elements, which are trying to share the same physical space. PDMS enables you to avoid such problems in two ways: 1. By viewing the design interactively during the design process, allowing

visual checks on the model from different viewpoints. Potential problems can thus be resolved as they arise.

2. By using the powerful clash checking facility within PDMS, which will detect clashes anywhere in the plant. This can be done interactively or retrospectively.

Annotation and dimensions obtained directly from the design database Extracted information from the PDMS database, such as arrangement drawings, piping isometrics and reports, will always be the latest available as it is stored only in one source. Through the course of a project, information is constantly


PDMS functions

changing and drawings need to be reissued. When this happens, drawings, reports etc can be updated and reissued with the minimum of effort.

2.2 Using PDMS in the Plant Design process

The sequence of operations (greatly simplified) in a new plant design project would be: Create the project and set up administrative controls (using the PDMS Admin

module). Create the Catalogue and Specification data from which standard design

Components can be selected (using the Paragon and Specon modules). Design the various parts of the plant, referencing items from the catalogues

(using the Design module). Check the design for errors and inconsistencies (Design). Document the design in the form of drawings (general arrangement,

construction, assembly, and isometric), reports and material lists (Draft and Isodraft modules).

You may also wish to transfer design data to or from other systems at various stages.

2.3 PDMS modules

PDMS is split into a number of modules which are used at different stages in the plant design process. Chapter 3 contains details of the PDMS user documentation, which describes the PDMS modules and how to use them.

2.3.1 Design modules

Design Design is the main, graphically driven constructor module within PDMS. Design enables a full sized three-dimensional plant model to be defined in the Design database, with selected views of the current state of the design shown on the graphics screen as the design progresses. All parts of the design (including equipment, and piping and structural steelwork layouts) can be created. Component selection is provided through Specifications that dictate which Catalogue Components can be used. Each part of the design model can be displayed in colour-shaded solid colour-coded representations for ease of interpretation. Design can check for interferences (clashes) between items created in the design. There is a very flexible reporting capability that can be used to produce a wide variety of design documents - from bulk Material Take Off to detailed nozzle schedules. Piping isometrics can be previewed in Design (without having to switch to the Isometric generation module, Isodraft).


PDMS functions

Figure 2-2 A typical Design 3D View Spooler Spooler is used for pipework spooling. It allows the designer to split the pipework design into logical sections (spools) ready for fabrication. The spool data can then be output as isometric drawings using Isodraft (see below).

2.3.2 Drafting modules

Draft Draft enables dimensioned and annotated scale drawings of selected parts of the design model to be produced. All information needed to create the drawing is accessible via a single drawing database, which extracts data to be used for dimensioning directly from the Design database. Annotation can be in the form of labels attached to design elements, or 2D annotation such as drawing notes, or drawing frames, tables, lines etc. Annotation attached to a Design data element on the drawing will move if the 3D position of the element changes. Dimensions are recalculated automatically every time the drawing is updated. A Design model 3D view can be previewed in Draft to aid assembly of a drawing in the 2D view.


PDMS functions

Figure 2-3 A typical Draft annotated and dimensioned drawing Isodraft Isodraft produces automatically annotated and dimensioned piping isometric drawings, with associated material lists, of specified sections of the plant pipework. The content and style of the drawings can be chosen to suit the needs of pipe fabricators and/or erectors and can include a wide range of optional features to suit local requirements. Other facilities include:

Full material lists. Automatic spool identification. Automatic splitting of complex drawings. User-defined drawing sheets.


PDMS functions

Figure 2-4 A typical Isodraft piping isometric

2.3.3 Catalogue and specification management modules

Paragon Used to generate and modify catalogues, with facilities for catalogue component construction with visual control (including 3D colour-shaded representations of the item being designed). The catalogues in PDMS serve a similar purpose to the manufacturers catalogues, which you would refer to when using conventional design methods. The PDMS component catalogue is used to specify the geometry, connection information, obstruction and detailing data of steelwork, piping, and HVAC and cable tray components. It should be noted that, where the design data is specific to a particular design, catalogues and specifications may be specific to a company but general to a number of projects in that company. For example, the same catalogue component may also appear in other designs proceeding at the same time.


PDMS functions

Figure 2-5 A typical Paragon catalogue component display Specon Used to create or modify the component specifications within the catalogue database. Specifications define the suitability of catalogue components for particular types of use. Propcon Used to create or modify the properties database, which holds details of those properties of the components and materials which may be needed for stress analysis or safety auditing of all or part of a design.

2.3.4 Project administration modules

Admin Large plants designed using PDMS will usually be broken down into individual areas (either physical areas or design areas), depending on the physical size, complexity and configuration of the plant. On a large Project, the System Administrator will first agree with Project and Design Management, the breakdown of the PDMS Project into sections which:

Are relevant to the needs of project reporting and control. Form reasonable design subdivisions with sensible match-lines and design

content. Enable enough designers to work in parallel with simultaneous access to carry

out their design tasks.


PDMS functions

In much the same way as in a design office (with its section leader, draughts people, etc.), PDMS has Teams, the members of which are called Users. These Teams can consist of any number of Users and can be organised by discipline or physical work areas. The main features are:

Access Control (Teams and Users) Databases Multiple Databases (MDBs) Database management functionality

Admin includes a database integrity checking utility, used to check for inconsistencies in the contents of the databases and to derive statistical information about the use of the database storage capacity. Admin also allows the System Administrator to reconfigure a project. This may be necessary:

to compact databases at intervals, freeing disk space to upgrade PDMS projects when the database structure changes to compare the contents of two similar databases; for example, to create a

modification record Lexicon Used by the System Administrator to set up user-defined attributes. Attributes defined in this way are held in a Lexicon (or dictionary) database and may then be assigned to elements in other databases as required. UDAs allow additional information to be stored in the databases and extracted into drawings and reports.


3 Finding out more the user documentation and the online help

PDMS comes with an extensive set of user documents and online help files. This chapter explains how to access these resources and how to make the best use of them.

3.1 The User Documentation

3.1.1 Accessing and using the documentation

The user documentation is provided as a set of Acrobat .pdf files on the PDMS product CD. After installing PDMS, the user documentation may be found at (for example) C:\AVEVA\Pdms11.6\manuals\pdms116. This folder will contain a .pdf file called iindex.pdf, which is a contents list for the documentation set. Provided you have the Acrobat Reader correctly installed on your workstation, double-clicking on the will give a display something like:

Using the mouse to point at one of the documents in the list and clicking the left-hand mouse button will display the selected document in the Acrobat Reader window. From here it can be read on-screen, printed and searched through using the Acrobat Reader facilities.


Finding out more the user documentation and the online help

If you are unsure which document contains information on the topic you are interested in, use the Acrobat catalogue search facility. This is accessed from the button on the Acrobat Reader toolbar. Typing a keyword to search for will result in a (selectable) list of all the documents in the contents list which contain that keyword.

3.1.2 The content of the documentation

Broadly speaking, the supplied user documentation may be divided into three classes: Reference Manuals User Guides Others

Reference Manuals contain detailed information about the PDMS databases and facilities, usually at module level. User Guides (including Tutorial guides) tell you how to use PDMS to perform a particular task, and contain worked examples. Other manuals do not fit easily into either of the above classes, for example the PDMS User Bulletin. Also, there are manuals which, strictly speaking, are not PDMS-specific but which are included in the PDMS user documentation set because they are still relevant to PDMS. In the order of the .pdf document contents list, the documents are:

Title Description

User Bulletin Tells you about the new features and bug fixes in the current version of PDMS Installation Guide Tells you how to install the current version of PDMS Structural Design Using PDMS

Tells you how to use PDMS to produce a connected steelwork structure; includes a hands-on tutorial exercise.

Support Design Using PDMS

Tells you how to use PDMS to create pipe hangers and supports; includes a hands-on tutorial exercise.

Pipework Design Using PDMS

Tells you how to use PDMS to create interconnected piping networks; includes a hands-on tutorial exercise.

HVAC Design Using PDMS, Volume 1

Tells you how to use PDMS to create interconnected HVAC networks; includes a hands-on tutorial exercise.

HVAC Design Using PDMS, Volume 2

Contains HVAC Design and Catalogue database reference material

Reporting from PDMS Tells you how to use the reporting facilities in PDMS; includes a hands-on tutorial exercise.

Monitor Reference Manual

Describes the command syntax available in the Monitor module. Useful if you wish to produce a customised interface, write macros or set up batch files.



Title Description

Draft Administrator Application User Guide

Describes how to set up the Libraries used by the PDMS Draft applications. For System Administrators.

AutoDRAFT User Guide

Describes how to use the AutoDRAFT AutoCAD application in conjunction with drawings produced by PDMS Draft and Isodraft.

Draft User Guide The definitive Draft reference manual; mainly command syntax but with many illustrated examples; useful for those wishing to customise the interface or write macros.

Drawing Production Using PDMS

Tells you how to use PDMS to create 2D drawings; includes a hands-on tutorial exercise.

Isodraft User Guide Introduces Isodraft, PDMSs isometric plotting facility. Explains the concepts underlying Isodraft and describes how to tailor the options to meet your own requirements.

Isodraft Reference Manual

Describes the command syntax available to control the production of isometric drawings; useful for those wishing to customise the interface or write macros. Also shows the default symbol keys (SKEYs) that are used to plot the drawings, and gives examples of plotfiles. Aimed at experienced PDMS users and system administrators.

Paragon Reference Manual

Describes the command syntax available for designing catalogue components; useful for those wishing to customise the interface or write macros.

Plant Design Conventions for Catalogues and Specifications

Describes the conventions to be adhered to when constructing PDMS Catalogues and Specifications, if data inconsistencies within a project are to be avoided. Intended for specialists who are responsible for building up and maintaining the standard Catalogue databases within a PDMS project team.

Admin Command Reference Manual

Describes the PDMS Admin commands for Standard (non-Global) and Global projects. Written for System Administrators who are already experienced Admin users and who wish to write macros or use command input rather than the GUI.

Admin User Guide Describes how (using the GUI) to set up and administer PDMS projects. Written for System Administrators.

SAINT Reference Manual

Describes, the PDMS Structural Analysis Interface module, an interface to the GTSTRUDL and STAAD-III packages, used for the stress analysis of structural steelwork.

Access Stairs and Tells you how to add access features to structural steelwork



Title Description Ladders User Guide created using PDMS; includes a hands-on tutorial exercise.

Data Access Routines User Guide

Describes the use of a set of FORTRAN 77 subroutines which may be incorporated into user-written software for the purposes of navigating and manipulating the data held within a PDMS project. Can be used for the creation of interfaces to other software packages, e.g. material take-off, pipe stress, isometrics, etc.

Plot User Guide Explains how to use the Plot stand-alone graphical plotting utility to interpret plotfiles in a range of pseudo-code formats, as produced by a number of AVEVA (and third party) programs.

Data Checker Utility User Guide

Describes how to allow data consistency checking software written in AVEVAs Programmable Macro Language (PML) to be added to PDMS Design.

Pipework Spooling Using PDMS

Tells you how to use PDMS to produce Pipework Spools from existing Pipework data; includes a hands-on tutorial exercise.

Introduction to PDMS Design Templates

Tells you how to use the facilities provided in PDMS for the creation of Design Templates; includes a hands-on tutorial exercise.

Design Graphical Model Manipulation User Guide

Introduces the graphical facilities available in both the Model Editor 3D View and the Model Editor itself.

Design Reference Manual Part 1

Describes general Design commands, which are used, for example, for setting up the display, and querying and navigating around the Design database. Useful for those who wish to write macros or use command input rather than the GUI.


Describes the commands for creating database elements and setting their attributes.


Contains details of all the elements which can be created in the Design database, their position in the database hierarchy and their attributes.


Describes the Design Utilities for data consistency checking and clash detection, and for exporting Design data to programs such as Review.

Industrial Building Design Using PDMS

Tells you how to use PDMS to carry out the design and documentation of interconnected walls and floors; includes a hands-on tutorial exercise.

Propcon Reference Describes the commands for creating and editing the



Title Description Manual Properties database.

Specon Reference Manual

Describes the commands for creating used to create or modify Specification (SPEC) elements in Catalogue Database.

Lexicon Reference Manual

Describes how to create user-defined attributes (UDAs) for use in the Design, Draft and Catalogue databases.

Plant Design Software Customisation Guide

Describes how to use PML, AVEVAs Programmable Macro Language. Should be used together with the Plant Design Software Customisation Reference Manual.

Plant Design Software Customisation Reference Manual

The Reference Manual for PML; intended for users who are already familiar with PML.



3.2 The online help

The online help exists to provide you with assistance with a particular feature of PDMS as you are using that feature, down to form level. (See Chapter 7 for more details of forms and menus.) The online help does not attempt to provide a structured narrative, although much reference material does exist within the help.

3.2.1 Accessing and using the help

Online help exists for all PDMS modules with a graphical user interface, namely Admin, Design, Draft, Isodraft, Monitor, Paragon and Spooler. Most bar menus end with a Help option, which gives you the following choices from its submenu: Help>Contents

This displays the Help window with the Contents tab at the front, so that you can find the required topic from the hierarchical contents list. Help>Index

This displays the Help window with the Index tab at the front, so that you can find all topics relevant to a selected keyword. Help>Search



This displays the Help window with the Search tab at the front, so that you can search for instances of a keyword across all the help topics. Help>About

This displays information about the current operating system on your computer and about the versions of PDMS and its applications to which you have access. Pressing the F1 key at any time will display the help topic for the currently active window. The help attempts to provide you with information in a variety of ways:

How to help. Pick from a list of how tos. The how to will jump to a sequence of steps telling you how to perform the task you have selected.

Context-sensitive help. Provides help specific to the form you are using. Index search. Finds all topics relevant to a selected keyword. Keyword search. Finds all topics which contain a user-specified word or phrase.

3.2.2 The help icons

Note: not all of the icons listed below will necessarily appear in all PDMS helps The symbol indicates a book with own content. This book does not contain

any help topics, but double-clicking the icon will bring up the content of the book.

The symbol indicates a book with own content and topics. Double-clicking the icon will bring up the content of the book and a list of the help topics (and/or other books) contained within that book.

The symbol is a normal book. Double-clicking the icon will bring a list of the help topics (and/or other books) contained within the book.

The symbol indicates an ordered steps topic (typically a How to topic). The symbol indicates a reference topic giving supplementary information. The symbol indicates an ordinary help topic.


4 The PDMS databases

4.1 Introduction

The overall purpose of PDMS is the controlled creation of a complete threedimensional process plant design model using computersimulation techniques. All information which exists about a PDMS design project, whether administrative or technical, is stored in a series of hierarchical databases. Use of the various PDMS modules allows you to create, modify and extract information from these databases. This chapter describes

The purpose of each type of database How the detailed project information is held in each How the separate databases are related to each other

4.2 The database types

4.2.1 The Project

A PDMS Project consists of the complete collection of information which relates to a single design project. This is identified by a three-character name, allocated by the Project Administrator when the project is first initiated. This name is used to identify the project to the system whenever you wish to work in the project using PDMS. This allows access rights and use of system resources to be monitored and controlled. For further details of these functions, see the VANTAGE PDMS Admin and Monitor Reference Manuals. There are 10 different types of database which can go to make up a complete Project:

Design and Drawing Databases: DESIGN database PADD database ISOD database

Reference Databases: CATALOGUE database DICTIONARY database PROPERTIES database

Administration Databases:


The PDMS databases

SYSTEM database COMMS database MISC database TRANSACTION database

(See section 4.4 for more background information on Reference databases) Each PDMS module requires access to one or more specific database types, and entry to the module may be prevented if appropriate databases do not exist or if you dont have the appropriate access rights. New databases can only be created by the Project Administrator; see the PDMS Admin Reference Manual for details. The functions of each type of database are summarised in the following subsections.

4.2.2 DESIGN database

The Design databases contain all information needed to create a full-scale three-dimensional representation of the plant. Each user is normally allowed to modify the Design databases which relate to his function in the plant design team, and will often have permission to look at other Design databases so that his work is compatible with that of other designers. Typical design functions, each of which may use a different Design database, include:

Equipment design (process vessels, storage vessels, pumps, heat exchangers etc.) Pipework design (the interconnecting pipes between the various equipment

items) Structural design (the columns, beams, walls, stairways etc. which support and

give access to the operational equipment and pipework) Hangers and Supports (specialised pipe support structures)

The compositions of the principal types of Design database are described in the PDMS Design Reference Manual, Part 3.

4.2.3 PADD database

(PADD is an acronym for Production of Annotated and Dimensioned Drawings) This type of database holds data about both the pictorial content of drawings and about their annotation and dimensional information. It therefore holds a complete specification of the contents of a drawing. Its use is specific to the interactive drawing module Draft. For further information, see the PDMS Draft User Guide, Part 1.

4.2.4 ISOD database

The ISOD database holds pipework spool drawings generated by the Spooler module. See Pipework Spooling Using PDMS for more details of Spooler.


The PDMS databases

4.2.5 CATALOGUE database

This contains a catalogue of the standard components which you may select when designing pipework, ducting, hangers and supports or structural steelwork. It includes:

Dimensional details for each component Details of permissible connections between different components and of the bolts

needed to assemble flanged components Specifications of the components, which define the conditions of use for each type

(maximum pressure, temperature etc.) A Catalogue database may contain a single universal catalogue, but it will more commonly contain a general catalogue plus one or more specialised catalogues specific to particular design functions.

4.2.6 LEXICON database

The Lexicon (or Dictionary) database is a projectspecific database which is used to hold the definitions of user-defined attributes (UDAs). The UDAs are used to hold any information, not allowed for by the standard attributes, about elements which are themselves part of either a Design, Catalogue or Draft database. For further information, see the PDMS Lexicon Reference Manual.

4.2.7 PROPERTIES database

This is available for storing data about material properties, which may be needed to supplement Catalogue and Specification data for some design functions such as stress analysis. Its use is specialised and will not be described further in this manual. For further information, see the PDMS Propcon Reference Manual.

4.2.8 SYSTEM database

There is one, and only one, System database in each Project Folder. It holds administrative information about the composition and use of the project, including the following:

A list of databases of all categories which are usable in the project A list of all users, identified by name and password, who can legally access the

databases, and the operating Team(s) to which they are assigned A list of PDMS modules available for use in the project Access control data, which defines those databases which are accessible to any

specific user and whether he may modify them or only look at them


The PDMS databases

4.2.9 COMMS database

The COMMS database stores the information about who is using which module and which databases are current. Each user has a separate area of the COMMS database, which can be accessed in write mode, and so can record module changes etc. Each user has read access to the other users areas, and so can find out about other users in the project.

4.2.10 MISC database

The MISC database is used to store inter-user messages, and inter-database macros. This database can only be opened in write mode by one user at a time, but many users can read from it. All users need to be able to write to this database, but only when they are sending messages or writing inter-database macros, or deleting messages and macros. All users can read from the database at any time.

4.2.11 TRANSACTION database

To enable the System Administrator to monitor the progress of Global commands, PDMS Global stores details of issued commands in a TRANSACTION database. Transaction messages are generated in the database each time the progress of the command changes. Transaction databases are only present when PDMS incorporates the Global product. See Chapter 9 and the PDMS Admin Reference Manual for details of Global.

4.3 PDMS project structure

A project is identified by a 3-character name. For example, the sample project supplied with PDMS is project SAM. The structure of the project folder is shown below:

Figure 4-1 Project SAM structure sam000 The project directory. The files under sam000 are: samsys The SYSTEM database. samcom The COMMS database. sammis The MISC database.


The PDMS databases

samnnnn_sammmmm Database files which contain the actual model data. nnnn has a maximum value of 8188. samiso The directory which stores files needed by Isodraft. sampic The directory which stores picture files produced by Draft. sammac The directory which stores inter-database connection macros. DFLTS The PDMS defaults directory.

4.3.1 Other projects

Besides SAM, your PDMS install CD will include the MAS and IMP projects: MAS (Master) provides the sample project data in read-only databases. This data

should not be deleted or changed in any way, or the rest of the sample project will become unusable.

IMP is an (empty) project set to use Imperial units

4.4 The relationships between databases

Although each type of database contains its own specific type of data, some of the data items in one database are derived from crossreferences to data items in other databases. It is therefore sensible, and sometimes essential, to build up the various types of database in a logical order. In particular you should note the following points:

A SYSTEM database must exist before you can access any other type of database in which you wish to work. It is created (using the MAKE macro) when a new project is set up; all other types of database are created using the ADMIN module. See the ADMIN Reference Manual for further details.

DESIGN databases, particularly those containing piping or structural steelwork design data, derive information about the individual design components from the CATALOGUE databases. This information includes dimensional data, specifications for use, and connectivity data. A CATALOGUE database must therefore be built up before you try to work in a DESIGN database.

PROPERTIES databases, if used, are referenced by CATALOGUE and DESIGN databases.

PADD databases normally incorporate references to parts of the design model, for graphical representation, as well as selfcontained information for drawing annotation and administration. A DESIGN database, and hence a CATALOGUE database, should therefore exist before you try to work in a PADD database.

LEXICON (DICTIONARY) databases hold definitions which are referenced from DESIGN, CATALOGUE or PADD databases.

Generally multi-discipline projects are executed using discipline-specific designers who will use specific applications in PDMS to construct the model components for their discipline. A project, therefore, may consist of a number of Design databases for each discipline.


The PDMS databases

When constructing the model, references are made to catalogue, property and user-defined attribute data that are held in different types of databases. As this data is common to all users of each discipline, each user will refer to a common set of data for the project. These databases are collectively known as Reference databases. In order that each user can see the required design components modelled by other users and refer to the common catalogue, property and user defined attribute data, the Design and Reference databases are grouped together into a Multiple Database, or MDB. See section 4.5 for more details of Multiple Databases.

The cross-references that exist between the various types of database (excluding the administration databases) are illustrated in Figure 4-2.

PROPERTIES DB

CATALOGUE DB

DESIGN DB

PADD DB

DICTIONARYDB

ISOD DB

Figure 4-2 Relationships between the database types

4.5 Multiple databases (MDBs)

When a PDMS project is set up by the Project Administrator, groups of databases are defined for particular purposes. For example, the members of any design team will need access to those databases containing the parts of the design data for which that team is responsible plus some of the Catalogue and Drawing databases. Such a group of databases is known as a Multiple Database or MDB. There would usually be several MDBs for a project, each defining specific groups of databases, for users with different tasks to perform.


The PDMS databases

The way in which an MDB is set up, in terms of its constituent databases and access rights, is described in the PDMS ADMIN Reference Manual. Although an MDB may contain up to 1000 databases, only 300 of these may be accessed at any one time. These accessible databases are known as the current databases; all others within that MDB are said to be non-current or deferred. Databases may be transferred between current and deferred status at any time. Many users can access the same MDB, but in most situations it is recommended that there is one MDB per user. This allows the database with write access to be placed at the start of the MDB. This is essential if new data is to be added to an empty database. An alternative approach is to have a single MDB for many users, and then use the Monitor module to move the required database to the front of the list.


The PDMS databases


5 How PDMS data is stored

Despite the huge power and potential of PDMS, the database is structured in a very simple and logical form. The database is hierarchical, a tree like structure, as illustrated below. Note: the hierarchy below illustrates the (simplified) Design database hierarchy, but

the Catalogue, PADD, ISOD, Lexicon and Properties databases also have a hierarchical structure.

Figure 5-1 The PDMS Design database hierarchy In this hierarchical structure all the database elements are owned by other elements, with the exception of the WORLD. Elements that are owned by another element, e.g. a ZONE is owned by a SITE, are said to be members of the owning element, e.g. The ZONE is a member of the SITE.


How PDMS data is stored

5.1 The Design database element types

5.1.1 WORLD

When the database is first built, it is empty except for a single element named the WORLD. Every database has its own WORLD element as the first element in the hierarchy.

5.1.2 SITE

Below the WORLD, the second level of the hierarchy is the SITE. A SITE may be considered as a significant collection of plant, whose size is not necessarily determined by physical area, but by practical considerations. It may, for example be the whole Project, or one part of a large Project. There can be as many SITEs within a PDMS project as required for data organisation.

5.1.3 ZONE

The next level below a SITE is a ZONE. Again, a ZONE is not necessarily used to define a physical area, it is more likely to store similar types of item for easy reference, such as a piping system in one ZONE, related equipment in another, and so on. There can be as many ZONEs owned by a site as required for data organisation. SITE and ZONE elements are common to all disciplines. Below ZONE level the hierarchy is discipline dependent, i.e. the elements depend on which discipline you are modelling.

5.1.4 EQUIPMENT (EQUI)

Equipment items are built up in PDMS using elements known as primitives. Each piece of Equipment can comprise any number of primitive shapes positioned to form the item. The primitives may be owned directly by the EQUI element or by a Sub-Equipment element. An Equipment would typically be a Pump, or a Vessel. The Box and Cylinder primitives are clearly visible in the Pump Equipment shown in Figure 5-2.



Figure 5-2 A Pump EQUI element

5.1.5 SUB-EQUIPMENT (SUBE)

A SUBE is an optional element to further sub-divide an EQUI. The SUBE can also own primitive elements.

Figure 5-3 A Vessel EQUI, with a SUBE



5.1.6 PRIMITIVES

Primitives are the basic building blocks of PDMS. They are used by other disciplines to create catalogue components. There are many types of primitive, each with its own features, which when combined with other primitives can represent complex shapes. Examples of primitives are nozzle (NOZZ), box (BOX), cylinders (CYLI) and pyramids (PYRA).

5.1.7 STRUCTURES (STRU)

STRU elements are administrative elements, i.e. they exist to own FRAMEWORK elements, and allow the plant structures to be separated for ease of modelling and reporting.

5.1.8 FRAMEWORK (FRMW)

FRMW elements are used to store structural components in the model. A complex structure can be divided into logical frameworks. Dividing the structure in this way allows structural modelling, and also reporting, to be done more efficiently, e.g. by copying a complete FRMW. Structural components may also be owned by a Sub-Framework element.

Figure 5-4 A pipe rack FRMW element



5.1.9 SUB-FRAMEWORK (SBFR)

A SBFR is an optional element that can own structural components. Subframeworks are used to further sub-divide complex projects or for modelling sub-assemblies within a framework.

5.1.10 STRUCTURAL COMPONENTS

Structural profiles are represented in PDMS by section (SCTN) elements. I-section profile sizes are selected using a Section Specification that references standard catalogue data for section sizes complying with various national standards. Plates are represented by panel (PANE) elements and curved profiles are modelled using a general section (GENSEC) component.

5.1.11 PIPE

Pipes may be considered like lines on a flowsheet. They may run between several end connection points and are usually grouped by a common specification and process.

Figure 5-5 A Pipe element, showing Branches



5.1.12 BRANCH (BRAN)

Branch elements are sections of a pipe, which have known start and finish points. In PDMS the start and finish points are called the Head and Tail. Heads and tails may be connected to nozzles, tees or other Heads and tails, depending on the configuration of the pipe, or left open ended.

5.1.13 PIPING COMPONENTS

A BRAN can own a wide variety of components such as gaskets (GASK), flanges (FLAN), tees (TEE), valves (VALV), elbows (ELBO), etc. These form the shape and geometry of the BRAN and ultimately the pipeline itself. Piping components are selected using Piping Specifications that reference standard catalogue data. For example, each time you want to use a 100mm bore elbow, PDMS always accesses the data for it from the component catalogue. The data for this remains constant no matter how many 100mm bore elbows are used in the design.

Figure 5-6 A selection of piping components



5.2 Attributes in PDMS

Every element in a PDMS database has a fixed set of properties known as its attributes. Some attributes are common throughout the range of elements while others differ according to the type of element involved. For example, a cylinder (CYLI) has Height and Diameter attributes whilst the size of a box (BOX) is determined by Xlength, Ylength and Zlength attributes, as illustrated below:

Figure 5-7 Cylinder and Box attributes When you create an element, a set of appropriate attributes are entered into the database. The attributes will vary according to the type of element but essentially the process is the same. For example, a cylinder has the following attributes:

Attribute Default Value

Name Name if specified or hierarchy description Type CYLI Lock false (the element is not locked) Owner the name of the owning element or its hierarchy description Position N 0mm E 0mm U 0mm (relative to its owner) Orientation Y is N and Z is U (relative to its owner)



Attribute Default Value

Level 0 10 (this is a representation level setting) Obstruction 2 (it is a solid hard element for clashing purposes) Diameter 0 mm Height 0 mm

These are all of the attributes of a cylinder, and all cylinders in the database will have precisely the same number of attributes.

5.2.1 NAME

Every element in PDMS can be named. Whether named or not every element will have a unique system-generated reference number. If a name is not specified, then a hierarchy description will be displayed in the Design Explorer or Members List (see section 8.3). Internally PDMS uses the reference number since this cannot change. A table of names against reference numbers is maintained for this purpose. All PDMS names begin with a forward slash character (/), which is considered to be part of the name. In order to save you the effort of typing this, all of the forms you encounter will add the forward slash for you when you press the Enter key after typing a name. The forward slash character is not shown in the Design Explorer or Members List. The WORLD has a special name in PDMS, /*. Names cannot contain spaces and are case sensitive. For example, /E1302A is a different name from /E1302a or /e1302A. Elements in a PDMS database are unique, i.e. they cannot have the same name or reference number.

5.2.2 TYPE

This attribute refers to the specific type of element it is, e.g. EQUI is an Equipment type.

5.2.3 LOCK

The LOCK attribute determines if an element may be changed or not. If an element is locked, its LOCK attribute is set to the value TRUE, preventing it from being modified until unlocked. By default, LOCK is false.

5.2.4 OWNER

The different levels in the hierarchy are maintained by an Owner-Member relationship. An EQUI will have ZONE as its owner, while a CYLI might well be one of the EQUIs members. The owner is that element which is directly related to the current element at the next level up in the hierarchy, as shown in the diagram below:



Figure 5-8 A simple ownership structure The element on the upper level is the Owner of those elements directly below it, e.g. the equipment (EQUI) owns the primitive (CYLI). The lower level elements are Members of the owning element, e.g. the EQUI is a member of the ZONE.

5.2.5 POSITION

Many items in a database have a POSITION attribute which is the position of the element in relation to its owner. All primitives have a position attribute which relates to its point of origin. As each primitive has a different Point of Origin changing the position attribute will have the effect of moving the cylinder to some other position with its point of origin positioned on the new co-ordinates.



Figure 5-9 Point of Origin of a CYLI

5.2.6 ORIENTATION

By default, a cylinder is created in a vertical direction; that is, with one of its ends facing up. The orientation attribute allows this to be changed to any angle on any axis.

5.2.7 LEVEL

PDMS can produce different representations of an item, depending on how it has been modelled and the representation levels used. The default level is 0 to 10 but levels can be set beyond this range if needed. For example, steelwork profiles can be represented by centreline (stick representation) only or by the full detail of the section profile. By manipulating level settings it is, therefore, possible to have simple or complex representation of elements for Design display or Draft drawings.

5.2.8 OBSTRUCTION

The OBSTRUCTION attribute is used to declare whether an element is solid or not. Obstructions can be declared as Hard, Soft or No Obstruction, depending on the value of the OBSTRUCTION attribute. The default value of 2 results in a Hard obstruction, 1 results in a Soft obstruction (used for walkways, maintenance access etc.) and 0 is for No Obstruction (used to save computing time when elements are enclosed in another element which acts as an overall obstruction).



5.2.9 HEIGHT

The height of the cylinder.

5.2.10 DIAMETER

The diameter of the cylinder.

5.3 UDAs (User Defined Attributes)

This type of attribute is defined and assigned to elements using the Lexicon module by the System or Project Administrator. A UDA is just like any other attribute but may be specific to the company or the particular project. The setting of the UDA is up to the user, although it may have been set to a default value. Changing this is the same as with all other attributes. Their current values may be found by querying the items attributes. A UDA can be recognised by the colon placed in front of it:

COLOUR (User Defined Attribute) HEIGHT (Normal Attribute)


6 Using PDMS

6.1 Getting into PDMS

Assuming PDMS has been correctly installed on your workstation, start PDMS by selecting (for example) Start>Programs>AVEVA>VANTAGE PDMS 11.6>Run PDMS; two command windows and a splashscreen will appear briefly. The VANTAGE PDMS Login form that appears requires you to specify a number of details at the outset of your session.

To enter PDMS, you must first click on the PDMS Login form to make it active. Project is the project you will be working on (for example, SAM). Type in, or select

from the pull-down list, pressing Enter in each case. Username will have been allocated to you by your System Administrator. Type in, or

select from the pull-down list, pressing Enter in each case. Password will have been allocated to you by your System Administrator; type in. MDB is the multiple database within the given Project that you wish to use. Type

in, or select from the pull-down list, pressing Enter in each case. Make sure that you leave the Read Only box unchecked if you wish to modify the database as you work.

Module is the PDMS module that you wish to use. Type in, or select from the pull-down list, pressing Enter in each case.


Using PDMS

Use Load from to specify which setup files to load at startup. You can choose either the application default settings (Load from Macro Files) or a customised setup saved during an earlier session (Load from Binary Files).

The example below shows that user STRUC has entered PDMS to access MDB STRUC from the Design module, loading the initial setup from in-built macro files.

Click on the button to enter the Design module.

6.1.1 Working in a module

Once you have entered a module you can carry out any valid operations (normally reading, adding to or modifying the data stored in the current databases; see Chapter 8) by using the GUI (see Chapter 7) or by using the command syntax for that module as described in the relevant Reference Manual. You can usually change the databases to which the module has access from within the module. You can transfer data from PDMS to parts of your computer network which are not part of the PDMS database, such as external files or hardware devices, and you can also give non-PDMS commands directly the computer operating system, as described in section 7.9. You can update your writeable databases at any time, so as to reflect any design changes youve made while working in the current module.

6.1.2 Changing to another module

Each PDMS module has a Modules submenu enabling you to switch to any other module to which you have access rights. For example, for the Design module:


Using PDMS

An option form will be displayed asking you whether you wish to save the changes you have made in the current module before entering another one.

6.2 Getting out of PDMS

You will normally leave PDMS directly from the application module in which you are working. You may either save all work done in the current module before leaving or you may quit directly without updating any databases. All the modules have an Exit menu selection; the one shown below being for Design:


Using PDMS

If you have made changes prior to selecting Exit (and if you have not carried out a SAVEWORK operation), you will be asked if you first wish to save your changes to the appropriate database:

Clicking YES at this point would be the equivalent of doing a SAVEWORK (and then a QUIT). If you have done a SAVEWORK (and made no subsequent changes), or if you have made no changes at all during your Design session, then Exit will display a message which merely asks you to confirm that you wish to leave Design:

In every case, when you leave PDMS you will be returned to the operating system at the point from which you entered PDMS.


Using PDMS

6.3 Internationalisation

Microsoft produces many localised variants of Windows. VANTAGE products are designed to work in English on all of these, though they do not currently support the use of all the local languages. At the time of writing, AVEVA provides limited facilities that vary somewhat between products. Users of PDMS need to enter data (text and names) using their local language and output the same onto deliverables such as drawings, reports etc. In some cases, there is also a need to localise or translate the user interface. The same data are also required in other products such as VANTAGE Plant Design Review. By default, your PDMS project can use any language whose characters are contained within the Latin-1 character set, comprising: Danish Dutch English Faroese Finnish French Icelandic Irish Spanish German Norwegian Portuguese Swedish Italian PDMS can also support the following groups of languages: Far Eastern, comprising: Japanese Simplified Chinese Korean Traditional Chinese Latin-2, comprising: Albanian Czech English German Hungarian Polish Rumanian Serbo-Croatian Slovak Slovene Latin-Cyrillic, comprising: Bulgarian Byelorussian English Macedonian Serbo-Croatian Ukrainian Russian PDMS does not support any other character set/language, nor does it support the mixing of any of the above except the mixing of one Far Eastern language with English. PDMS must know if you are using a non-Latin-1 language in order to display characters correctly on drawings. To use an alternative character set/language:

You must use an appropriate version of Windows and a suitable keyboard. You must select the appropriate options from the Windows ,

Regional Options. For further details, see the PDMS Installation Guide, also the PDMS Admin User Guide for details of font families.


Using PDMS

6.4 Customisation facilities; the programmable macro language

Most PDMS modules make use of a GUI to drive the software. The interfaces provided with PDMS are designed to apply to a wide range of situations and business needs. However, as you become more experienced with PDMS you may wish to design an interface which is more closely related to your requirements. You do this using AVEVAs programmable macro language (PML). There are two versions of PML, the older one, known as PML 1, and the newer one, known as PML 2. PML 2 has been specifically designed for writing and customising the Forms and Menus of PDMS and other AVEVA products. Almost all the facilities available in PML 1 and the older Forms and Menus facilities are present in PML2. Before you begin customising a GUI, you must have a good working knowledge of the command syntax for the module you are working with. The commands are described in detail in the reference manuals for the modules. PML 2 has not completely replaced PML 1, and there are some tasks which are carried out more efficiently using PML 1 facilities. In particular, the PML 1 expressions package, which is used within PDMS for writing rules and defining report templates. The ability to customise individual Applications to suit your own specific needs gives you great flexibility in the ways in which you use your system. But it also introduces the risk that your modified macros may not be compatible with future versions of the software, since they are no longer under AVEVAs control. Your own Applications may diverge from future standard versions and may not take advantage of product enhancements incorporated into the standard product. To minimise this risk, it is most important that your in-house customisation policies constrain any changes which you make to the Applications so that they retain maximum compatibility with the standard product at all times. Remember that AVEVA can give you full technical support only for products over which it has control. It cannot guarantee to solve problems caused by software which you have written yourself. For full details of PML, refer to the VANTAGE Plant Design Software Customisation Guide and the Plant Design Software Customisation Reference Manual. If you need a full description of PML 1, for example if you are maintaining old code, you will need to refer to previous versions of the Plant Design Software Customisation Guide. The last one to describe PML 1 fully was dated October 1995.


7 Basic GUI features

PDMS uses a GUI using forms (dialog boxes) and menus with which Microsoft Windows users should not be unfamiliar. This chapter describes those GUI features which are specific to PDMS.

7.1 Using the mouse

You use the mouse to steer the pointer around the screen and to select or pick items by using the mouse buttons. The buttons perform different tasks depending on the type of window, and the position within the window, where the pointer is positioned. The appearance of the pointer changes according to the type of display item that is underneath it. The left-hand mouse button has three functions:

On a graphical view, clicking the left-hand button with the pointer over a design element results in that element becoming the current element (that is, the design item on which you want to carry out the next operation).

In a sequence of menus, dragging with the left-hand button activates the command represented by the highlighted menu option when the button is released.

On a form, the effect varies according to what you select. The middle mouse button is used primarily to manipulate a graphical view; the right-hand button is used to access the menu options specific to the graphical view window.

7.2 Using forms

Forms can include any of the following: text boxes drop-down lists option buttons check boxes scrollable lists action buttons.

Text boxes and drop-down lists are explained below; the remainder are explained later in this chapter.


Basic GUI features

7.2.1 Using text boxes

Text boxes are the areas where you type in alphanumeric data such as names or dimensions. A text box will usually have a label to tell you what to enter. When you first open a form which contains text boxes, the first text-box on the form is current and a text editing cursor (a vertical bar) is displayed in the box. A text-box often contains a default entry (such as unset) when first displayed. Some text boxes accept only text or only numeric data, and entries with the wrong type of data are not accepted. To enter data into a text box:

Click in the box to insert the text editing cursor. Type in the required data, editing any existing entry as necessary. (You may

need to delete the existing entry first.) When you have finished, confirm the entry by pressing the Enter (or Return) key.

Any text box with an unconfirmed setting is highlighted by a yellow background.

7.2.2 Using drop-down lists

Drop-down lists let you choose one option from a multiple selection. The list will usually have a label to tell you what you are setting and will show the current selection. They typically have the following appearance:

To change the setting, click on the down arrow or button face to reveal the full list of available options, then pick the required option.

7.3 Using menus

Menu options in pull-down or pop-up menus can be in any of three formats:

Standalone options initiate an action immediately.

Options followed by three dots display a form.

Options followed by a pointer, display a subsidiary menu that offers a further range of options. Throughout this guide, related selections from menus are abbreviated form using the > symbol as a separator. For example: Select Position>At>Explicit means:


Basic GUI features

1. Select Position from the bar men. 2. Select At from the resulting pull-down menu 3. Move the pointer to the right and select Explicit from the resultant submenu.

7.4 Using the toolbars

Toolbars are displayed immediately below the main menu bar in the application window. Some modules are provided with several toolbars. Toolbars contain a number of icon buttons which let you carry out common tasks without searching for the options in the menus. The actions of the buttons are explained in the online help. If you hover the cursor over a button, a tool-tip pop-up box will remind you of the function of the button. To activate a button, you click on it. Note: Toolbars can be switched on or off by right-clicking on a tool bar or the menu bar.

The names of all the toolbars available for the module will then be listed. Toolbars currently displayed will have a tick next to their names. Click on the name of a toolbar to add or remove it from the display as required.

7.5 Using the status bar

The status bar displays messages telling you what actions the application is carrying out. You should look at it frequently, especially if the system appears to be waiting for you to do something, since it will always prompt you for any input or action which is required to carry out the next step of your current activity. If the prompt lets you repeat a task an unspecified number of times, such as picking a selection of items using the cursor, you must press the Esc key when you have finished to indicate that you are ready to move to the next operation.

7.6 More on using forms

Forms are used both to display information and to let you enter new data. Forms typically comprise an arrangement of buttons of various types, text-boxes, and scrollable lists. Input to a form is usually via a combination of mouse and keyboard. While you have access to a form, you can change a setting, return to the initial values, accept and act on the current data, or cancel the form without applying any changes, according to the nature of the form.


Basic GUI features

7.6.1 Using option buttons

Option buttons (sometimes referred to as radio buttons) are used to select one, and only one, from a group of options. The selection is mutually exclusive, so that selecting one option deselects others in that group automatically. They typically have the following appearance:

Option selected Option not selected

To change the selected option button in a group, click the required button.

7.6.2 Using check boxes

Check boxes are used to switch an option between two states, typically set and unset. Unlike option buttons, they do not interact, so that you can set any combination of check boxes at the same time. They typically have the following appearance:

Set

Unset

7.6.3 Using scrollable lists

A scrollable list is displayed as a vertical list of options within a form, with vertical and horizontal scroll bars along its sides. To select an option, click on the line you want. The selected line is highlighted. Some scrollable lists let you make only a single selection, so that selecting any option deselects all others automatically. Other lists let you make multiple selections, with all selected options highlighted simultaneously. You can deselect a highlighted option in a multiple-choice list, by clicking on it again (repeated clicks toggle a selection).

7.6.4 Using action buttons

Most forms include one or more action buttons. You use these to tell PDMS what to do with the details you have entered in the form.


Basic GUI features

The common action buttons are:

Tells PDMS to accept the current form settings, and closes the form.

Cancels any changes you have made to the form, and closes the form.

Tells PDMS to accept the current form settings, and leaves the form displayed for further use.

Cancels any changes you have made to the form, and leaves the form displayed for further use.

Closes the form, keeping the current settings. Some forms contain more specific types of control button which carry out particular command options. The action is indicated by the name of the button (such Add or Remove).

7.7 Responding to alert forms

Alert forms are used to display information such as error messages, prompts and requests for confirmation of changes. You should respond by carrying out the task prompted for, or by clicking on the control buttons on the form (usually an OK or Cancel button).

7.8 Dockable Windows, Menu Bars and Tool Bars

PDMS uses a number of Microsoft .NET forms where windows are dockable and undockable, and where other window manipulation facilities are available. For full details of these facilities see the PDMS online help (for the graphical modules), Dockable Windows, Menu Bars and Tool Bars help topic.

7.9 Using commands

PDMS commands can be typed in when using PDMS via the Display>Command Line menu selection, which gives the Command Window:


Basic GUI features

To give a command, click in the Command> text entry box, type in the command, and press Enter. The scrollable list shows the command(s) entered and any resulting output from PDMS (including error messages). Command editing aids are available:

Clicking on a line in the scrollable list area copies that line to the Co

Documents

Getting Started With Pd Ms 116 Sp 1