Documente Academic
Documente Profesional
Documente Cultură
Administration
TM-3534
TRAINING GUIDE
www.aveva.com
www.aveva2
Revision Log
Date
27/09/2013
Revision
1.0
Description of Revision
Issued for Training 12.1.SP4.1
Author
SR
Reviewed
KA
Approved
GC
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 the AVEVA
Training and Product Support at tps@aveva.com
This manual provides documentation relating to products to which you may not have access or which may
not be licensed to you. For further information on which products are licensed to you please refer to your
licence conditions.
Disclaimer
1.1 AVEVA does not warrant that the use of the AVEVA software will be uninterrupted, error-free or free
from viruses.
1.2 AVEVA shall not be liable for: loss of profits; loss of business; depletion of goodwill and/or similar losses;
loss of anticipated savings; loss of goods; loss of contract; loss of use; loss or corruption of data or
information; any special, indirect, consequential or pure economic loss, costs, damages, charges or
expenses which may be suffered by the user, including any loss suffered by the user resulting from the
inaccuracy or invalidity of any data created by the AVEVA software, irrespective of whether such losses are
suffered directly or indirectly, or arise in contract, tort (including negligence) or otherwise.
1.3 AVEVA's total liability in contract, tort (including negligence), or otherwise, arising in connection with the
performance of the AVEVA software shall be limited to 100% of the licence fees paid in the year in which the
user's claim is brought.
1.4 Clauses 1.1 to 1.3 shall apply to the fullest extent permissible at law.
1.5 In the event of any conflict between the above clauses and the analogous clauses in the software
licence under which the AVEVA software was purchased, the clauses in the software licence shall take
precedence.
www.aveva3
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.aveva4
Contents
1
Introduction .............................................................................................................................................. 7
1.1
Aim..................................................................................................................................................... 7
1.2
Objectives ......................................................................................................................................... 7
1.3
Prerequisites .................................................................................................................................... 7
1.4
Course Structure .............................................................................................................................. 7
1.5
Using this guide ............................................................................................................................... 7
Administrative Settings ........................................................................................................................... 9
2.1
Creating a New Project .................................................................................................................... 9
2.2
Data Base Setup ............................................................................................................................. 10
2.3
MDB Setup ...................................................................................................................................... 11
2.4
Copying Data between Databases ............................................................................................... 13
2.5
Include or Copy Foreign Databases............................................................................................. 13
2.6
Document Files and Sessions ...................................................................................................... 14
2.7
Cleaning Old Session Files ........................................................................................................... 14
2.1
Current Session Units ................................................................................................................... 15
Systems and Explorers ......................................................................................................................... 17
3.1
Creating a System .......................................................................................................................... 17
3.2
PBS Hierarchy ................................................................................................................................ 19
AVEVA Diagrams ................................................................................................................................... 23
4.1
How to Create a New Template ..................................................................................................... 23
4.2
Creating a New Stencil .................................................................................................................. 24
4.3
Creating Symbols........................................................................................................................... 25
4.3.1
Creating Microsoft Visio Shapes .............................................................................................. 25
4.3.2
Creating a Branch Symbol ....................................................................................................... 26
4.3.3
Creating Flow Direction Symbol ............................................................................................... 29
4.3.4
Creating an Inline Fitting Symbol for Piping ............................................................................. 30
4.3.5
Creating an Inline Fitting Symbol for HVAC ............................................................................. 31
4.3.6
Creating an Elconn for Cabling ................................................................................................ 31
4.3.7
Creating Grouped Shapes ....................................................................................................... 32
4.3.8
Instrument Relationship Shapes .............................................................................................. 33
4.3.9
Creating an Area Shape ........................................................................................................... 33
4.3.10
Creating Line Patterns in Microsoft Visio ................................................................................. 34
4.3.11
Creating Double Sided Connector Line (Worked Example) .................................................... 35
4.3.12
Creating a Label with an Attachment Line (Worked Example) ................................................ 37
4.3.13
Creating a KKS Flag Annotation .............................................................................................. 40
4.3.14
Creating a Title Block ............................................................................................................... 42
4.3.15
Creating a Nozzle Shape (Worked Example) .......................................................................... 43
4.3.16
Creating Equipment Symbol .................................................................................................... 44
4.4
Importing Stencils and Drawings ................................................................................................. 44
4.5
Publish to AVEVA NET Configurations ....................................................................................... 45
4.6
Upgrade Drawing ........................................................................................................................... 47
4.7
Upgrade Database.......................................................................................................................... 47
4.8
Upgrade Diagrams Options .......................................................................................................... 47
4.9
Batch Update .................................................................................................................................. 48
4.10 Edit Master ...................................................................................................................................... 52
4.11 Compare/Update ............................................................................................................................ 52
4.11.1
Integration UDA ........................................................................................................................ 52
4.11.2
Options ..................................................................................................................................... 52
4.11.3
Linking ...................................................................................................................................... 57
4.12 Automatically Replacing a Schematic Symbol ........................................................................... 58
Auto Naming ........................................................................................................................................... 61
5.1
Defining Naming Rules .................................................................................................................. 61
5.1.1
Inserting a Rule (Worked Example) ......................................................................................... 61
5.1.2
Modifying a Rule....................................................................................................................... 63
5.1.3
Removing a Rule ...................................................................................................................... 64
Diagrams Rules ...................................................................................................................................... 65
www.aveva6
CHAPTER 1
Introduction
The AVEVA Diagrams application supports the creation of Piping, HVAC and Cabling Diagrams. The
application is based on the AVEVA Design Platform GUI and diagram layouts are created using an
embedded Microsoft Office Visio drawing control. All relevant data entered through the application is stored
into the Schematic Database. The training course will be taken by schematic administrator, and will provide
the necessary skill to create and maintain AVEVA projects that include schematic information and design.
1.1
Aim
Over the duration of this training the participants will learn to administer the AVEVA Diagrams application,
be familiar with the creation and maintenance processes.
1.2
Objectives
1.3
To be able to prepare and maintain the settings related to AVEVA Diagrams in Admin module,
To be able to create symbols and stencils,
To be able to create systems,
To be able to understand and maintain autonaming,
To be able to understand and maintain reports and report templates.
Prerequisites
It is necessary to have a good understanding of the AVEVA Plant Design or AVEVA Marine Outfitting
systems and it would be beneficial to complete one of the AVEVA Plant or AVEVA Marine Diagrams courses
(P&ID, Cable or HVAC) and have some experience on Windows file system handling beforehand.
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
Certain text styles are used to indicate special situations throughout this document, here is a summary;
Menu pull downs and button click actions are indicated by bold turquoise text.
Information the user has to key-in red bold and italic text.
Annotation for trainees benefit:
Additional information
www.aveva8
CHAPTER 2
Administrative Settings
In a design project, the administrator plays an important role by managing the privileges of the general users
and the Data Access Controls (DAC) rights. An administrator is able to change the access types of a project
and modify any MDB if required. A free user or administrator will have to create a new project and apply
some setting changes in the Admin module before proceeding to the next stage. This is to ensure that the
administrator will have the required access to schematic and 3D data accordingly.
2.1
Depending on the design requirements, it may be necessary to create a new project. This could be done via
All Programs > AVEVA Plant > Engineer > Diagrams > Project Creation Wizard or All Programs >
AVEVA Marine > Engineer > Diagrams > Project Creation Wizard command from the Start menu.
Three project variables are needed in AVEVA Plant and AVEVA Marine to support the AVEVA Diagrams
application. They are for the types of Diagrams, Stencils, and Templates, typically named as:
2.2
To be able to work in AVEVA Diagrams the administrator will need to prepare the Database relations for the
users. For this reason the administrator needs to login to the Admin module and set the MDB, including its
database(s) and projects module definitions.
To start AVEVA Diagrams Admin, select All
Programs > AVEVA Plant > Engineer > Diagrams
12.1.SP2 > Admin or All Programs > AVEVA
Marine > Engineer > Diagrams 12.1.SP2 > Admin
from the Start menu.
The AVEVA Plant or AVEVA Marine Login box appears. Select Project ADMIN, key-in the Username
SYSTEM, the Password XXXXXX, and then click OK
A new team and schematic (SCHE) database must be created
in a project where AVEVA Diagrams will be used. The
Schematic database is an extension of the existing Design
database. It is advisable to create a new database for
Schematic purposes i.e. DIAGRAMS as exists in the sample
project.
The MDB to be used for AVEVA Diagrams must contain:
At least one SCHE DB. The system administrator
can add several schematic DBs to the MDB if
desired. The SCHE DB(s) must be writeable.
At least one DESI DB for the System Hierarchy.
The DESI DB(s) can be read-only if so desired.
This would mean that the administrator would
have to go into design to create the systems. It is
recommended to keep the System Hierarchy in a
separate DESI DB to make administration easier.
If the diagram users need to be able to access
data in 3D design elements, additional DESI DBs
can be added to the MDB.
www.aveva10
When a SCHE database has been created, this will automatically create the Schematic world element,
(Schematic WORL*). From the Schematic world the user can add any number of Schematic Group
elements, (SCGROU), to hold their schematic elements, such as Diagrams, Stencils, Templates,
Equipment, Pipelines, Cables and HVAC lines.
For more information on database creation please see the TM-1300 AVEVA Plant (12.1) System
Administration (Basic) or TM-2120 AVEVA Marine (12.1) System Administration (Basic) Training Guides
2.3
MDB Setup
For more information on MDB creation please see the TM-1300 AVEVA Plant (12.1) System
Administration (Basic) or TM-2120 AVEVA Marine (12.1) System Administration (Basic) Training
Guides
www.aveva11
www.aveva12
2.4
It is possible to use the RECONFIGURE command to copy schematic data between databases and also to
copy databases between projects. Below is an example of procedure for copying data from
SAMPLE/CABLDIA database in SAM or SCHEMATIC/DIAGRAMS database in MAR project to
SCHEMATIC/DIAGRAMS database located in a newly created TPS project.
Log in to Admin module using SAM or MAR project and type following commands in the command line.
FROM DB SAMPLE/CABLDIA
TO FILES /TMPF1 /TMPF2
RCFCOPY ALL
RECONFIGURE
Switch to Admin module using TPS project. Make sure that the target TEST database exists in TPS project
(if not create it). It is not necessary that the source and target databases have the same number. Type the
following instructions in command line:
FROM FILES /TMPF1 /TMPF2
TO DB SCHEMATIC/DIAGRAMS
RECONFIGURE
All data have been copied now together with associated files (for diagrams, templates and stencils) and no
other action is required before they can be used
For more information on the RECONFIGURE command please see Administrator Command Reference
Manual
2.5
www.aveva13
2.6
All Microsoft Visio documents such as diagrams, stencils and templates are handled through index elements
in the database. When a diagram is created, an SCDIAG element is created in the database, and this
contains a pseudo attribute called VISF that provides the file name of the actual file in the file system. File
names are composed by <element ID><session no>. This mechanism and naming convention supports the
Dabacon session concept and provides a mechanism for Global to manage the files in a multi-location
project. These file names are not visible to the user. The user will handle all diagrams through the index
elements in the database and will only see the names of the index elements.
This mechanism creates new files each time a SaveWork is executed. This means that when users have
been working for a certain amount of time, a large quantity of files may exist in the
%<PROJECTCODE>DIA% directory, in the same way that a Dabacon database grows as sessions are
being added. There is currently no mechanism to automatically delete obsolete versions of the files when a
database session merge is executed.
At the same time as a diagram file is saved, an SVG format file is also created. This is for the purpose of
viewing the diagrams in other applications such as the AVEVA Schematic 3D Integrator without having the
need for a Microsoft Visio installation. In the same way as querying the VISF attribute on the SCDIAG
element for obtaining the Microsoft Visio diagram file name, the SVG file name can be found by querying the
NVIEWF attribute. Changing the Create SVG on Save Work setting to Always in Diagrams Options, will
result in creation a new SVG file every time a save work processed. When it is set to False a new SVG file
would only be created if any element is released to 3D.
Changing the KEEP_SESSION_FILES default setting to False in Diagram Options, will result in only the
latest version of the Visio diagram file to be kept. If this setting is used it will not be possible to restore a
previous session including the corresponding diagram file version.
Microsoft Visio templates and stencils are handled in the same way as the diagrams, using SCTEMP and
SCSTEN index elements in the database. With the exception that no SVG format files are created when
templates and stencils are saved by the application.
2.7
The AVEVA Diagrams application provides a tool for removing old document session files from a project. It
can be used when the Keep session files setting (KEEP_SESSION_FILES) in Diagrams Options is set to
False
Select Project Maintenance > Clean Old Session Files from the Admin tab, the dialogue window is
opened and provides the possibility to select the document types to clean.
Select the document type(s) to clean. After clicking OK button the following
confirmation dialogue is displayed.
www.aveva14
2.1
Cleaning old session files allows saving disc space in the case that there is no need to keep previous
documents versions, but after performing the operation it will not be possible to restore earlier sessions
including the corresponding diagram file versions
When the user enters dimensional data in any window in AVEVA Diagrams, the units applied will be taken
from the default settings. The default units are specified independently for each unit type. To change the
default units, the user will have to select Units from the Admin tab to display the Current Session Units form.
A system default file is supplied for both metric and imperial units as %pdmsdflts%/system-current-unitsMet.pmldat and %pdmsdflts%/system-current-units-Imp.pmldat.
To set the default units for a specific project the administrator must select the required units using the
Current Session Units window and click the Save button. A file, %pdmsuser%/xxx-save- current-unitsMet.pmldat or %pdmsuser%/xxx-save-current-units- Imp.pmldat will then be created. The created file must
be copied to the project defaults folder and renamed to %xxxdflts%/project-current-units-Met.pmldat or
%xxxdflts%/project-current-units-Imp.pmldat to be able to permit the use the Project Defaults or use a saved
file created by them.
On Global projects, it is necessary to propagate the units settings file to all project satellites. If the Other
Data Transfer mechanism has been implemented, then project units settings files could be propagated in
this way. Otherwise, the most practical method of propagating a project units file is simply to distribute the
file to all satellites and have the file copied to the appropriate project folder. In practice, project units files will
be configured at the beginning of a project, and are unlikely to be changed frequently during the life of a
project.
The Save and Restore buttons can be disabled by the administrator which forces the user to use the project
default settings. To disable the buttons, the administrator must open the file saved in the project defaults
folder and change the !!comFormats.allowUserSaveFile = true to !!comFormats.allowUserSaveFile =
false
www.aveva15
www.aveva16
CHAPTER 3
3
3.1
A system is basically used to define the Pipe Spec, Insulation Spec, Tracing Spec, Paint and Fluid of a pipe.
User can choose to omit or set a default system. A system can be used with or without any default values
included, in this case the item belonging to this system will only have a system reference stored in scsysf
attribute.
To create a new system for AVEVA Diagrams application the user must have the appropriate login, i.e.
must be a user with the right privileges
The administrator should ensure there is at least one (which could be a Reference Only) DESI DB in
the MDB with read/write access to be able to create new systems using the AVEVA Diagrams
application
Select Systems from the Admin tab.
17
The Purpose of the group area needs to be set to PIPE, ELEC, or HVAC to allow the modelling
applications related form(s) to filter the systems, i.e. Create Cable, Create HVAC and Create Pipe
forms in AVEVA Plant Design or Marine Outfitting modules
Now select the SYGPAR SYSTEMS_GR_AR, right click and select Create System from right click context
menu. The Create System form appears, key in the Name TRA, the Function Training, the Description
System for Training, and then click the OK button.
For each system, there is also a subordinate SYSCDA (System Schematic Data) element which contains
default values per system for the AVEVA Diagrams application and SYSMDA (System Model Data) element
which contains default values per system for the Outfitting application.
Navigate to the SYSGRP TRA and right click, select Create System Schematic Data. Enter name
TRA_Default, Description Training, and Pipe Spec SP/DR07C and click OK button.
Once the training system and defaults have been created, create systems and their schematic data
respectively for HVAC and Electrical elements. Then the user can then set these systems as default or in
particular against design elements without needing an administrative login.
The Track New Elements checkbox can be used to automatically navigate to the newly created items
www.aveva18
3.2
PBS Hierarchy
PBS (Project Breakdown Structure) is a customisable hierarchy which allows administrators to set up a
display in order to allow users to see the elements in a specifically organised manner.
To be able to use a PBS hierarchy the administrator will need to ensure that there is at least one readable
Dictionary database in the current MDB for the users. The administrator will need to login to the Lexicon
module to prepare the hierarchy in advance. The PBS nodes are generated during runtime and maintenance
and changes made to the PBS hierarchy in Lexicon will be shown the next time a user enters to the AVEVA
Diagrams module.
Login to the AVEVA Lexicon module in AVEVA Plant or AVEVA Marine and navigate to the Sample_PBS_
World. If this does not exist in your design then the macro provided can be used.
Please note, if desired the PBS hierarchy could be created manually. However, the administrator will
need to remove the copied or included Dictionary databases earlier on in this training
For more information on creation of PBS please see the TM-1308 AVEVA Plant (12.1) Lexicon
or TM-
In the Current Element Editor, the administrator can see the value
of PBS text. This is the text that will be displayed for this node in
AVEVA Diagrams application. This could be a text or PML text
expression.
The PBS formula type determines how the PBS formula is parsed. The PBS formula shown from Lexicon on
the left will then be evaluated and the items matching this criterion will be collected under this node as
shown from AVEVA Diagrams on the right below.
www.aveva19
Please note that the sample functions may require alteration to suit to the
needs of the schematic elements
The result will display the schematic item types in AVEVA Diagrams with a
folder symbol, ready to include the actual database items in the next steps.
www.aveva20
The criteria (PBSCRT) for filtering the elements displayed in the PBS
hierarchy could be created at any level after the administrative
elements are created. Please note that, creating a PBSCRT element
will reduce the number of the elements returned depending on the
criteria requirement(s). On the right a PBSCRT element is shown
where it expects to read the result of GetEngItems as an answer when
the DSIAST attribute of a datasheet is questioned. i.e. to be able to get
all datasheets attached to C-1101, an elimination is made throughout
the all datasheet elements and those have DSIAST attribute with a
value of C-1101 are collected under the relevant node.
The result in PBS should display all systems with the member schematic equipment elements underneath.
Beneath this, equipment should display their datasheets, diagrams, linked items and members. The names
and the order could change per project and it should be noted that the administrator should ensure that both
the PBS definition and the representation in AVEVA Diagrams are built consistently.
www.aveva21
www.aveva22
CHAPTER 4
AVEVA Diagrams
Depending on the way the project has been set up initially will show differences in which groups will
belong to which DB i.e. Diagrams should belong to the DIAGRAMS, Templates belong to DIAGTEMP
and Stencils belong to STENCILS. This will be controlled by the administrator. To find out which DB an
element belongs to select the folder in the Schematic Explorer and from the Command Window key in
Q DBname. For the training purposes everything will be saved into the Training folder
4.1
From the main pull down menu select New > New Diagram from the Project tab, the Choose Template form
appears. From the database tree select the folder that holds the Templates i.e. Project_Templates, all of the
available templates under the folder are now visible, select the template required and then click the Open
button. A new blank diagram is opened complete with the border as a background.
The New diagram will not exist on the DB until the Save Work function has been done
The Save Diagram as form appears. Browse in the tree to select a SCGROU where the new template is to
be saved, then key the name TRA_A2_Template and select from the Save as type pull down Template
(SCTEMP) then click the Save button.
23
4.2
To create a new stencil select New > New Stencil from the Project tab, the new stencil appears and is
docked into the existing diagram.
The newly created stencil now requires saving to the DB before shapes can be added. From the main pull
down menu select Save Stencil As from the Project tab, the Save Stencil StencilX as form appears.
Browse in the tree to where the new stencil is to be saved, key-inn the name TRA_Stencil and then click the
Save button. Another information form appears asking the user Do you want to save work? Click the Yes
button.
www.aveva24
4.3
Creating Symbols
A major part of the AVEVA Diagrams functionality is based on a set of specialised AVEVA Diagrams
shapes. Many of these shapes contain information about what kind of database element the shape should
be related to, while others do not have any database equivalent at all such as annotation labels etc. This
mechanism enables the application to automatically create related database elements, as well as provide
automatic annotation and general intelligence.
Shapes that should be recognized by AVEVA Diagrams and handled by the application logic must be
created through the Import Shape accessible through the Admin tab. These include shapes corresponding
to DB elements, (for instance branches, valves, instruments and fittings), off-page connector shapes and
label shapes presenting attribute information.
The shapes processed by the Import Shape Wizard will be stored in a user-selected stencil and will contain
data specific to the AVEVA Diagrams application. Other Visio shapes that have not been processed through
the Import Shape Wizard can still be used for annotation etc. on drawings, but these will not be handled
'intelligently' by the application.
AVEVA Diagrams shapes can also contain default attribute values, which can enable users to create
specialised shapes and will reduce the amount of information that is necessary to enter when diagrams are
created.
4.3.1
Before shapes can be imported to a stencil using the Import Shape Wizard, they will have to be created
using Microsoft Visio tools. It is highly recommended that the user creating the shapes has a good
knowledge of Microsoft Visio and is familiar with how Visio shapes works before proceeding to create
AVEVA Diagrams shapes. Microsoft Visio offers many possibilities for creation of smart shapes with different
kinds of behaviour. AVEVA recommends that this is used carefully, as complex shape behaviour can result
in reduced performance and also interact with the AVEVA Diagrams application code in a way that can give
unexpected errors. A few examples of useable behaviour are described below.
To be able to create shapes with special features, the Microsoft Visio Shape Sheet has to be used. For
technical reasons, this is not available in the AVEVA Diagrams application. If the user needs to access
the Shape Sheet for making special settings in the shapes before import, the user will have to copy the
shape to the Standard Microsoft Office Visio application, access the Shape Sheet, and then copy the
shape back to AVEVA Diagrams
When drawing the shape, it is recommended to use the same grid setting that will be applied when the
shape will be used in the drawing, thereby avoiding alignment and snapping problems. To minimize the risk
of mistakes when different zoom settings are used, the grid can be set to Fixed. A suitable grid size is
suggested to be 1mm. To set the Ruler and Grid select Ruler and Grid from the View tab.
www.aveva25
All of the Valves supplied have been drawn using a 4mm x 8mm grid
Connection points can be added to shapes by using the Connection Point Tool icon available on the
dropdown in the Standard toolbar.
To add connection points, activate the shape and holding down the Ctrl key indicate where the connection
point should be added. For inline Pipe/HVAC elements, the order in which connection points are added is
important. The first point added will correspond to the arrive and the second the leave. The direction of the
connection points can be changed by right clicking on a connection point and selecting Inward, Outward or
Inward & Outward
4.3.2
These directions are NOT related to flow directions of the component. This only
relates to Visios mechanisms for connecting shapes to each other. Connection
points for 2D shapes (such as equipment, valves, fittings etc.) should normally be
Inward. Outward connection points are only required if the user intends the shape to
be directly connected to other 2D shapes. The normal approach is to always use
Inward when shapes are created. The connection can then be changed to Outward if
required after the shape has been added to the diagram
From the Standard toolbar select the Connector Tool; draw the shape of the line to become the branch
symbol. Once the line has been drawn select the line so the vertexes are highlighted and then right click.
A right click context menu will appear select Line from the
Shape Tools context sensitive tab, this will allow the user
to change the representation of the line i.e. Pattern,
Weight, etc. when finished click the Apply button followed
by the OK button.
www.aveva26
Selecting the element type as Pipeline will result in Create Pipeline form to be displayed when the
current shape is dropped to the drawing canvas
The Import Wizard Destination Stencil form appears, select the destination stencil and click Next. The
Import Wizard Annotation Style Settings form appears, click the Next button.
If this is set to True, the shape text settings will be fetched from the default
set up in the Diagrams Options Element options for the relevant type. If it
www.aveva27
www.aveva28
The reason for the prompt of Save Work is that if the application subsequently closed without any Save
Work command being issued, the imported shapes will be lost. So if the user clicks No, then they will have
to remember to perform a SaveWork at a later time.
This procedure for creating a branch is the same for Pipe, HVAC and Cable Lines
4.3.3
www.aveva29
Now from the Standard toolbar, click the Pointer Tool icon, and select the
element so the vertexes are highlighted. Select Import Shape from the Admin
tab.
www.aveva30
4.3.5
Using the Visio drawing tools create a Damper symbol, once complete make sure that all the lines, circles,
etc are grouped together using the right click context menu Group > Group. Now select the shape so it is
active and then select the Connection Point Tool from the Standard toolbar. Holding down the Ctrl key on
the keyboard click with the cursor where the connections are to be placed.
The Import Shape Wizard Type and Name of Shape form appears, using the Import selected shape as tree,
navigate to the correct element type that corresponds to the previously drawn shape. Key in the Shape
name HVAC Damper and then click the Next button. Repeat the same process as shown in the previous
example until the shape is saved to the required stencil.
4.3.6
From the Home tab, Tools section; select the Line Tool, draw the line and then select the Ellipse Tool, and
draw the circle.
www.aveva31
From the right click context menu select Group > Group, this will
group the two elements together. Now from the Home tab, Tools
section; select the Connection Point Tool
With the grouped element selected, hold down the Ctrl key and indicate the two positions for the
connections, now select each connection in turns and right click, then select from the right click context
menu making sure that one connection is Outward (this is the one that will attach to the equipment) and the
other Inward (this is the one that the cable will connect to).
Now from the Standard toolbar, click the Pointer Tool icon, and select the element so the vertexes are
highlighted. From the Admin tab, select Import Shape and repeat the same process as shown in the
previous example until the shape is saved to the required stencil.
The shapes will be undefined and they could be grouped manually. The administrator will need to save this
shape into a stencil by dragging and dropping the shape to the appropriate stencil.
www.aveva32
If grouped prior to adding to a stencil when an assembly of shapes is added to the drawing, it is
recommended to ungroup it using the Right click > Shape > Ungroup before proceeding to connect or
modify. If this is not done, it can result in unexpected behaviour
In case the arrangement contains more than one branch, the user will have to select a part in each branch
and define them by right clicking on the branch in the drawing and selecting Define Branch or using the
Define icon from the toolbar.
4.3.8
These shapes can be used to show not only the connections between off-line instruments and between offline instruments and actuators but also instead of instrument lines to demonstrate a high level of instrument
connectivity. An Instrument Relationship Shape does not represent a database element, but does connect
the attached items in the database.
An instrument relationship shape is created as a connector tool, the same as for pipelines and a style can be
applied to the line to represent the type of signal line, if required. Import the shape as an Instrumentation,
Instrument Relationship Shape item from the list.
4.3.9
Area shapes provide the possibility to define an area on the diagram which may correspond to a Room.
However it doesnt represent any database element but gives general mechanism for assigning attribute
values based on the location of the shape within the frame provided by the Area Shape unless it is defined
in the database. Area Shape can control sets of attributes and their values are automatically applied to
shapes it contains.
An area can be represented by any 2-dimensional shape which is imported on a stencil as an Area Shape
using the Import Shape Wizard. After that it can be used by dragging and dropping onto any drawing. An
Area shape can be located on foreground or background of a diagram page.
Default set of attributes controlled by Area Shape can be modified in Diagrams Options in Attribute
Presentation tab. Additional attribute could be added by clicking Referenced attributes button.
www.aveva33
It is possible to override these attributes during the Import Shape Wizard, provided that Allow individual
shape settings to override default settings checkbox is checked in Diagrams Options
All attributes with Propagate checkbox checked will be
controlled by Area and propagated to contained shapes.
In addition it is possible to specify prefixes which would
be set for both propagated and not propagated attributes
in Shape Data. The prefixes can be set in Diagrams
Options for Area Shape.
4.3.10
To be able to create this shape we need to be able to display the shape sheet, this can NOT be done from
inside the AVEVA diagram application and Microsoft Visio has to be used.
Before the user starts to create the shape, remember to set the grid size to Fixed and 1mm spacing and also
make sure that the Run in developer mode is activated. This is done by selecting Tools > Options and
selecting the Advanced tab.
www.aveva34
4.3.11
Open Microsoft Visio and create a new blank diagram (Metric). A blank diagram appears. Select the
Developer tab and check the Drawing Explorer checkbox. The Drawing Explorer form appears. Select
Line Patterns, right click and select New Pattern from the right click context menu.
Name the new pattern line as HVAC Duct, pick the line pattern Radio button, select the third behaviour ,
check the Scaled check box and click OK. The HVAC Duct pattern appears in the Drawing Explorer Menu.
Right Click the New Pattern and select Edit Pattern Shape
www.aveva35
Draw the required lines. In this case, a horizontal line has been drawn 1 mm from above and 1 mm from
below; to create a branch connector of width 2 mm.
Close the diagram. The dialogue box below appears. Click Yes, after which the
application switches to the original diagram.
Select the Connector Tool and draw a 4x6 line and right click the line and select
Format > Line from the right click context menu. The newly created HVAC Duct
appears under the Line Pattern. Select it, click Apply then OK
The connector line is now double sided and can be used in AVEVA Diagrams. Copy the connector line with
the HVAC Duct pattern and paste into AVEVA Diagrams and import the shape.
www.aveva36
4.3.12
Using the Line tool in Visio, create the shape as shown to represent the label and then group the shape
together, this is done so the attachment line can appear behind the label.
Now with the shape grouped and the vertexes highlighted right click and from the right click context menu
select Show ShapeSheet. The Shape sheet appears, the user now needs to insert two sections one for the
Geometry and one for the controls, to do this right click on the shape sheet and select Insert Section. The
Insert Section form appears, tick the two required sections and then click the OK button.
The two new sections are now visible inside the shape sheet window.
In the Geometry section change the MoveTo for the X and Y to Width*0.5 and Height*0.5 and change the
LineTo for the X and Y to Controls.Row_1 and Controls.Row_1.Y
Move the control point by dragging or use the control section to move the geometry away from the corner, in
the Controls.Row_1 for the X change to Width*1.9167
www.aveva37
In case there should be a possibility to turn on and off the attachment line, this can be achieved by inserting
an Actions section with the
=SETF(GetRef(Actions.Row_1.Checked),NOT(GetVal(Actions.Row_1.Checked))) in Action, Show
attachment line in Menu and 001 in SortKey fields referring the Checked property using the
=NOT(Actions.Row_1.Checked) formula from the NoShow property of the Geometry section:
The attachment line can now be turned on and off by using the shape right click context menu.
To get the shape from Visio into the AVEVA Diagrams application, select the shape so the vertexes are
highlighted and right click, from the right click context menu select Copy. Return to the AVEVA Diagrams
application, right click and select Paste
www.aveva38
To get the shape into the stencil, select the shape so the vertexes are highlighted and drag the shape into
the required stencil. A message dialogue box appears, telling the user This stencil is open read-only. Would
you like to edit the stencil, so that the operation can be complete? click the Yes button.
The new shape is now added to the stencil, right click on the shape and from the right click context menu
select Rename Master. Key in the new name Label_Type1
www.aveva39
Modify the TxtPinX and TxtPinY where necessary to show the text in the flag.
Change the LocPinX and LocPinY value where necessary to move the centre of rotation to the bottomcentre of the shape.
www.aveva40
To use the flag annotation; drag and drop the shape on the canvas and connect it to a line using the yellow
diamond handle. If the connection is successful, the handle should turn red, the direction of the flag should
be adjusted according to the flow and the flag should display the attribute value of the connected element.
The size and the position of the flag could be adjusted manually.
www.aveva41
To enhance the title block labels the user can combine native attribute presentation with PML1
expressions, for more information on annotation please see Appendix A
The user can use PML1 expressions in the Shape Text attribute when creating a new symbol or editing
a master. For more information on PML1 Expressions please see Appendix A
After dropping the Title Block on to a diagram/template the annotation strings defined for particular fields are
evaluated according to the existing database attributes. Those strings can be re-defined using the shape
data of a single text field.
www.aveva42
Now in Microsoft Visio, with the shape grouped and the vertexes highlighted right click and from the right
click context menu select Show ShapeSheet. The Shape sheet appears and user will have to scroll down to
the Connection Points section.
At the connection point 1, change the DirX / A to -1 mm and leave the others as 0 mm. Now the nozzle will
orientate itself towards the outside of the equipment when user drags the nozzle near to the connection
point of the equipment.
www.aveva43
4.3.16
In the Import Shape Wizard step, the user can determine whether the equipment shape to accept dropped
elements, i.e. sub-equipment, electrical connections etc.
4.4
This can for instance be used in a way that for a cable or HVAC line shape as well, a filter is referred
that includes searching in the correct category for cables. When the user will subsequently select such
a cable shape in the drawing and go to the catalogue search window, it will automatically apply the predefined filter so only the relevant cable catalogue items will be shown
Stencils, templates and diagrams that do not have any SCDIAG, SCSTEN or SCTEMP elements in the
database, these can be brought in by using the Import command in the Project tab. Diagrams and
templates can be opened using the Import > Drawing command and stencils can be opened using the File
> Import > Stencil command from the Project tab. It is also possible to export these items to be used in
another project in a similar way using the Export command in the same tab.
After being opened in this way, database items can be saved using the Save Diagram As and Save Stencil
As commands via the Save As group in Project tab which will create the index elements in the database
and save the files in the location pointed to by the %<Project code>DIA%, %<project code>STE% and
%<project code>TPL% variables.
www.aveva44
4.5
To be able to configure AVEVA NET Publish settings, the administrator user needs to be a member of
AVEVANETADMIN team. If this team is not created in the project, it could be done as described in the
previous chapters.
To be able to define how deliverables and data are mapped to their
corresponding AVEVA NET objects, attributes are also mapped, and
instructions on CAD output handling Publish to AVEVA NET configuration can
be used. A set of sample configuration files are included in the sample projects
for each supported product.
To be able to use the integration between the AVEVA Diagrams and AVEVA NET, the administrator or a
free user must set up the options beforehand. The configuration interface can be reached via AVEVA NET
from the Configuration section in Admin tab.
Publish to AVEVA Net form consists of
three areas. In the Configurations area,
the administrator can select which
configuration they want to edit.
Using the Name drop down list Diagrams and Reports can be selected. Using the Location text box, it is
possible to either type or browse the folder path where the configuration files to be found.
In the Logging Options area, the administrator can record all the activity during the publishing by checking
the Log Enabled checkbox and typing or browsing the path for the log file.
In the Staging Options area, the administrator must provide a writable folder in the Staging Area text box by
typing or browsing for the published documents to be created in.
Checking Create Trigger File checkbox will create a trigger file during the publishing which can then be
used by AVEVA NET to initialise the import automatically when exists.
The administrator can also reset the form to its default values using Restore Defaults button.
www.aveva45
In the Settings tab, the administrator could set up the background and line thickness properties of the
drawing element(s) to be published. Checking the Fast Graphics Mode will disable the drawing entities
such as meshes that are not required for the output from being exported, in order to speed up the process.
If during an output procedure, a CSV file is to be produced to the output folder containing a list of all the
tagged objects and their corresponding classifications, the Create CSV Tag File checkbox must be
checked.
www.aveva46
4.6
Upgrade Drawing
The Drawing command in the Upgrade section of Admin tab will upgrade all Tribon M3 or any previous
AVEVA Diagrams shapes on the current drawing to the current version of AVEVA Diagrams shapes. NonTribon M3 shapes will be ignored. Upgraded shapes will not automatically be defined in the database. This
will have to be done manually afterwards using the Define function.
4.7
Upgrade Database
The Database command in the Upgrade section of Admin tab will copy values from CREF to SCIREF
attribute for earlier version(s) of offline instruments. The administrator will need to save work afterwards.
4.8
Diagrams Options are configured by an xml file that contains both the definitions and the actual values of all
options. For various reasons, the administrator may have more than one version of this file. If a definition of
the option exists in both the old options file and the current one a copy of the old value is inserted to the new
options file. If a value for a (new) definition of option is not found in the old options file the default value of
that option is assumed.
If a value of option is found in the old options file that is not available in the current options definition then the
option is ignored and a warning is given in the Message Log. If any problem is detected during upgrade, the
user will be prompted.
www.aveva47
The user storage area is the location corresponding to %PDMSDFLTS%\Diagrams\, while the admin
storage area is %<PROJ_CODE>DFLTS%\Diagrams\
The Attribute Presentation settings are stored in DiagramsAttributePresentations.xml file in the defaults
folder which is referred as %<PROJ_CODE>DFLTS%/Diagrams or %PDMSDFLTS%/Diagrams
Provided that the admin storage area is only controlled by the administrator access to the options (read-only
or read-write) is decided by an administrator. The user can only affect the option value if allowed to do so.
The rest of the option data i.e. position in the options file, name, description, type, default value is not
editable.
4.9
Batch Update
This functionality allows administrators to update many drawings in one go without opening them where the
user may request to update the drawings according the master shape changes, defaults, catalogue defaults
and/or Diagrams Options. The option is available from the Batch Job command in Tools tab.
Select the diagram to be updated and using the
Add button, ensure the diagram is displayed in
the Selection list. Then click Update Diagrams
button.
Make sure the selected diagram is closed
before proceeding, otherwise a warning will be
displayed and it wont be possible to update an
open diagram.
www.aveva48
If an attribute is removed using Batch Update, the system will not remove it but will give a warning if
other attributes are using this data, i.e. where Instrument type is used as shown, it will not be possible
to update the shape not to show this attribute in Shape Data
www.aveva49
Refresh shapes
Ignore stencil settings option will not work for autolabels layer. The layer for autolabel is taken from
master that is used to create autolabel
Shapes that do not have settings in Diagrams Options will require master to be selected, i.e. Title
blocks and Multi labels
Batch Update cannot be used to set any default values to shape data
Once the desired settings are checked on the Update Diagrams Options, it is possible to select the masters
for the update to be applied to. Click on the Browse button which is next to Select master shapes to use for
update (0 selected). This message will be updated with the number of the master shapes after the selection
is accepted. The Select Masters to update form will be displayed where the user can add a stencil and pick
some or all masters from it to be updated in the drawing(s) previously selected.
www.aveva50
It is possible to use the Load log button on the Update Diagrams Options form to open a saved log file
using Save Report button on Update Diagrams Status form
The Update Diagrams Status is now displayed and the user can click on the links shown in the related
columns to view the informational messages, warnings or errors.
If the user deleted an auto label from a shape, it may not be added after the update as system
remembers the deletion. To add the auto label, use Ignore stencil settings checkbox or select the
appropriate master
Click OK button on the Update Diagrams Status form, then dismiss the Batch Job form and open the
updated diagram.
Clicking Cancel on the Update Diagrams Status form will revert all changes done by Batch Update
process
www.aveva51
In step 3, the annotation settings can be changed, in step 4 the attribute presentation can be changed and in
step 5 the Default catalogue search filter can be changed.
The administrator / the user can select Edit Shape command from the Shape context sensitive tab for
the same purpose on shapes already in the drawing
4.11 Compare/Update
4.11.1 Integration UDA
The integration UDA should be defined using Lexicon module by
the administrator in an accessible dictionary database from the
current MDB. Once available, if AVEVA Instrumentation or
Electrical data have previously been imported into the target
database the UDA will provide the comparison using AVEVA
Instrumentation or Electrical source database references. If the
UDA is not available the comparison will be done according to
the default matching criteria.
It is recommended for the administrator to use the definition of the UDA elements as follows. It is possible to
extend the element types list for any additional UDET items provided that they are based on the given
element types below.
UDA Name
pmg-sch-ai
pmg-sch-ae
text
50
Element Types
SCINSTRUMENT
SCOINSTRUMENT
SCLOOP
SCVALV
SCACTUATOR
SCEQUI
SCCABLE
The UDA may be created in any UGROUP in a current dictionary database. If used in conjunction with
the specific module, it is suggested to include this UDA in the same group
4.11.2 Options
The Compare/Update add-in is standard for all AVEVA Plant and AVEVA Marine applications. Therefore the
settings for its functionalities are included in the Options form. The Options form could be used to configure
and maintain the attribute and element type mappings, links between database elements and AVEVA
Schematic 3D Integrator rules.
www.aveva52
The Manage Links button, the Use advanced configuration checkbox and the Configuration Explorer
button will become enabled when a Dabacon source is selected in Compare/Update add-in and a
configuration is available
For more information on configuration of the integration rules database please see the AVEVA Plant
AVEVA Schematic 3D Integrator (Administration) (TM-3563) Training Guide
If configuration is required to access the source database, the Configure Design Database button will be
activated with an appropriate name. Currently this is used only for AVEVA P&ID source data in Tags.
For more information on configuration of the source database please see the AVEVA Plant AVEVA
Engineering - Tags (Advanced) (TM-3551) Training Guide
To display the Options form click on the Options command from the
Compare/Update context sensitive tab.
The Manage Configuration button allows the administrator to create a new configuration for element and
attribute mappings between the databases or to modify an existing configuration. To create and edit
configurations the administrator must be a free user or a member of CUADMIN team. The configuration
defines the source and target types of objects that will be compared, and their attributes that will be mapped.
Clicking on the Manage Configuration button on the
Options form will display the Compare/Update
Configuration Wizard. The wizard will take the
administrator through creating a new configuration or
choosing an existing configuration to edit, defining
the type of source and the target objects, mapping
the attributes and finally defining any filters that may
be applied to the source data.
In Step 1 of 6, the options to create a new
configuration or to edit an existing one will be
displayed.
Select Create new configuration or Edit existing
configuration radio button. Selecting the option to
edit an existing configuration will display a list of
existing configurations to select from.
Click Next to continue.
If creating a new configuration; the administrator will be expected to enter the data in the fields in all the
steps. However, if editing an existing configuration then the fields will be populated using the information
from the selected configuration automatically.
www.aveva53
www.aveva54
The configuration is saved and the Compare/Update add-in is now ready to be used.
After creating a configuration or editing an existing one, the administrator should ensure the linking structure
is in place. If this is not set, the following error will be displayed to users and it will not be possible to update
the schematic database using AVEVA Engineering and AVEVA Design databases.
www.aveva55
This is an administrative dialogue used to manage Link Worlds. Before using it, it is recommended that
the administrator creates a separate Design Reference database in Admin module, and ensures it is
available on all MDBs where linking will occur, and all users who need to link can write to it
The list includes all the Design and Design Reference databases available, identifying any that contains
links. The following functions are available from the File menu or the right click context menu.
Create
Validate
Validate All
Remove invalid references
Create a new Link World in the selected database if there isnt one already.
Output a list of links and any errors to the command line for the selected
database.
As for Validate for all databases in the list.
Remove invalid references from links in the selected database. Invalid
references can occur when elements are deleted and the Link World
database cannot be updated.
This operation should be used only when all of the databases holding objects that have been linked are
current on the MDB
Properties
The Edit menu provides Cut, Copy, Paste and Delete functions to move the Link Worlds between
databases. The administrator can also drag and drop from one database to another to move or merge a Link
World.
www.aveva56
4.11.3 Linking
Compare/Update add-in can link matched elements when both the source and target are Dabacon
databases. The mechanism used is shared with AVEVA Schematic 3D Integrator so that any links are
consistent.
The link information is stored on a CYMLNK object which is situated in a reference database and not
normally visible to the user. This has references to the linked objects. The deslnk, schlnk and englnk pseudo
attributes can be used as direct references between linked items to populate data in reports and other
deliverables.
www.aveva57
Always
Never
Ask
Always replace without prompt when the catalogue reference has changed.
Never replace when the catalogue reference has changed.
Prompt for replace when the catalogue reference has changed.
In addition to this, there is also a setting for Auto replace manually replaced shapes. This can have the
same values as described above for the Auto replace shape from catalogue, with the difference that it
only applies to shapes that the user has previously exchanged manually. This basically provides a way
to disallow any automatic changes to shapes that the user has manually replaced
www.aveva58
The item has received a new catalogue reference outside the control of the AVEVA Diagrams
application and the symbol has therefore not been updated accordingly.
The user has manually replaced a symbol and now wants to return to the symbol provided by
the catalogue.
The catalogue has been updated with new symbol references and the diagram should reflect
this change.
www.aveva59
www.aveva60
CHAPTER 5
Auto Naming
AVEVA Plant and AVEVA Marine Auto naming allows the AVEVA Plant or AVEVA Marine administrator to
define rules to be used when creating elements, i.e. pipes and valves. Rules are created based on element
types and attributes.
5.1
Select Naming from the Admin tab, the Naming Settings form appears. Make sure that Auto Naming On/Off
checkbox is checked to be able to see the rules working.
Infill
Append
Save
Load
61
Location
Determines where the Element Rules is stored. If User is selected the file
is stored in the %pdmsuser% folder. If Project is selected the file is stored
in the %project%\<PROJECTNAME>\<PROJECTCODE>dflts folder. If
the PDMS is selected the file is stored in %PDMSUI%\dflts folder.
On the Naming Rules form key in DIAGRAM and click the selection icon next to Rule Name field and select
previously created All Diagrams. Data input section will be updated automatically. Complete the Data Input
section as shown and click Insert
The user can select Before or After to insert a rule into the list of rules
www.aveva62
Click OK button and on Naming Rules form and select File > Save to save the
naming rules on the Naming Settings form.
www.aveva63
www.aveva64
CHAPTER 6
6
6.1
Diagrams Rules
Consistency Check Rules
In AVEVA Diagrams the user can define rules to be applied during consistency checks. The Consistency
Rules and the Formatting Rules both reside in the Diagrams Rules form which can be reached via the Rules
command from the Admin tab.
The Consistency Rules provide functionality to configure actions depending on user defined conditions and
create fully configurable definitions when a consistency check is made.
In the Diagrams Rules form, the main nodes will be displayed under the Diagrams Rules node. It is not
possible to remove or reorder these nodes, but they could be checked, partially checked or unchecked to
determine whether the rules beneath are active or not. The same could be applied to rule sets or individual
rules as well. When a rule or rule set is not active it will be skipped by the consistency check, but could be
either executed manually or automatically on certain events.
Using the right click context menus, the user can execute a number of commands.
Save
Export
Import
Restore
Apply
Create Rule Set
Create Rule
Rename
This will save the changes made to the current rule set.
This will export the current rule set to an xml file.
This will import a rule set from an xml file.
This will discard any unsaved changes, and will restore the current rule set
from the latest saved point.
This will apply the current rule.
This will create a new rule set.
This will create a new rule.
This will rename a rule set.
65
Copying and re-ordering is only possible in the scope of one kind of rules. As well as using the right
click context menu, drag and drop can be used to re-order the rules
Depending on the hierarchy, it is possible to execute the commands on the right hand side of the form
as well
Consistency rules can be specified by modifying their rule name and description, selection criter ia, check
to be performed on pre-selected shapes and the action to be taken on non-satisfying shapes. The details of
each rule can be viewed and modified using the Diagrams Rule Details form.
The name and the description of the rules can be changed any time using the appropriate fields at the top of
the form.
In the Shape Selection Criteria, the user can determine which elements should be taken into account while
performing consistency check, e.g. bore size should be checked for inline components only. From the drop
down list, Type & attribute value, PML Expression or Shapes without DB element can be selected. Each
of these options will enable the form to display attributes; a textbox to define the PML expression or further
options to specify the condition for the shapes without database element.
www.aveva66
Once the selection criteria are given, it is possible to highlight the matching shapes on the currently open
drawing using the Highlight link label. The highlight could be reset using the Reset highlight link label.
The shapes selected according to the shape selection criteria will
be checked against the definition given as a PML expression or
the definition selected from the library as shown.
The PML expression should be a Boolean type and it should return
a value of TRUE. Returning a FALSE value will cause the actions
in the next tab to be applied to all shapes on the page that dont
comply with the shape selection criteria.
There are a number of standard checks defined in Diagrams
Consistency Rules Library, but it is also possible to define custom
checks. They should be defined as classes implementing
IDiagramsRulesCheck specified in
Aveva.Diagrams.DiagramsRules in Aveva.Diagrams.dll. To be
automatically picked up, the class defining check should be placed
in a dll named *ConsistencyRulesLibrary.dll.
www.aveva67
As well as actions, severity of the rule and a message could be added to the rule details using the Actions
tab. The severity could be selected as Information, Warning or Error. The icon displayed in the Message Log
will depend on the severity of the rule and will be different for each. The message to be displayed in the
Message Log can be typed in the Message field.
Custom configuration
Behaviour is specified
locally for the rule and
doesnt depend on
default configuration.
www.aveva68
6.1
In AVEVA Diagrams the user can define rules to be applied during the design to affect the formatting of the
shapes. The Consistency Rules and the Formatting Rules both reside in the Diagrams Rules form which can
be reached via the Rules command from the Admin tab as shown previously.
Once the Diagrams Rules form is displayed, right click on the Formatting Rules node and select Create
Rule Set option from the right click context menu. Key in a name for the rule set and click OK
Having created and selected a rule set, it is possible to right click on the
rule set or the right hand side of the form and select Create Rule from
the right click context menu.
This will display the Diagrams Rule Details form which has 3 tabs,
Shape Selection Criteria, Format to be assigned and Rule options.
The Shape Selection Criteria tab is used to specify which items and
which attributes should be used to select the items. In this example
the Criteria is set to Type and attribute value, which means the
type of item can be selected from the drop down list below (in this
case All is selected) and the rules for applicable attributes and their
values are set-up in the grid below.
The alternative to the Type and attribute value method of selecting
the criteria is to use a PML expression.
Key in the name and the description of the rule. In the Shape
Selection Criteria tab, select the PSPE attribute and key in
SP/DR07C in the Value field as shown.
The administrator can also determine which shapes are selected
using a Visio formula to filter the shapes on the page as described
previously.
If the administrator has access to the schematic design; to identify which items on the diagram match
this shape selection criteria the Highlight link on the form could be used, this highlighting can be
removed using the Reset highlighting link
www.aveva69
The drawing layer must have been previously set up to be visible in the drop down list
Clear auto formatting checkbox can be used to clear previous formatting applied by other rules if the items
fulfill the current rule criteria. When checked the
formatting table will be greyed out and disabled for
editing.
These options will be ignored and disabled for editing when Clear auto formatting is checked in
Format to be assigned tab
If the Apply rule automatically on events (if enabled) option is not checked then rule will not be executed
automatically even if Auto apply rules is setting is on during executing the rules.
In the Handling Annotations section the settings provide the possibility to decide when shape matches the
rule, format should be applied to the shape itself without its annotations (labels), to shape with its
annotations or to the annotations only.
Once the rule has been set up as required, the Save button will save the rule and make it available to be
applied.
www.aveva70
As rules are created the Auto Formatting Rules form will be updated. This form can be used to select which
rules or rule sets should be applied using the check boxes in the tree view.
www.aveva71
www.aveva72
CHAPTER 7
7
7.1
The Configuration of Status sequences and their status values is an administrative task done for each
project. The configuration data is defined in the Lexicon module and is stored in the Dictionary database.
Normal Lexicon commands for creating and deleting elements and setting the attributes values, are
available to allow the systems administrator to build the status sequence and status value data structure.
Status Management is the ability to control and report on the status of individual model objects as they
progress through their lifecycles. It can be applied to any model objects, i.e. tagged items, catalogue
components, drawings etc. the example below is a typical workflow
73
Status Definition
Status Link
Element Ref
Status Value Ref
Comment: Text
Diagram /TRA_Diagram
Pseudo Attribute
Design Status Value: Work Completed
Design Status Number: 40%
Status Value
7.2
Having selected a writable element, from the Dictionary Explorer, right click and from the context sensitive
menu select Create > STAWLD: Status Configuration world, the Current Element Editor is now active for
the new element key in the Name Diagram_Status and the Description Diagram Status
www.aveva74
7.3
Using the Dictionary Explorer navigate to the newly created Diagram_Status world, click the right mouse
button and from the context sensitive menu select Create > STADEF: Status Definition, the Current
Element Editor can now be updated key in the Name Diagram_Creation and the Description Diagram
Creation. Now on the Current Element Editor form, click in the Controllable element types field and a
browse icon is activated.
The New Status Group which appears on the context sensitive menu is to allow the administrator to
sub-divide the hierarchy under the Status world
Click the activated browse icon, the Select element type form is displayed, in the Filter field key in SCD,
select SCDIAGRAM from the list and then click the Add to List button, this adds the selected element to the
Chosen element types list. Additional elements could be added if required, if no more elements are required
click the OK button.
www.aveva75
7.4
Using the Dictionary Explorer navigate to the newly created Equipment_Creation definition, click the right
mouse button and from the context sensitive menu select Create > STAVAL: Status Value, the Current
Element Editor can now be updated key in the Name WorkPending, the Description Work Pending and
Numerical value 0. Repeat this process for creating the additional Status Values as given below.
Name
Description
Numerical Value
Work_Started
Work_Suspended
Work_Complete
Rework
Preliminary
For_Check
Checked
Approved
Released
Work Started
Work Suspended
Work Complete
Rework
Preliminary
For Check
Checked
Approved
Released
20
15
50
25
55
60
80
90
100
7.5
Once all the Status Values have been created the Transitions need to be set up against each status value.
Using the Dictionary Explorer navigate to the first Status Value Work_Started, in the Current Element Editor,
select the Valid transactions field, a browse button appears. Click the browse button and the Select Valid
status transitions for is displayed. Click the Valid transitions i.e. Work_Started and click the OK button
www.aveva76
Status Value
Valid Transactions
Promote
Demote
Work_Started
Work_Suspended
Work_Complete
Work_Started
Preliminary
For_Check
For_Check
Rework
Checked
Rework
Released
Work_Complete
Work_Suspended
Work_Suspended
Work_Complete
Preliminary
For_Check
Checked
Work Started
Preliminary
For_Check
Rework
Checked
Rework
Released
www.aveva77
www.aveva78
CHAPTER 8
Link Documents
Each document or other resource, either external or internal, that can be linked to a database element is
represented in the database as Link Descriptor. The Link Descriptor's main role is to carry information about
the document it describes and a Uniform Resource Locator (URL).
It is possible for any other elements in the database to reference these Link Descriptors through a two-way
mechanism. This enables the users to find all elements that reference a particular Link Descriptor and the
reverse, to find all documents referenced by an element.
It is also possible to assign classification information to each Link Descriptor. The classification information
provides the facility of assigning multiple class information to a Link Descriptor so that a search for all
elements that have references to documents with specific classification assigned can be made. i.e., a search
can be made for all Link Descriptors classified as "Installation"- class document or all pumps that do not
reference any "Certificate" and "Security"- class documents.
The schematic overview below shows the possible linkage to external documents and internal drawings.
8.1
All elements related to links are stored under Link World elements. To use links the user has to create at
least one Link World. It can store Link Folders, Link Classes and Link Descriptors.
It is possible to assign Link Descriptors to elements in other databases. It is therefore recommended that
LINKWL elements are created in a Schematic database of its own to which all relevant teams have read and
write access.
8.2
Under Link Worlds it is possible to organise all elements into a tree structure. The users can create Link
Folders that can contain more Link Folders or Link Classes and Link Descriptors. This way it is possible to
freely configure the hierarchy
Copyright 1974 to current year.
AVEVA Solutions Limited and its subsidiaries.
All rights reserved.
79
8.3
A Link Descriptor (LNDESC) element holds a link to documents and external resources. Both external
documents and draft drawing elements can be referenced using a LNDESC.
A Link Descriptor has the following attributes.
NAME
User-defined name of the LNDESC element.
DESC
Description of the element.
LNKURL
A string storing raw Uniform Resource Locator of the linked document.
8.4
Link Class
The classification of documents is possible through use of Link Classes (LNCLAS). Each Link Descriptor
(LNDESC) may be classified by multiple classes. The diagram below shows how each LNDESC is
associated with more than one LNCLAS. A single Link Class may classify multiple Link Descriptors; in the
diagram LNCLASI is associated with all three LNDESC.
A Link Class has the following attributes: NAME - user-defined name of the LNCLAS element.
DESC - description of the element
There is also a pseudo attribute available named LNKDOC that returns a list of LNDESC elements
that are classified by this LNCLAS
8.5
Before it is possible to link documents to database elements it is necessary to create at least one Link World
(LINKWL). The user can organise Link Descriptors and Link Classes into a hierarchy of folders.
From the main pull down menu, select Links command from the View tab, the Linked Documents form is
displayed. Select the Folders/Classes tab on the form and then right click and from the context menu select
New World
www.aveva80
8.6
Using the Schematic Explorer navigate to the element that requires the link. From the right click context
menu of the current element or the Linked Documents form select Add Link
or
www.aveva81
The linked web page details can now be seen in the Linked Documents Form.
8.7
Assigning a Class
Once a Document has been linked a Class can be assigned. From the Linked Documents folder select the
linked document to add it to a class. Select the Assigned Class required i.e. TrainingLinkClass by checking
the relevant check box.
www.aveva82
8.8
Displaying Links
If it is necessary for the user to check if a link exists, select the Links tab on the Linked Documents form and
check the Follow CE check box. Using the Schematic Explorer the user can select each element to check if
a link has been added.
www.aveva83
www.aveva84
CHAPTER 9
9
9.1
Reports
How to Create a Visio Report
All of the information needed to generate a report can be saved in a report definition. A report definition
determines which shapes and properties are included in the report and how the report is formatted. The user
can save a report definition in a file or directly in a drawing. To use the same report definition to generate
reports from multiple drawings, the user must save their definitions in a file. To generate a report only in one
drawing and easily distribute that drawing, save the definition in the drawing.
The user can set up report definitions to summarize data by including subtotals and grand totals in the
generated report. The user can also sort the report by columns and rows.
From the Tools tab, select Reports > Visio Reports, the Reports form appears now click the New button.
Choose the shapes desired to report on and then click the Advanced button.
85
The previous form is once more displayed, click the Next button. Select the properties to produce a report
on by ticking the boxes i.e. Description, Name etc. and then click the Next button.
Key in a Report Title Valve_Report and then click the Sort button to put the Report into the correct reporting
sequence.
Move the Column order up or down to suit the report required, then click the OK button.
www.aveva86
When the user runs the definition the data will be sorted
with respect to the report definition given.
For more information on creating a report template see the TM-1300 AVEVA Plant (12.1) System
Administration (Basic) or TM-2120 AVEVA Marine (12.1) System Administration (Basic) Training Guides
9.2
Report Designer
The administrator can launch the Report Designer by selecting Reports > Designer from the Tools tab.
This will display the Report Designer with a new report. The administrator then could create the report
definition and save it to be used later.
www.aveva87
www.aveva88
Pseudo attributes or PML expressions can be typed directly into the Data Source Column List. It is possible
to click the Back button to modify the definition. To complete the process click the Finish button.
To edit the definition of this data source at a later stage use the Data source icon from the toolbar and
select Edit option. It is also possible to create a copy and modify the definition of element views, project
views or previously created data source definitions using the Copy option.
After binding the data source the administrator could use the tools and facilities in the Report Designer to
enhance the output.
For more information about the Report Designer please see the DevExpress Report Designer user
guide
www.aveva89
www.aveva90
CHAPTER 10
Below is an example of the .xml file. By changing the file, it is possible to apply different rules for the
selection of icons. The administrator can view and modify this file in a text or XML editor.
91
www.aveva92
www.aveva93
www.aveva94
CHAPTER 11
Avoid having many pages in the same diagram. It is better to create separate diagram files. At the
moment, all the pages in the diagram are being processed and saved as SVG files during
SaveWork, this is the case even if the user has just modified one of the pages.
Avoid using heavy bitmaps or too detailed vector graphics in title block and backgrounds. You can
experiment by removing some of these and measure the SaveWork performance to determine if you
have an issue with this.
There is a setting to control whether SVG files should always be created, or only when the drawing
contains anything released to 3D. If this setting is used, it is possible to get better performance when
initially working with the drawing. After it has been released to 3D, there will then be a performance
degradation as the SVG files starts getting created. Please note that once SVG files starts
generating, you cannot turn it off again, so this setting has to be applied from the start of a new
diagram drawing.
During Save Work, there is intense file storage activity with Visio and SVG files. For this reason it is
recommended that the IT infrastructure such as network and file server disk performance where the
files reside (xxxDIA) is optimized.
Only use the Refresh command when necessary, i.e. when it is suspected something has been
updated in the DB and the user needs to see it reflected in the drawing.
If some shapes are selected in a drawing when doing the refresh, only those shapes will be
affected. It is often unnecessary to refresh the whole drawing if only one part is being worked on.
Reduce the number of attributes per shape to be shown in Custom Properties down to a set of
attributes that are really being used by the AVEVA Diagrams user. It is possible to control which
attributes should appear in the Custom Properties through the Attribute Presentation function. If for
instance half of the attributes shown in the Custom Properties are never used, then removing them
will halve the time used for refreshing the whole drawing. Check the usage of the UDAs regularly
and remove unused ones from the project.
As mentioned above, it is possible to disable the SVG creation until it is really needed (when the
diagram has been released to 3D).
There is a setting to control whether to use binary Visio files or XML format Visio files. XML format
requires much more storage space, thus make sure to use the binary format.
There is a 'Keep session files' setting that will determine whether the old versions of the Visio and
SVG files will be kept during each Save Work or not. With this setting the user can switch between
'more data management capability & more storage space required' or 'less data management
capability & less storage space required' as is described below.
If this setting set to True there is a possibility to backtrack the Dabacon session and access
the specific Visio/SVG file versions related to that particular session. The drawback is that it
may take a significant amount of storage space to save the related files for all sessions.
95
If this setting set to False only latest versions of the Visio/SVG files will be kept. This means
that backtracking a Dabacon session will not give access to the corresponding Visio/SVG
files. However, storage space requirements will be less demanding.
Alternatively, if 'Keep session files' setting is set to True, and sessions are to be merged, then select
Tools > Utilities > Project Maintenance > Clean Old Session Files to remove the corresponding
Visio/SVG files. This can be an approach where there is a possibility to backtrack changes during a
period. Merge and clean the sessions and continue from there.
www.aveva96
APPENDIX A
The dot notation can be replaced by the of word in PML1, i.e. instead of {AFTER([owner.name],/)
it could be used {AFTER([name of owner],/)
97
The notation can also be a result of a PML1 expression. For more information about PML1 functions
please see Software Customisation Reference Manual, PML1 Expressions
To get a particular element from an attribute of array type, use a (number) notation. i.e.,
owner.diaref(1). The enumeration of elements is 1-based. The (0) string will give all elements of the
array. To reference an array element in PML1 expressions, use the attribute name followed directly
by a number, i.e. ppbo2
www.aveva98
APPENDIX B
13 Appendix B - Licensing
In AVEVA Diagrams 12.0.SP4 or earlier versions the AVEVA Diagrams application has 3 separate modes of
use; P&ID, HVAC and Cable. The P&ID and HVAC modes check out a licence seat of AVEVA Diagrams
(Marine Diagrams in versions prior to SP4). The Cable mode requires a separate Cable Design licence.
From AVEVA Diagrams 12.0.SP5 onwards the AVEVA Diagrams application enables all of the P&ID, HVAC
and Cable modes using an AVEVA Diagrams licence and without requiring a separate Cable Design licence.
A new licence feature, (SCHE-DB-ACCESS), is required for all accesses (read and write) to the schematics
(SCHE) database in Dabacon. One seat is required for each user reading or writing to the Schematic
database.
The SCHE-DB-ACCESS licence feature cannot be purchased separately. The only way to get the
licence feature is to buy the required number of AVEVA Schematics products
The SCHE-DB-ACCESS licence feature is checked out whenever a Schematic database is opened by any
AVEVA product. Any of the following will check out the licence feature:
Entering AVEVA Diagrams or AVEVA Schematic Model Manager applications
Entering any Outfitting module where a Schematic DB is included in the MDB and the module
definition is defined to open Schematics DB(s).
99
www.aveva100
APPENDIX B
101
14.1.1
PML Function
If the administrator wants to call a simple PML function that as shown below,
define function !!DiagramsPrint()
$P Hello world!
endfunction
The only action needed is to write a formula in the Action cell. In this case, it will look like below:
=QUEUEMARKEREVENT("/module=Diagrams /type=shapecontext /code=PMLFUNC
/name=DiagramsPrint")
In some cases it might be useful to pass reference number of the database element that the shape
is representing
If the administrator wants to call a PML function that as shown below,
define function !!DiagramsPrintParam(!DbRefNum is string)
!a = object DBREF(!DbRefNum)
handle any
endhandle
if (UNDEFINED(!a) or UNSET(!a) or BADREF(!a)) then
$P element not found
return
endif
!n = !a.name
$P The clicked item is $!n
endfunction
In this case a parameter needs to be passed to the PML function. This can be achieved by adding
/param=refnum to the formula. The updated formula should look like this:
=QUEUEMARKEREVENT("/module=Diagrams /type=shapecontext /code=PMLFUNC
/name=DiagramsPrintParam /param=refnum")
14.1.2
Command Execute
www.aveva102
Allowed Values
Diagrams
shapecontext
PMLFUNC
COMMAND
[PML function name]
[Command Key]
refnum
shape
Comments
Application name
Says that it is shape context menu.
The PML function will be called
The Command Execute will be called
Used with PMLFUNC only
Used with COMMAND only
Database reference number as string of item that is
represented by Visio Shape. This parameter can be
used only when PMLFUNC
Visio Shape will be passed as parameter.
www.aveva103
www.aveva104
APPENDIX D
15 Appendix D Exercises
15.1 Project Preparation
1.
2.
3.
4.
2. Log in to the AVEVA Diagrams application as SCHEM user with password SCHEM and test if the
newly created system is working.
3. Create the following line patterns, Pneumatic, Capillary and Electrical Line.
105
5. If you have any other stencils in your system, import these stencils into your current project.
6. Create a new template with your company title. You can insert an AutoCAD file to assist you with
this.
7. If you have any other template in your system, import these templates into your current project.
15.6 Links
1.
2.
3.
4.
www.aveva106
www.aveva107